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

AgentKit

复制全文
下载 pdf
MCP
GetMCPService - 查询MCP服务详情。
复制全文
下载 pdf
GetMCPService - 查询MCP服务详情。
查询MCP服务详情。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:GetMCPService​
要执行的操作,取值:GetMCPService。​
​
Version string 必选 示例值:2025-10-30​
API的版本,取值:2025-10-30。​
​
MCPServiceId string 必选 示例值:m-ye7f6gd7nktv3gi6c***​
MCP服务的ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
MCPService object 示例值:--​
MCP服务详情。​
AssociatedMCPToolsets object[] 示例值:--​
MCP服务关联的MCP工具集列表。​
MCPToolsetId string 示例值:mt-yefjsz5s0054ppxu****​
MCP工具集ID。​
​
Name string 示例值:mcp_toolset_****​
MCP工具集名称。​
​
​
RoleName string 示例值:TestRoleForAgentKit​
MCP服务绑定的IAM角色名称。​
​
BackendConfiguration object 示例值:--​
MCP服务的后端服务详情。​
CustomConfiguration object 示例值:--​
固定域名详情。​
Domain string 示例值:www.***.com​
域名。​
​
Port integer 示例值:80​
端口。​
​
ProtocolType string 示例值:HTTP​
协议,取值:​
  • HTTP:后端为HTTP服务。​
  • HTTPS:后端为HTTPS服务。​
​
​
CustomMcpConfiguration object 示例值:--​
自定义MCP Server配置。​
EnableApmplus boolean 示例值:true​
是否开启日志服务。取值:​
  • true:开启。​
  • false:未开启。​
​
FunctionId string 示例值:faas-****​
创建的veFaaS Function ID(由系统自动填充,用户无需提供)。​
​
FunctionName string 示例值:function-01​
创建的veFaaS Function 名称(由系统自动填充,用户无需提供)。​
​
PrivatePackage object 示例值:--​
私有包配置。​
Command string 示例值:./run.sh​
启动命令,默认 ./run.sh。​
​
Envs object[] 示例值:--​
环境变量。​
Key string 示例值:k1​
键。​
​
Value string 示例值:v1​
值。​
​
​
ImageUrl string 示例值:http://****​
镜像 URL。​
​
​
PublicPackage object 示例值:--​
公共包配置。​
McpType string 示例值:Stdio​
MCP 服务类型,取值:​
  • Stdio:标准输入输出。​
  • Remote:远程服务。​
​
PackageManagerType string 示例值:NPX​
包管理器类型,取值:NPX或UVX。​
​
RawConfig string 示例值:--​
MCP Server完整配置(JSON 字符串)无状态。​
​
​
​
EcsConfiguration object 示例值:--​
ECS详情。​
Instances object[] 示例值:--​
ECS实例列表。​
InstanceId string 示例值:i-yeattc3lkw****​
ECS实例ID。​
​
Ip string 示例值:172.xx.xx.109​
ECS实例私网IP。​
​
Port integer 示例值:80​
ECS实例端口。​
​
​
​
FunctionConfiguration object 示例值:--​
veFaaS函数详情。​
FunctionId string 示例值:65a075a2​
veFaaS函数ID。​
​
FunctionName string 示例值:func-name-****​
veFaaS函数名称。​
​
​
VkeConfiguration object 示例值:--​
VKE详情。​
ClusterId string 示例值:cd59nk5v1a****​
VKE集群ID。​
​
Namespace string 示例值:namespace01​
VKE集群命名空间。​
​
Port integer 示例值:80​
VKE集群服务端口​
​
ServiceName string 示例值:service01​
VKE集群服务名称。​
​
​
​
BackendType string 示例值:Function​
MCP服务的后端服务的类型,取值:​
  • Function:veFaaS函数。​
  • Domain:固定域名。​
  • ECS:云服务器。​
  • VKE:容器服务。​
  • CustomPublic:公共包(NPX/UVX)。​
  • CustomPrivate:私有包(自定义镜像)。​
