DescribePrefixLists - - Centro de documentación de Alibaba Cloud

Consulta la información de una o más listas de prefijos.

Descripción

Puede especificar los parámetros de solicitud AddressFamily, PrefixListId.N y PrefixListName para filtrar la consulta. Los parámetros especificados tienen una relación lógica AND. Solo los parámetros indicados se incluyen en las condiciones de filtro.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribePrefixLists	La operación que desea ejecutar. Establezca el valor en DescribePrefixLists.
RegionId	String	Sí	cn-chengdu	El ID de la región. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
PrefixListName	String	No	PrefixListNameSample	El nombre de la lista de prefijos.
NextToken	String	No	AAAAAdDWBF2****	El token de consulta. Establezca este parámetro con el valor de `NextToken` devuelto en la llamada anterior a la operación DescribePrefixLists. Deje este parámetro vacío la primera vez que llame a esta operación.
MaxResults	Integer	No	10	El número de entradas por devolver en cada página. Valor máximo: 100. Valor predeterminado: 10.
AddressFamily	String	No	IPv4	La familia de direcciones IP de la lista de prefijos. Valores válidos: IPv4 IPv6 Si este parámetro se deja vacío, se consultan todas las listas de prefijos.
PrefixListId.N	String	No	pl-x1j1k5ykzqlixdcy****	El ID de la lista de prefijos N. Valores válidos de N: 0 a 100.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
NextToken	String	AAAAAdDWBF2****	El token de consulta devuelto en esta llamada. Si el valor está vacío, no hay más datos por devolver.
RequestId	String	38793DB8-A4B2-4AEC-BFD3-111234E9188D	El ID de la solicitud.
PrefixLists	Array of PrefixList		Detalles de las listas de prefijos.
PrefixList
CreationTime	String	2021-02-20T07:11Z	La hora de creación de la lista de prefijos.
AssociationCount	Integer	1	El número de recursos asociados.
MaxEntries	Integer	20	El número máximo de entradas que puede contener la lista de prefijos.
Description	String	This is description.	La descripción de la lista de prefijos.
AddressFamily	String	IPv4	La familia de direcciones IP de la lista de prefijos. Valores válidos: IPv4 IPv6
PrefixListName	String	PrefixListNameSample	El nombre de la lista de prefijos.
PrefixListId	String	pl-x1j1k5ykzqlixdcy****	El ID de la lista de prefijos.

Ejemplos

Solicitudes de ejemplo

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

Respuestas de ejemplo

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidParameter	%s	El mensaje de error devuelto porque un parámetro especificado no es válido.
400	LimitExceed.PrefixListId	The specified number of PrefixListId exceeds the limit.	El mensaje de error devuelto porque se alcanzó el número máximo de listas de prefijos.

Para obtener una lista de códigos de error, visite el Centro de errores de API.