擷取資源中繼資料。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
GET /api/v1/providers/{provider}/products/{product}/resourceTypes/* HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| requestPath |
string |
否 |
請求路徑。格式為: /api/v1/providers/{provider}/products/{product}/resourceTypes/{resourceType} 請求路徑中變數說明: provider: 雲廠商,目前只支援 Aliyun。 product: 產品 Code。 resourceType: 資源類型。有父資源時,格式為{父資源類型 code}/{資源類型 code} |
無父資源: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance 有父資源: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance/Account |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 |
list 操作時可以作為 filter 參數的屬性集合。 |
|
|
string |
filter 參數。 |
/properties/ResourceGroupId |
|
| getOnlyProperties |
array |
查詢操作私人參數集合。資源查詢操作中不會返回的屬性,但是查詢操作中需要傳入的參數。 |
|
|
string |
查詢操作私人參數。 |
/properties/DryRun |
|
| getResponseProperties |
array |
查詢返回的屬性集合。 |
|
|
string |
查詢返回的屬性。 |
/properties/NetworkInterfaces/items/properties/IpvSets |
|
| handlers |
object |
支援的資源操作資訊(包括 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 |
產品 Code。 |
ECS |
| properties |
object |
資源屬性定義,key 是屬性名稱,value 為屬性詳細資料。 |
|
| publicProperties |
array |
公用的屬性集合,為資源基本屬性。非操作私人參數。 |
|
|
string |
公用屬性。 |
/properties/Description |
|
| readOnlyProperties |
array |
唯讀參數集合,只在 list 或者 get 操作中返回,建立及變更時不作為入參。 |
|
|
string |
唯讀參數。 |
/properties/CreateTime |
|
| required |
array |
資源建立必填參數集合。 |
|
|
string |
資源建立必填參數。 |
RegionId |
|
| resourceType |
string |
資源類型。資源有父資源時,返回格式為{父資源類型 code/資源類型 code}。 |
無父資源: Instance 有父資源: DBInstance/Account |
| sensitiveInfoProperties |
array |
敏感屬性集合,例如密碼等。 |
|
|
string |
敏感屬性。 |
/properties/VncPassword |
|
| updateOnlyProperties |
array |
更新操作私人參數集合。資源查詢操作中不會返回的屬性,但是更新操作中需要傳入的參數。 |
|
|
string |
更新操作私人參數。 |
/properties/DryRun |
|
| updateTypeProperties |
array |
可以修改的屬性集合。 |
|
|
string |
可改屬性。 |
/properties/InstanceName |
樣本
正常返回樣本
JSON格式
{
"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"
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。