获取网关详情 - ShowCoreGateway
功能介绍
通过 ID 获取指定网关的详细信息。
URI
GET /v1/core/gateways/{gateway_id}
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体编码格式。用于告知服务端请求体(Body)所采用的主体数据类型,以便服务端正确解析。 约束限制: 不涉及 取值范围: application/json 默认取值: application/json |
| Authorization | 是 | String | 参数解释: 签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| X-Sdk-Date | 是 | String | 参数解释: 请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| gateway_id | String | 参数解释: 网关的唯一标识符。 网关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}$。 |
| name | String | 参数解释: 网关名称。 取值范围: 长度为 2-40 个字符,匹配以小写字母开头、以小写字母或数字结尾、中间可包含0到38个小写字母、数字或连字符的字符串,符合正则条件^[a-z][a-z0-9-]{0,38}[a-z0-9]$。 |
| description | String | 参数解释: 网关的详细描述。 取值范围: 长度为 1-1000 个字符。 |
| status | String | 参数解释: 网关的当前状态。 取值范围: |
| protocol_type | String | 参数解释: 网关协议类型。 取值范围: |
| authorizer_type | String | 参数解释: 入站认证类型,查询响应中不返回配置详情,可通过 workload_identity.urn 获取入站认证配置详情。 取值范围: |
| agency_name | String | 参数解释: 委托名称,用于指定网关使用的委托身份。 取值范围: 长度为 1-64 个字符。 |
| endpoint_url | String | 参数解释: 访问网关的 URL 端点。 取值范围: 长度为 1-512 个字符。 |
| log_delivery_configuration | 参数解释: 日志上报配置。 取值范围: 不涉及。 | |
| workload_identity | CoreGatewayWorkloadIdentity object | 参数解释: 工作负载身份标识,用于代理身份认证。 取值范围: 不涉及。 |
| agent_gateway_id | String | 参数解释: AgentGateway ID,关联底层 AgentGateway 实例。 取值范围: 匹配标准的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}$。 |
| outbound_network_configuration | 参数解释: 出站网络配置。 约束范围: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | |
| tags | Array of CoreGatewayTag objects | 参数解释: 资源标签列表。 取值范围: 数组长度为0-20。 |
| created_at | String | 参数解释: 网关创建时间戳。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 网关最后更新时间戳。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enabled | Boolean | 参数解释: 是否启用日志。 取值范围: 当取值为true时,表示启用日志。当取值为false时,表示不启用日志。 |
| log_group_id | String | 参数解释: LTS日志组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}$。 |
| log_stream_id | String | 参数解释: LTS日志流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}$。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| urn | String | 参数解释: 工作负载标识的统一资源名称,格式为'agentIdentity:<region-id>:<account-id>:workloadIdentity:gateway_<gateway-name>'。 取值范围: 长度为 1-200 个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| network_mode | String | 参数解释: 网络模式。 约束范围: 不涉及。 取值范围: 默认取值: 不涉及。 |
| vpc_config | CoreGatewayVpcConfig object | 参数解释: VPC网络配置。 约束范围: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| vpc_id | String | 参数解释: VPC 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}$。 默认取值: 不涉及。 |
| subnet_id | String | 参数解释: 子网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}$。 默认取值: 不涉及。 |
| security_group_ids | Array of strings | 参数解释: 安全组ID列表。 约束范围: 不涉及。 取值范围: 数组长度为0-10。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键。 约束范围: 不涉及。 取值范围: 长度为 1-36 个字符,支持大小写字母、数字、连字符、下划线和中文字符。 默认取值: 不涉及。 |
| value | String | 参数解释: 标签值。 约束范围: 不涉及。 取值范围: 长度为 0-43 个字符,支持大小写字母、数字、连字符、下划线和中文字符,可以为空。 默认取值: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 取值为固定18个字符,匹配以 AgentArts. 开头、后接恰好8位数字的字符串,符合正则条件^AgentArts.[0-9]{8}$。 |
| error_msg | String | 参数解释: 错误消息。 取值范围: 取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。 |
| error_reason | String | 参数解释: 错误原因。 取值范围: 取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。 |
| error_suggestion | String | 参数解释: 错误处理建议。 取值范围: 取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 取值为固定18个字符,匹配以 AgentArts. 开头、后接恰好8位数字的字符串,符合正则条件^AgentArts.[0-9]{8}$。 |
| error_msg | String | 参数解释: 错误消息。 取值范围: 取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。 |
| error_reason | String | 参数解释: 错误原因。 取值范围: 取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。 |
| error_suggestion | String | 参数解释: 错误处理建议。 取值范围: 取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。 |
请求示例
无
响应示例
状态码:200
成功检索网关详情
{
"gateway_id" : "b2fc0463-8b28-46c5-87ba-6267295ffc57",
"name" : "my-gateway",
"description" : "我的 MCP 网关",
"status" : "active",
"protocol_type" : "mcp",
"authorizer_type" : "custom_jwt",
"agency_name" : "my-agency",
"endpoint_url" : "https://b2fc0463-8b28-46c5-87ba-6267295ffc57.gateway.agentarts.cn-southwest-2.huaweicloudapis.com",
"log_delivery_configuration" : {
"log_group_id" : "6183535a-8eb7-435b-b32c-00ec997c15b6",
"log_stream_id" : "4b81a675-cf35-45ab-8260-14ce70a8f15e"
},
"workload_identity" : {
"urn" : "agentIdentity:cn-southwest-2:9446b54a-f78e-4a5a-956e-e6ef73450599:workloadIdentity:gateway_my-gateway"
},
"agent_gateway_id" : "b2fc0463-8b28-46c5-87ba-6267295ffc57",
"outbound_network_configuration" : {
"network_mode" : "public"
},
"tags" : [ {
"key" : "Environment",
"value" : "production"
}, {
"key" : "Team",
"value" : "ai-platform"
} ],
"created_at" : "2024-01-15T10:30:00Z",
"updated_at" : "2024-01-15T10:30:00Z"
} 状态码:404
网关未找到
{
"error_code" : "AgentArts.02000102",
"error_msg" : "网关未找到"
} 状态码:500
内部服务器错误
{
"error_code" : "AgentArts.02000500",
"error_msg" : "内部服务器错误"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功检索网关详情 |
| 404 | 网关未找到 |
| 500 | 内部服务器错误 |
错误码
请参见错误码。