You need to enable JavaScript to run this app.
导航
云企业网
  • 文档首页
    • /
  • 云企业网

DescribeCenServiceRouteEntries

最近更新时间：2024.04.22 17:47:03

首次发布时间：2022.08.08 14:40:11

我的收藏

调用 DescribeCenServiceRouteEntries 接口，查询满足指定条件的云服务访问路由的详细信息。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionString是DescribeCenServiceRouteEntries要执行的操作，取值为DescribeCenServiceRouteEntries。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
PageNumberInteger否1列表的页码。默认值为1。
PageSizeInteger否10分页查询时每页的行数。取值范围为1～100，默认值为20。
CenIdString否cen-2nim00ybaylts7trquyzt****云企业网实例的ID。您可以调用DescribeCens接口获取云企业网实例ID。
DestinationCidrBlockString否100.XX.XX.0/24云服务的地址段，必须属于100.64.0.0/10或fd00:64::/32网段。
ServiceRegionIdString否cn-beijing云服务所属的地域。
ServiceVpcIdString否vpc-3rlkeggyn6tc010exd32q****访问云服务时使用的私有网络实例ID。您可以调用DescribeVpcs接口获取私有网络实例的ID。
CenRouteEntryIds.NString否CenRouteEntryIds.1=rte-7qthudw0ll6jmc****&CenRouteEntryIds.rte-2fexiqjlgjif45oxruvso****路由条目的ID。

返回参数

参数名称
类型
示例值
描述
PageNumberInteger1当前页码。
PageSizeInteger1当前分页的行数。
TotalCountInteger1符合条件的路由条目总数。
ServiceRouteEntriesArray of Struct-云服务访问路由的详细信息。具体请参见下表“ ServiceRouteEntry结构 ”。

ServiceRouteEntry结构

参数名称
类型
示例值
描述
CenIdStringcen-2nim00ybaylts7trquyzt****云企业网实例的ID。
DestinationCidrBlockString100.XX.XX.0/24云服务部署的地址，属于100.64.0.0/10或fd00:64::/32网段。
ServiceRegionIdStringcn-beijing云服务所属的地域。
ServiceVpcIdStringvpc-3rlkeggyn6tc010exd32q****访问云服务时使用的私有网络ID。

Status

String

Available

云服务访问路由的状态。

  • Available：可用。
  • Pending：配置中。
  • Creating：创建中。
  • Deleting：删除中。
CreationTimeString2022-04-28T22:57:03+08:00云服务访问路由的创建时间。
DescriptionStringtest-service-route云服务访问路由的描述信息。

PublishMode

String

Custom

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

  • LocalDCGW：表示自动将该云服务访问路由发布到云服务所在地域中所有已加载至CEN实例的专线网关。
  • Custom：表示手动指定该云服务访问路由需要发布到的网络实例。
PublishToInstancesArray of Struct-云服务访问路由的发布信息。具体请参见下表“ PublishToInstance结构”。

PublishToInstance结构

参数名称
类型
示例值
描述
InstanceRegionIdStringcn-beijing云服务访问路由发布的地域。

InstanceType

String

VPC

云服务访问路由发布的网络实例类型。

  • VPC：私有网络。
  • DCGW：专线网关。
InstanceIdStringvpc-uf6o8d1dj8sjwxi6o****云服务访问路由发布的网络实例ID。

请求示例

GET /?Action=DescribeCenServiceRouteEntries&Version=2020-04-01&CenId=cen-2nim00ybaylts7trquyzt**** HTTP/1.1
Host: open.volcengineapi.com
Service: cen
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211222122528010225****",
        "Action": "DescribeCenServiceRouteEntries",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 1,
        "TotalCount": 1,
        "ServiceRouteEntries": [
            {
                "CenId": "cen-2nim00ybaylts7trquyzt****",
                "DestinationCidrBlock": "100.XX.XX.0/24",
                "ServiceRegionId": "cn-beijing",
                "ServiceVpcId": "vpc-3rlkeggyn6tc010exd32q****",
                "Status": "Available",
                "CreationTime": "2022-04-28T22:57:03+08:00",
                "Description": "test-service-route",
                "PublishMode": "Custom",
                "PublishToInstances": [
                    {
                        "InstanceRegionId": "cn-beijing",
                        "InstanceType": "VPC",
                        "InstanceId": "vpc-uf6o8d1dj8sjwxi6o****"
                    },
                    {
                        "InstanceRegionId": "cn-guangzhou",
                        "InstanceType": "VPC",
                        "InstanceId": "vpc-7qthudw0ll6jmc****"
                    }
                ]
            }
        ]    
    }
}

错误码

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

HttpCode错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.ResourceIdsYou've reached the limit of 100 resource IDs that can be specified in this request.已达到单次可查询的实例数量上限。