DescribePrefixLists - : Central de Documentação do Alibaba Cloud

Descrição

Você pode especificar os parâmetros de solicitação AddressFamily, PrefixListId.N e PrefixListName para filtrar a consulta. Os parâmetros especificados têm relação lógica E. Apenas os parâmetros informados são incluídos nas condições de filtro.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribePrefixLists	A operação que você deseja executar. Defina o valor como DescribePrefixLists.
RegionId	String	Sim	cn-chengdu	O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.
PrefixListName	String	Não	PrefixListNameSample	O nome da lista de prefixos.
NextToken	String	Não	AAAAAdDWBF2****	O token de consulta. Defina o valor como o valor de `NextToken` retornado na chamada anterior à operação DescribePrefixLists. Deixe este parâmetro vazio na primeira vez que chamar esta operação.
MaxResults	Integer	Não	10	O número de entradas a retornar por página. Valor máximo: 100. Valor padrão: 10.
AddressFamily	String	Não	IPv4	A família de endereços IP da lista de prefixos. Valores válidos: IPv4 IPv6 Este parâmetro está vazio por padrão, o que indica que todas as listas de prefixos são consultadas.
PrefixListId.N	String	Não	pl-x1j1k5ykzqlixdcy****	O ID da lista de prefixos N. Valores válidos de N: 0 a 100.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
NextToken	String	AAAAAdDWBF2****	O token de consulta retornado nesta chamada. Se o valor retornado estiver vazio, não há mais dados a serem retornados.
RequestId	String	38793DB8-A4B2-4AEC-BFD3-111234E9188D	O ID da solicitação.
PrefixLists	Array of PrefixList		Detalhes sobre as listas de prefixos.
PrefixList
CreationTime	String	2021-02-20T07:11Z	O horário em que a lista de prefixos foi criada.
AssociationCount	Integer	1	O número de recursos associados.
MaxEntries	Integer	20	O número máximo de entradas que a lista de prefixos pode conter.
Description	String	This is description.	A descrição da lista de prefixos.
AddressFamily	String	IPv4	A família de endereços IP da lista de prefixos. Valores válidos: IPv4 IPv6
PrefixListName	String	PrefixListNameSample	O nome da lista de prefixos.
PrefixListId	String	pl-x1j1k5ykzqlixdcy****	O ID da lista de prefixos.

Exemplos

Solicitações de exemplo

http(s)://ecs.aliyuncs.com/?Action=DescribePrefixLists
&RegionId=cn-chengdu
&PrefixListName=PrefixListNameSample
&NextToken=AAAAAdDWBF2****
&MaxResults=10
&AddressFamily=IPv4
&PrefixListId=["pl-x1j1k5ykzqlixdcy****"]
&<Common request parameters>

Respostas de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePrefixListsResponse>
    <NextToken>AAAAAdDWBF2****</NextToken>
    <RequestId>38793DB8-A4B2-4AEC-BFD3-111234E9188D</RequestId>
    <PrefixLists>
        <CreationTime>2021-02-20T07:11Z</CreationTime>
        <AssociationCount>1</AssociationCount>
        <MaxEntries>20</MaxEntries>
        <Description>This is description.</Description>
        <AddressFamily>IPv4</AddressFamily>
        <PrefixListName>PrefixListNameSample</PrefixListName>
        <PrefixListId>pl-x1j1k5ykzqlixdcy****</PrefixListId>
    </PrefixLists>
</DescribePrefixListsResponse>

Formato 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****"
  } ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	%s	A mensagem de erro retornada porque um parâmetro especificado é inválido.
400	LimitExceed.PrefixListId	The specified number of PrefixListId exceeds the limit.	A mensagem de erro retornada porque o número máximo de listas de prefixos foi atingido.

Para obter uma lista de códigos de erro, visite a Central de Erros de API.