GetUserDeliveryTask - Edge Security Acceleration - Alibaba Cloud ドキュメントセンター

特定のユーザーのタスクの配信設定とステータスを照会します。

操作説明

機能：この操作は、Alibaba Cloud ユーザーの特定のタスクに関する詳細な配信情報 (タスク名、破棄率、リージョン、ビジネスタイプ、ステータス、配信タイプ、配信設定、フィルタールールなど) を取得します。
ユースケース：この操作を使用して、特定のタスクのログ処理と配信設定を確認します。これは、処理効率の分析や問題のトラブルシューティングに役立ちます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:GetUserDeliveryTask

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskName	string	必須	タスク名。	test_project

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	7072132a-bd3c-46a6-9e81-aba3e0e3f861
TaskName	string	タスク名。	testoss11
DiscardRate	number	破棄率。	0
DataCenter	string	データセンター。有効な値： cn：中国本土 sg：グローバル (中国本土を除く)	cn
BusinessType	string	ビジネスタイプ。有効な値： dcdn_log_access_l1 (デフォルト)：アクセスログ。 dcdn_log_er：エッジ関数ログ。 dcdn_log_waf：WAF ログ。 dcdn_log_ipa：レイヤー 4 アクセラレーションログ。	dcdn_log_er
Status	string	タスクのステータス。	online
DeliveryType	string	配信タイプ。有効な値： sls：Log Service http：HTTP サービス aws3：Amazon S3 oss：OSS kafka：Kafka サービス aws3cmpt：Amazon S3 互換サービス	oss
FieldList	string	フィールドのカンマ区切りリスト。	ClientRequestID,ClientRequestHost
FilterRules	string	フィルタールール。	[{"ClientSSLProtocol": {"equals": ["TLSv1.3"]}}]
SinkConfig	any	配信設定。	{'Project': 'er-online-hjy-pro', 'Logstore': 'er-online-hjy-log', 'Region': 'cn-hangzhou', 'Endpoint': 'cn-hangzhou.log.aliyuncs.com', 'Aliuid': '1077912128805410'}
Details	string
RawRule	string
FilterVer	string

例

成功レスポンス

JSONJSON

{
  "RequestId": "7072132a-bd3c-46a6-9e81-aba3e0e3f861",
  "TaskName": "testoss11",
  "DiscardRate": 0,
  "DataCenter": "cn",
  "BusinessType": "dcdn_log_er",
  "Status": "online",
  "DeliveryType": "oss",
  "FieldList": "ClientRequestID,ClientRequestHost",
  "FilterRules": "[{\"ClientSSLProtocol\": {\"equals\": [\"TLSv1.3\"]}}]",
  "SinkConfig": "{'Project': 'er-online-hjy-pro', 'Logstore': 'er-online-hjy-log', 'Region': 'cn-hangzhou', 'Endpoint': 'cn-hangzhou.log.aliyuncs.com', 'Aliuid': '1077912128805410'}",
  "Details": "",
  "RawRule": "",
  "FilterVer": ""
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter	The specified parameter is invalid.
400	InternalError	An internal exception occurred, please try again later.
403	EsaService.NotOpen	ESA service has not opend.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。