查询资源列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
bdrc:DescribeResources |
none |
*全部资源
|
无 | 无 |
请求语法
GET /api/v1/resources HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ResourceType |
string |
否 |
资源类型 |
ACS::ECS::Instance |
| ResourceId |
string |
否 |
资源 ID。例如，当待查询的资源为实例时，可以理解为 InstanceId。 |
i-0003***110 |
| FailedRuleTemplate |
string |
否 |
评分失败的规则过滤 |
rule-000c***yc9 |
| NextToken |
string |
否 |
分页游标，如果有下一页，则该字段有返回值。说明 该参数只要返回数据，则说明还有下一页。您可以将返回的 NextToken 作为请求参数再次获得下一页的数据，直到返回为 Null，表示获取到了所有的数据。 |
cae**********699 |
| MaxResults |
integer |
否 |
分页查询时每页行数。最大值为 100。默认值：当不设置值或设置的值小于 10 时，默认值为 10。当设置的值大于 100 时，默认值为 100。 |
10 |
| SortBy |
string |
否 |
排序方式 |
protectionScore |
| SortOrder |
string |
否 |
ASC: 升序, DESC: 降序 |
ASC |
| StorageClass |
string |
否 |
ARCHIVE |
|
| DataRedundancyType |
string |
否 |
LRS |
|
| ResourceCategoryId |
string |
否 |
rc-000***123 |
|
| ResourceRegionId |
string |
否 |
cn-hangzhou |
|
| ResourceArn |
string |
否 |
acs:ecs:cn-hangzhou:123***7890:instance/i-123***7890 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
BaseResponse<ListResult |
||
| Data |
object |
返回数据 |
|
| Content |
array |
本次请求所返回的记录集合 |
|
|
object |
|||
| ResourceArn |
string |
资源 ARN(全局唯一) |
acs:ecs:cn-hangzhou:xxxxxxxx:instance/xxxxx |
| ProductType |
string |
云产品类型 |
ecs |
| ResourceType |
string |
资源类型 |
ACS::ECS::Instance |
| ResourceId |
string |
资源唯一标识 |
i-xxxxxxxx |
| ResourceName |
string |
资源名称 |
test server |
| RegionId |
string |
地域 |
cn-hangzhou |
| ZoneId |
string |
可用区 |
cn-hangzhou-i |
| VpcId |
string |
vpc ID |
vpc-xxxxxxxx |
| VSwitchId |
string |
vSwitch ID |
vsw-xxxxxxxx |
| CreateTime |
integer |
资源的创建时间 |
1697798340 |
| Status |
string |
资源状态 |
Running |
| TotalDataSize |
integer |
数据量 |
0 |
| StandardDataSize |
integer |
标准类型数据量 |
0 |
| IaDataSize |
integer |
低频类型数据量 |
0 |
| ArchiveDataSize |
integer |
归档类型数据量 |
0 |
| ColdArchiveDataSize |
integer |
冷归档类型数据量 |
0 |
| EnableCheck |
boolean |
是否开启数据保护评分评估 |
0 |
| ProtectionScore |
integer |
资源保护评分 |
0 |
| ProtectionScoreUpdatedTime |
integer |
评分时间 |
0 |
| RiskCount |
integer |
有风险的检查项目数 |
0 |
| CheckFailedCount |
integer |
失败的检查项个数 |
0 |
| StorageClass |
string |
数据存储类型 |
|
| DataRedundancyType |
string |
数据冗余类型 |
|
| NextToken |
string |
用来表示当前调用返回读取到的位置，空代表数据已经读取完毕 |
fb836242f4225fa0f0e0257362dfc6dd |
| MaxResults |
integer |
本次请求所返回的最大记录条数 |
100 |
| TotalCount |
integer |
本次请求条件下的数据总量，此参数为可选参数，默认可不返回 |
149 |
| RequestId |
string |
请求的唯一标识 |
700683DE-0154-56D4-8D76-3B7A2C2C7DF9 |
示例
正常返回示例
JSON格式
{
"Data": {
"Content": [
{
"ResourceArn": "acs:ecs:cn-hangzhou:xxxxxxxx:instance/xxxxx\n",
"ProductType": "ecs",
"ResourceType": "ACS::ECS::Instance\n",
"ResourceId": "i-xxxxxxxx\n",
"ResourceName": "test server",
"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-i",
"VpcId": "vpc-xxxxxxxx",
"VSwitchId": "vsw-xxxxxxxx",
"CreateTime": 1697798340,
"Status": "Running",
"TotalDataSize": 0,
"StandardDataSize": 0,
"IaDataSize": 0,
"ArchiveDataSize": 0,
"ColdArchiveDataSize": 0,
"EnableCheck": true,
"ProtectionScore": 0,
"ProtectionScoreUpdatedTime": 0,
"RiskCount": 0,
"CheckFailedCount": 0,
"StorageClass": "",
"DataRedundancyType": ""
}
],
"NextToken": "fb836242f4225fa0f0e0257362dfc6dd",
"MaxResults": 100,
"TotalCount": 149
},
"RequestId": "700683DE-0154-56D4-8D76-3B7A2C2C7DF9"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。