Retrieves resource metadata.
Try it now
Test
RAM authorization
Request syntax
GET /api/v1/providers/{provider}/products/{product}/resourceTypes/* HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| requestPath |
string |
No |
The request path. Format: /api/v1/providers/{provider}/products/{product}/resourceTypes/{resourceType} Description of variables in the request path: provider: The cloud provider. Currently, only Aliyun is supported. product: The product code. resourceType: The resource type. If a parent resource exists, the format is {parentResourceTypeCode}/{resourceTypeCode}. |
No parent resource: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance Has parent resource: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance/Account |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| x-acs-accept-language |
string |
No |
The language in which the product information is returned. Valid values: zh_CH: Chinese (default) en_US: English. Valid values:
|
zh_CH |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response struct. |
||
| requestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| resourceType |
object |
The resource type. |
No parent resource: Instance Has parent resource: DBInstance/Account |
| createOnlyProperties |
array |
The properties exclusive to the create operation. These properties are not returned in resource query operations but are required as input parameters for the create operation. |
|
|
string |
The create-only property. |
/properties/AutoRenew |
|
| deleteOnlyProperties |
array |
The properties exclusive to the delete operation. These properties are not returned in resource query operations but are required as input parameters for the delete operation. |
|
|
string |
The delete-only property. |
/properties/ForceDelete |
|
| filterProperties |
array |
The properties that can be used as filter parameters in the list operation. |
|
|
string |
The filter property. |
/properties/ResourceGroupId |
|
| getOnlyProperties |
array |
The properties exclusive to the get operation. These properties are not returned in resource query operations but are required as input parameters for the get operation. |
|
|
string |
The get-only property. |
/properties/DryRun |
|
| getResponseProperties |
array |
The properties returned by the get operation. |
|
|
string |
The property returned by the get operation. |
/properties/NetworkInterfaces/items/properties/IpvSets |
|
| handlers |
object |
The supported resource operations, including RAM permissions. |
|
| create |
object |
The information about the create operation. |
|
| permissions |
array |
The information about the required RAM permissions. |
|
|
string |
RAM permissions. |
ecs:CreateInstance |
|
| delete |
object |
The information about the delete operation. |
|
| permissions |
array |
The information about the required RAM permissions. |
|
|
string |
RAM permissions. |
ecs:DeleteInstance |
|
| get |
object |
The information about the query operation. |
|
| permissions |
array |
The information about the required RAM permissions. |
|
|
string |
RAM permissions. |
ecs:DescribeInstanceAttachmentAttributes |
|
| list |
object |
The information about the list operation. |
|
| permissions |
array |
The information about the required RAM permissions. |
|
|
string |
RAM permissions. |
ecs:DescribeInstances |
|
| update |
object |
The information about the update operation. |
|
| permissions |
array |
The information about the required RAM permissions. |
|
|
string |
RAM permissions. |
ecs:ModifyInstanceNetworkSpec |
|
| info |
object |
The basic information about the resource type. |
|
| chargeType |
string |
The payment form. Valid values: paid free |
paid |
| deliveryScope |
string |
The delivery level. Valid values: center region zone |
region |
| description |
string |
The description of the resource type. |
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 |
The name of the resource type. |
Instance |
| listOnlyProperties |
array |
The properties exclusive to the list operation. These properties are not returned in resource query operations but are required as input parameters for the list operation. |
|
|
string |
The list-only property. |
/properties/DryRun |
|
| listResponseProperties |
array |
The properties returned by the list operation. |
|
|
string |
The property returned by the list operation. |
/properties/InstanceId |
|
| primaryIdentifier |
string |
The resource ID. |
/properties/InstanceId |
| product |
string |
The product code. |
ECS |
| properties |
object |
The resource properties. The key specifies the property name and the value specifies the details of the property. |
|
| publicProperties |
array |
The common properties that represent basic resource attributes. These are not operation-specific properties. |
|
|
string |
The common property. |
/properties/Description |
|
| readOnlyProperties |
array |
The read-only properties. These properties are returned only in list or get operations and cannot be used as input parameters for create or update operations. |
|
|
string |
The read-only property. |
/properties/CreateTime |
|
| required |
array |
The required parameters for resource creation. |
|
|
string |
The required parameter for resource creation. |
RegionId |
|
| resourceType |
string |
The resource type. If the resource has a parent resource, the format is {parentResourceTypeCode/resourceTypeCode}. |
无父资源： Instance 有父资源： DBInstance/Account |
| sensitiveInfoProperties |
array |
The sensitive properties, such as passwords. |
|
|
string |
The sensitive property. |
/properties/VncPassword |
|
| updateOnlyProperties |
array |
The properties exclusive to the update operation. These properties are not returned in resource query operations but are required as input parameters for the update operation. |
|
|
string |
The update-only property. |
/properties/DryRun |
|
| updateTypeProperties |
array |
The properties that can be modified. |
|
|
string |
The modifiable property. |
/properties/InstanceName |
Examples
Success response
JSON format
{
"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"
]
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.