You need to enable JavaScript to run this app.
文档中心
ArkClaw 企业版

ArkClaw 企业版

复制全文
下载 pdf
ClawInstance
GetClawInstanceTerminalToken - 获取ArkClaw实例终端凭证
复制全文
下载 pdf
GetClawInstanceTerminalToken - 获取ArkClaw实例终端凭证
获取访问ArkClaw实例终端所需的临时鉴权凭据,获取后可建立与实例终端的交互式连接,进行命令行操作。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:GetClawInstanceTerminalToken​
要执行的操作,取值:GetClawInstanceTerminalToken。​
​
Version string 必选 示例值:2026-05-01​
API的版本,取值:2026-05-01。​
​
InstanceId string 必选 示例值:ci-yenklf05q8a9xf1s****​
ArkClaw实例ID。​
​
SpaceId string 必选 示例值:csi-yei8347ta8xmf5qd****​
ArkClaw实例所属空间ID。可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Endpoint string 示例值:sd3p0****.apigateway-cn-beijing.volceapi.com​
实例终端的连接地址。​
​
InstanceId string 示例值:ci-yenklf05q8a9xf1s****​
ArkClaw实例ID。​
​
TerminalToken string 示例值:tt-c93e7d7b-f788-4925-98****​
用于访问实例终端的临时鉴权Token,格式为:tt-36位UUID字符。​
​
​
​
请求示例​
​
GET /?Action=GetClawInstanceTerminalToken&Version=2026-05-01&InstanceId=ci-yenklf05q8a9xf1s****&SpaceId=csi-yei8347ta8xmf5qd**** HTTP/1.1​
Host: https://arkclaw.cn-beijing.volcengineapi.com​
X-Date: 20260605T125122Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260605/cn-beijing/arkclaw/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2026060520512714801****",​
"Action": "GetClawInstanceTerminalToken",​
"Version": "2026-05-01",​
"Service": "arkclaw",​
"Region": "cn-beijing"​
},​
"Result": {​
"Endpoint": "sd3p0****.apigateway-cn-beijing.volceapi.com",​
"InstanceId": "ci-yenklf05q8a9xf1s****",​
"TerminalToken": "tt-c93e7d7b-f788-4925-98****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter.InstanceId​
The required parameter InstanceId is not supplied.​
参数InstanceId不能为空。​
400​
MissingParameter.SpaceId​
The required parameter SpaceId is not supplied.​
参数SpaceId不能为空。​
400​
InvalidInstanceStatus​
The ClawInstance must be in the {expected status} status to complete the operation.​
ArkClaw实例状态错误无法操作​
404​
InvalidInstance.NotFound​
The specified Instance does not exist.​
指定ArkClaw实例不存在。​
404​
InvalidSpace.NotFound​
The specified Space does not exist.​
指定ArkClaw空间不存在。​
429​
FlowLimitExceeded​
The request was rejected due to flow control.​
请求触发限流。​
500​
InternalError​
An internal error has occurred.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2026.06.05 21:31:13
这个页面对您有帮助吗?
有用
有用
无用
无用