通过此接口查询资源。
接口说明
用户可前往在线调试 API 门户查看资源文档和体验 Cloud Control API。
此 API 包括资源的 Get 和 List 功能,根据不同的请求路径,用户可分别调用资源 List 和 Get 能力。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cloudcontrol:GetResources | get |
|
| 无 |
请求语法
GET /api/v1/providers/{provider}/products/{product}/resources/* HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
requestPath | string | 是 | 请求路径。根据不同的请求路径,用户可分别调用资源 List 和资源 Get。 1.List: /api/v1/providers/{provider}/products/{product}/resources/{resourceType} 2.Get: /api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId} 请求路径中变量说明: provider: 云厂商,目前只支持 Aliyun。 product: 产品 Code。 resourceType: 资源类型。有父资源时,格式为{父资源类型 code}/父资源 ID/{资源类型 code}。 resourceId: 资源 ID。 | 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 格式,可以将部分资源属性作为过滤条件。 | |
nextToken | string | 否 | 用来标记当前开始读取的位置,置空表示从头开始。 | AAAAAdDWBF2**** |
maxResults | integer | 否 | 分页查询时每页行数,最大不能超过 100。 | 10 |
返回参数
示例
正常返回示例
JSON
格式
{
"maxResults": 10,
"nextToken": "AAAAAdDWBF2****",
"requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"resource": {
"resourceAttributes": {
"Status": "Available",
"Description": "",
"AccountPrivilege": "RoleReadWrite",
"InstanceId": "r-8vbf5abe31c9c4d4",
"RegionId": "cn-zhangjiakou",
"AccountType": "Normal",
"TypeInfo": {},
"AccountName": "cctest"
},
"resourceId": "cctest"
},
"resources": [
{
"resourceAttributes": {
"Status": "Available",
"Description": "",
"AccountPrivilege": "RoleReadWrite",
"InstanceId": "r-8vbf5abe31c9c4d4",
"RegionId": "cn-zhangjiakou",
"AccountType": "Normal",
"TypeInfo": {},
"AccountName": "cctest"
},
"resourceId": "cctest"
}
],
"totalCount": 20
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|