You need to enable JavaScript to run this app.
文档中心
AgentKit

AgentKit

复制全文
下载 pdf
Runtime
GetRuntime - 获取一个运行时详情
复制全文
下载 pdf
GetRuntime - 获取一个运行时详情
获取一个运行时详情。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:GetRuntime​
要执行的操作,取值:GetRuntime。​
​
Version string 必选 示例值:2025-10-30​
API的版本,取值:2025-10-30。​
​
RuntimeId string 必选 示例值:r-ye7agye1a8cr38iu****​
运行时 ID。您可以调用 ListRuntimes 获取运行时 ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Endpoint string 示例值:https://xxxxiqpabcr6dormd12.apigateway-cn-beijing.volceapi.com​
智能体访问域名。​
​
AgentSpaceId string 示例值:as-yeh6q4a48****​
关联A2A智能体空间ID。​
​
ApmplusEnable boolean 示例值:true​
是否开启APMPlus和日志服务,以提供对Runtime的观测并写入日志。包括:​
  • true:开启。​
  • false:不开启。​
​
ArtifactType string 示例值:image​
镜像类型。取值:​
  • image:自定义镜像。​
  • public_image:公共镜像。​
​
ArtifactUrl string 示例值:cp-enterprise-cn-beijing.cr.volces.com/demo/agent:latest​
镜像URL。格式为<host/namespace/repo:tag>的镜像地址。​
​
AuthorizerConfiguration object 示例值:--​
入站身份认证信息。目前支持API Key和OAuth JWT认证配置。​
CustomJwtAuthorizer object 示例值:--​
OAuth JWT认证配置。​
AllowedClients string[] 示例值:["client1"]​
允许访问的客户端列表。当允许所有客户端访问时,置为空列表。​
​
DiscoveryUrl string 示例值:https://example.com/.well-known/openid-configuration​
令牌签名密钥 URL。此 URL 用于获取 OpenID Connect 配置或授权服务器元数据,以验证传入的令牌。​
​
​
KeyAuth object 示例值:--​
API Key认证配置。​
ApiKey string 示例值:22243eefff**​
API Key的值。​
​
ApiKeyLocation string 示例值:Header​
API Key传递的位置。当前只支持Header。​
​
ApiKeyName string 示例值:test-key​
API Key名称。​
​
​
​
Command string 示例值:./run.sh​
运行时启动命令。​
​
CpuMilli integer 示例值:1000​
单实例最大CPU。单位:milli cpu。​
​
CreatedAt string 示例值:2025-10-20T16:02:15+08:00​
运行时创建时间。​
​
CurrentVersionNumber integer 示例值:1​
当前生效版本号。​
​
Description string 示例值:runtime01​
运行时描述。​
​
Envs object[] 示例值:--​
运行时环境变量。​
Key string 示例值:test-key​
环境变量的Key。​
​
Value string 示例值:test-value​
环境变量的Value。​
​
​
FailedLogFileUrl string 示例值:https://xx.tos-s3-cn.volces.com/release_failed_instance_logs/******​
运行时部署失败的日志文件下载地址。​
​
KnowledgeId string 示例值:kb-ye9g****​
关联的知识库ID。​
​
LlmshieldAppId string 示例值:app-d65v55avi7p8hpl3****​
关联的大模型安全围栏资产ID。​
​
MCPToolsetId string 示例值:mt-3tigy72q3qddxxxx​
关联MCP工具集ID。​
​
MaxConcurrency integer 示例值:100​
实例最大并发请求数量。​
​
MaxInstance integer 示例值:10​
最大实例数量。​
​
MemoryId string 示例值:mem-1763997****​
关联的记忆库ID。​
​
MemoryMb integer 示例值:2048​
单实例最大内存,单位 MB。​
​
MinInstance integer 示例值:1​
最小实例数量。​
​
ModelAgentName string 示例值:doubao-seed-1.6​
推理模型接入点。​
​
Name string 示例值:my-agent​
运行时名称。​
​
NetworkConfigurations object[] 示例值:--​
Runtime的访问信息,包括公网和VPC。​
Endpoint string 示例值:https://sd3p0u******.apigateway-cn-beijing.volceapi.com​
运行时访问域名。​
​
NetworkType string 示例值:public​
运行时访问域名的类型,取值:​
  • public:公网访问。​
  • private:私网访问。​
​
VpcConfiguration object 示例值:--​
VPC私网配置。​
EnableSharedInternetAccess boolean 示例值:true​
公网出口配置。取值:​
  • ture:开启,表示运行时使用平台提供的公网出口访问公网。​
  • false:未开启,表示运行时使用私有网络中已配置的公网NAT网关出口访问公网。​
