通过此接口查询资源。
接口说明
用户可前往在线调试 API 门户查看资源文档和体验 Cloud Control API。
此 API 包括资源的 Get 和 List 功能，根据不同的请求路径，用户可分别调用资源 List 和 Get 能力。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v1/providers/{provider}/products/{product}/resources/* HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| requestPath |
string |
否 |
请求路径。 根据不同的请求路径，用户可分别调用资源的 List 操作或 Get 操作。
请求路径中包含以下变量：
|
List（无父资源）： /api/v1/providers/Aliyun/products/Redis/resources/DBInstance List（有父资源）： /api/v1/providers/aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account Get（无父资源）： /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo**** Get（有父资源）： /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account/user**** |
| regionId |
string |
否 |
地域 ID。若云产品是 region 化产品，则此参数为必填。 |
cn-beijing |
| filter |
object |
否 |
资源过滤条件。 该参数支持以 JSON 格式传入多组键值对，用于对资源进行过滤。当某个云产品的资源在执行 List 或 Get 操作时，若对应操作支持根据特定属性进行过滤，则可将该属性作为 filter 参数的过滤条件。 说明
不同资源类型支持的过滤字段可能存在差异，具体支持字段请参见对应资源的 OpenAPI 文档。 例如，DBInstance 资源支持通过 |
{ "EditionType": "Community", "PaymentType": "PostPaid" } |
| nextToken |
string |
否 |
分页游标。
说明
若传入参数中仅包含数字，云控制 API 会将其视为页码 |
AAAAAdDWBF2**** |
| maxResults |
integer |
否 |
分页查询时每页的最大记录条数。最大值：100。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结构。 |
||
| maxResults |
integer |
本次请求所返回的最大记录条数。List 操作返回。 |
10 |
| nextToken |
string |
表示当前调用返回读取到的位置，空代表数据已经读取完毕。List 操作返回。 |
AAAAAdDWBF2**** |
| requestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| resource |
object |
指定资源。Get 操作返回。 |
|
| resourceAttributes |
object |
资源属性（JSON 格式）。 |
{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"} |
| resourceId |
string |
资源 ID。 |
cctest |
| resources |
array<object> |
资源列表。List 操作返回。 |
|
|
object |
资源。 |
||
| resourceAttributes |
object |
资源属性（JSON 格式）。 |
{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"} |
| resourceId |
string |
资源 ID。 |
cctest |
| totalCount |
integer |
本次请求条件下的数据总量。List 操作返回。 |
20 |
示例
正常返回示例
JSON格式
{
"maxResults": 10,
"nextToken": "AAAAAdDWBF2****",
"requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"resource": {
"resourceAttributes": {
"Status": "Available",
"Description": "",
"AccountPrivilege": "RoleReadWrite",
"InstanceId": "r-2ze8v41uei31lo****",
"RegionId": "cn-zhangjiakou",
"AccountType": "Normal",
"TypeInfo": {},
"AccountName": "cctest"
},
"resourceId": "cctest"
},
"resources": [
{
"resourceAttributes": {
"Status": "Available",
"Description": "",
"AccountPrivilege": "RoleReadWrite",
"InstanceId": "r-2ze8v41uei31lo****",
"RegionId": "cn-zhangjiakou",
"AccountType": "Normal",
"TypeInfo": {},
"AccountName": "cctest"
},
"resourceId": "cctest"
}
],
"totalCount": 20
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。