DescribeCenRouteEntries--云企业网-火山引擎

文档中心

立即注册

导航

DescribeCenRouteEntries

最近更新时间：2024.10.18 15:45:55首次发布时间：2022.01.07 11:44:37

调用 DescribeCenRouteEntries 接口，查询CEN路由条目详细信息。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCenRouteEntries	要执行的操作，取值为DescribeCenRouteEntries。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
CenId	String	否	cen-7qthudw0ll6jmc****	CEN的ID。您可以调用 DescribeCens 接口，查询云企业网实例ID。
InstanceRegionId	String	否	cn-beijing	路由条目的下一跳地域ID。
InstanceType	String	否	VPC	路由条目的下一跳类型，取值如下： VPC：私有网络 DCGW：专线网关
InstanceId	String	否	vpc-2fexiqjlgjif45oxruvso****	路由条目的下一跳网络实例ID。您可以调用DescribeVpcs接口，查询“VPC”类型网络实例的ID。您可以调用DescribeDirectConnectGateways接口，查询“DCGW”类型网络实例的ID。
DestinationCidrBlock	String	否	172.XX.XX.0/24	路由条目的目标网段。
PageNumber	Integer	否	1	列表的页码。默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数。取值范围为1～100，默认值为20。

返回参数

参数名称	类型	示例值	描述
PageSize	Integer	20	分页大小。
PageNumber	Integer	1	分页页码。
TotalCount	Integer	33	满足指定条件的路由条目总数。
CenRouteEntries	Array of Struct	-	路由条目的详细信息。具体请参见“CenRouteEntry结构”。

CenRouteEntry结构

参数名称	类型	示例值	描述
CenId	String	cen-7qthudw0ll6jmc****	CEN的ID。
DestinationCidrBlock	String	172.XX.XX.0/24	路由条目的目标网段。
InstanceType	String	VPC	路由条目的下一跳类型。
InstanceRegionId	String	cn-beijing	路由条目的下一跳地域ID。
InstanceId	String	vpc-2fexiqjlgjif45oxruvso****	路由条目的下一跳网络实例ID。
Status	String	Available	路由条目的生效状态。 Available：可用 Pending：配置中 Conflicted：冲突
PublishStatus	String	Published	路由条目的发布状态。 Published：已发布 Unpublished：未发布
AsPath	List	["20314","23141"]	路由条目的AS路径。
Type	String	System	云企业网路由的类型。 Custom：自定义路由，表示云服务访问路由 System：系统路由，表示从网络实例学习到的路由。

请求示例

GET /?Action=DescribeCenRouteEntries&Version=2020-04-01&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
Service: cen
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112221232570102251331****",
        "Action": "DescribeCenRouteEntries",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 0,
        "TotalCount": 1,
				"CenRouteEntries": [
            {
						    "CenId": "cen-7qthudw0ll6jmc****",
								"DestinationCidrBlock": "172.XX.XX.0/24",
								"InstanceId": "vpc-2fexiqjlgjif45oxruvso****",
								"InstanceRegionId": "cn-beijing",
								"InstanceType": "VPC",
								"PublishStatus": "Published",
								"Status": "Available",
                "Type": "System",
                "AsPath": []
						}
				]
		}
}

错误码

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

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