この操作を呼び出して、リソースメタデータを取得できます。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /api/v1/providers/{provider}/products/{product}/resourceTypes/* HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| requestPath |
string |
任意 |
リクエストパスです。このパラメーターは、/api/v1/providers/{provider}/products/{product}/resourceTypes/{resourceType} の形式で指定します。 リクエストパス内の変数。有効な値は次のとおりです。 provider：クラウドサービスプロバイダー。現在、Aliyun のみがサポートされています。 product：プロダクトコード。 resourceType：リソースのタイプ。親リソースがある場合、形式は {親リソースタイプコード}/{リソースタイプコード} になります。 |
/api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| x-acs-accept-language |
string |
任意 |
返されるプロダクトに適用する言語。 zh_CH：中国語 (デフォルト) en_US：英語 列挙値:
|
zh_CH |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| requestId |
string |
リクエスト ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| resourceType |
object |
リソースタイプ。有効な値： |
|
| 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 |
配信レベル。有効な値： center region zone |
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 |
リソースのタイプです。リソースが親リソースに属する場合、戻り値の形式は {親リソースタイプコード /リソースタイプコード} です。 |
Instance |
| 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": "Instance",
"sensitiveInfoProperties": [
"/properties/VncPassword"
],
"updateOnlyProperties": [
"/properties/DryRun"
],
"updateTypeProperties": [
"/properties/InstanceName"
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。