ArkClaw 企业版
ArkClaw 企业版
文档指南
请输入
- 文档首页
ArkClaw 企业版ArkClaw 企业版开发者指南API 参考ClawInstanceGetClawInstance - 获取ArkClaw实例详情
复制全文
下载 pdfGetClawInstance - 获取ArkClaw实例详情
文档反馈
问问助手获取ArkClaw实例详情。
请求参数
Action string 必选 示例值：GetClawInstance
要执行的操作，取值：GetClawInstance。
Version string 必选 示例值：2026-05-01
API的版本，取值：2026-05-01。
InstanceId string 必选 示例值：ci-yenklf05q8a9xf1s****
SpaceId string 必选 示例值：csi-yei8347ta8xmf5q****
ArkClaw实例所属空间ID。可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。
返回参数
Instance object 示例值：--
ArkClaw实例结构体。
CreatedAt string 示例值：2026-01-01T11:02:08+08:00
ArkClaw创建时间，时间格式为time.RFC3339。
RecycledAt string 示例值：2026-01-01T11:02:08+08:00
ArkClaw回收时间，时间格式为time.RFC3339。
UpdatedAt string 示例值：2026-01-01T11:02:08+08:00
ArkClaw更新时间，时间格式为time.RFC3339。
Description string 示例值：Claw for the HR department.
ArkClaw实例描述。
InstanceId string 示例值：ci-yenklf05q8a9xf1s****
ArkClaw实例ID。
InstanceName string 示例值：instance-001
ArkClaw 实例名称。
ModelName string 示例值：doubao-seed-2-0-lite-260215
ArkClaw模型名称。
SpaceId string 示例值：csi-yei8347ta8xmf5qd****
ArkClaw实例所属空间ID。
Status string 示例值：Running
ArkClaw状态。取值：
- Creating：创建中。
- Running：运行中。
- Upgrading：升级中。
- Updating：更新中。
- Stopping：关机中。
- Starting：开机中。
- Rebooting：重启中。
- Resetting：重新初始化中。
- Fixing：修复中。
- Stopped：已关机。
- Error：异常。
- Resizing：变配中。
UserId string 示例值：22e122d8-f804-4a86-999f-ddd1a****
用户 ID。
ModelSource string 示例值：ModelSquare
ArkClaw模型来源。取值：
- CodingPlan：来源于CodingPlan。
- ModelSquare：来源于模型广场。
- Customer：来源于用户自定义。
SeatType string 示例值：Starter
ArkClaw席位类型，取值：
- Starter：轻量版。
- Standard：标准版。
- Premium：高级版。
- Ultimate：旗舰版。
BillingType string 示例值：InstancePrePaid
计费方式。取值：
- SeatPrePaid：按席位预付费。
- InstancePrePaid：按实例预付费。
ExpiredAt string 示例值：2026-04-21T10:00:00Z
实例计费到期时间，time.RFC3339格式。
EnableHeadless boolean 示例值：false
是否启用 Headless 模式。取值：
- true：启用。
- false：不启用。
Tags object[] 示例值：--
ArkClaw 实例标签。
Key string 示例值：tag
标签键。
Type string 示例值：custom
标签类型。取值：
- custom：自定义标签。
- system：系统标签。
Value string 示例值：production
标签值。
请求示例
GET /?Action=GetClawInstance&Version=2026-05-01&InstanceId=ci-yenklf05q8a9xf1s****&SpaceId=csi-yei8347ta8xmf5q**** HTTP/1.1 Host: https://arkclaw.cn-beijing.volcengineapi.com X-Date: 20260605T125337Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260605/cn-beijing/arkclaw/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
返回示例
{
"ResponseMetadata": {
"RequestId": "2026062916131123322****",
"Action": "GetClawInstance",
"Version": "2026-05-01",
"Service": "arkclaw",
"Region": "cn-beijing"
},
"Result": {
"Instance": {
"CreatedAt": "2026-01-01T11:02:08+08:00",
"RecycledAt": "2026-01-01T11:02:08+08:00",
"UpdatedAt": "2026-01-01T11:02:08+08:00",
"Description": "Claw for the HR department.",
"InstanceId": "ci-yenklf05q8a9xf1s****",
"InstanceName": "instance-001",
"ModelName": "doubao-seed-2-0-lite-260215",
"SpaceId": "csi-yei8347ta8xmf5qd****",
"Status": "Running",
"UserId": "22e122d8-f804-4a86-999f-ddd1a****",
"ModelSource": "ModelSquare",
"SeatType": "Starter",
"BillingType": "InstancePrePaid",
"ExpiredAt": "2026-04-21T10:00:00Z",
"EnableHeadless": false,
"Tags": [
{
"Key": "tag",
"Value": "production",
"Type": "custom"
}
]
}
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | MissingParameter.InstanceId | The required parameter InstanceId is not supplied. | 参数InstanceId不能为空。 |
400 | MissingParameter.InstanceId | The required parameter InstanceId is not supplied. | 参数InstanceId不能为空。 |
400 | MissingParameter.SpaceId | The required parameter SpaceId is not supplied. | 参数SpaceId不能为空。 |
404 | InvalidSpace.NotFound | The specified Space does not exist. | 指定ArkClaw空间不存在。 |
404 | InvalidInstance.NotFound | The specified Instance does not exist. | 指定ArkClaw实例不存在。 |
429 | FlowLimitExceeded | The request was rejected due to flow control. | 请求触发限流。 |
500 | InternalError | An internal error has occurred. | 内部错误，请重试。如果多次尝试失败，请提交工单。 |
最近更新时间：2026.07.16 20:03:48
这个页面对您有帮助吗？
有用
有用
无用
无用