更新时间:2026-11-09 GMT+08:00
分享

更新网关 - UpdateCoreIngress

功能介绍

该接口用于根据ingress_id更新Ingress的配置信息。(异步接口)

注意:vpc私网入口只允许绑定一次,如果当前入网配置已经绑定过其他私网VPC,则本次更新请求失败。

适用场景:

修改Ingress的描述信息。

启用或禁用公网访问。

首次绑定VPC私网入口。

异步任务确认方式:

调用更新接口后,通过查询Ingress详情接口(GET /v1/core/ingresses/{ingress_id})查询status字段,当status变为ACTIVE时表示更新成功,变为FAILED时表示更新失败。

调用方法

请参见如何调用API。

授权信息

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

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

agentarts::updateCoreIngress

Write

instance *

-

-

agentnetwork:instance:update

-

agentarts:AllowIngressPublicAccess

URI

PUT /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}。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

description

否

String

参数解释:

Ingress描述信息,用于补充说明Ingress的用途或备注。

约束限制:

不涉及。

取值范围:

长度为 0 - 255 个字符。

默认取值:

不涉及。

enable_public_network

否

Boolean

参数解释:

是否启用公网访问,启用后将自动分配公网访问地址,禁用后将释放公网访问地址。

约束限制:

不涉及。

取值范围:

true:启用公网访问,false:禁用公网访问。

默认取值:

不涉及。

vpc

否

CoreIngressVpcConfig object

参数解释:

Ingress VPC网络配置,包含VPC ID和子网ID,用于指定Ingress关联的VPC网络。

约束限制:

不涉及。

表3 CoreIngressVpcConfig

参数

是否必选

参数类型

描述

vpc_id

否

String

参数解释:

VPC ID,用于指定Ingress关联的VPC网络。获取方式:在VPC控制台获取,具体参见查询VPC。

约束限制:

vpc_id和subnet_id需要同时填写或不填写。

取值范围:

长度为 1 - 64 个字符,匹配标准的UUID格式。

默认取值:

不涉及。

subnet_id

否

String

参数解释:

子网ID,用于指定Ingress关联的子网。获取方式:在VPC控制台获取,进入子网列表页面,在子网列表中,单击目标子网名称超链接,进入子网详情页面,在子网的“基本信息”页签中,查看子网的“网络ID”。

约束限制:

vpc_id和subnet_id需要同时填写或不填写。子网需属于指定的VPC。

取值范围:

长度为 1 - 64 个字符,匹配标准的UUID格式。

默认取值:

不涉及。

响应参数

状态码:202

表4 响应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 个字符。

vpc

IngressVpcConfig object

参数解释:

网络配置的VPC入网配置详情,包含VPC和子网信息。

取值范围:

不涉及。

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。

表5 IngressVpcConfig

参数

参数类型

描述

status

String

参数解释:

入站网络状态。

取值范围:

CREATING:创建中;ACTIVE:已就绪;FAILED:创建失败。

subnet_id

String

参数解释:

子网ID,用于指定Ingress关联的子网。获取方式:在VPC控制台获取,进入子网列表页面,在子网列表中,单击目标子网名称超链接,进入子网详情页面,在子网的“基本信息”页签中,查看子网的“网络ID”。

取值范围:

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

ip_address

String

参数解释:

分配的IP地址,由系统自动分配,用于通过VPC内部网络访问Agent运行时。

取值范围:

IPv4格式,长度为 1 - 48 个字符。

default_private_zone_domain_name

String

参数解释:

默认私网域名,通过该域名可在VPC内部访问Agent运行时,仅当status为ACTIVE时有值。

取值范围:

长度为 1 - 128 个字符。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

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

取值范围:

固定值:AgentArts.03000400。

error_msg

String

参数解释:

错误详细信息。

取值范围:

长度为1-512个字符。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

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

取值范围:

不涉及。

error_msg

String

参数解释:

错误详细信息。

取值范围:

长度为 1 - 512 个字符。

状态码:403

表8 响应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。

表9 CoreRunErrorDetail

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

长度为 18 个字符。

error_msg

String

参数解释:

错误信息。

取值范围:

长度为 1 - 1024 个字符。

状态码:404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

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

取值范围:

固定值:AgentArts.03000404。

error_msg

String

参数解释:

错误详细信息。

取值范围:

长度为 1 - 512 个字符。

状态码:409

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。枚举值说明:AgentArts.03000409表示资源冲突。

取值范围:

固定值:AgentArts.03000409。

error_msg

String

参数解释:

错误详细信息。

取值范围:

长度为 1 - 512 个字符。

状态码:429

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

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

取值范围:

固定值:AgentArts.03000429。

error_msg

String

参数解释:

错误详细信息。

取值范围:

长度为 1 - 512 个字符。

状态码:500

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

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

取值范围:

固定值:AgentArts.03000500。

error_msg

String

参数解释:

错误详细信息。

取值范围:

长度为 1 - 512 个字符。

请求示例

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

响应示例

状态码:202

{
  "id" : "a3bad420-33b8-4e26-e99b-bdf67aa8e72b",
  "name" : "test-ingress",
  "description" : "updated description",
  "status" : "PENDING",
  "enable_public_network" : false,
  "public_domain_name" : "www.public.com",
  "created_at" : "2023-01-01T01:01:01Z",
  "updated_at" : "2023-01-02T02:02:02Z"
}

状态码

状态码

描述

202

更新成功,返回Ingress信息。

400

请求参数错误。

401

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

403

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

404

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

409

资源冲突。

429

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

500

服务器内部错误。

错误码

请参见错误码。

相关文档