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

ArkClaw 企业版

复制全文
下载 pdf
ClawInstance
ListClawInstanceSnapshots - 批量查询ArkClaw实例备份记录详情
复制全文
下载 pdf
ListClawInstanceSnapshots - 批量查询ArkClaw实例备份记录详情
通过自定义筛选条件批量查询ArkClaw实例备份记录详情。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListClawInstanceSnapshots​
要执行的操作,取值:ListClawInstanceSnapshots。​
​
Version string 必选 示例值:2026-05-01​
API的版本,取值:2026-05-01。​
​
InstanceIds.N string[] 可选 示例值:InstanceIds.1=ci-yenklf05q8a9xf1s****&InstanceIds.2=fhwrgferhglj3dvfdv****​
ArkClaw实例ID列表。查询实例ID的方式请参见ListClawInstances。​
  • 参数 - N:表示实例ID的序号,取值范围:1~100。​
  • 多个实例ID之间用&分隔。​
  • 若传入重复ID,系统将自动去重,不可为空。​
​
MaxResults integer 可选 示例值:20​
分页查询时设置的每页行数。​
  • 最小值:1。​
  • 最大值:100。​
  • 默认值:20。​
  • 若传入非法MaxResults值,会被自动调整为默认值。​
​
NextToken string 可选 示例值:Y2kteWVqMXJreTVma3F0YzM4e******​
分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。​
​
SpaceId string 必选 示例值:csi-yehw6ow1kwa5g0****​
ArkClaw实例所属空间ID。可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。​
​
Statuses.N string[] 可选 示例值:Statuses.1=Ready&Statuses.2=Ready​
按实例备份记录状态进行筛选。取值:​
  • Ready:备份记录已创建完成,可用于恢复实例。​
  • Creating:备份记录正在创建中。​
  • Restoring:正在基于该备份记录执行实例恢复。​
  • Failed:备份记录创建失败。​
  • 参数 - N:表示备份记录的序号,取值范围:1~100。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
NextToken string 示例值:Y2kteWVqMXJreTVma3F0YzM4e******​
本次调用返回的查询凭证值,返回为空表示该页为末页。​
​
Snapshots object[] 示例值:--​
备份记录详情。​
CreatedAt string 示例值:2026-06-24 20:51:39​
ArkClaw实例备份记录创建时间,时间格式为:time.RFC3339。​
​
ExpireAt string 示例值:2026-07-24 20:51:39​
ArkClaw实例备份记录的过期时间,时间格式为:time.RFC3339。​
​
InstanceId string 示例值:ci-yenklf05q8a9xf1s****​
ArkClaw实例ID。​
​
Name string 示例值:ops-snapshot-2026-06-24 20:51:39​
ArkClaw实例备份记录的名称。​
​
SnapshotId string 示例值:snp-yep5dw9t6ory0vsz****​
备份记录ID。​
​
Status string 示例值:Ready​
实例备份记录状态。​
​
​
​
​
请求示例​
​
GET /?Action=ListClawInstanceSnapshots&Version=2026-05-01&InstanceIds.1=ci-yenklf05q8a9xf1s****&InstanceIds.2=fhwrgferhglj3dvfdv****&MaxResults=20&NextToken=Y2kteWVqMXJreTVma3F0YzM4e******&SpaceId=csi-yehw6ow1kwa5g0****&Statuses.1=Ready&Statuses.2=Ready HTTP/1.1​
Host: https://arkclaw.cn-beijing.volcengineapi.com​
X-Date: 20260624T144949Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260624/cn-beijing/arkclaw/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2026062422500519621****",​
"Action": "ListClawInstanceSnapshots",​
"Version": "2026-05-01",​
"Service": "arkclaw",​
"Region": "cn-beijing"​
},​
"Result": {​
"NextToken": "Y2kteWVqMXJreTVma3F0YzM4e******",​
"Snapshots": [​
{​
"SnapshotId": "snp-yep5dw9t6ory0vsz****",​
"InstanceId": "ci-yenklf05q8a9xf1s****",​
"Name": "ops-snapshot-2026-06-24 20:51:39",​
"Status": "Ready",​
"CreatedAt": "2026-06-24 20:51:39",​
"ExpireAt": "2026-07-24 20:51:39"​
},​
{​
"SnapshotId": "snp-yem8ac2v****",​
"InstanceId": "ci-fhwrgferhglj3dvfdv****",​
"Name": "ops-snapshot-2026-06-24 20:51:39",​
"Status": "Ready",​
"CreatedAt": "2026-06-24 20:51:39",​
"ExpireAt": "2026-07-24 20:51:39"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidNextToken.Malformed​
The specified NextToken is malformed.​
无效的NextToken。​
400​
MissingParameter.SpaceId​
The required parameter SpaceId is not supplied.​
参数SpaceId不能为空。​
400​
InvalidInstanceIds.Malformed​
The specified InstanceIds is malformed.​
参数InstanceIds不合法,InstanceId不能传入空字符串​
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.29 18:59:57
这个页面对您有帮助吗?
有用
有用
无用
无用