CreateExternalAgentBootstrapToken - 创建外部智能体 Bootstrap Token-阿里云帮助中心

接口说明

为指定外部智能体创建接入所需的 Bootstrap Token 和 CMS 配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

agentcore:CreateExternalAgentBootstrapToken

none

*ExternalAgent

acs:agentcore:{#regionId}:{#accountId}:workspace/{#workspaceId}/externalAgent/{#agentId}

无

请求语法

POST /workspaces/{workspaceId}/external-agents/{agentId}/bootstrap/create HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
workspaceId	string	是	工作空间 ID。	ws-1
agentId	string	是	外部智能体 ID。	agent-1

请求参数

名称	类型	必填	描述	示例值
networkType	string	是	接入网络类型。枚举值：INTRANET（内网）、INTERNET（公网）。枚举值： INTERNET : 公网 INTRANET : 内网	INTERNET

请求参数的具体含义和取值要求见下方参数说明。

返回参数

名称	类型	描述	示例值
	object	创建外部智能体 Bootstrap Token 的成功响应。
code	string	业务状态码。成功时为 SUCCESS。	SUCCESS
data	object	外部智能体接入所需的 Bootstrap Token 和 CMS 配置。
agentId	string	外部智能体 ID。	agent-1
bootstrapToken	string	外部智能体接入使用的 Bootstrap Token。	bootstrap-token
cms	object	外部智能体接入使用的 CMS 配置。
endpoint	string	CMS 上报端点。	https://public.example.com/apm/trace/opentelemetry
licenseKey	string	CMS 接入使用的 License Key。	license-key
workspace	string	CMS 工作空间名称。	cms-workspace
networkType	string	接入网络类型。枚举值：INTRANET（内网）、INTERNET（公网）。枚举值： INTERNET : 公网 INTRANET : 内网	INTERNET
tokenFingerprint	string	Bootstrap Token 的指纹。	fingerprint
workspaceId	string	工作空间 ID。	ws-1
httpStatusCode	integer	HTTP 状态码。成功时为 200。	200
message	string	请求处理结果消息。	success
requestId	string	请求 ID。	1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx
success	boolean	请求是否成功。

成功响应的字段含义见下方响应参数说明。

示例

正常返回示例

JSON格式

{
  "code": "SUCCESS",
  "data": {
    "agentId": "agent-1",
    "bootstrapToken": "bootstrap-token",
    "cms": {
      "endpoint": "https://public.example.com/apm/trace/opentelemetry",
      "licenseKey": "license-key",
      "workspace": "cms-workspace"
    },
    "networkType": "INTERNET",
    "tokenFingerprint": "fingerprint",
    "workspaceId": "ws-1"
  },
  "httpStatusCode": 200,
  "message": "success",
  "requestId": "1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "success": true
}

错误码

HTTP status code	错误码	错误信息	描述
404	Resource.NotFound	The specified ExternalAgent does not exist.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。