GetResources 操作を使用してリソースをクエリ - Cloud Control API

操作説明

API Explorer に移動して、リソースドキュメントの表示や Cloud Control API のテストを実行できます。

この API は、リソースに対する Get 操作と List 操作を提供します。異なるリクエスト URI を使用して呼び出すことができます。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

GET /api/v1/providers/{provider}/products/{product}/resources/* HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
requestPath	string	任意	リクエストの URI です。リクエスト URI によって、List 操作と Get 操作のどちらを呼び出すかが決まります。 List： `/api/v1/providers/{provider}/products/{product}/resources/{resourceType}` Get： `/api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId}` リクエスト URI には、次の変数が含まれます。 provider：クラウドサービスプロバイダー。現在、`Aliyun` のみがサポートされています。 product：プロダクトコード。 resourceType：リソースタイプ。親リソースが存在する場合、フォーマットは `{親リソースタイプコード}/{親リソース ID}/{リソースタイプコード}` です。 resourceId：リソース ID。	/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-8vbf5abe31c9****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
regionId	string	任意	リージョン ID。クラウドプロダクトがリージョン固有である場合、このパラメーターは必須です。	cn-beijing
filter	object	任意	リソースのフィルター条件です。 JSON フォーマットで複数のキーと値のペアを指定して、リソースをフィルターします。クラウドプロダクトの List 操作または Get 操作が特定のプロパティによるフィルターをサポートしている場合、それらのプロパティをこのパラメーターのフィルター条件として使用できます。説明サポートされているフィルターフィールドは、リソースタイプによって異なる場合があります。サポートされているフィールドの詳細については、特定のリソースの OpenAPI ドキュメントをご参照ください。たとえば、DBInstance リソースは、`EditionType` および `PaymentType` フィールドによるフィルターをサポートしています。	{ "EditionType": "Community", "PaymentType": "PostPaid" }
nextToken	string	任意	ページネーショントークンです。最初のクエリでは、このパラメーターを指定する必要はありません。システムは最初のページからデータを返します。後続のクエリでは、このパラメーターを前の呼び出しから返された nextToken の値に設定します。説明このパラメーターに数字のみが含まれている場合、Cloud Control API はそれをページングのための `PageNumber` として扱います。	AAAAAdDWBF2****
maxResults	integer	任意	ページングクエリで各ページに返すレコードの最大数。最大値：100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス構造体です。
maxResults	integer	現在のリクエストで返されるレコードの最大数。このパラメーターは List 操作によって返されます。	10
nextToken	string	現在の呼び出しが読み取りを終了した位置。空の値は、すべてのデータが読み取られたことを示します。このパラメーターは List 操作によって返されます。	AAAAAdDWBF2****
requestId	string	リクエスト ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
resource	object	指定されたリソース。このパラメーターは Get 操作によって返されます。
resourceAttributes	object	JSON フォーマットのリソースプロパティです。	{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-8vbf5abe31c9c4d4","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}
resourceId	string	リソース ID です。	cctest
resources	array<object>	リソースのリスト。このパラメーターは List 操作によって返されます。
	array<object>	リソースです。
resourceAttributes	object	JSON フォーマットのリソースプロパティです。	{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-8vbf5abe31c9c4d4","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}
resourceId	string	リソース ID です。	cctest
totalCount	integer	クエリ条件に一致するエントリの総数。このパラメーターは List 操作によって返されます。	20

例

成功レスポンス

JSONJSON

{
  "maxResults": 10,
  "nextToken": "AAAAAdDWBF2****\n",
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\n",
  "resource": {
    "resourceAttributes": {
      "Status": "Available",
      "Description": "",
      "AccountPrivilege": "RoleReadWrite",
      "InstanceId": "r-8vbf5abe31c9c4d4",
      "RegionId": "cn-zhangjiakou",
      "AccountType": "Normal",
      "TypeInfo": {},
      "AccountName": "cctest"
    },
    "resourceId": "cctest\n"
  },
  "resources": [
    {
      "resourceAttributes": {
        "Status": "Available",
        "Description": "",
        "AccountPrivilege": "RoleReadWrite",
        "InstanceId": "r-8vbf5abe31c9c4d4",
        "RegionId": "cn-zhangjiakou",
        "AccountType": "Normal",
        "TypeInfo": {},
        "AccountName": "cctest"
      },
      "resourceId": "cctest"
    }
  ],
  "totalCount": 20
}

エラーコード

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

変更履歴

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