You need to enable JavaScript to run this app.
导航
CreateCenServiceRouteEntry
最近更新时间:2024.10.18 15:45:55首次发布时间:2022.08.08 14:40:11

调用 CreateCenServiceRouteEntry 接口,配置指定的云服务访问路由。

说明

自定义云服务访问路由发布范围的功能正在邀测中,暂仅支持完成 企业认证 的账号申请试用,如需试用,请联系客户经理。

调试

请求参数

下表中,PublishToInstances.N.a类型参数中的“N”表示云服务访问路由发布信息的序号,需按照数字顺序从1开始填写,单次调用数量上限100个。多个云服务访问路由的发布信息之间使用&分隔。

参数名称
类型
是否必选
示例值
描述
ActionStringCreateCenServiceRouteEntry要执行的操作,取值为CreateCenServiceRouteEntry。
VersionString2020-04-01API版本信息,当前版本为2020-04-01。

Description

String

test-service-route

云服务访问的描述信息。

  • 必须以字母、数字或中文开头,可包含字母、数字、中文和以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。
  • 长度限制为0 ~ 255个字符。
  • 不填则默认为空字符串。

CenId

String

cen-2nim00ybaylts7trquyzt****

云企业网实例的ID。
您可以调用DescribeCens接口,查询云企业网实例ID。

DestinationCidrBlock

String

100.XX.XX.0/24

云服务部署的地址,必须属于100.64.0.0/10fd00:64::/32网段。

说明

云企业网支持IPv6的功能正在邀测中,如需试用,请联系客户经理。

ServiceRegionIdStringcn-beijing云服务所属的地域。

ServiceVpcId

String

vpc-3rlkeggyn6tc010exd32q****

访问云服务时使用的私有网络实例ID。
您可以调用DescribeVpcs接口,查询私有网络的ID。

说明

该私有网络必须与云服务属于相同地域,且已加载至对应的云企业网实例中。

PublishMode

String

LocalDCGW

云服务访问路由的发布范围。

  • LocalDCGW(默认值):表示自动将该云服务访问路由发布到云服务所在地域中所有已加载至CEN实例的专线网关。
  • Custom:表示手动指定该云服务访问路由需要发布到的网络实例。

PublishToInstances.N.InstanceType

String

PublishToInstances.1.InstanceType=VPC&PublishToInstances.2.InstanceType=VPC

云服务访问路由需要发布的网络实例类型。
仅参数PublishMode取Custom时,本参数有效且必填。取值如下:

  • VPC:私有网络。
  • DCGW:专线网关。

PublishToInstances.N.InstanceRegionId

String

PublishToInstances.1.InstanceRegionId=cn-guangzhou&PublishToInstances.2.InstanceRegionId=cn-beijing

云服务访问路由需要发布的地域。

  • 仅参数PublishMode取Custom时,本参数有效且必填。
  • 云企业网支持的地域可参见区域与地域

PublishToInstances.N.InstanceId

String

PublishToInstances.1.InstanceId=vpc-7qthudw0ll6jmc****&PublishToInstances.2.InstanceId=vpc-uf6o8d1dj8sjwxi6o****

云服务访问路由需要发布的网络实例ID。

  • 仅参数PublishMode取Custom时,本参数有效且必填。
  • 您可以调用DescribeVpcs接口,查询“VPC”类型网络实例的ID。
  • 您可以调用DescribeDirectConnectGateways接口,查询“DCGW”类型网络实例的ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

GET /?Action=CreateCenServiceRouteEntry&Version=2020-04-01&CenId=cen-2nim00ybaylts7trquyzt****&DestinationCidrBlock=100.XX.XX.0/24&ServiceRegionId=cn-beijing&ServiceVpcId=vpc-3rlkeggyn6tc010exd32q**** HTTP/1.1
Host: open.volcengineapi.com
Service: cen
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211222122528010225****",
        "Action": "CreateCenServiceRouteEntry",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode
错误码
错误信息
描述
400InvalidCidr.MalformedThe specified cidr block is malformed.指定的网段格式不合法。
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法,描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法,请修复描述格式后重试。
400InvalidServiceRoute.ExistedThe specified service route already exists.指定的云服务访问路由已经存在。
400InvalidServiceRoute.MalformedThe specified destination cidr block is malformed.指定的云服务访问路由的目的网段不在100.64.0.0/10或fd00:64::/32内。
400InvalidServiceRoute.PublishInstanceDuplicatedThe specified publish instance is specified more than once in the request.指定的发布实例存在重复。
400QuotaExceeded.CenRouteEntryYou've reached the number of route entries can be published to CEN.已达到云企业网路由条目数量的配额上限。
403Forbidden.CreateServiceRouteYou are not authorized to perform operations on the service route.无权限对指定资源进行操作, 请开通云服务访问的白名单。
403Forbidden.PublishIPv6CenRouteEntryYou are not authorized to publish IPv6 route entry to CEN.无权限对指定的IPv6路由进行发布操作。
404InvalidCen.NotFoundThe specified CEN does not exist.指定的云企业网实例不存在。
403InvalidCenAttachedInstance.NotFoundThe specified CEN attached instance does not exist.指定的网络实例不存在。
403InvalidServiceRoute.PublishInstanceNotFoundThe specified publish instance does not exist.指定的发布实例不存在。
409InvalidCen.InvalidStatusThe specified CEN instance is not in the correct status for the request.指定的云企业网实例所处的状态无法响应该请求,请稍后再试。
409InvalidServiceRoute.ConflictThere is conflict between the specified service route and existed routes.指定的云服务路由和云企业网路由表中已存在的路由存在冲突。