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

ArkClaw 企业版

复制全文
下载 pdf
Image
ListClawImages - 批量查询ArkClaw镜像详情
复制全文
下载 pdf
ListClawImages - 批量查询ArkClaw镜像详情
通过自定义筛选条件批量查询ArkClaw镜像详情。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListClawImages​
要执行的操作,取值:ListClawImages。​
​
Version string 必选 示例值:2026-05-01​
API的版本,取值:2026-05-01。​
​
Creators.N string[] 可选 示例值:Creators.1=7ebfbe5b-****&Creators.2=03c4a823-****​
按创建者ID进行筛选。​
  • 参数- N:创建者ID的序号,取值范围:1~100。​
  • 多个创建者ID之间用&分隔。​
​
ImageIds.N string[] 可选 示例值:ImageIds.1=cimg-yeqsxms****&ImageIds.2=cimg-yeqsrqz****​
按镜像ID进行筛选。​
  • 参数- N:镜像ID的序号,取值范围:1~100。​
  • 多个镜像ID之间用&分隔。​
​
MaxResults integer 可选 示例值:10​
分页查询时设置的每页行数。​
  • 最小值:1。​
  • 最大值:100。​
  • 默认值:10。​
  • 若传入非法MaxResults值,会被自动调整为默认值。​
​
Name string 可选 示例值:demo​
按镜像名称精确筛选。​
​
NextToken string 可选 示例值:Y2kteWVqMXJreTVma3F0YzM4e******​
分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。​
​
SpaceId string 必选 示例值:csi-yehw6ow1kwa5g0****​
ArkClaw空间ID。可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。​
​
Statuses.N string[] 可选 示例值:Statuses.1=Active&Statuses.2=Failed​
按镜像状态进行筛选。​
  • 参数- N:镜像状态的序号,取值范围:1~100。​
  • 多个镜像状态之间用&分隔。​
  • 取值:​
  • Creating:创建中。​
  • Active:可用。​
  • Failed:创建失败。​
  • Deleting:删除中。​
​
Types.N string[] 可选 示例值:Types.1=Custom&Types.2=Public​
按镜像类型进行筛选。​
  • 参数- N:镜像类型的序号,取值范围:1~100。​
  • 多个镜像类型之间用&分隔。​
  • 取值:​
  • Public:公共镜像​
  • Custom:自定义镜像。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Images object[] 示例值:--​
镜像列表。​
ApplicationVersion string 示例值:v1.0.0​
版本号。​
​
CreatedAt string 示例值:2026-05-27T12:00:00Z​
创建时间,时间格式为RFC3339 UTC。​
​
CreatorId string 示例值:7ebfbe5b-****​
创建者 ID。​
​
Description string 示例值:demo image​
镜像描述。​
​
CreatorType string 示例值:User​
创建者类型。取值:​
  • Admin:管理员。​
  • User:员工。​
​
ImageId string 示例值:cimg-yeqsxms****​
镜像ID。​
​
Name string 示例值:demo-image​
镜像名称。​
​
Status string 示例值:Active​
镜像状态。​
​
Type string 示例值:Custom​
镜像类型。​
​
UpdatedAt string 示例值:2026-05-27T12:10:00Z​
更新时间,时间格式为RFC3339 UTC。​
​
​
NextToken string 示例值:Y2kteWVqMXJreTVma3F0YzM4e******​
分页查询凭证,没有更多结果时为空。​
​
​
​
请求示例​
​
GET /?Action=ListClawImages&Version=2026-05-01&SpaceId=csi-yehw6ow1kwa5g0****​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2026070219163813600109****",​
"Action": "ListClawImages",​
"Version": "2026-05-01",​
"Service": "arkclaw",​
"Region": "cn-beijing"​
},​
"Result": {​
"Images": [​
{​
"ApplicationVersion": "v1.0.0",​
"CreatedAt": "2026-05-27T12:00:00Z",​
"CreatorId": "7ebfbe5b-****",​
"CreatorType": "User",​
"Description": "demo image",​
"ImageId": "cimg-yeqsxms****",​
"Name": "demo-image",​
"Status": "Active",​
"Type": "Custom",​
"UpdatedAt": "2026-05-27T12:10:00Z"​
},​
{​
"ApplicationVersion": "v1.0.0",​
"CreatedAt": "2026-05-28T09:00:00Z",​
"CreatorId": "03c4a823-****",​
"CreatorType": "User",​
"Description": "demo image 2",​
"ImageId": "cimg-yeqsrqz****",​
"Name": "demo-image-2",​
"Status": "Failed",​
"Type": "Public",​
"UpdatedAt": "2026-05-28T09:05:00Z"​
}​
],​
"NextToken": "Y2kteWVqMXJreTVma3F0YzM4e******"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter.SpaceId​
The required parameter SpaceId is not supplied.​
参数SpaceId不能为空。​
400​
InvalidMaxResults.Malformed​
The specified MaxResults is malformed.​
无效的MaxResults。​
400​
InvalidType.Malformed​
The specified Type is malformed.​
Types 存在不支持的枚举值。​
400​
InvalidStatus.Malformed​
The specified Status is malformed.​
指定的实例状态不合法。​
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.07.21 14:22:37
这个页面对您有帮助吗?
有用
有用
无用
无用