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

ArkClaw 企业版

复制全文
下载 pdf
Image
CreateClawImage - 创建一个ArkClaw自定义镜像
复制全文
下载 pdf
CreateClawImage - 创建一个ArkClaw自定义镜像
创建一个ArkClaw自定义镜像。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:CreateClawImage​
要执行的操作,取值:CreateClawImage。​
​
Version string 必选 示例值:2026-05-01​
API的版本,取值:2026-05-01。​
​
AgentMd string 可选 示例值:YWdlbnQ=​
Agent配置文件内容,base64编码。解码后为UTF-8文本,长度不超过10000字符。​
​
BuildScript string 可选 示例值:6Kou5bu6566h5gKs****​
构建脚本内容,base64编码。解码后为UTF-8文本,长度不超过10000字符。​
​
ClientToken string 可选 示例值:23fa21A8823nfasd7f****​
保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。​
取值:仅支持ASCII字符,且不能超过64个字符。​
​
Description string 可选 示例值:image description​
镜像描述,长度不超过200个字符。​
​
DryRun boolean 可选 示例值:false​
是否仅做参数和权限检查而不实际执行操作。取值:​
  • true:仅做检查,校验通过返回DryRunOperation错误码。​
  • false(默认):实际执行操作。​
​
Name string 必选 示例值:demo-image​
镜像名称。取值:​
  • 支持大小写英文字母、数字、中划线(-)、下划线(_)。​
  • 长度限制为4 ~ 64个字符。​
​
PluginInfos object[] 可选 示例值:--​
插件配置列表。​
Blacklist boolean 可选 示例值:false​
是否禁用插件。取值:​
  • true:禁用插件。​
  • false(默认):不禁用插件。​
​
Type string 可选 示例值:built-in​
插件类型。​
  • 取值:built-in,基础镜像内置插件。​
​
Description string 可选 示例值:Description​
插件描述。​
​
Version string 可选 示例值:0.4.5​
插件版本。​
​
Id string 可选 示例值:agent-identity​
插件ID。查询插件ID的方式请参见GetBaseImageManifest。​
​
Name string 可选 示例值:agent-identity​
插件名称。​
​
DisplayName string 可选 示例值:Agent Identity​
插件展示名称。​
​
Source string 可选 示例值:global:agent-identity/dist/index.js​
插件来源。​
  • 为空时将使用平台默认来源。​
  • 如需指定自定义来源,填写格式为global:/。​
​
​
SkillInfos object[] 可选 示例值:--​
技能配置列表。​
Blacklist boolean 可选 示例值:false​
是否禁用技能。取值:​
  • true:禁用技能。​
  • false(默认):不禁用技能。​
​
Slug string 可选 示例值:find-skills​
公共技能唯一标识。可以在ArkClaw控制台“技能中心”页面目标技能的“技能信息”获取。​
  • 建议格式为小写字母、数字和连字符,长度1~128个字符,首尾必须为字母或数字。​
说明​
当Type为Skillhub时必填。​
​
Type string 可选 示例值:built-in​
技能类型。取值:​
  • built-in(默认):基础镜像内置技能。​
  • skillhub:来自技能中心的技能。​
​
IsPrivate boolean 可选 示例值:false​
是否是企业私有技能。取值:​
  • true:企业私有技能,仅管理员可见,需加入技能库并配置权限后员工方可使用。​
  • false(默认):公开技能,所有用户可见。​
​
Id string 可选 示例值:s-xxx​
企业私有技能ID。​
说明​
当Type为skillhub且IsPrivate是true时必填。​
​
Name string 可选 示例值:find-skills​
技能名称。​
​
Description string 可选 示例值:Description​
技能描述。​
​
DisplayName string 可选 示例值:Find Skills​
技能展示名称。​
​
​
SoulMd string 可选 示例值:c291bA==​
Soul配置文件内容,base64编码。解码后为UTF-8文本,长度不超过10000字符。​
​
MdEditMode string 可选 示例值:append​
MD文件写入模式。取值:​
  • append(默认):在原有内容末尾追加写入。​
  • overwrite:覆盖原有内容,重新写入。​
​
SpaceId string 必选 示例值:csi-yei8347ta8xmf5qd****​
ArkClaw空间ID,可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
ImageId string 示例值:cimg-yeqssiu****​
镜像ID。​
​
​
​
请求示例​
​
POST /?Action=CreateClawImage&Version=2026-05-01 HTTP/1.1​
Host: https://arkclaw.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260723T064609Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260723/cn-beijing/arkclaw/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"AgentMd": "YWdlbnQ=",​
"BuildScript": "6Kou5bu6566h5gKs****",​
"ClientToken": "23fa21A8823nfasd7f****",​
"Description": "image description",​
"DryRun": true,​
"Name": "demo-image",​
"PluginInfos": [​
{​
"Blacklist": true,​
"Type": "built-in",​
"Description": "Description",​
"Version": "0.4.5",​
"Id": "agent-identity",​
"Name": "agent-identity",​
"DisplayName": "Agent Identity",​
"Source": "global:agent-identity/dist/index.js"​
}​
],​
"SkillInfos": [​
{​
"Blacklist": true,​
"Slug": "find-skills",​
"Type": "built-in",​
"IsPrivate": true,​
"Id": "s-xxx",​
"Name": "find-skills",​
"Description": "Description",​
"DisplayName": "Find Skills"​
}​
],​
"SoulMd": "c291bA==",​
"MdEditMode": "append",​
"SpaceId": "csi-yei8347ta8xmf5qd****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2026070221364409****",​
"Action": "CreateClawImage",​
"Version": "2026-05-01",​
"Service": "arkclaw",​
"Region": "cn-beijing"​
},​
"Result": {​
"ImageId": "cimg-yeqssiu****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
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​
MissingParameter.Name​
The required parameter Name is not supplied.​
参数Name不能为空。​
400​
InvalidDescription.Malformed​
The specified Description is malformed.​
参数Description不合法。​
400​
MissingParameter.SpaceId​
The required parameter SpaceId is not supplied.​
参数SpaceId不能为空。​
400​
InvalidName.Malformed​
The specified Name is malformed.​
Name 长度或格式不合法。​
400​
InvalidPluginInfos.Malformed​
The specified PluginInfos are malformed.​
YAML 中插件配置不合法。​
400​
InvalidSkillInfos.Malformed​
The specified SkillInfos are malformed.​
YAML 中技能配置不合法。​
400​
InvalidSoulMd.Malformed​
The specified SoulMd is malformed.​
SoulMd 不是合法 base64 UTF-8 内容。​
400​
InvalidAgentMd.Malformed​
The specified AgentMd is malformed.​
AgentMd 不是合法 base64 UTF-8 内容。​
400​
InvalidBuildScript.Malformed​
The specified BuildScript is malformed.​
BuildScript 不是合法 base64 UTF-8 内容。​
400​
InvalidSpaceStatus​
The Space must be in the Running status to complete the operation.​
空间状态不允许创建镜像。​
404​
InvalidSpace.NotFound​
The specified Space does not exist.​
指定ArkClaw空间不存在。​
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.​
请求触发限流。​
429​
QuotaExceeded.Images​
The image quota has been exceeded.​
镜像数量达到配额上限。​
500​
InternalError​
An internal error has occurred.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2026.07.23 21:47:02
这个页面对您有帮助吗?
有用
有用
无用
无用