获取路由表关联的子网--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取路由表关联的子网

最近更新时间：2024.07.18 11:03:32首次发布时间：2024.07.02 18:00:51

本接口用于获取路由表关联的子网的列表。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=ListRouteTableAssociatedSubnets&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListRouteTableAssociatedSubnets`	接口名称。当前 API 的名称为 `ListRouteTableAssociatedSubnets`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
route_table_identity	String	是	`route-table-x66rf6****`	路由表的 ID。
fuzzy_subnet_id	String	否	`subnet-sl7jpnt69`	子网的 ID。支持模糊查询。
fuzzy_name	String	否	`SubNet`	子网的名称。名称大小写敏感。支持模糊查询。
fuzzy_cidr_ip	String	否	`172.16.1.0`	IP 地址。支持模糊查询。
pagination	Pagination	否	`请参见下文说明`	分页查询配置。

Pagination

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
page	Integer	否	`1`	子网列表的页码。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
limit	Integer	否	`10`	分页查询时设置的每页行数。默认值：10。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
order_by	Integer	否	`1`	查询出来的子网的排列顺序，按照创建时间排序。取值范围： 1（默认值）：按照降序排列。 2：按照升序排列。

page

Integer

否

1

子网列表的页码。
如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。

limit

Integer

否

10

分页查询时设置的每页行数。
默认值：10。
如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。

order_by

Integer

否

1

查询出来的子网的排列顺序，按照创建时间排序。取值范围：

1（默认值）：按照降序排列。
2：按照升序排列。

返回参数

参数	类型	示例值	描述
subnet_instances	[]SubnetInstances	`请参见返回示例`	子网的信息。
count	Long	`2`	子网的数量。

SubnetInstances

参数	类型	示例值	描述
subnet_identity	String	`subnet-sl7jpnt69tr****`	子网 ID。
cidr_ip	String	`172...128`	IP 地址。
cidr_mask	Integer	`26`	前缀长度。
name	String	`subnet-dev01`	子网的名称。
desc	String	`dev01`	子网的描述。
status	String	`available`	子网的状态： available：可用。 modifying：变更中。 deleting：删除中。
create_time	Long	`1675062289`	子网的创建时间。
update_time	Long	`1675062289`	子网的更新时间。

请求示例

POST https://veenedge.volcengineapi.com/?Action=ListRouteTableAssociatedSubnets&Version=2021-04-30
&<其他公共参数>
{
    "route_table_identity": "route-table-6b4hvr****",
    "fuzzy_name": "Sub",
    "fuzzy_cidr_ip": "172.16.1.0"
    
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202403191119438821827AE5FCEA83****",
        "Action": "ListRouteTableAssociatedSubnets",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "subnet_instances": [
            {
                "account_identity": 210006****,
                "user_identity": 0,
                "subnet_identity": "subnet-sl7jpnt69t****",
                "cidr_ip": "172.16.1.0",
                "cidr_mask": 24,
                "name": "SubNet01",
                "desc": "",
                "status": "available",
                "create_time": 1710417509,
                "update_time": 1710417510
            },
            {
                "account_identity": 210006****,
                "user_identity": 0,
                "subnet_identity": "subnet-2hjczm2ll****",
                "cidr_ip": "172.16.2.0",
                "cidr_mask": 24,
                "name": "SubNet02",
                "desc": "",
                "status": "available",
                "create_time": 1710417941,
                "update_time": 1710417941
            }
        ],
        "count": 2
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。