​
CreatedAt string 示例值:2006-01-02T15:04:05Z07:00​
MCP服务的创建时间。​
​
FailedLogFileUrl string 示例值:https://xx.tos-s3-cn.volces.com/******​
MCP服务部署失败时的日志文件下载地址。​
说明​
仅当MCP服务状态为不可用(即Status为Error)且后端服务为新建MCP服务(即BackendType为CustomPublic、CustomPrivate)时,有返回值。​
​
InboundAuthorizerConfiguration object 示例值:--​
MCP服务入站身份认证信息。​
Authorizer object 示例值:--​
认证器具体配置详情。​
CustomJwtAuthorizer object 示例值:--​
OAuth JWT认证配置。​
AllowedClients string[] 示例值:["client1","client2"]​
允许访问的客户端列表。​
​
DiscoveryUrl string 示例值:https://example.com/.well-known/openid-configuration​
认证服务地址。​
​
​
IdentityAuthorizer object 示例值:--​
后端服务使用身份与权限(Identity)进行出站凭据时,凭证管理的配置。​
CredentialProviderName string 示例值:Oauth2M2m01​
凭证管理名称。​
​
ProviderType string 示例值:Oauth2M2m​
凭据管理的类型。取值:​
  • ApiKey:使用API Key凭据。​
  • Oauth2M2m:使用OAuth Client。​
​
​
KeyAuth object 示例值:--​
API Key认证配置。​
ApiKeyLocation string 示例值:HEADER​
API Key的传递位置。​
​
ApiKeys object[] 示例值:8b02f2e2-ae83-11f0-b6e5-******&In​
API Key认证配置。​
Key string 示例值:65a075a2-aeff-11f0-****-00163e72f914​
API Key值。​
​
Name string 示例值:key-ye7f6gd7nktv3gi6c***​
API Key名称。​
​
​
Parameter string 示例值:Authorization​
请求头(Header)中携带的API Key对应的参数名称。​
​
​
​
AuthorizerType string 示例值:ApiKey​
MCP服务入站身份认证安全的类型,取值:​
  • ApiKey:使用API Key认证。​
  • CustomJWT:使用OAuth JWT认证。​
​
​
MCPServiceId string 示例值:m-ye7f6gd7nktv3gi6c***​
MCP服务ID。​
​
Name string 示例值:mcp-name-***​
MCP服务名称。​
​
NetworkConfigurations object[] 示例值:--​
MCP服务网络配置详情。​
Endpoint string 示例值:***.apigateway.com​
访问MCP服务的Endpoint。​
​
NetworkType string 示例值:Public​
MCP服务开启的访问类型,取值:​
  • Public:公网访问。​
  • Private:私网访问。​
​
VpcConfiguration object 示例值:--​
VPC网络配置信息。​
SubnetIds string[] 示例值:["subnet-ye7s6jatq8rxg218****"]​
子网ID列表。​
​
VpcId string 示例值:vpc-ye7s6jatq8rxg218****​
VPC的ID。​
​
​
EnableSharedInternetAccess boolean 示例值:false​
是否启用共享公网访问。​
  • false:未启用。​
  • true:已启用。​
​
​
OutboundAuthorizerConfiguration object 示例值:--​
MCP服务出站身份认证配置。​
Authorizer object 示例值:--​
认证器具体配置详情。​
CustomJwtAuthorizer object 示例值:--​
OAuth JWT认证配置。​
AllowedClients string[] 示例值:["client1","client2"]​
允许访问的客户端列表。​
​
DiscoveryUrl string 示例值:https://example.com/.well-known/openid-configuration​
认证服务地址。​
​
​
IdentityAuthorizer object 示例值:--​
使用身份与权限(Identity)进行出站凭据时,凭证管理的配置。​
CredentialProviderName string 示例值:Oauth2M2m01​
凭证管理名称。​
​
ProviderType string 示例值:Oauth2M2m​
凭据管理的类型。取值:​
  • ApiKey:使用API Key凭据。​
  • Oauth2M2m:使用OAuth Client。​
​
​
KeyAuth object 示例值:--​
使用API Key进行出站凭据时,API Key认证的配置。​
ApiKeyLocation string 示例值:HEADER​
API Key的传递位置。​
​
ApiKeys object[] 示例值:8b02f2e2-ae83-11f0-b6e5-******&In​
API Key认证配置。​
Key string 示例值:65a075a2-aeff-11f0-****-00163e72f914​
API Key值。​
​
Name string 示例值:key-ye7f6gd7nktv3gi6c***​
API Key名称。​
​
​
Parameter string 示例值:Authorization​
请求头(Header)中携带的API Key对应的参数名称。​
​
​
​
AuthorizerType string 示例值:ApiKey​
MCP服务出站身份认证安全的类型,取值:​
  • ApiKey:使用API Key认证。​
  • Identity:使用身份与权限(Identity)认证。​
