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

AgentKit

复制全文
下载 pdf
Runtime
ListRuntimes - 批量查询运行时详情
复制全文
下载 pdf
ListRuntimes - 批量查询运行时详情
通过自定义筛选条件批量查询运行时详情。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListRuntimes​
要执行的操作,取值:ListRuntimes。​
​
Version string 必选 示例值:2025-10-30​
API的版本,取值:2025-10-30。​
​
CreateTimeAfter string 可选 示例值:2006-01-02T15:04:05Z07:00​
筛选该时间点后创建的运行时。(RFC3339格式)​
​
CreateTimeBefore string 可选 示例值:2006-01-02T15:04:05Z07:00​
筛选该时间点前创建的运行时。(RFC3339格式)​
​
Filters.N.Name string[] 可选 示例值:Name​
精确过滤的字段名,取值:​
  • 参数 - N:表示过滤条件的序号,取值范围:1~10。​
  • 多个字段名之间用&分隔,为“或”的关系。​
  • 取值:​
  • Id:运行时ID。​
  • Name:运行时名称。​
  • Description:运行时描述。​
  • Status:运行时状态。​
说明​
当Filters.N.Name和Filters.N.NameContains同时传入时,仅Filters.N.Name生效。​
​
Filters.N.NameContains string[] 可选 示例值:Name​
模糊过滤的字段名,取值:​
  • 参数 - N:表示过滤条件的序号,取值范围:1~10。​
  • 多个字段名之间用&分隔,为“或”的关系。​
  • 取值:​
  • Id:运行时ID。​
  • Name:运行时名称。​
  • Description:运行时描述。​
  • Status:运行时状态。​
说明​
当Filters.N.Name和Filters.N.NameContains同时传入时,仅Filters.N.Name生效。​
​
Filters.N.Values.N string[] 可选 示例值:Ready​
过滤字段的值。​
  • 参数 - N:表示过滤条件的序号,取值范围:1~10。​
  • 多个字段名之间用&分隔。​
当过滤字段为Status时,取值:​
  • Creating:正在创建中。​
  • Error: 不可用。​
  • Releasing: 发布中。​
  • Ready: 运行中。​
  • Deleting: 删除中。​
  • Deleted: 已删除。​
  • Updating: 更新中。​
  • UnReleased: 未发布​
​
MaxResults integer 可选 示例值:10​
分页查询时设置的每页行数。​
  • 最小值:1。​
  • 最大值:100。​
  • 默认值:10。​
​
NextToken string 可选 示例值:dC15ZTdjZ2xlM3VvYzFrZHRvcn***​
分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。​
​
ProjectName string 可选 示例值:default​
所属项目名称。​
​
TagFilters.N.Key string[] 可选 示例值:TagFilters.1.Key=k1​
根据标签查询资源时指定的标签键,不允许重复。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 多个标签键之间用&分隔。​
​
TagFilters.N.Values.N string[] 可选 示例值:TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2​
根据标签查询资源时指定的标签值。​
  • 第一个N:表示标签键的序号,取值范围:1~10。​
  • 第二个N:表示标签值的序号,取值范围:1~3,即同一标签键最多支持同时查询3个标签值。​
  • 多个标签值之间用&分隔。​
说明​
  • 如果传入该参数,则必须先传入TagFilters.N.Key。​
  • 不传则表示查询同一标签键下的所有标签值。​
  • 传入空字符串时,表示查询标签值为空的标签。​
​
UpdateTimeAfter string 可选 示例值:2006-01-02T15:04:05Z07:00​
筛选该时间点后更新的运行时。(RFC3339格式)​
​
UpdateTimeBefore string 可选 示例值:2006-01-02T15:04:05Z07:00​
筛选该时间点前更新的运行时。(RFC3339格式)​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
AgentKitRuntimes object[] 示例值:--​
符合条件的运行时详情。​
RequestModifierConfig object 示例值:--​
请求改写配置。​
FunctionId string 示例值:fn-2abcxxxx​
veFaaS函数ID。您可以调用GetFunction获取函数ID。​
​
Path string 示例值:/hello​
自行定义访问 HTTP 服务器的路径。用于指定请求修改器作用。​
​
​
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:读写权限。​
​
​
​
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。​
​
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 配置或授权服务器元数据,以验证传入的令牌。目前仅支持火山引擎identity服务的签名秘钥URL。​
​
​
KeyAuth object 示例值:--​
API Key认证配置。​
ApiKey string 示例值:22243eefff**​
API Key的值。​
​
ApiKeyLocation string 示例值:Header​
APIKey传递的位置。取值:​
  • Header:当前仅支持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。​
