获取资源列表
拉取巡检资源列表(需要在触发资源信息同步后才能获取最新结果)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeAdvisorResources | 系统规定参数。取值:DescribeAdvisorResources。 |
ResourceId | String | 否 | i-2zecnwitr2s7aca6**** | 资源/实例ID。 |
Keyword | String | 否 | ecs001 | 查询关键词,可用来模糊匹配资源/实例ID或资源/实例名称。 |
Language | String | 否 | zh | 请求的语言。 |
Product | String | 否 | ecs | 云产品Code。 |
PageNumber | Integer | 否 | 1 | 分页号。 |
PageSize | Integer | 否 | 10 | 每页数据条数。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 566331F9-5AB3-550F-B745-A730331F97A9 | 请求ID。 |
Data | Object | 查询结果。 |
|
PageNo | Integer | 1 | 分页号。 |
PageSize | Integer | 10 | 每页数据条数。 |
Total | Integer | 100 | 数据总条数。 |
Result | Array of Resource | 查询结果数组。 |
|
Resource | |||
Data | String | {"resourceId": "i-2zecnwitr2s7aca6****","resourceName": "ecs-20230701","regionId": "cn-hangzhou",...} | 资源详情Json,具体请参考各个云产品实例详情查询相关api文档。 |
ResourceId | String | i-2zecnwitr2s7aca6**** | 资源/实例ID。 |
Product | String | ecs | 云产品Code。 |
ResourceName | String | ecs-20230701 | 资源名称。 |
RegionId | String | cn-hangzhou | 地域信息。 |
示例
请求示例
http(s)://advisor.cn-hangzhou.aliyuncs.com/?Action=DescribeAdvisorResources
&ResourceId=i-2zecnwitr2s7aca6****
&Keyword=ecs001
&Language=zh
&Product=ecs
&PageNumber=1
&PageSize=10
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeAdvisorResourcesResponse>
<RequestId>566331F9-5AB3-550F-B745-A730331F97A9</RequestId>
<Data>
<PageNo>1</PageNo>
<PageSize>10</PageSize>
<Total>100</Total>
<Result>
<Data>{"resourceId": "i-2zecnwitr2s7aca6****","resourceName": "ecs-20230701","regionId": "cn-hangzhou",...}</Data>
<ResourceId>i-2zecnwitr2s7aca6****</ResourceId>
<Product>ecs</Product>
<ResourceName>ecs-20230701</ResourceName>
<RegionId>cn-hangzhou</RegionId>
</Result>
</Data>
</DescribeAdvisorResourcesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "566331F9-5AB3-550F-B745-A730331F97A9",
"Data" : {
"PageNo" : 1,
"PageSize" : 10,
"Total" : 100,
"Result" : [ {
"Data" : "{\"resourceId\": \"i-2zecnwitr2s7aca6****\",\"resourceName\": \"ecs-20230701\",\"regionId\": \"cn-hangzhou\",...}",
"ResourceId" : "i-2zecnwitr2s7aca6****",
"Product" : "ecs",
"ResourceName" : "ecs-20230701",
"RegionId" : "cn-hangzhou"
} ]
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
500 | InternalError | The request processing has failed due to some unknown error. | 服务端错误。 |
访问错误中心查看更多错误码。