ListInstances - 查询云渲染实例列表_云渲染(GCS)-阿里云帮助中心

查询云渲染实例列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cgcs:ListInstances	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ProjectId	string	否	项目 ID，不填默认查询所有项目下的实例。	4820372607851300489003
InstanceType	string	否	GCS 实例的规格，不填默认所有实例规格。	gcs.r1c1m1.1xlarge
DistrictId	string	否	大区 ID，不填默认所有大区。取值： huadong xinan huanan huabei huazhong	huadong
InstanceId	array	否	待查询的云渲染实例 ID 列表，不填默认所有实例 ID。
	string	否	实例 ID。	gcs-bmt0kbn7e013aedg9
NextToken	string	否	上一次查询返回的 Token，首次查询可为空。	BEXZPF01W23U46598WVf
MaxResults	integer	否	最大结果数。取值范围 1~200，默认值 200。	20
Status	string	否	云渲染实例话状态，包括： CREATING：创建中 RUNNING：实例运行中 OPERATING：实例运维中 DELETING: 实例删除中 MIGRATING: 实例迁移中	CREATING

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	46329898-489C-4E63-9BA1-C1DA5C5D0986
Instances	array<object>	云渲染实例列表。
Instance	object	实例信息。
InstanceId	string	实例 ID。	gcs-bmt0kbn7e013aedg9
InstanceType	string	GCS 云渲染实例规格。	gcs.r1c1m1.1xlarge
DistrictId	string	大区 ID。取值： huadong xinan huanan huabei huazhong	huadong
ProjectId	string	项目 ID。	4820372607851300489003
Status	string	云渲染实例话状态，包括： CREATING：创建中 RUNNING：实例运行中 OPERATING：实例运维中 DELETING: 实例删除中 MIGRATING: 实例迁移中	CREATING
CreationTime	string	创建时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2023-12-13T11:12:11Z
NextToken	string	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	BEXZPF01W23U46598WVf
MaxResults	string	本次请求所返回的最大记录条数。	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": 4.820372607851301e+21,
      "Status": "CREATING",
      "CreationTime": "2023-12-13T11:12:11Z"
    }
  ],
  "NextToken": "BEXZPF01W23U46598WVf",
  "MaxResults": 50
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidNextToken	invalid nextToken.	令牌无效
400	InvalidArgs	invalid status.	参数状态无效

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

变更历史

变更时间	变更内容概要	操作
2024-08-28	OpenAPI 错误码发生变更	查看变更详情