更新时间:2026-06-10 GMT+08:00
分享

查询网关详情 - ShowCoreIngress

功能介绍

该接口用于根据ingress_id查询Ingress的详细信息。

适用场景:

查询某一个具体的Ingress详情。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

agentarts::showCoreIngress

List

instance *

-

-

-

URI

GET /v1/core/ingresses/{ingress_id}

表1 路径参数

参数

是否必选

参数类型

描述

ingress_id

String

参数解释

Ingress ID,用于唯一标识一个Ingress实例。获取方式:通过创建网关接口返回的id字段获取,或通过查询网关列表接口获取。

约束限制:

不涉及。

取值范围

匹配标准的UUID格式,符合正则条件[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。

默认取值:

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

id

String

参数解释:

Ingress ID,用于唯一标识一个Ingress实例。

取值范围

匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔)。

name

String

参数解释:

Ingress名称,同一账号下名称不可重复。

取值范围

以字母开头,长度为 2 - 48 个字符,可包含小写字母、数字和中划线。

description

String

参数解释:

Ingress描述。

取值范围

长度为 0 - 255 个字符。

status

String

参数解释:

Ingress状态。

取值范围

PENDING:操作进行中;ACTIVE:已就绪;FAILED:操作失败;DELETE_FAILED:删除失败;UPDATE_FAILED:更新失败。

enable_public_network

Boolean

参数解释:

是否启用公网访问。

取值范围

true:启用公网访问;false:不启用公网访问。

public_domain_name

String

参数解释:

公网域名,创建完成后自动赋值,仅当enable_public_network为true时有值。

取值范围

长度为 1 - 512 个字符。

created_at

String

参数解释:

资源创建时间,UTC时间格式,格式为YYYY-MM-DDTHH:mm:ssZ,由系统自动生成。

取值范围

UTC时间格式,格式为YYYY-MM-DDTHH:mm:ssZ。

updated_at

String

参数解释:

资源最后更新时间,UTC时间格式,格式为YYYY-MM-DDTHH:mm:ssZ,由系统自动生成。

取值范围

UTC时间格式,格式为YYYY-MM-DDTHH:mm:ssZ。

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。枚举值说明:AgentArts.03000400表示客户端请求参数错误。

取值范围

固定值:AgentArts.03000400。

error_msg

String

参数解释

错误详细信息。

取值范围

长度为1-512个字符。

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。枚举值说明:AgentArts.03000401表示未授权(认证令牌缺失、无效或已过期)。

取值范围:

不涉及。

error_msg

String

参数解释

错误详细信息。

取值范围

长度为 1 - 512 个字符。

状态码:403

表5 响应Body参数

参数

参数类型

描述

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。

表6 CoreRunErrorDetail

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

长度为 18 个字符。

error_msg

String

参数解释

错误信息。

取值范围

长度为 1 - 1024 个字符。

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。枚举值说明:AgentArts.03000404表示资源不存在。

取值范围

固定值:AgentArts.03000404。

error_msg

String

参数解释

错误详细信息。

取值范围

长度为 1 - 512 个字符。

状态码:429

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。枚举值说明:AgentArts.03000429表示请求过于频繁(触发限流)。

取值范围

固定值:AgentArts.03000429。

error_msg

String

参数解释

错误详细信息。

取值范围

长度为 1 - 512 个字符。

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。枚举值说明:AgentArts.03000500表示服务器内部错误。

取值范围

固定值:AgentArts.03000500。

error_msg

String

参数解释

错误详细信息。

取值范围

长度为 1 - 512 个字符。

请求示例

GET https://{Endpoint}/v1/core/ingresses/{ingress_id}

响应示例

状态码:200

查询成功,返回Ingress详情。

状态码

状态码

描述

200

查询成功,返回Ingress详情。

400

请求参数错误。

401

未授权(认证令牌缺失、无效或已过期)。

403

禁止访问(认证后权限不足、配额不足)。

404

资源不存在(指定的ingress_id未找到)。

429

请求过于频繁(触发限流)。

500

服务器内部错误。

错误码

请参见错误码

相关文档