​
​
KnowledgeId string 示例值:kb-ye9g****​
关联的知识库ID。​
​
MCPToolsetId string 示例值:mt-3tigy72q3u3vj0x2****​
关联MCP工具集ID。​
​
MemoryId string 示例值:mem-1763997****​
关联的记忆库ID。​
​
MemoryMb integer 示例值:2048​
单实例最大内存,单位 MB。​
​
Name string 示例值:my-agent​
运行时名称。​
​
NetworkConfigurations object[] 示例值:--​
运行时网络访问信息。​
Endpoint string 示例值:http://sd3qupshmeps3v7l9****.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​
运行时所属项目名称。​
​
RoleName string 示例值:MyTestRole​
运行时绑定的IAM角色名称。​
​
RuntimeId string 示例值:r-daf******​
运行时ID。​
​
SessionStoreId string 示例值:ss-yefjbwgpa8c1kdto****​
关联会话资源ID。​
​
Status string 示例值:Ready​
运行时状态。取值:​
  • Creating:创建中。​
  • Error: 错误。​
  • Releasing: 发布中。​
  • Ready: 运行中。​
  • Deleting: 删除中。​
  • Deleted: 已删除。​
  • Updating: 更新中。​
  • UnReleased: 未发布。​
​
Tags object[] 示例值:--​
运行时标签。​
Key string 示例值:k1​
标签键。​
​
Type string 示例值:custom​
标签类型。​
  • system:系统标签。​
  • custom:用户标签。​
​
Value string 示例值:v1​
标签值。​
​
​
ToolId string 示例值:t-dascxxxxx​
运行时关联的工具ID。​
​
UpdatedAt string 示例值:2025-10-20T16:02:15+08:00​
运行时版本更新时间。​
​
GatewayMode string 示例值:Shared​
网关模式。取值:​
  • Shared:共享网关。​
  • Exclusive:专属网关。​
​
GatewayInstanceId string 示例值:g-dab8me4bbg9nb6j6****​
专属网关实例ID。​
说明​
仅当GatewayMode配置为 Exclusive 时有返回。​
​
​
NextToken string 示例值:bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq****​
本次调用返回的查询凭证值,返回为空表示该页为末页。​
​
​
​
请求示例​
​
POST https://agentkit.cn-beijing.volcengineapi.com?Action=ListRuntimes&Version=2025-10-30 HTTP/1.1​
Content-Type: application/json​
{​
"Filters": [​
{​
"Name": "Name",​
"Values": [​
""​
]​
}​
]​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20251027221557619118028A455F3C0C79",​
"Action": "ListRuntimes",​
"Version": "2025-10-30",​
"Service": "agentkit",​
"Region": "cn-beijing"​
},​
"Result": {​
"AgentKitRuntimes": [​
{​
"RuntimeId": "r-ye7t******",​
"Name": "agent1******",​
"Description": "",​
"Status": "Error",​
"CreateTime": "2025-10-27T21:19:19+08:00",​
"UpdateTime": "2025-10-27T21:20:52+08:00",​
"ArtifactType": "",​
"ArtifactUrl": "",​
"AuthorizerConfiguration": null,​
"Envs": [],​
"Tags": [],​
"RoleName": "",​
"ApmplusEnable": false,​
"Command": "",​
"Endpoint": "",​
"CpuMilli": 0,​
"MemoryMb": 0,​
"CurrentVersionNumber": 1,​
"CreatedAt": "2025-10-27T21:19:19+08:00",​
"UpdatedAt": "2025-10-27T21:20:52+08:00"​
},​
{​
"RuntimeId": "r-ye******",​
"Name": "simple******",​
"Description": "AgentKit",​
"Status": "Ready",​
"CreateTime": "2025-10-27T17:09:37+08:00",​
"UpdateTime": "2025-10-27T17:10:52+08:00",​
"ArtifactType": "image",​
"ArtifactUrl": "agentkit******/******/******",​
"AuthorizerConfiguration": {​
"KeyAuth": {​
"ApiKey": "Dht******",​
"ApiKeyLocation": "Header",​
"ApiKeyName": "dsfy******"​
},​
"CustomJwtAuthorizer": null​
},​
"Envs": [],​
"RoleName": "test-xxx",​
"ApmplusEnable": false,​
"Command": "run.sh",​
"Endpoint": "http://sd3qupshmeps3v7l9****.apigateway-cn-beijing.volceapi.com",​
"CpuMilli": 1000,​
"MemoryMb": 2048,​
"CurrentVersionNumber": 1,​
"CreatedAt": "2025-10-27T17:09:37+08:00",​
"UpdatedAt": "2025-10-27T17:10:52+08:00"​
}​
]​
}​
}​
​
错误码​
您可访问公共错误码,获取更多错误码信息。​
​
最近更新时间:2026.09.09 14:26:23
这个页面对您有帮助吗?
有用
有用
无用
无用