创建runtime - CreateCoreRuntime
功能介绍
该接口用于创建Agent运行时,支持为该运行时进行入站认证,网络访问,可观测配置等。该接口会同时创建运行时以及对应的初始版本。
适用场景:
部署一个已经开发完成的Agent应用。
为Agent应用配置入站认证。
为Agent应用配置入口和出口网络。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
POST /v1/core/runtimes
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: Agent运行时名称,用于在租户内部唯一标识一个Agent运行时。 约束限制: 同一账号下名称不可重复。 取值范围: 以小写字母开头,以小写字母或数字结尾,可以包含小写字母、数字和中划线,长度为2-48个字符。 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 描述信息,用于对Agent运行时的内容和用途进行简要说明。 约束限制: 不涉及。 取值范围: 长度为 0 - 4096 个字符。 默认取值: 不涉及。 |
| artifact_source | 是 | CoreRunArtifactSource object | 参数解释: Agent来源数据结构。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| environment_variables | 否 | Array of CoreRunEnvironmentVariable objects | 参数解释: 环境变量配置列表,用于配置运行时环境变量。 约束限制: 总大小约束2MB。 取值范围: 支持0 - 1024个元素。 默认取值: 不涉及。 |
| identity_configuration | 是 | CoreRunIdentityCreateReqBody object | 参数解释: 运行时入站认证配置请求Body体。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| execution_agency_name | 否 | String | 参数解释: 运行时委托名称。 约束限制: 必须是一个存在的信任委托名称,且该委托授权对象为安全沙箱元数据。 取值范围: 长度为 1 - 64 个字符。 默认取值: 不涉及。 |
| network_config | 否 | CoreRunNetworkConfig object | 参数解释: 出站网络配置,不配置默认是PUBLIC。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| agent_gateway_id | 否 | String | 参数解释: Agent网关的唯一ID,用户可以通过AgentGateway的查询网关实例列表接口来查询到对应的网关ID。 约束限制: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
| invoke_config | 否 | invoke_config object | 参数解释: 智能体调用相关配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| observability | 否 | CoreRunObservability object | 参数解释: 可观测性配置(日志+指标)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| storage_config | 否 | CoreRunStorageConfig object | 参数解释: 运行时存储配置,支持挂载SFS Turbo存储类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| tags | 否 | Array of CoreRunTagItem objects | 参数解释: 标签配置列表,对接TMS标签服务,用于资源分类。 约束限制: 元素个数0 - 20。 取值范围: 不涉及。 默认取值: 不涉及。 |
| arch | 否 | String | 参数解释: Agent运行时架构,用于标明运行时需要运行在arm或者x86平台架构。 约束限制: 无 取值范围: 只允许填写arm64或者x86_64。 默认取值: arm64。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| url | 是 | String | 参数解释: Agent镜像地址,用于运行时拉取镜像启动Agent服务,可以通过SWR控制台以及SWR的镜像查询接口获取对应的镜像地址。 约束限制: 必须是一个有效的SWR镜像地址。 取值范围: 长度为 1 - 2048 个字符。 默认取值: 不涉及。 |
| commands | 否 | Array of strings | 参数解释: 启动镜像的命令,示例:python main.py --port=8080。 约束限制: 不涉及。 取值范围: 最多 10 个元素,每个元素长度为 1 - 256 个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 环境变量键。 约束限制: 不涉及。 取值范围: 必须以字母开头,由英文字母、数字、下划线和点号组成,长度为 1 - 512 个字符。 默认取值: 不涉及。 |
| value | 是 | String | 参数解释: 环境变量值。 约束限制: 不涉及。 取值范围: 长度为 0 - 1048576 个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| authorizer_type | 是 | String | 参数解释: Agent运行时所需的入站认证类型,Agent网关将根据该配置进行入站认证。 约束限制: 不涉及。 取值范围: 长度为1-10个字符。允许的值: 默认取值: IAM |
| authorizer_configuration | 是 | 参数解释: 运行时入站认证配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| custom_jwt | 否 | 参数解释: 运行时自定义JWT类型认证配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | |
| key_auth | 否 | 参数解释: APIKEY入站认证配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| discovery_url | 是 | String | 参数解释: 此 URL 用于获取 OpenID Connect 配置或授权服务器元数据,以验证传入的令牌。 约束限制: 不涉及。 取值范围: 长度为 1 - 2048 个字符。 默认取值: 不涉及。 |
| allowed_audience | 否 | Array of strings | 参数解释: 允许对入站 JWT 进行验证的受众值列表。 约束限制: 不涉及。 取值范围: 元素个数0 - 10,每个受众值元素的长度为1-512个字符。 默认取值: 不涉及。 |
| allowed_clients | 否 | Array of strings | 参数解释: 允许用于入站 JWT 验证的客户端标识符值列表。 约束限制: 不涉及。 取值范围: 元素个数0 - 50,每个客户端值的长度为 1 - 256 个字符。 默认取值: 不涉及。 |
| allowed_scopes | 否 | Array of strings | 参数解释: 允许对入站 JWT 进行验证的范围值列表。 约束限制: 不涉及。 取值范围: 元素个数0 - 50,每个范围值的长度为 1 - 256 个字符。 默认取值: 不涉及。 |
| custom_claims | 否 | Array of CoreRunCustomClaimValidation objects | 参数解释: 对入站 JWT 应用自定义声明验证规则。 约束限制: 不涉及。 取值范围: 最小数量 1,最大数量 20。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| authorizing_claim_match_value | 是 | 参数解释: 自定义声明匹配配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | |
| inbound_token_claim_name | 是 | String | 参数解释: 要检查的自定义声明字段的名称。 约束限制: 不涉及。 取值范围: 长度为 1 - 255 个字符,只包含字母数字、下划线、点号、中划线和冒号。 默认取值: 不涉及。 |
| inbound_token_claim_value_type | 是 | String | 参数解释: 要检查的声明值的数据类型。 约束限制: 不涉及。 取值范围: 长度为 1 - 12 个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| claim_match_operator | 是 | String | 参数解释: 定义声明字段值与要匹配的值之间的关系。 约束限制: 不涉及。 取值范围: 长度为 1 - 12 个字符。允许的值: 默认取值: 不涉及。 |
| claim_match_value | 是 | CoreRunClaimMatchValue object | 参数解释: 入站认证需要校验的自定义Claim字段锁需要的匹配策略。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| match_value_string | 否 | String | 参数解释: 入站认证需要校验的自定义Claim字段所要匹配的字符串值。 约束限制: 不涉及。 取值范围: 长度为 1 - 255 个字符,只包含字母数字、下划线、点号和中划线。 默认取值: 不涉及。 |
| match_value_string_list | 否 | Array of strings | 参数解释: 入站认证需要校验的自定义Claim字段所要匹配的字符串值列表。 约束限制: 不涉及。 取值范围: 最小数量 1,最大数量 50,每个值的长度为 1 - 255 个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| api_keys | 是 | Array of CoreRunApiKey objects | 参数解释: 入站认证允许的所有的API KEY密钥列表。 约束限制: 不涉及。 取值范围: 最小数量 0,最大数量 10。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| api_key | 否 | String | 参数解释: API密钥值。轮换期间,可以使用其中任何一个密钥。如果密钥为空,则会生成一个随机字符串。 约束限制: 不涉及。 取值范围: 长度为 1 - 512 个字符,只包含字母数字、中划线和下划线。 默认取值: 不涉及。 |
| api_key_name | 否 | String | 参数解释: API密钥名称,该名称仅用于标识该密钥,不用于实际认证。 约束限制: 不涉及。 取值范围: 长度为 0 - 64 个字符,只包含字母数字、中划线和下划线。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| network_mode | 是 | String | 参数解释: 出站网络类型,当前支持如下2种: 约束限制: 不涉及。 取值范围: 长度为 1 - 6 个字符。允许的值为: 默认取值: PUBLIC。 |
| vpc_config | 否 | CoreRunVpcConfig object | 参数解释: vpc网络配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| vpc_id | 是 | String | 参数解释: VPC ID,可以通过VPC的控制台页面或者VPC查询接口获取。 约束限制: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
| subnet_id | 是 | String | 参数解释: 子网ID,可以通过VPC的控制台页面或者VPC查询接口获取。 约束限制: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
| security_group_ids | 否 | Array of strings | 参数解释: VPC关联的安全组ID列表。可以通过VPC的控制台页面或者VPC查询接口获取。 约束限制: 不涉及。 取值范围: 元素个数0-10个,每个安全组值的长度为 1 - 36 个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| file_transfer_config | 否 | CoreRunFileTransferConfig object | 参数解释: 智能体运行时文件操作配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enabled | 否 | Boolean | 参数解释: 是否开启文件上传/下载功能,默认为false。 约束限制: 不涉及。 取值范围: 默认值: false |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| logs | 否 | CoreRunLogsConfig object | 参数解释: 日志采集配置。 约束限制: 日志组ID与日志流ID必须配套使用,要么同时缺省,要么同时填写。 取值范围: 不涉及。 默认取值: 不涉及。 |
| metrics | 否 | 参数解释: 自定义指标采集详细配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | |
| tracing | 否 | 参数解释: 调用链采集配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enabled | 否 | Boolean | 参数解释: 是否开启日志采集,默认为false。 约束限制: 不涉及。 取值范围: 默认值: false |
| group_id | 否 | String | 参数解释: 日志组ID,可以通过LTS的控制台页面或者LTS日志组查询接口获取。 约束限制: 与日志流ID配套使用,需同时填写或同时缺省。 取值范围: 长度为 1 - 64 个字符。 默认值: 无。 |
| stream_id | 否 | String | 参数解释: 日志流ID,可以通过LTS的控制台页面或者LTS日志流查询接口获取。 约束限制: 与日志组ID配套使用,需同时填写或同时缺省。 取值范围: 长度为 1 - 64 个字符。 默认值: 无。 |
| project_id | 否 | String | 参数解释: 日志流所在项目ID,可以访问我的凭据控制台页面获取对应的项目ID或者通过IAM的项目查询接口获取。 约束限制: 与日志组ID配套使用,需同时填写或同时缺省。 取值范围: 长度为 1 - 64 个字符。 默认值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enabled | 否 | Boolean | 参数解释: 是否开启自定义指标采集,默认为false。 约束限制: 不涉及。 取值范围: 默认值: false |
| instance_id | 否 | String | 参数解释: 自定义指标实例ID。可以通过AOM的Prometheus监控 > 实例列表页面获取实例ID,或者通过AOM的实例查询接口获取。 约束限制: 不涉及。 取值范围: 长度为 1 - 64 个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enabled | 否 | Boolean | 参数解释: 是否开启调用链采集,默认为false。 约束限制: 不涉及。 取值范围: 默认值: false |
| service_group | 否 | String | 参数解释: 调用链服务应用名。 约束限制: 不涉及。 取值范围: 长度为 1 - 64 个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| sfs_turbo | 否 | Array of CoreRunSfsTurboStorageConfig objects | 参数解释: SFS Turbo存储挂载配置列表。 约束限制: 最多支持5个SFS Turbo挂载点。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| sfs_turbo_id | 是 | String | 参数解释: SFS Turbo实例ID。 约束限制: 必选参数。 取值范围: 匹配标准的UUID格式。 默认取值: 不涉及。 |
| sfs_path | 否 | String | 参数解释: SFS Turbo存储的目录路径。 约束限制: 可选参数,若有值则必须以'/'开头,不能包含'..'。 取值范围: 0-4096 默认取值: / |
| mount_path | 是 | String | 参数解释: 挂载到运行时的目录路径。 约束限制: 必选参数,必须为/home, /mnt, /data, /tmp,或上述目录的子目录,不能包含'..'。不同挂载目录之间,禁止相同或存在包含关系。 取值范围: 不涉及。 默认取值: 不涉及。 |
| read_only | 否 | Boolean | 参数解释: 是否以只读方式挂载。 约束限制: 可选参数。 取值范围: 不涉及。 默认取值: false |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: AgentRuntime唯一标识(用户操作唯一键,UUID随机生成)。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 |
| description | String | 参数解释: 描述信息。 取值范围: 长度为 0 - 4096 个字符。 |
| name | String | 参数解释: Agent名称。 取值范围: 以小写字母开头,以小写字母或数字结尾,可以包含小写字母、数字和中划线,长度为2-48个字符。 |
| latest_version | String | 参数解释: 最新版本名称。 取值范围: 长度为 2 - 24 个字符,必须以字母开头和结尾,支持中划线。 |
| created_at | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
| agent_gateway_id | String | 参数解释: Agent Gateway ID。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 |
| updated_at | String | 参数解释: 最后更新时间。 取值范围: 不涉及。 |
| workload_identity_urn | String | 参数解释: Identity URN。 取值范围: 长度为 1 - 1500 个字符。 |
| tags | Array of CoreRunTagItemResp objects | 参数解释: 标签配置列表,对接TMS标签服务,用于资源分类。 取值范围: 不涉及。 |
| arch | String | 参数解释: 运行时架构。 取值范围: arm64、x86_64 |
| version_detail | CoreRunRuntimeVersion object | 参数解释: 关联版本信息(查询接口返回,非存储字段,关联指定版本配置)。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键。 取值范围: 长度为 1 - 128 个字符。 |
| value | String | 参数解释: 标签值。 取值范围: 长度为 0 - 255 个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| version | String | 参数解释: 版本名称,默认为v1、v2自增长,用户也可自定义。 取值范围: 以小写字母或数字开头,以小写字母或数字结尾,可以包含小写字母、数字和中划线,长度为2-24个字符。 |
| description | String | 参数解释: 版本描述(创建/更新版本时可选)。 取值范围: 长度为 0 - 4096 个字符。 |
| created_at | String | 参数解释: 创建时间(系统自动生成,UTC时区)。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 最近更新时间(系统自动生成,版本更新/标签修改时刷新)。 取值范围: 不涉及。 |
| artifact_source | CoreRunArtifactSourceResp object | 参数解释: Agent来源数据结构。 取值范围: 不涉及。 |
| network_config | CoreRunNetworkConfigResp object | 参数解释: 出站网络配置,不配置默认是PUBLIC。 取值范围: 不涉及。 |
| environment_variables | Array of CoreRunEnvironmentVariableResp objects | 参数解释: 环境变量配置列表,用于配置运行时环境变量。 取值范围: 支持0 - 1024个元素。 |
| invoke_config | CoreRunInvokeConfigResp object | 参数解释: 智能体调用相关配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| observability | CoreRunObservabilityResp object | 参数解释: 可观测性配置(日志+指标)。 取值范围: 不涉及。 |
| storage_config | CoreRunStorageConfig object | 参数解释: 运行时存储配置,支持挂载SFS Turbo存储类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| url | String | 参数解释: Agent镜像地址,用于运行时拉取镜像启动Agent服务,可以通过SWR控制台以及SWR的镜像查询接口获取对应的镜像地址。 取值范围: 长度为 1 - 2048 个字符。 |
| commands | Array of strings | 参数解释: 启动镜像的命令,示例:python main.py --port=8080。 取值范围: 最多 10 个元素,每个元素长度为 1 - 256 个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| network_mode | String | 参数解释: 出站网络类型,当前支持如下2种: 取值范围: 长度为 1 - 6 个字符。允许的值为: |
| vpc_config | CoreRunVpcConfigResp object | 参数解释: vpc网络配置。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| vpc_id | String | 参数解释: VPC ID,可以通过VPC的控制台页面或者VPC查询接口获取。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 |
| subnet_id | String | 参数解释: 子网ID,可以通过VPC的控制台页面或者VPC查询接口获取。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 |
| security_group_ids | Array of strings | 参数解释: VPC关联的安全组ID列表。可以通过VPC的控制台页面或者VPC查询接口获取。 取值范围: 元素个数0-10个,每个安全组值的长度为 1 - 36 个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 环境变量键。 取值范围: 必须以字母开头,由英文字母、数字、下划线和点号组成,长度为 1 - 512 个字符。 |
| value | String | 参数解释: 环境变量值。 取值范围: 长度为 0 - 1048576 个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| port | Integer | 参数解释: 智能体运行时监听的端口号,用于接收外部请求,默认值8080。 约束限制: 不涉及。 取值范围: 1 - 65535 默认值: 8080 |
| protocol | String | 参数解释: 智能体运行时支持的协议类型,默认值HTTP。 约束限制: 不涉及。 取值范围: 长度为 1 - 4 个字符。允许的值为: 默认值: HTTP |
| file_transfer_config | CoreRunFileTransferConfig object | 参数解释: 智能体运行时文件操作配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| url_match_type | String | 参数解释: 智能体运行时调用URL的匹配模式
取值范围: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enabled | Boolean | 参数解释: 是否开启文件上传/下载功能,默认为false。 约束限制: 不涉及。 取值范围: 默认值: false |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| logs | CoreRunLogsConfigResp object | 参数解释: 日志采集配置。 取值范围: 不涉及。 |
| metrics | 参数解释: 自定义指标采集详细配置。 取值范围: 不涉及。 | |
| tracing | 参数解释: 调用链采集配置。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enabled | Boolean | 参数解释: 是否开启日志采集,默认为false。 取值范围: |
| group_id | String | 参数解释: 日志组ID,可以通过LTS的控制台页面或者LTS日志组查询接口获取。 取值范围: 长度为 1 - 64 个字符。 |
| stream_id | String | 参数解释: 日志流ID,可以通过LTS的控制台页面或者LTS日志流查询接口获取。 取值范围: 长度为 1 - 64 个字符。 |
| project_id | String | 参数解释: 日志流所在项目ID,可以访问我的凭据控制台页面获取对应的项目ID或者通过IAM的项目查询接口获取。 取值范围: 长度为 1 - 64 个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enabled | Boolean | 参数解释: 是否开启自定义指标采集,默认为false。 取值范围: |
| instance_id | String | 参数解释: 自定义指标实例ID。可以通过AOM的Prometheus监控 > 实例列表页面获取实例ID,或者通过AOM的实例查询接口获取。 取值范围: 长度为 1 - 64 个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enabled | Boolean | 参数解释: 是否开启调用链采集,默认为false。 取值范围: |
| service_group | String | 参数解释: 调用链服务应用名。 取值范围: 长度为 1 - 64 个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| sfs_turbo | Array of CoreRunSfsTurboStorageConfig objects | 参数解释: SFS Turbo存储挂载配置列表。 约束限制: 最多支持5个SFS Turbo挂载点。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| sfs_turbo_id | String | 参数解释: SFS Turbo实例ID。 约束限制: 必选参数。 取值范围: 匹配标准的UUID格式。 默认取值: 不涉及。 |
| sfs_path | String | 参数解释: SFS Turbo存储的目录路径。 约束限制: 可选参数,若有值则必须以'/'开头,不能包含'..'。 取值范围: 0-4096 默认取值: / |
| mount_path | String | 参数解释: 挂载到运行时的目录路径。 约束限制: 必选参数,必须为/home, /mnt, /data, /tmp,或上述目录的子目录,不能包含'..'。不同挂载目录之间,禁止相同或存在包含关系。 取值范围: 不涉及。 默认取值: 不涉及。 |
| read_only | Boolean | 参数解释: 是否以只读方式挂载。 约束限制: 可选参数。 取值范围: 不涉及。 默认取值: false |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000400表示客户端请求参数错误。 取值范围: 固定值:AgentArts.03000400。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为1-512个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000401表示未授权(认证令牌缺失、无效或已过期)。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000403表示禁止访问(认证后权限不足)。 取值范围: 固定值:AgentArts.03000403。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
| coded_authorization_message | String | 参数解释: IAM5 当OpenAPI无权限时报错信息。 取值范围: 长度为 1 - 1024 个字符。 |
| details | Array of CoreRunErrorDetail objects | 参数解释: 依赖的下游服务错误信息列表。 取值范围: 最小数量 0,最大数量 10。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 长度为 18 个字符。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 长度为 1 - 1024 个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000404表示资源不存在。 取值范围: 固定值:AgentArts.03000404。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:409
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000409表示资源冲突。 取值范围: 固定值:AgentArts.03000409。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000429表示请求过于频繁(触发限流)。 取值范围: 固定值:AgentArts.03000429。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000500表示服务器内部错误。 取值范围: 固定值:AgentArts.03000500。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
请求示例
-
POST https://{Endpoint}/v1/core/runtimes { "name" : "hello-agent", "description" : "一个简单的 Hello World Agent", "arch" : "arm64", "agent_gateway_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "artifact_source" : { "url" : "swr.cn-north-7.myhuaweicloud.com/agentrun/hello-world:v1" }, "identity_configuration" : { "authorizer_type" : "IAM", "authorizer_configuration" : { } } } -
POST https://{Endpoint}/v1/core/runtimes { "name" : "production-agent", "description" : "生产环境 AI 助手运行时", "arch" : "arm64", "agent_gateway_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "artifact_source" : { "url" : "swr.cn-north-7.myhuaweicloud.com/agentrun/ai-assistant:v2.1.0", "commands" : [ "python", "main.py", "--env=prod" ] }, "environment_variables" : [ { "key" : "LOG_LEVEL", "value" : "INFO" }, { "key" : "MAX_TOKENS", "value" : "4096" }, { "key" : "MODEL_NAME", "value" : "gpt-4" } ], "identity_configuration" : { "authorizer_type" : "CUSTOM_JWT", "authorizer_configuration" : { "custom_jwt" : { "discovery_url" : "https://auth.example.com/.well-known/openid-configuration", "allowed_audience" : [ "https://api.example.com" ], "allowed_clients" : [ "my-client-app" ], "allowed_scopes" : [ "read", "write" ] } } }, "invoke_config" : { "port" : 8080, "protocol" : "HTTP" }, "observability" : { "logs" : { "enabled" : true, "group_id" : "prod-lts-group", "stream_id" : "prod-lts-stream", "project_id" : "prod-lts-stream" }, "metrics" : { "enabled" : true }, "tracing" : { "enabled" : true } }, "storage_config" : { "sfs_turbo" : [ { "sfs_turbo_id" : "a8f6b2e1-xxxx-xxxx-xxxx-123456789012", "user_id" : 1000, "group_id" : 1000, "sfs_path" : "/shared/knowledge_base", "mount_path" : "/mnt/kb", "read_only" : false } ] }, "tags" : [ { "key" : "env", "value" : "production" }, { "key" : "team", "value" : "ai-platform" } ] } -
POST https://{Endpoint}/v1/core/runtimes { "name" : "api-gateway-agent", "description" : "对外开放的 API 网关 Agent", "arch" : "arm64", "agent_gateway_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "artifact_source" : { "url" : "swr.cn-north-7.myhuaweicloud.com/agentrun/gateway:v1" }, "identity_configuration" : { "authorizer_type" : "API_KEY", "authorizer_configuration" : { "key_auth" : { "api_keys" : [ { "api_key_name" : "x-api-key", "api_key" : "sk-prod-abc123xyz" } ] } } } }
响应示例
状态码:200
创建成功,返回完整AgentRun信息(含初始版本详情)。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建成功,返回完整AgentRun信息(含初始版本详情)。 |
| 400 | 客户端参数错误(如name为空、必填配置缺失、格式非法等)。 |
| 401 | 未授权(认证令牌缺失、无效或已过期)。 |
| 403 | 禁止访问(认证后权限不足)。 |
| 404 | 引用的资源不存在(如指定的环境ID无效)。 |
| 409 | 资源冲突(如name对应的runtime_id已存在)。 |
| 429 | 请求过于频繁(触发限流)。 |
| 500 | 服务器错误(如数据库插入失败、依赖服务异常等)。 |
错误码
请参见错误码。