说明​
仅当网络配置为私网访问时有返回。​
​
SecurityGroupIds string[] 示例值:["sg-w08tvkc3e****"]​
安全组ID列表。​
​
SubnetIds string[] 示例值:["subnet-1234567890"]​
子网ID列表。​
​
VpcId string 示例值:vpc-257gqcdfvx6n****​
VPC的ID。​
​
​
​
ProjectName string 示例值:default​
运行时所属项目名称。​
​
RequestModifierConfig object 示例值:--​
请求改写配置。​
FunctionId string 示例值:wrwsk****​
veFaaS函数ID。您可以调用GetFunction获取函数ID。​
​
Path string 示例值:/hello​
访问 HTTP 服务器的路径。用于指定请求修改器作用的请求路径。​
​
​
RoleName string 示例值:MyTestRole​
运行时绑定的IAM角色名称。​
​
RuntimeId string 示例值:r-22ddsc***​
运行时ID。​
​
SessionStoreId string 示例值:ss-yefjbwgpa8c1kdto****​
关联会话资源ID。​
​
Status string 示例值:Ready​
运行时状态,取值:​
  • Creating:正在创建中。​
  • Error: 错误。​
  • Releasing: 发布中。​
  • Ready: 运行中。​
  • Deleting: 删除中。​
  • Deleted: 已删除。​
  • Updating: 更新中。​
  • UnReleased: 未发布。​
​
StatusMessage string 示例值:release finished successfully​
当前状态的详细信息,作为发布状态的补充。例如启动失败的原因。​
​
Tags object[] 示例值:--​
运行时标签列表。​
Key string 示例值:k1​
标签键。​
​
Type string 示例值:custom​
标签类型。​
  • system:系统标签。​
  • custom:用户标签。​
​
Value string 示例值:v1​
标签值。​
​
​
ToolId string 示例值:t-dasc*****​
关联的工具ID。​
​
TosMountConfig object 示例值:--​
TOS 挂载配置。​
Credentials object 示例值:--​
TOS凭证。​
AccessKeyId string 示例值:GY2OGJiOTdl****​
火山引擎平台的Access Key ID。​
​
SecretAccessKey string 示例值:emRoTnpVNU5HU****​
火山引擎平台的Secret Access Key ID。​
​
​
EnableTos boolean 示例值:true​
是否启用TOS挂载。挂载后,运行时实例对应目录产生的数据将存储至TOS服务。取值:​
  • true:开启。​
  • false:不开启。​
​
MountPoints object[] 示例值:--​
TOS挂载点列表。​
BucketName string 示例值:bucket01​
TOS存储桶名称。​
​
BucketPath string 示例值:http://tos-cn-beijing.ivolces.com​
TOS存储桶路径。​
​
Endpoint string 示例值:tmp/abc​
TOS存储桶子目录。​
​
LocalMountPath string 示例值:/home/app​
待挂载的运行时实例本地目录。​
​
ReadOnly boolean 示例值:false​
指定待挂载的运行时实例的访问权限。取值:​
  • true:只读权限。​
  • false:读写权限。​
​
​
​
UpdatedAt string 示例值:2025-10-20T16:02:15+08:00​
运行时更新时间。​
​
GatewayMode string 示例值:Shared​
网关模式。取值:​
  • Shared:共享网关。​
  • Exclusive:专属网关。​
​
GatewayInstanceId string 示例值:g-dab8me4bbg9nb6j6****​
专属网关实例ID。​
说明​
仅当GatewayMode配置为 Exclusive 时有返回。​
​
​
​
请求示例​
​
POST https://agentkit.cn-beijing.volcengineapi.com?Action=GetRuntime&Version=2025-10-30 HTTP/1.1​
Content-Type: application/json​
{​
"RuntimeId": "r-ye6xzwchkwoaroxxxxxx"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202106111445100102252431000052****",​
"Action": "GetRuntime",​
"Version": "2025-10-30",​
"Service": "agentkit",​
"Region": "cn-beijing"​
},​
"Result": {​
"RuntimeId": "r-ye7******",​
"Name": "runtime******",​
"Description": "agentkit",​
"ArtifactType": "image",​
"ArtifactUrl": "agentkit******/******/******",​
"AuthorizerConfiguration": {​
"KeyAuth": {​
"ApiKey": "Dht******",​
"ApiKeyLocation": "Header",​
"ApiKeyName": "dsfy******"​
},​
"CustomJwtAuthorizer": null​
},​
"Envs": [​
{​
"Key": "test-key",​
"Value": "test-value"​
}​
],​
"Tags": [],​
"RoleName": "TestRoleForAgentKit",​
"ApmplusEnable": true,​
"Command": "python3 my_agent.py",​
"Status": "Ready",​
"ProjectName": "default",​
"Endpoint": "http://sd3qupshmeps3v7l9****.apigateway-cn-beijing.volceapi.com",​
"CpuMilli": 1000,​
"MemoryMb": 2048,​
"CurrentVersionNumber": 1,​
"CreatedAt": "2025-10-23T20:35:07+08:00",​
"UpdatedAt": "2025-10-23T20:36:21+08:00",​
"StatusMessage": ""​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter.RuntimeId​
The required parameter RuntimeId is not supplied.​
runtime id不能为空。​
404​
InvalidAgentKitRuntime.NotFound​
The specified AgentKitRuntime does not exist.​
资源不存在。​
​
​
最近更新时间:2026.09.09 14:43:43
这个页面对您有帮助吗?
有用
有用
无用
无用