文档

GetResources - 查询资源

更新时间:

用户通过此接口查询资源。

接口说明

用户可前往在线调试 API 门户查看资源文档和体验 Cloud Control API。

此 API 包括资源的 Get 和 List 功能,根据不同的请求路径,用户可分别调用资源 List 和 Get 能力。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/providers/{provider}/products/{product}/resources/*

请求参数

名称类型必填描述示例值
requestPathstring

请求路径。根据不同的请求路径,用户可分别调用资源 List 和 Get 能力。

1.List: /api/v1/providers/{provider}/products/{product}/resources/{parentResourcePath}/{resourceTypeCode}

2.Get: /api/v1/providers/{provider}/products/{product}/resources/{parentResourcePath}/{resourceTypeCode}/{resourceId}

请求路径中变量说明:

provider: 云厂商,目前只支持 Aliyun。

product: 产品 Code。

parentResourcePath: 父资源路径。以 Redis Account 为例,Redis DBInstance 是 Account 的父资源,那么 parentResourcePath 格式为:父资源 Code/父资源 ID(DBInstance/r-8vbf5abe31c9****)。

resourceTypeCode: 资源 Code。资源 Code 为资源类型 resourceType(父资源 Code/子资源 Code)的后一部分。以 Redis Account 为例,resourceType 为 DBInstance/Account,resourceTypeCode 为 Account。

resourceId: 资源 ID。

示例如下:

Redis DBInstance List: /api/v1/providers/Aliyun/products/Redis/resources/DBInstance

Redis DBInstance Get: /api/v1/providers/Aliyun/products/Redis/resources/Instance/r-8vbf5abe31cxxxxx

ECS Instance List: /api/v1/providers/Aliyun/products/ECS/resources/Instance

ECS Instance Get: /api/v1/providers/Aliyun/products/ECS/resources/Instance/i-123****

RDS Instance List: /api/v1/providers/Aliyun/products/RDS/resources/DBInstance

RDS Instance Get: /api/v1/providers/Aliyun/products/RDS/resources/DBInstance/r-123****

VPC VPC List: /api/v1/providers/Aliyun/products/VPC/resources/VPC

VPC VPC Get: /api/v1/providers/Aliyun/products/VPC/resources/VPC/vpc-123****

SLB LoadBalancer List: /api/v1/providers/Aliyun/products/SLB/resources/LoadBalancer

SLB LoadBalancer Get: /api/v1/providers/Aliyun/products/SLB/resources/LoadBalancer/lb-123****

OSS Bucket List: /api/v1/providers/Aliyun/products/OSS/resources/Bucket

OSS Bucket Get: /api/v1/providers/Aliyun/products/OSS/resources/Bucket/cctest****

/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-8vbf5abe31c9****
regionIdstring

地域 ID。若云产品是 region 化产品,则此参数为必填。

cn-beijing
filterobject

过滤条件。json 格式,可以将部分资源属性作为过滤条件。

nextTokenstring

用来标记当前开始读取的位置,置空表示从头开始。

AAAAAdDWBF2****
maxResultsinteger

分页查询时每页行数,最大不能超过 100。

10

返回参数

名称类型描述示例值
object

返回结构。

requestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
totalCountinteger

本次请求条件下的数据总量。List 操作返回。

20
nextTokenstring

表示当前调用返回读取到的位置,空代表数据已经读取完毕。List 操作返回。

AAAAAdDWBF2****
maxResultsinteger

本次请求所返回的最大记录条数。List 操作返回。

10
resourceobject

指定资源。Get 操作返回。

resourceAttributesobject

资源属性(json 格式)。

{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-8vbf5abe31c9c4d4","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}
resourceIdstring

资源 ID。

cctest
resourcesobject []

资源列表。List 操作返回。

resourceIdstring

资源 ID。

cctest
resourceAttributesobject

资源属性(json 格式)。

{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-8vbf5abe31c9c4d4","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}

示例

正常返回示例

JSON格式

{
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\n",
  "totalCount": 20,
  "nextToken": "AAAAAdDWBF2****\n",
  "maxResults": 10,
  "resource": {
    "resourceAttributes": {
      "Status": "Available",
      "Description": "",
      "AccountPrivilege": "RoleReadWrite",
      "InstanceId": "r-8vbf5abe31c9c4d4",
      "RegionId": "cn-zhangjiakou",
      "AccountType": "Normal",
      "TypeInfo": {},
      "AccountName": "cctest"
    },
    "resourceId": "cctest\n"
  },
  "resources": [
    {
      "resourceId": "cctest",
      "resourceAttributes": {
        "Status": "Available",
        "Description": "",
        "AccountPrivilege": "RoleReadWrite",
        "InstanceId": "r-8vbf5abe31c9c4d4",
        "RegionId": "cn-zhangjiakou",
        "AccountType": "Normal",
        "TypeInfo": {},
        "AccountName": "cctest"
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史