最近更新时间:2024.04.22 11:15:33
首次发布时间:2023.09.05 08:11:46
调用 DescribePrefixLists 接口,查询满足指定条件的前缀列表。
说明
前缀列表功能正在邀测中,如需试用,请联系客户经理。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribePrefixLists | 要执行的操作,取值:DescribePrefixLists。 |
Version | String | 是 | 2020-04-01 | API版本信息,取值为:2020-04-01。 |
PrefixListIds.N | String | 否 | PrefixListIds.1=pl-bp1fg655nh68xyz9****&PrefixListIds.2=pl-bp1fg655nh688888**** | 前缀列表的实例ID。
|
PrefixListName | String | 否 | PrefixList-1 | 要查询的前缀列表的名称。 |
IpVersion | String | 否 | IPv4 | 前缀列表的IP版本。取值:
|
PageNumber | Integer | 否 | 1 | 列表的页码。默认值为1。 说明 本参数即将下线,建议您使用 |
PageSize | Integer | 否 | 20 | 分页查询时每页的行数。最大值为100,默认值为20。 说明 本参数即将下线,建议您使用 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a**** | 分页查询凭证,用于标记分页的位置。
|
MaxResults | Integer | 否 | 50 | 查询的数量,默认为 10,最大为100。 |
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 2021062415303301022514515207C4**** | 请求ID。 |
TotalCount | Integer | 2 | 符合条件的前缀列表总数。 说明 本参数即将下线,使用 |
PageNumber | Integer | 1 | 当前页码。 说明 本参数即将下线,建议您使用 |
PageSize | Integer | 10 | 当前分页的行数。 说明 本参数即将下线,建议您使用 |
NextToken | String | caeba0bbb2be03f84eb48b699f0a**** | 本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。 |
PrefixLists | Array | - | VPC前缀列表集合。具体请见下表“PrefixList结构”。 |
PrefixList结构
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PrefixListId | String | pl-bp1fg655nh68xyz9**** | VPC前缀列表的ID。 |
PrefixListName | String | PrefixList-1 | VPC前缀列表名称。 |
Description | String | PrefixList_Common | VPC前缀列表描述信息。 |
IpVersion | String | IPv4 | 前缀列表的IP版本。 |
MaxEntries | Integer | 10 | 最大条目数,即前缀列表做多可添加条目的数量。 |
AssociationCount | Integer | 5 | 前缀列表关联资源数目。 |
Cidrs | Array of String | 1.XX.XX.0/24,2.XX.XX.0/24 | 前缀列表的CIDR地址块信息。 |
Status | String | Available | 前缀列表的状态。取值:
|
CreationTime | String | 2017-12-05T22:40:00+08:00 | VPC前缀列表的创建时间。 |
UpdateTime | String | 2017-12-05T22:40:00+08:00 | VPC前缀列表的修改时间。 |
GET /?Action=DescribePrefixLists&Version=2020-04-01&IpVersion=IPv4 HTTP/1.1 Host: open.volcengineapi.com Service: vpc Region: cn-beijing
{ "ResponseMetadata": { "RequestId": "2021062415303301022514515207C4****", "Action": "DescribePrefixLists", "Version": "2020-04-01", "Service": "vpc", "Region": "cn-beijing" }, "Result":{ "RequestId": "2021062415303301022514515207C4****", "TotalCount": 2, "PageNumber": 1, "PageSize": 20, "NextToken": "caeba0bbb2be03f84eb48b699f0a****", "PrefixLists": [ { "PrefixListId": "pl-bp1fg655nh68xyz9****", "PrefixListName": "PrefixList-1", "Description": "PrefixList_Common", "IpVersion": "IPv4", "MaxEntries": 50, "AssociationCount": 5, "Cidrs": [ "1.XX.XX.0/24", "2.XX.XX.0/24" ] "Status": "Available", "CreationTime": "2021-07-22T10:51:41+08:00", "UpdateTime": "2021-07-23T11:55:12+08:00" } ] } }
此处仅展示当前API的错误码,更多错误码请参见公共错误码。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidMaxResults.Malformed | The specified parameter MaxResults is malformed. | 查询数量不合法。 |
400 | InvalidNextToken.Malformed | The specified parameter NextToken is invalid. | 查询 NextToken 不合法。 |
400 | InvalidPage.Malformed | The specified page is malformed. | 指定的分页参数不合法。 |
400 | InvalidParameter.IpVersion | The specified IP version is not supported. | 指定的IP地址类型不支持。 |
400 | LimitExceeded.PrefixListID | You've reached the limit on the number of prefix list IDs that you can describe. | 已达到可查询的前缀列表ID数量上限。 |
403 | Forbidden | You are not authorized to access VPC prefix list. | 您无权限访问VPC前缀列表。 |
409 | InvalidOperation.Conflict | The specified resource operation conflicts. | 指定的资源操作冲突。 |