Queries the list of cloud asset schema definitions.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageSize |
integer |
No |
The number of entries per page. |
10 |
| CurrentPage |
integer |
No |
The number of the page to return. Default value: 1. |
1 |
| CloudAssetTypes |
array<object> |
No |
The types of cloud assets. |
|
|
object |
No |
The types of cloud assets. |
||
| AssetType |
integer |
No |
The type of the asset. Valid values:
|
0 |
| AssetSubType |
integer |
No |
The subtype of the cloud service or asset. Valid values:
|
0 |
| Vendor |
integer |
No |
The server type. Valid values:
|
0 |
| DataNames |
array |
No |
The list of asset data names. |
|
|
string |
No |
The asset data name. |
ACS_ECS_Disk |
|
| AssociatedDataOnly |
boolean |
No |
Specifies whether to filter out attributes that can be associated with other assets. |
true |
| Lang |
string |
No |
The language of the request and response. Default value: zh. Valid values: - zh: Chinese - en: English |
zh |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
| RequestId |
string |
The request ID. |
F8B6F758-BCD4-597A-8A2C-DA5A552C**** |
| PageInfo |
object |
The pagination information. |
|
| CurrentPage |
integer |
The current page number. |
1 |
| PageSize |
integer |
The number of entries returned per page. |
10 |
| TotalCount |
integer |
The total number of entries returned. |
54 |
| Count |
integer |
The number of entries returned on the current page. |
10 |
| CloudAssetSchemas |
array<object> |
The list of asset schema definitions. |
|
|
object |
|||
| DataName |
string |
The name of the asset schema definition. |
ACS_ECS_Disk |
| Vendor |
integer |
The source of the server. Valid values:
|
0 |
| AssetType |
integer |
The type of the cloud asset. Valid values:
|
0 |
| AssetSubType |
integer |
The subtype of the cloud asset. |
1 |
| Properties |
string |
The asset schema definition in JSON format. |
[{\"associatedData\":[{\"assetSubType\":100,\"assetType\":0,\"dataName\":\"ACS_ECS_Instance\",\"properties\":[{\"name\":\"InstanceId\",\"path\":\"InstanceId\"}],\"vendor\":0}],\"description\":\"The ID of the instance to which the disk is attached.\",\"example\":\"i-bp67acfmxazb4q****\",\"name\":\"InstanceId\",\"type\":\"STRING\",\"withAssociatedData\":true},{\"description\":\"Disk name\",\"example\":\"testDiskName\",\"name\":\"DiskName\",\"type\":\"STRING\"},{\"description\":\"Only encrypted disks\",\"example\":\"false\",\"name\":\"Encrypted\",\"type\":\"BOOLEAN\"},{\"description\":\"Disk status\",\"example\":\"In_use\",\"name\":\"Status\",\"type\":\"STRING\"},{\"description\":\"Disk category\",\"example\":\"cloud_ssd\",\"name\":\"Category\",\"type\":\"STRING\"},{\"description\":\"Disk type\",\"example\":\"system\",\"name\":\"Type\",\"type\":\"STRING\"},{\"description\":\"Specifies whether to set an automatic snapshot policy for the disk.\",\"example\":\"false\",\"name\":\"EnableAutomatedSnapshotPolicy\",\"type\":\"BOOLEAN\"},{\"description\":\"The ID of the automatic snapshot policy.\",\"example\":\"sp-bp67acfmxazb4p****\",\"name\":\"AutoSnapshotPolicyId\",\"type\":\"STRING\"},{\"description\":\"Disk, local disk, or elastic ephemeral disk ID\",\"example\":\"d-bp18um4r4f2fve24****\",\"name\":\"DiskId\",\"type\":\"STRING\"}] |
Examples
Success response
JSON format
{
"Success": true,
"RequestId": "F8B6F758-BCD4-597A-8A2C-DA5A552C****",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 10,
"TotalCount": 54,
"Count": 10
},
"CloudAssetSchemas": [
{
"DataName": "ACS_ECS_Disk",
"Vendor": 0,
"AssetType": 0,
"AssetSubType": 1,
"Properties": "[{\\\"associatedData\\\":[{\\\"assetSubType\\\":100,\\\"assetType\\\":0,\\\"dataName\\\":\\\"ACS_ECS_Instance\\\",\\\"properties\\\":[{\\\"name\\\":\\\"InstanceId\\\",\\\"path\\\":\\\"InstanceId\\\"}],\\\"vendor\\\":0}],\\\"description\\\":\\\"The ID of the instance to which the disk is attached.\\\",\\\"example\\\":\\\"i-bp67acfmxazb4q****\\\",\\\"name\\\":\\\"InstanceId\\\",\\\"type\\\":\\\"STRING\\\",\\\"withAssociatedData\\\":true},{\\\"description\\\":\\\"Disk name\\\",\\\"example\\\":\\\"testDiskName\\\",\\\"name\\\":\\\"DiskName\\\",\\\"type\\\":\\\"STRING\\\"},{\\\"description\\\":\\\"Only encrypted disks\\\",\\\"example\\\":\\\"false\\\",\\\"name\\\":\\\"Encrypted\\\",\\\"type\\\":\\\"BOOLEAN\\\"},{\\\"description\\\":\\\"Disk status\\\",\\\"example\\\":\\\"In_use\\\",\\\"name\\\":\\\"Status\\\",\\\"type\\\":\\\"STRING\\\"},{\\\"description\\\":\\\"Disk category\\\",\\\"example\\\":\\\"cloud_ssd\\\",\\\"name\\\":\\\"Category\\\",\\\"type\\\":\\\"STRING\\\"},{\\\"description\\\":\\\"Disk type\\\",\\\"example\\\":\\\"system\\\",\\\"name\\\":\\\"Type\\\",\\\"type\\\":\\\"STRING\\\"},{\\\"description\\\":\\\"Specifies whether to set an automatic snapshot policy for the disk.\\\",\\\"example\\\":\\\"false\\\",\\\"name\\\":\\\"EnableAutomatedSnapshotPolicy\\\",\\\"type\\\":\\\"BOOLEAN\\\"},{\\\"description\\\":\\\"The ID of the automatic snapshot policy.\\\",\\\"example\\\":\\\"sp-bp67acfmxazb4p****\\\",\\\"name\\\":\\\"AutoSnapshotPolicyId\\\",\\\"type\\\":\\\"STRING\\\"},{\\\"description\\\":\\\"Disk, local disk, or elastic ephemeral disk ID\\\",\\\"example\\\":\\\"d-bp18um4r4f2fve24****\\\",\\\"name\\\":\\\"DiskId\\\",\\\"type\\\":\\\"STRING\\\"}]"
}
]
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | AccountIdNotExist | AccountId not exist | |
| 400 | NoPermission | no permission | |
| 500 | ServerError | ServerError | |
| 403 | NoPermission | caller has no permission | You are not authorized to do this operation. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.