文档中心

ArkClaw 企业版

请输入

ClawInstance

StopClawInstance - 停止一个ArkClaw实例

停止一个ArkClaw实例。

请求参数

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

Action string 必选示例值：StopClawInstance

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

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

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

ClientToken string 可选示例值：23fa21A8823nfasd7f****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

取值：仅支持ASCII字符，且不能超过64个字符。

DryRun boolean 可选示例值：false

是否仅做参数和权限检查而不实际执行操作。取值：

true：仅做检查，校验通过返回 DryRunOperation 错误码。

false（默认）：实际执行操作。

InstanceId string 必选示例值：ci-yenklf05q8a9xf1s****

ArkClaw实例ID。查询实例ID的方式请参见ListClawInstances。

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

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

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=StopClawInstance&Version=2026-05-01 HTTP/1.1​
Host: arkclaw.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260605T093849Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260605/cn-beijing/arkclaw/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "ci-yenklf05q8a9xf1s****",​
  "SpaceId": "csi-yei8347ta8xmf5qd****"​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "2026060517385619524319****",​
    "Action": "StopClawInstance",​
    "Version": "2026-05-01",​
    "Service": "arkclaw",​
    "Region": "cn-beijing"​
  },​
  "Result": {}​
}​

错误码

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

状态码	错误码	错误信息	说明
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实例状态错误无法操作
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	ClientToken 不符合规范：长度需为 1~64 字符；仅支持 ASCII 可见字符。
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	幂等参数不一致：相同ClientToken复用于参数不同的请求。
404	InvalidInstance.NotFound	The specified Instance does not exist.	指定ArkClaw实例不存在。
404	InvalidSpace.NotFound	The specified Space does not exist.	指定ArkClaw空间不存在。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中：相同ClientToken的前序请求尚未完成。
412	DryRunOperation	The user has the required permissions, so the request would have succeeded, but the DryRun parameter was used.	DryRun检查通过；由于设置了DryRun参数，请求未真正执行。
429	FlowLimitExceeded	The request was rejected due to flow control.	请求触发限流。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.06.05 21:31:13

这个页面对您有帮助吗？

有用

无用