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

ArkClaw 企业版

复制全文
下载 pdf
ClawInstance
CreateClawInstanceSnapshots - 批量创建ArkClaw实例备份
复制全文
下载 pdf
CreateClawInstanceSnapshots - 批量创建ArkClaw实例备份
批量创建ArkClaw实例备份。
请求参数
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数
Action string 必选 示例值:CreateClawInstanceSnapshots
要执行的操作,取值:CreateClawInstanceSnapshots。
Version string 必选 示例值:2026-05-01
API的版本,取值:2026-05-01。
InstanceIds string[] 必选 示例值:[ci-yemjf738cgwr0****,ci-yem8ac2vi8hxvx****]
需要创建备份的ArkClaw实例ID列表。查询实例ID的方式请参见ListClawInstances
  • 每次最多传入100个实例ID,至少传入1个。
  • 若传入重复ID,系统将自动去重,不可为空。
ClientToken string 可选 示例值:23fa21A8823nfasd7f****
保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。
取值:仅支持ASCII字符,且不能超过64个字符。
DryRun boolean 可选 示例值:false
是否仅做参数和权限检查而不实际执行操作。取值:
  • true:仅做检查,校验通过返回DryRunOperation错误码。
  • false(默认):实际执行操作。
SpaceId string 必选 示例值:csi-yei8347ta8xmf5qd****
ArkClaw实例所属空间ID。可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。
返回参数
下方仅列出本接口特有的返回参数。更多信息请参见返回结构
OperationDetails object[] 示例值:--
逐实例结果列表。
Error object 示例值:--
单个用户结果项处理失败时返回的错误描述,主要用于展示和排查问题;成功时为空或不返回。
Code string 示例值:InvalidUser.NotFound
错误码。
Message string 示例值:The specified Instance does not exist.
错误信息。
InstanceId string 示例值:ci-yenklf05q8a9xf1s****
ArkClaw实例ID。
SnapshotId string 示例值:snp-f7b3****
备份记录ID。
Status string 示例值:Accepted
当前实例的备份请求结果。取值:
  • Accepted:请求已成功接收,备份任务将在后台排队执行。
  • Skipped:实例当前有进行中的备份、恢复等操作,为避免冲突,本次请求已跳过。
  • Failed:实例的备份请求失败,不影响批量请求中的其他实例。
请求示例
POST /?Action=CreateClawInstanceSnapshots&Version=2026-05-01 HTTP/1.1
Host: https://arkclaw.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260624T125029Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260624/cn-beijing/arkclaw/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"ClientToken": "23fa21A8823nfasd7f****",
"SpaceId": "csi-yei8347ta8xmf5qd****",
"InstanceIds": [
"ci-yemjf738cgwr0****",
"ci-yem8ac2vi8hxvx****"
]
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202606242050550602****",
"Action": "CreateClawInstanceSnapshots",
"Version": "2026-05-01",
"Service": "arkclaw",
"Region": "cn-beijing"
},
"Result": {
"OperationDetails": [
{
"InstanceId": "ci-yemjf738cgwr0****",
"SnapshotId": "snp-f7b3****",
"Status": "Accepted",
"Error": null
},
{
"InstanceId": "ci-yem8ac2vi8hxvx****",
"SnapshotId": "snp-j4h3****",
"Status": "Accepted",
"Error": null
}
]
}
}
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码
错误码
错误信息
说明
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
同一 Token 但请求参数与首次调用不一致,需更换 Token
400
InvalidClientToken.Malformed
The specified ClientToken is malformed.
Token 格式非法(非 ASCII 或超过 64 字节)
400
LimitExceeded.MaximumInstanceIds
The number of specified InstanceIds exceeds the maximum limit.
InstanceIds数量超过最大限制。
400
MissingParameter.InstanceIds
The required parameter InstanceIds is not supplied.
参数InstanceIds不能为空。
400
MissingParameter.SpaceId
The required parameter SpaceId is not supplied.
参数SpaceId不能为空。
412
DryRunOperation
The user has the required permissions, so the request would have succeeded, but the DryRun parameter was used.
DryRun检查通过;由于设置了DryRun参数,请求未真正执行。
412
IdempotentProcessing
The previous request with the same ClientToken is still processing.
同一 Token 的首次请求仍在处理中,请稍后重试
429
FlowLimitExceeded
The request was rejected due to flow control.
请求触发限流。
500
InternalError
An internal error has occurred.
内部错误,请重试。如果多次尝试失败,请提交工单。
最近更新时间:2026.06.29 18:59:57
这个页面对您有帮助吗?
有用
有用
无用
无用