文档

ListInstances - 查询云渲染实例列表

更新时间:

查询云渲染实例列表。

调试

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

授权信息

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

请求参数

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

项目 ID,不填默认查询所有项目下的实例。

4820372607851300489003
InstanceTypestring

GCS 实例的规格,不填默认所有实例规格。

gcs.r1c1m1.1xlarge
DistrictIdstring

大区 ID,不填默认所有大区。取值:

  • huadong

  • xinan

  • huanan

  • huabei

  • huazhong

huadong
InstanceIdarray

待查询的云渲染实例 ID 列表,不填默认所有实例 ID。

string

实例 ID。

gcs-bmt0kbn7e013aedg9
NextTokenstring

上一次查询返回的 Token,首次查询可为空。

BEXZPF01W23U46598WVf
MaxResultsinteger

最大结果数。取值范围 1~200,默认值 200。

20
Statusstring

云渲染实例话状态,包括:

  • CREATING:创建中
  • RUNNING:实例运行中
  • OPERATING:实例运维中
  • DELETING: 实例删除中
  • MIGRATING: 实例迁移中
CREATING

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

46329898-489C-4E63-9BA1-C1DA5C5D0986
Instancesobject []

云渲染实例列表。

InstanceIdstring

实例 ID。

gcs-bmt0kbn7e013aedg9
InstanceTypestring

GCS 云渲染实例规格。

gcs.r1c1m1.1xlarge
DistrictIdstring

大区 ID。取值:

  • huadong

  • xinan

  • huanan

  • huabei

  • huazhong

huadong
ProjectIdstring

项目 ID。

4820372607851300489003
Statusstring

云渲染实例话状态,包括:

  • CREATING:创建中
  • RUNNING:实例运行中
  • OPERATING:实例运维中
  • DELETING: 实例删除中
  • MIGRATING: 实例迁移中
CREATING
CreationTimestring

创建时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-12-13T11:12:11Z
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

BEXZPF01W23U46598WVf
MaxResultsstring

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

50

返回示例

正常返回 JSON 格式

{
  "Instances": [
    {
      "Status": "RUNNING",
      "InstanceId": "gcs-bmt0kbn7e013aedg8",
      "DistrictId": "huadong",
      "ProjectId": "4820372607851300489003",
      "CreationTime": "2023-12-13T11:12:11Z",
      "InstanceType": "gcs.r1c1m1.1xlarge"
    },
    {
      "Status": "RUNNING",
      "InstanceId": "gcs-bmt0kbn7e013aedg9",
      "DistrictId": "huadong",
      "ProjectId": "4820372607851300489003",
      "CreationTime": "2023-12-13T11:12:11Z",
      "InstanceType": "gcs.r1c1m1.1xlarge"
    }
  ],
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "NextToken": "BEXZPF01W23U46598WVf",
  "MaxResults": 200
}

示例

正常返回示例

JSON格式

{
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "Instances": [
    {
      "InstanceId": "gcs-bmt0kbn7e013aedg9",
      "InstanceType": "gcs.r1c1m1.1xlarge",
      "DistrictId": "huadong",
      "ProjectId": "4820372607851300489003",
      "Status": "CREATING",
      "CreationTime": "2023-12-13T11:12:11Z"
    }
  ],
  "NextToken": "BEXZPF01W23U46598WVf",
  "MaxResults": "50"
}

错误码

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

  • 本页导读 (0)
文档反馈