DescribePrefixListAssociations--私有网络-火山引擎

文档中心

立即注册

导航

DescribePrefixListAssociations

最近更新时间：2024.05.17 08:35:46首次发布时间：2023.09.05 08:11:46

调用 DescribePrefixListAssociations 接口，查询指定前缀列表关联的资源。

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的前缀列表，若没有符合条件的前缀列表，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有前缀列表。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribePrefixListAssociations	要执行的操作，取值：DescribePrefixListAssociations。
Version	String	是	2020-04-01	API版本信息，取值为：2020-04-01。
PrefixListId	String	是	pl-bp1fg655nh68xyz9****	前缀列表的ID。您可以调用 DescribePrefixLists 接口，查询前缀列表的ID。
ResourceType	String	否	VpcRouteTable	关联资源类型，取值： VpcRouteTable：路由表 VpcSecurityGroup：安全组
PageNumber	Integer	否	1	列表的页码。默认值为1。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
PageSize	Integer	否	20	分页查询时每页的行数。最大值为100，默认值为20。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置。不填则从头开始查询。传入之前调用本API返回的`NextToken`，则从该次API调用标记分页的位置往后开始查询。
MaxResults	Integer	否	50	查询的数量，默认为 10，最大为100。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
TotalCount	Integer	2	符合条件的前缀列表关联资源总数。说明本参数即将下线，使用`NextToken`和`MaxResults`分页查询时，此参数无意义。
PageNumber	Integer	1	当前页码。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
PageSize	Integer	10	当前分页的行数。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。
PrefixListAssociations	Array	-	VPC前缀列表关联资源集合。具体请见下表“PrefixListAssociation结构”。

PrefixListAssociation结构

参数名称	类型	示例值	描述
ResourceId	String	vtb-bp1drpcfz9srr393h****	关联的资源ID。
ResourceType	String	VpcRouteTable	关联的资源类型。

请求示例

GET /?Action=DescribePrefixListAssociations&Version=2020-04-01&PrefixListId=pl-0b78hw45f****&ResourceType=VpcRouteTable HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribePrefixListAssociations",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result":{
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "PrefixListAssociations": [
            {
                 "ResourceId": "vtb-bp1drpcfz9srr393h****",
                 "ResourceType": "VpcRouteTable"
            },
            {
                 "ResourceId": "vtb-bp1drpcfz9srr8888****",
                 "ResourceType": "VpcRouteTable"
            }
         ]
    }
}

错误码

此处仅展示当前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.	指定的分页参数不合法。
403	Forbidden	You are not authorized to access VPC prefix list.	您无权限访问VPC前缀列表。
409	InvalidOperation.Conflict	The specified resource operation conflicts.	指定的资源操作冲突。