GetResourceType を使用したリソースメタデータ取得 - Cloud Control API - Alibaba Cloud - Cloud Control API

リソースメタデータを取得します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
requestPath	string	任意	リクエストの URI。フォーマット: /api/v1/providers/{provider}/products/{product}/resourceTypes/{resourceType} リクエストパスの変数: provider: クラウドプロバイダー。現在、Aliyun のみがサポートされています。 product: プロダクトコード。 resourceType: リソースタイプ。リソースに親リソースがある場合、フォーマットは {親リソースタイプコード}/{リソースタイプコード} です。	No parent resource: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance Has parent resource: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance/Account

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
x-acs-accept-language	string	任意	返されるプロダクト情報の言語を指定します。有効な値: zh_CH: 中国語 (デフォルト) en_US: 英語列挙値: zh_CH : zh_CH en_US : en_US	zh_CH

レスポンスフィールド

フィールド	型	説明	例
	object	応答の構造体。
requestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
resourceType	object	リソースタイプ。	No parent resource: Instance Has parent resource: DBInstance/Account
createOnlyProperties	array	作成操作の非公開パラメーター。これらのプロパティはリソースクエリ操作では返されませんが、作成操作ではパラメーターとして渡す必要があります。
	string	作成操作の非公開パラメーター。	/properties/AutoRenew
deleteOnlyProperties	array	削除操作の非公開パラメーター。これらのプロパティはリソースクエリ操作では返されませんが、削除操作ではパラメーターとして渡す必要があります。
	string	削除操作の非公開パラメーター。	/properties/ForceDelete
filterProperties	array	リスト操作でフィルターパラメーターとして使用できるプロパティ。
	string	フィルターパラメーター。	/properties/ResourceGroupId
getOnlyProperties	array	取得操作の非公開パラメーター。これらのプロパティはリソースクエリ操作では返されませんが、取得操作ではパラメーターとして渡す必要があります。
	string	取得操作の非公開パラメーター。	/properties/DryRun
getResponseProperties	array	取得操作で返されるプロパティ。
	string	取得操作で返されるプロパティ。	/properties/NetworkInterfaces/items/properties/IpvSets
handlers	object	サポートされるリソース操作情報 (Resource Access Management (RAM) 権限を含む)。
create	object	作成操作に関連する情報。
permissions	array	必須の RAM 権限。
	string	RAM 権限。	ecs:CreateInstance
delete	object	削除操作に関連する情報。
permissions	array	必須の RAM 権限。
	string	RAM 権限。	ecs:DeleteInstance
get	object	取得操作に関連する情報。
permissions	array	必須の RAM 権限。
	string	RAM 権限。	ecs:DescribeInstanceAttachmentAttributes
list	object	リスト操作に関連する情報。
permissions	array	必須の RAM 権限。
	string	RAM 権限。	ecs:DescribeInstances
update	object	更新操作に関連する情報。
permissions	array	必須の RAM 権限。
	string	RAM 権限。	ecs:ModifyInstanceNetworkSpec
info	object	リソースタイプの基本情報。
chargeType	string	課金方法。有効な値: paid: 有料 free: 無料	paid
deliveryScope	string	Deployment の範囲。有効な値: center: センター (集中型 Deployment) region: リージョンレベルの Deployment zone: ゾーンレベルの Deployment	region
description	string	リソースタイプの説明。	An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.
title	string	リソースタイプの名前。	Instance
listOnlyProperties	array	リスト操作の非公開パラメーター。これらのプロパティはリソースクエリ操作では返されませんが、リスト操作ではパラメーターとして渡す必要があります。
	string	リスト操作の非公開パラメーター。	/properties/DryRun
listResponseProperties	array	リスト操作で返されるプロパティ。
	string	リスト操作で返されるプロパティ。	/properties/InstanceId
primaryIdentifier	string	リソース ID。	/properties/InstanceId
product	string	プロダクトコード。	ECS
properties	object	リソースプロパティの定義。キーはプロパティ名、値は詳細なプロパティ情報です。
publicProperties	array	パブリックプロパティ。リソースの基本プロパティであり、操作の非公開パラメーターではありません。
	string	パブリックプロパティ。	/properties/Description
readOnlyProperties	array	読み取り専用パラメーター。これらのパラメーターはリスト操作または取得操作でのみ返され、作成時または変更時には入力パラメーターとして使用されません。
	string	読み取り専用パラメーター。	/properties/CreateTime
required	array	リソース作成の必須パラメーター。
	string	リソース作成の必須パラメーター。	RegionId
resourceType	string	リソースタイプ。リソースに親リソースがある場合、返されるフォーマットは {親リソースタイプコード/リソースタイプコード} です。	Resource without a parent resource: Instance Resource with a parent resource: DBInstance/Account
sensitiveInfoProperties	array	パスワードなどの機密プロパティ。
	string	機密プロパティ。	/properties/VncPassword
updateOnlyProperties	array	更新操作の非公開パラメーター。これらのプロパティはリソースクエリ操作では返されませんが、更新操作ではパラメーターとして渡す必要があります。
	string	更新操作の非公開パラメーター。	/properties/DryRun
updateTypeProperties	array	変更可能なプロパティ。
	string	変更可能なプロパティ。	/properties/InstanceName

例

成功レスポンス

JSONJSON

{
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "resourceType": {
    "createOnlyProperties": [
      "/properties/AutoRenew"
    ],
    "deleteOnlyProperties": [
      "/properties/ForceDelete"
    ],
    "filterProperties": [
      "\t\n/properties/ResourceGroupId"
    ],
    "getOnlyProperties": [
      "/properties/DryRun"
    ],
    "getResponseProperties": [
      "/properties/NetworkInterfaces/items/properties/IpvSets"
    ],
    "handlers": {
      "create": {
        "permissions": [
          "ecs:CreateInstance"
        ]
      },
      "delete": {
        "permissions": [
          "ecs:DeleteInstance"
        ]
      },
      "get": {
        "permissions": [
          "ecs:DescribeInstanceAttachmentAttributes"
        ]
      },
      "list": {
        "permissions": [
          "ecs:DescribeInstances"
        ]
      },
      "update": {
        "permissions": [
          "ecs:ModifyInstanceNetworkSpec"
        ]
      }
    },
    "info": {
      "chargeType": "paid",
      "deliveryScope": "region",
      "description": "An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.",
      "title": "Instance"
    },
    "listOnlyProperties": [
      "/properties/DryRun"
    ],
    "listResponseProperties": [
      "/properties/InstanceId"
    ],
    "primaryIdentifier": "/properties/InstanceId\n",
    "product": "ECS",
    "properties": {
      "test": "test",
      "test2": 1
    },
    "publicProperties": [
      "\t\n/properties/Description"
    ],
    "readOnlyProperties": [
      "/properties/CreateTime"
    ],
    "required": [
      "RegionId"
    ],
    "resourceType": "无父资源：\nInstance\n有父资源：\nDBInstance/Account",
    "sensitiveInfoProperties": [
      "/properties/VncPassword"
    ],
    "updateOnlyProperties": [
      "/properties/DryRun"
    ],
    "updateTypeProperties": [
      "/properties/InstanceName"
    ]
  }
}

エラーコード

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

変更履歴

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