GetResources_云控制API_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

流控信息

请求速率为100/1(s)。

授权信息

当前云产品暂无权限信息透出。

请求语法

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

路径参数

字段名称字段详情
requestPathstring

请求路径。根据不同的请求路径,用户可分别调用资源 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****

请求参数

字段名称字段详情
regionIdstring

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

示例值:cn-beijing
filterobject

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

nextTokenstring

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

示例值:AAAAAdDWBF2****
maxResultsinteger<int32>

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

示例值:10

返回参数

字段名称字段详情
maxResultsinteger<int32>

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

示例值:10
nextTokenstring

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

示例值:AAAAAdDWBF2****
requestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
resourceobject

指定资源。Get 操作返回。

resourcesarray<object>

资源列表。List 操作返回。

totalCountinteger<int32>

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

示例值:20

返回示例

变更历史

暂无变更历史

相关示例