AgentsListOptionalParams interface

選擇性參數。

Extends

屬性

after

用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如,如果您提出清單要求並收到 100 個物件 (結尾為 obj_foo),則後續呼叫可以包含 after=obj_foo 來擷取清單的下一頁。

before

用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如,如果您提出清單請求並收到 100 個以 obj_foo 結尾的物件,則後續呼叫可以包含 before=obj_foo 以取得清單的上一頁。

kind

按種類過濾代理。 如果未提供,則會傳回所有代理程式。

limit

要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間,預設值為 20。

order

created_at 物件的時間戳排序順序。 asc 用於升序和desc 用於降序。

繼承的屬性

abortSignal

可用來中止要求的訊號。

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

tracingOptions

啟用追蹤時所使用的選項。

屬性詳細資料

after

用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如,如果您提出清單要求並收到 100 個物件 (結尾為 obj_foo),則後續呼叫可以包含 after=obj_foo 來擷取清單的下一頁。

after?: string

屬性值

string

before

用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如,如果您提出清單請求並收到 100 個以 obj_foo 結尾的物件,則後續呼叫可以包含 before=obj_foo 以取得清單的上一頁。

before?: string

屬性值

string

kind

按種類過濾代理。 如果未提供,則會傳回所有代理程式。

kind?: AgentKind

屬性值

limit

要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間,預設值為 20。

limit?: number

屬性值

number

order

created_at 物件的時間戳排序順序。 asc 用於升序和desc 用於降序。

order?: PageOrder

屬性值

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

繼承自 OperationOptions.abortSignal

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

onResponse?: RawResponseCallback

屬性值

繼承自 OperationOptions.onResponse

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

requestOptions?: OperationRequestOptions

屬性值

繼承自 OperationOptions.requestOptions

tracingOptions

啟用追蹤時所使用的選項。

tracingOptions?: OperationTracingOptions

屬性值

繼承自 OperationOptions.tracingOptions