DescribeDataPushResult を使用したアプリケーションデータファイルのプッシュ状态查询 - ENS

この API を呼び出すことで、アプリケーションのデータファイルがエッジゾーンに事前プッシュされる際のステータス結果を取得できます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeDataPushResult

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーションの ID です。	e76f8985-7965-41fc-925b-9648bb6bf650
DataNames	string	任意	データファイルの名前です。複数指定する場合はカンマ (,) で区切ります。デフォルトでは、すべてのデータファイルがクエリ対象となります。	159828628258496/mirror_file/game-2553efe7-7bf8-40fb-a6e7-09c9c00a992a.tar
DataVersions	string	任意	データファイルのバージョン番号です。複数指定する場合はカンマ (,) で区切ります。デフォルトでは、すべてのバージョンのデータファイルがクエリ対象となります。	90396
MinDate	string	任意	クエリ対象となる期間の開始日時です。日付形式は「2006-01-02」で指定してください。デフォルトでは、期間制限はありません。	2022-02-15
MaxDate	string	任意	クエリ対象となる期間の終了日時です。日付形式は「2006-01-02」で指定してください。デフォルトでは、期間制限はありません。	2022-02-20
PageNumber	integer	任意	ページ番号（1 から開始）。全情報をエクスポートする場合は省略可能です。	1
PageSize	integer	任意	1 ページあたりの表示件数です。すべてのデータファイルのプッシュステータスを返す場合、このパラメーターは省略可能です。	10
RegionIds	string	任意	ENS ノードの ID です。複数指定する場合はカンマ (,) で区切ります。デフォルトでは、すべての ENS ノードがクエリ対象となります。	cn-wuhan-telecom_unicom_cmcc-2,cn-jiaozuo-2

レスポンスフィールド

フィールド	型	説明	例
	object
PageNumber	integer	ページ番号です。	1
PageSize	integer	1 ページあたりの表示件数です。	10
PushResults	object
PushResult	array<object>	データファイルのプッシュ結果です。
	array<object>
Name	string	データファイルの名前です。	gcs-pre-websocket-eip-telecom
StatusStatS	object
StatusStat	array<object>	データファイルのプッシュステータスです。
	array<object>
RegionIdCount	integer	ENS ノードの合計数です。	2
RegionIds	object
RegionId	array<object>	ENS ノードにおけるデータファイルのプッシュステータスです。
	object
RegionId	string	ENS ノードの ID です。	cn-wuxi-5
StartTime	string	プッシュ操作の開始時刻です。協定世界時 (UTC) で表示されます。	2021-12-28T16:00:00Z
StatusDescrip	string	ステータスの説明です。	Success
UpdateTime	string	ステータスが最後に更新された時刻です。協定世界時 (UTC) で表示されます。	2021-12-07T02:37:10Z
Status	string	プッシュステータスです。列挙型の値です。有効な値：SUCCESS、FAILED、PUSHING	FAILED
Version	string	データファイルのバージョン番号です。	standard
RequestId	string	リクエストの ID です。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCount	integer	返却された合計件数です。	6

例

成功レスポンス

JSONJSON

{
  "PageNumber": 1,
  "PageSize": 10,
  "PushResults": {
    "PushResult": [
      {
        "Name": "gcs-pre-websocket-eip-telecom",
        "StatusStatS": {
          "StatusStat": [
            {
              "RegionIdCount": 2,
              "RegionIds": {
                "RegionId": [
                  {
                    "RegionId": "cn-wuxi-5",
                    "StartTime": "2021-12-28T16:00:00Z",
                    "StatusDescrip": "Success",
                    "UpdateTime": "2021-12-07T02:37:10Z"
                  }
                ]
              },
              "Status": "FAILED"
            }
          ]
        },
        "Version": "standard"
      }
    ]
  },
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 6
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	LimitExceeded.SecurityGroup	The number of securityGroup exceeds the limit.
400	ens.interface.error	An error occurred while calling the API.
400	CallInterface	Call Interface Happen Error.

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

変更履歴

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