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

Consulta informações sobre uma ou mais listas de prefixos.

Descrição da operação

Os parâmetros de solicitação AddressFamily, PrefixListId.N e PrefixListName atuam como filtros e possuem uma relação lógica AND. Se um parâmetro estiver vazio, o filtro correspondente não terá efeito.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ecs:DescribePrefixLists

get

*PrefixList.

acs:ecs:{#regionId}:{#accountId}:prefixlist/{#PrefixListId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-chengdu
PrefixListName	string	Não	O nome da lista de prefixos.	PrefixListNameSample
NextToken	string	Não	O token de paginação. Defina este parâmetro com o valor NextToken retornado na chamada anterior. Você não precisa definir este parâmetro para a primeira solicitação.	AAAAAdDWBF2****
MaxResults	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
AddressFamily	string	Não	A família de endereços da lista de prefixos. Valores válidos: IPv4 IPv6 Valor padrão: vazio, o que indica que as informações sobre todas as listas de prefixos serão consultadas.	IPv4
PrefixListId	array	Não	O ID da lista de prefixos. Valores válidos de N: 0 a 100.	pl-x1j1k5ykzqlixdcy****
	string	Não	O ID da lista de prefixos. Valores válidos de N: 0 a 100.	pl-x1j1k5ykzqlixdcy****
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a lista de prefixos pertence.	rg-bp67acfmxazb4p****
Tag	array<object>	Não	As tags.
	object	Não	As tags.
Key	string	Não	A chave da tag da lista de prefixos. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres e não pode começar com aliyun ou acs:. Não pode conter http:// ou https://.	TestKey
Value	string	Não	O valor da tag da lista de prefixos. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode conter http:// ou https://.	TestValue

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação retornado nesta chamada. Se o valor retornado estiver vazio, não há mais dados disponíveis.	AAAAAdDWBF2****
RequestId	string	O ID da solicitação.	38793DB8-A4B2-4AEC-BFD3-111234E9188D
PrefixLists	object
PrefixList	array<object>	As informações da lista de prefixos.
	array<object>
CreationTime	string	A hora em que a lista de prefixos foi criada. A hora é exibida no formato ISO 8601 em UTC.	2021-02-20T07:11Z
AssociationCount	integer	O número de recursos associados.	1
MaxEntries	integer	O número máximo de entradas que a lista de prefixos suporta.	20
Description	string	A descrição da lista de prefixos.	Esta é a descrição
AddressFamily	string	A família de endereços da lista de prefixos. Valores válidos: IPv4 IPv6	IPv4
PrefixListName	string	O nome da lista de prefixos.	PrefixListNameSample
PrefixListId	string	O ID da lista de prefixos.	pl-x1j1k5ykzqlixdcy****
Tags	object
Tag	array<object>	As tags.
	object	As tags.
TagValue	string	A chave da tag da lista de prefixos. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres e não pode começar com aliyun ou acs:. Não pode conter http:// ou https://.	TestKey
TagKey	string	O valor da tag da lista de prefixos. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode conter http:// ou https://.	TestValue
ResourceGroupId	string	O ID do grupo de recursos ao qual a lista de prefixos pertence.	rg-bp67acfmxazb4p****

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
  "PrefixLists": {
    "PrefixList": [
      {
        "CreationTime": "2021-02-20T07:11Z",
        "AssociationCount": 1,
        "MaxEntries": 20,
        "Description": "Esta é a descrição",
        "AddressFamily": "IPv4",
        "PrefixListName": "PrefixListNameSample",
        "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestKey",
              "TagKey": "TestValue"
            }
          ]
        },
        "ResourceGroupId": "rg-bp67acfmxazb4p****"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	%s	Os parâmetros da solicitação atual são inválidos. Tente novamente.
400	LimitExceed.PrefixListId	The specified number of PrefixListId exceeds the limit.	O número de valores de PrefixListId excede o limite.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	O RegionId especificado não existe. Verifique se o produto está disponível nesta região.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.