文档中心

ArkClaw 企业版

ClawInstance

ListClawInstances - 批量查询ArkClaw实例详情

通过自定义筛选条件批量查询ArkClaw实例详情。

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ListClawInstances

要执行的操作，取值：ListClawInstances。

Version string 必选示例值：2026-05-01

API的版本，取值：2026-05-01。

InstanceIds.N string[] 可选示例值：InstanceIds.1=ci-yemjf738cgwr0****&InstanceIds.2=ci-yem8ac2vi8hxvx****

ArkClaw实例ID列表。

参数 - N：表示实例ID的序号，取值范围：1～100。

多个实例ID之间用&分隔。

传入的无效ID将被忽略。

MaxResults integer 可选示例值：20

分页查询时设置的每页行数。

最小值：1。

最大值：100。

默认值：20。

若传入非法MaxResults值，会被自动调整为默认值。

NextToken string 可选示例值：Y2kteWVqMXJreTVma3F0YzM4e******

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

Recycled boolean 可选示例值：false

是否返回回收站列表，取值：

true：返回。

false（默认）：不返回。

SeatTypes.N string[] 可选示例值：SeatTypes.1=Starter&SeatTypes.2=Starter

ArkClaw席位类型。

参数 - N：表示席位的序号，取值范围：1～4。

取值：

Starter：轻量版。

Standard：标准版。

Premium：高级版。

Ultimate：旗舰版。

SpaceId string 必选示例值：csi-yehw6ow1kwa5g0****

ArkClaw实例所属空间ID。可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。

Status string 可选示例值：Running

ArkClaw状态。取值：

Creating：创建中。

Running：运行中。

Upgrading：升级中。

Updating：更新中。

Stopping：关机中。

Starting：开机中。

Rebooting：重启中。

Resetting：重新初始化中。

Fixingv修复中。

Stopped：已关机。

Error：异常。

Resizing：变配中。

TagFilters.N.Key string[] 可选示例值：TagFilters.1.Key=k1&TagFilters.2.Key=k2

根据标签查询资源时指定的标签键。

N：表示标签序号，取值范围1～10。

多个标签键之间用&分隔。

标签键不允许重复。

传入的无效标签键将被忽略。

TagFilters.N.Values.N string[] 可选示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

根据标签查询资源时指定的标签值。

第一个N表示标签键序号，取值范围1～10。

第二个N表示标签值序号，取值范围1～3。

多个标签值之间用&分隔。

BillingType string 可选示例值：InstancePrePaid

计费方式。取值：

SeatPrePaid（默认）：席位预付费。

InstancePrePaid：实例预付费。

UserIds.N string[] 可选示例值：UserIds.1=baadc2dc-****&UserIds.2=9fc5ff57-****

用户ID列表。

参数 - N：表示用户ID的序号，取值范围：1～100。

多个实例ID之间用&分隔。

传入的无效ID将被忽略。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Instances object[] 示例值：--

ArkClaw实例列表。

CreatedAt string 示例值：2026-01-01T11:02:08+08:00

ArkClaw创建时间，时间格式为：time.RFC3339。

Description string 示例值：Claw for the HR department.

ArkClaw实例描述。

InstanceId string 示例值：ci-yemj8hrdvkwr0****

ArkClaw实例的ID。

InstanceName string 示例值：instance-001

ArkClaw实例名称。

RecycledAt string 示例值：2026-01-01T11:02:08+08:00

ArkClaw回收时间，时间格式为：time.RFC3339。

SeatType string 示例值：Starter

ArkClaw席位类型。

SpaceId string 示例值：csi-yei8347ta8xmf5****

ArkClaw实例所属空间ID。

Status string 示例值：Running

ArkClaw实例的状态。

UpdatedAt string 示例值：2026-01-01T11:02:08+08:00

ArkClaw更新时间，时间格式为：time.RFC3339。

EnableHeadless boolean 示例值：false

