此 API 旨在查询不同维度下,用户购买的云渲染实例统计信息。 用户可以通过此接口获取项目(ProjectId)、大区(DistrictId)和实例类型(InstanceType)等条件下的实例统计信息, 实例统计信息中包含: 创建中、运行中、运维中、释放中等状态的实例数量。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cgcs:DescribeInstanceStatsInfo | list | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectIds | array | 否 | 项目 ID 列表,不填默认所有。 | |
string | 否 | 项目 ID | 6733705348307226241003 | |
InstanceTypes | array | 否 | 实例类型列表,不填默认所有。 | |
string | 否 | 实例类型 | gcs.r1c1m1.1xlarge | |
DistrictIds | array | 否 | 大区 ID 列表,不填默认所有。 | |
string | 否 | 大区 ID | huabei |
返回参数
返回示例
正常返回示例 JSON 格式
{
"RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0977",
"Data": [
{
"ProjectId": "6733705348307226241003",
"DistrictId": "huabei",
"InstanceType": "gcs.r1c1m1.1xlarge",
"TotalCount": 4,
"RunningInstanceCount": 1,
"OperatingInstanceCount": 1,
"ReservingInstanceCount": 1,
"ReleasingInstanceCount": 1
}
]
}
``
示例
正常返回示例
JSON
格式
{
"Data": [
{
"ProjectId": 6.733705348307227e+21,
"DistrictId": "huabei",
"InstanceType": "gcs.r1c1m1.1xlarge\n",
"TotalCount": 4,
"RunningInstanceCount": 1,
"OperatingInstanceCount": 1,
"ReservingInstanceCount": 1,
"ReleasingInstanceCount": 1
}
],
"RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0977"
}
错误码
访问错误中心查看更多错误码。