调用DescribePrefixLists查询一个或多个前缀列表的信息。
接口说明
请求参数AddressFamily
、PrefixListId.N
和PrefixListName
类似于过滤器,为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribePrefixLists |
系统规定参数。取值:DescribePrefixLists。 |
RegionId | String | 是 | cn-chengdu |
地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
PrefixListName | String | 否 | PrefixListNameSample |
前缀列表的名称。 |
NextToken | String | 否 | AAAAAdDWBF2**** |
查询凭证(Token)。取值为上一次调用该接口返回的 |
MaxResults | Integer | 否 | 10 |
分页查询时每页行数。 最大值:100。 默认值:10。 |
AddressFamily | String | 否 | IPv4 |
前缀列表的地址族。取值范围:
默认值:空,查询所有前缀列表信息。 |
PrefixListId.N | String | 否 | pl-x1j1k5ykzqlixdcy**** |
前缀列表ID。N的取值范围:0~100。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NextToken | String | AAAAAdDWBF2**** |
本次调用返回的查询凭证(Token)。当该返回值为空时,表示无更多返回的数据信息。 |
RequestId | String | 38793DB8-A4B2-4AEC-BFD3-111234E9188D |
请求ID。 |
PrefixLists | Array of PrefixList |
前缀列表信息组成的数组。 |
|
PrefixList | |||
CreationTime | String | 2021-02-20T07:11Z |
前缀列表的创建时间。 |
AssociationCount | Integer | 1 |
关联资源的数量。 |
MaxEntries | Integer | 20 |
前缀列表支持的最大条目容量。 |
Description | String | This is description. |
前缀列表的描述信息。 |
AddressFamily | String | IPv4 |
前缀列表的地址族。可能值:
|
PrefixListName | String | PrefixListNameSample |
前缀列表的名称。 |
PrefixListId | String | pl-x1j1k5ykzqlixdcy**** |
前缀列表ID。 |
示例
请求示例
http(s)://ecs.aliyuncs.com/?Action=DescribePrefixLists
&RegionId=cn-chengdu
&PrefixListName=PrefixListNameSample
&NextToken=AAAAAdDWBF2****
&MaxResults=10
&AddressFamily=IPv4
&PrefixListId=["pl-x1j1k5ykzqlixdcy****"]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
AAAAAdDWBF2****
38793DB8-A4B2-4AEC-BFD3-111234E9188D
2021-02-20T07:11Z
1
20
This is description.
IPv4
PrefixListNameSample
pl-x1j1k5ykzqlixdcy****
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"NextToken" : "AAAAAdDWBF2****",
"RequestId" : "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
"PrefixLists" : [ {
"CreationTime" : "2021-02-20T07:11Z",
"AssociationCount" : 1,
"MaxEntries" : 20,
"Description" : "This is description.",
"AddressFamily" : "IPv4",
"PrefixListName" : "PrefixListNameSample",
"PrefixListId" : "pl-x1j1k5ykzqlixdcy****"
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | %s | 无效的参数。 |
400 | LimitExceed.PrefixListId | The specified number of PrefixListId exceeds the limit. | PrefixListId的数量超出限制。 |
访问错误中心查看更多错误码。
腾讯云1折,限时活动,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/152704.html