DescribeInstanceStatsInfo - 查询实例统计

此 API 旨在查询不同维度下,用户购买的云渲染实例统计信息。 用户可以通过此接口获取项目(ProjectId)、大区(DistrictId)和实例类型(InstanceType)等条件下的实例统计信息, 实例统计信息中包含: 创建中、运行中、运维中、释放中等状态的实例数量。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cgcs:DescribeInstanceStatsInfolist
*全部资源
*

请求参数

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

项目 ID 列表,不填默认所有。

string

项目 ID

6733705348307226241003
InstanceTypesarray

实例类型列表,不填默认所有。

string

实例类型

gcs.r1c1m1.1xlarge
DistrictIdsarray

大区 ID 列表,不填默认所有。

string

大区 ID

huabei

返回参数

名称类型描述示例值
object

Schema of Response

Dataarray<object>

统计数据 Data

ProjectInstanceStatsInfoobject

实例统计数据列表。

ProjectIdstring

项目 id

6733705348307226241003
DistrictIdstring

大区 id

huabei
InstanceTypestring

实例类型

gcs.r1c1m1.1xlarge
TotalCountinteger

总实例数

4
RunningInstanceCountinteger

运行中实例数

1
OperatingInstanceCountinteger

运维中实例数

1
ReservingInstanceCountinteger

创建中实例数

1
ReleasingInstanceCountinteger

释放中实例数

1
RequestIdstring

请求 ID。

46329898-489C-4E63-9BA1-C1DA5C5D0977

返回示例

正常返回示例 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"
}

错误码

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