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

ArkClaw 企业版

复制全文
下载 pdf
Image
GetClawImage - 获取ArkClaw镜像详情
复制全文
下载 pdf
GetClawImage - 获取ArkClaw镜像详情
获取ArkClaw镜像详情。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:GetClawImage​
要执行的操作,取值:GetClawImage。​
​
Version string 必选 示例值:2026-05-01​
API的版本,取值:2026-05-01。​
​
ImageId string 必选 示例值:cimg-yeqssiu****​
镜像ID,可以在ArkClaw控制台“镜像管理”页面获取。​
​
SpaceId string 必选 示例值:csi-yei8347ta8xmf5qd****​
ArkClaw空间ID,可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Image object 示例值:--​
镜像详情。​
Name string 示例值:image-1​
镜像名称。​
​
YamlContent string 示例值:bmFtZTogaW1hZ2UtMQ==​
镜像YAML配置文件内容,base64编码。​
​
Visibility string 示例值:Specified​
镜像可见范围。取值:​
  • AllUsers:全部用户可见。​
  • Specified:仅指定目标可见。​
  • NoUsers:全部用户不可见。​
​
UpdatedAt string 示例值:2026-05-27T12:10:00Z​
镜像的更新时间,时间格式为RFC3339 UTC。​
​
TargetCount integer 示例值:3​
可使用该镜像的指定用户、用户组或部门的总数量。​
说明​
Visibility为AllUsers或NoUsers时默认为0。​
​
Status string 示例值:Active​
镜像状态。取值:​
  • Creating:创建中。​
  • Active:可用。​
  • Failed:创建失败。​
  • Deleting:删除中。​
​
SpaceId string 示例值:csi-yei8347ta8xmf5qd****​
镜像所属ArkClaw空间 ID。​
​
SoulMd string 示例值:c291bA==​
Soul配置文件,base64编码。​
​
AgentMd string 示例值:YWdlbnQ=​
Agent配置文件,base64编码。​
​
ImageId string 示例值:cimg-yeqssiu****​
镜像ID。​
​
ErrorMessage string 示例值:error message​
镜像构建失败时的错误信息。仅GetClawImage接口返回,构建成功时该字段为空。​
​
EcsImageId string 示例值:image-z0gwi5tp9j8rp****​
底层ECS镜像ID。镜像构建成功后返回。​
​
Description string 示例值:image-desc​
镜像描述。​
​
CreatorType string 示例值:Admin​
创建者类型。取值:​
  • Admin:管理员。​
  • User:员工。​
​
CreatorId string 示例值:b2a57a0b-96a3-****​
创建者ID。​
​
BuildScript string 示例值:YnVpbGQ=​
构建脚本,base64编码。​
​
CreatedAt string 示例值:2026-05-27T12:00:00Z​
镜像的创建时间,时间格式为RFC3339 UTC。​
​
Targets object[] 示例值:--​
镜像的可见范围列表。仅管理员调用时返回。​
说明​
Visibility为AllUsers或NoUsers时为空。​
TargetType string 示例值:User​
授权目标类型。取值:​
  • User:用户。​
  • Department:部门。​
  • UserGroup:用户组。​
​
TargetId string 示例值:986a1777-5d37-****​
授权目标ID。​
​
​
SkillInfos object[] 示例值:--​
镜像技能配置。​
Name string 示例值:weather​
技能名称。​
​
Blacklist boolean 示例值:false​
是否禁用技能。取值:​
  • true:禁用技能。​
  • false:不禁用技能。​
​
Description string 示例值:天气​
技能描述。​
​
DisplayName string 示例值:天气技能​
技能展示名称。​
​
Slug string 示例值:volcengine/seedream/byted-seedream-image-generate​
公共技能唯一标识。​
​
Type string 示例值:built-in​
技能类型。取值:​
  • built-in: 基础镜像内置技能。​
  • skillhub: 来自技能中心的技能。​
​
​
PluginInfos object[] 示例值:--​
镜像插件配置。​
Id string 示例值:plugin-1​
插件ID。​
​
Blacklist boolean 示例值:false​
是否禁用插件。取值:​
  • true:禁用插件。​
  • false:不禁用插件。​
​
Description string 示例值:plugin-desc​
插件描述。​
​
DisplayName string 示例值:语音通话​
插件展示名称。​
​
Name string 示例值:voice-call​
插件名称。​
​
Source string 示例值:global:openclaw-lark/index.js​
插件来源,为空表示使用平台默认来源。​
​
Type string 示例值:built-in​
插件类型。​
  • 取值:built-in,基础镜像内置插件。​
​
Version string 示例值:1.0.0​
插件版本。​
​
​
ApplicationVersion string 示例值:v1.0.0​
版本号。​
​
​
​
​
请求示例​
​
GET /?Action=GetClawImage&Version=2026-05-01&ImageId=cimg-yeqssiu****&SpaceId=csi-yei8347ta8xmf5qd****​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202607021942532340802****",​
"Action": "GetClawImage",​
"Version": "2026-05-01",​
"Service": "arkclaw",​
"Region": "cn-beijing"​
},​
"Result": {​
"Image": {​
"ApplicationVersion": "v1.0.0",​
"Name": "image-1",​
"YamlContent": "bmFtZTogaW1hZ2UtMQ==",​
"Visibility": "Specified",​
"UpdatedAt": "2026-05-27T12:10:00Z",​
"TargetCount": 3,​
"Status": "Active",​
"SpaceId": "csi-yei8347ta8xmf5qd****",​
"SoulMd": "c291bA==",​
"AgentMd": "YWdlbnQ=",​
"ImageId": "cimg-yeqssiu****",​
"ErrorMessage": "error message",​
"EcsImageId": "image-z0gwi5tp9j8rp****",​
"Description": "image-desc",​
"CreatorType": "Admin",​
"CreatorId": "creator-1",​
"BuildScript": "YnVpbGQ=",​
"CreatedAt": "2026-05-27T12:00:00Z",​
"Targets": [​
{​
"TargetType": "User",​
"TargetId": "986a1777-5d37-****"​
}​
],​
"SkillInfos": [​
{​
"Name": "weather",​
"Blacklist": true,​
"Description": "天气",​
"DisplayName": "天气技能",​
"Slug": "volcengine/seedream/byted-seedream-image-generate",​
"Type": "built-in"​
}​
],​
"PluginInfos": [​
{​
"Id": "plugin-1",​
"Blacklist": true,​
"Description": "plugin-desc",​
"DisplayName": "语音通话",​
"Name": "voice-call",​
"Source": "global:openclaw-lark/index.js",​
"Type": "built-in",​
"Version": "1.0.0"​
}​
]​
}​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter.ImageId​
The required parameter ImageId is not supplied.​
ImageId 不能为空。​
400​
MissingParameter.SpaceId​
The required parameter SpaceId is not supplied.​
参数SpaceId不能为空。​
404​
InvalidSpace.NotFound​
The specified Space does not exist.​
指定ArkClaw空间不存在。​
404​
InvalidImage.NotFound​
The specified Image does not exist.​
指定的Image不存在。​
429​
FlowLimitExceeded​
The request was rejected due to flow control.​
请求触发限流。​
500​
InternalError​
An internal error has occurred.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2026.07.21 14:22:37
这个页面对您有帮助吗?
有用
有用
无用
无用