是否启用 Headless 模式，取值：

true：启用。

false：不启用。

BillingType string 示例值：InstancePrePaid

计费方式。取值：

SeatPrePaid：按席位预付费。

InstancePrePaid：按实例预付费。

ExpiredAt string 示例值：2026-04-21T10:00:00Z

实例计费到期时间，time.RFC3339格式。

UserId string 示例值：baadc2dc-****

用户ID。

NextToken string 示例值：KK70rgmr****

本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=ListClawInstances&Version=2026-05-01&SpaceId=csi-yehw6ow1kwa5g0**** HTTP/1.1 Host: https://arkclaw.cn-beijing.volcengineapi.com X-Date: 20260605T125449Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260605/cn-beijing/arkclaw/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "202606291558111260162****",​
    "Action": "ListClawInstances",​
    "Version": "2026-05-01",​
    "Service": "arkclaw",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "Instances": [​
      {​
        "CreatedAt": "2026-01-01T11:02:08+08:00",​
        "Description": "Claw for the HR department.",​
        "InstanceId": "ci-yemj8hrdvkwr0****",​
        "InstanceName": "instance-001",​
        "RecycledAt": "2026-01-01T11:02:08+08:00",​
        "SeatType": "Starter",​
        "SpaceId": "csi-yehw6ow1kwa5g0****",​
        "Status": "Running",​
        "UpdatedAt": "2026-01-01T11:02:08+08:00",​
        "UserId": "baadc2dc-****",​
        "BillingType": "InstancePrePaid",​
        "ExpiredAt": "2026-04-21T10:00:00Z"​
      },​
      {​
        "CreatedAt": "2026-01-01T11:02:08+08:00",​
        "Description": "Claw for the HR department.",​
        "InstanceId": "ci-yem8ac2vi8hxvx****",​
        "InstanceName": "instance-001",​
        "RecycledAt": "2026-01-01T11:02:08+08:00",​
        "SeatType": "Starter",​
        "SpaceId": "csi-yehw6ow1kwa5g0****",​
        "Status": "Running",​
        "UpdatedAt": "2026-01-01T11:02:08+08:00",​
        "UserId": "9fc5ff57-****",​
        "BillingType": "InstancePrePaid",​
        "ExpiredAt": "2026-04-21T10:00:00Z"​
      }​
    ],​
    "NextToken": "KK70rgmr****"​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidUserId.Malformed	The specified UserId is malformed.	参数UserId不合法。
400	LimitExceeded.MaximumUserIds	The number of UserIds exceeds the maximum allowed limit.	UserIds 的数量超过了允许的最大限制。
400	LimitExceeded.MaximumInstanceIds	The number of specified InstanceIds exceeds the maximum limit.	InstanceIds数量超过最大限制。
400	InvalidBillingType.Malformed	The specified BillingType is malformed. Valid values: SeatPrePaid, InstancePrePaid.	计费类型不合法，有效值：SeatPrePaid、InstancePrePaid。
400	LimitExceeded.MaximumTagFilterKeys	The number of tag filter keys exceeds the maximum limit.	标签键数量过多。
400	LimitExceeded.MaximumTagFilterValues	The number of tag filter values exceeds the maximum limit.	标签值数量过多。
400	InvalidStatus.Malformed	The specified Status is malformed.	指定的实例状态不合法。
400	InvalidSeatType.Malformed	The specified SeatType is malformed.	指定的实例席位类型不合法。
400	MissingParameter.SpaceId	The required parameter SpaceId is not supplied.	参数SpaceId不能为空。
404	InvalidSpace.NotFound	The specified Space does not exist.	指定ArkClaw空间不存在。
409	InvalidTagFilterKey.Conflict	The specified TagFilterKey already exists.	指定的过滤标签键已存在。
429	FlowLimitExceeded	The request was rejected due to flow control.	请求触发限流。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.07.16 20:03:48

这个页面对您有帮助吗？

有用

无用