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

文档中心

立即注册

导航

DescribeCenSummaryRouteEntries

最近更新时间：2024.12.10 10:30:35首次发布时间：2023.03.03 08:18:36

调用 DescribeCenSummaryRouteEntries 接口，查询满足指定条件的CEN汇总路由。

说明

汇总路由正在邀测中，如需试用，请联系客户经理。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCenSummaryRouteEntries	要执行的操作，取值为DescribeCenSummaryRouteEntries。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
CenId	String	是	cen-7qthudw0ll6jmc****	云企业网实例ID。您可以调用 DescribeCens 接口，查询云企业网实例ID。
DestinationCidrBlock	String	否	172.XX.XX.0/24	CEN汇总路由的目标网段。
PageNumber	Integer	否	1	列表的页码。默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数。取值范围为1～100，默认值为20。

返回参数

参数名称	类型	示例值	描述
PageNumber	Integer	1	当前页码。
PageSize	Integer	1	当前分页的行数。
TotalCount	Integer	1	符合条件的汇总路由总数。
CenSummaryRouteEntries	Array of Struct	-	CEN汇总路由的详细信息。具体请参见下表“ CenSummaryRouteEntry结构 ”。

CenSummaryRouteEntry结构

参数名称	类型	示例值	描述
CenId	String	cen-7qthudw0ll6jmc****	云企业网实例的ID。
DestinationCidrBlock	String	172.XX.XX.0/24	汇总路由的目标网段。
Status	String	Available	汇总路由的生效状态。 Available：可用。 Pending：配置中。 Conflicted：冲突。
CreationTime	String	2021-04-09T08:36:47+08:00	创建汇总路由的时间。
UpdateTime	String	2021-04-10T09:18:28+08:00	更新汇总路由的时间。
Description	String	This is an example description.	CEN汇总路由的描述信息。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021081115253901022514606****",
        "Action": "DescribeCenSummaryRouteEntries",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 1,
        "TotalCount": 1,
        "CenSummaryRouteEntries": [
            {
                "CenId": "cen-2nim00ybaylts7trquyzt****",
                "DestinationCidrBlock": "172.XX.XX.0/24",
                "Status": "Available",
                "CreationTime": "2022-04-28T22:57:03+08:00",
                "UpdateTime": "2021-04-10T09:18:28+08:00",
                "Description": "This is an example description."
            }
        ]    
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。