​
​
Path string 示例值:/mcp​
MCP服务的访问路径。​
​
ProjectName string 示例值:default​
MCP服务所属项目名称。​
​
ProtocolConfiguration object 示例值:--​
MCP服务协议配置详情。​
ProtocolConvertConfiguration string 示例值:--​
MCP服务后端类型为HTTP时,根据接口信息解析结果。​
​
​
ProtocolType string 示例值:HTTP​
MCP服务访问方式,取值:​
  • HTTP:HTTP 转 MCP。​
  • MCP:直接访问 MCP。​
​
Status string 示例值:Ready​
MCP服务状态,取值:​
  • Ready:运行中。​
  • Creating:创建中。​
  • Updating:更新中。​
  • Deleting:删除中。​
  • Error:不可用。​
​
Tags object[] 示例值:--​
MCP服务标签。​
Type string 示例值:system​
标签类型。​
  • system:系统标签。​
  • custom:用户标签。​
​
Key string 示例值:k1​
标签键。​
​
Value string 示例值:v1​
标签值。​
​
​
UpdatedAt string 示例值:2006-01-02T15:04:05Z07:00​
MCP服务的更新时间。​
​
GatewayInstanceName string 示例值:exclusive-gateway​
MCP服务关联的专属网关实例名称,仅GatewayMode为Exclusive时返回此参数。​
​
BackendAccessType string 示例值:Public​
MCP服务后端服务为固定域名时的网络类型。​
  • Public:公网。​
  • Private:私网。​
​
GatewayMode string 示例值:Shared​
网关模式。​
  • Shared:共享网关。​
  • Exclusive:专属网关。​
​
​
​
​
请求示例​
​
POST https://agentkit.cn-beijing.volcengineapi.com?Action=GetMCPService&Version=2025-10-30 HTTP/1.1​
Content-Type: application/json​
{​
"MCPServiceId":"m-ye70cet5ogtt****"​
}​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202106111445100102252431000052****",​
"Action": "GetMCPService",​
"Version": "2020-04-01",​
"Service": "agentkit",​
"Region": "cn-beijing"​
},​
"Result": {​
"MCPService": {​
"MCPServiceId": " mcp-xxx",​
"Name": " mcp-service-x",​
"Path": " /mcp",​
"ProtocolType": " HTTP/MCP",​
"ProtocolConfiguration": {​
"ProtocolConvertConfiguration": " "​
},​
"NetworkConfigurations": [​
{​
"NetworkType": " Public",​
"Endpoint": " "​
}​
],​
"InboundAuthorizerConfiguration": {​
"AuthorizerType": " ApiKey/CustomJWT",​
"Authorizer": {​
"KeyAuth": {​
"ApiKeys": [​
{​
"Key": " ",​
"Name": " "​
}​
],​
"ApiKeyLocation": " HEADER"​
}​
}​
},​
"OutboundAuthorizerConfiguration": {},​
"BackendConfiguration": {​
"FunctionConfiguration": {​
"FunctionId": " u3hyo****",​
"FunctionName": " my_function"​
},​
"CustomConfiguration": {​
"Domain": " api.example.com",​
"Port": " 80",​
"ProtocolType": " HTTP/HTTPS",​
"TlsSettings": {​
"Sni": " example.com",​
"TlsMode": " SIMPLE"​
}​
}​
},​
"BackendType": " Function/Domain",​
"CreatedAt": " 2006-01-02T15:04:05Z07:00",​
"UpdatedAt": " 2006-01-02T15:04:05Z07:00"​
}​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter.MCPServiceId​
The required parameter MCPServiceId is not supplied.​
参数MCPServiceId不能为空。​
404​
InvalidResource.NotFound​
The specified resource does not exist.​
指定资源不存在。​
​
​
最近更新时间:2026.09.14 19:28:45
这个页面对您有帮助吗?
有用
有用
无用
无用