DescribeInstances - Anti-DDoS: Central de Documentação do Alibaba Cloud

Obtém uma lista de instâncias do Anti-DDoS Proxy.

Descrição da operação

Use esta operação para obter detalhes paginados das instâncias do Anti-DDoS na sua conta Alibaba Cloud. A resposta inclui o ID da instância, a versão, o horário de expiração e o status de encaminhamento de tráfego de serviço.

Limite de QPS

Esta operação é limitada a 10 chamadas por segundo por usuário. Exceder esse limite aciona o limitador de taxa, o que pode interromper seus serviços.

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

yundun-ddoscoo:DescribeInstances

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a instância do Anti-DDoS Proxy pertence no Resource Management. Se você omitir este parâmetro, o sistema usará o grupo de recursos padrão.	rg-acfm2pz25js****
PageNumber	string	Sim	O número da página a ser retornada. As páginas começam a partir de 1.	1
PageSize	string	Sim	O número de instâncias a serem retornadas por página. Valores válidos: 1 a 50.	10
Ip	string	Não	O endereço IP da instância do Anti-DDoS Proxy.	203.107.XX.XX
Remark	string	Não	A observação da instância do Anti-DDoS Proxy. Há suporte para correspondência aproximada.	doc-test
Edition	integer	Não	A edição da instância do Anti-DDoS Proxy. Valores válidos: 0: Anti-DDoS Proxy (Outside Chinese Mainland) Insurance. 1: Anti-DDoS Proxy (Outside Chinese Mainland) Unlimited. 2: Anti-DDoS Proxy (Outside Chinese Mainland) CMA. 9: Anti-DDoS Proxy (Chinese Mainland) Professional Edition.	9
Enabled	integer	Não	O status de encaminhamento de tráfego de serviço da instância do Anti-DDoS Proxy. Valores válidos: 0: O encaminhamento de tráfego está interrompido. 1: O tráfego está sendo encaminhado.	1
ExpireStartTime	integer	Não	O início do intervalo de tempo de expiração a ser consultado. A operação retorna apenas instâncias que expiram após este horário. O valor é um carimbo de data/hora UNIX em milissegundos.	1640361500000
ExpireEndTime	integer	Não	O fim do intervalo de tempo de expiração a ser consultado. A operação retorna apenas instâncias que expiram neste horário ou antes dele. O valor é um carimbo de data/hora UNIX em milissegundos.	1640361700000
InstanceIds	array	Não	Uma matriz de IDs de instâncias do Anti-DDoS Proxy. Você pode especificar até 200 IDs de instância.
	string	Não	O ID de uma instância do Anti-DDoS Proxy.	ddoscoo-cn-7pp2g9ed****
Status	array	Não	Uma matriz de status de instância para filtragem. Você pode especificar até dois status.
	integer	Não	O status da instância do Anti-DDoS Proxy. Valores válidos: 1: Normal. 2: Expirado.	1
Tag	array<object>	Não	Uma matriz de tags para filtragem de instâncias.
	object	Não
Key	string	Não	A chave da tag usada para filtragem. Você pode especificar até 200 tags. Uma tag é um par chave-valor definido por uma chave de tag (Key) e um valor de tag (Value). Você pode usar tags para filtrar instâncias. Nota Os parâmetros Key e Value de uma tag devem ser especificados como um par.	test-key
Value	string	Não	O valor da tag usado para filtragem. Você pode especificar até 200 tags. Uma tag é um par chave-valor definido por uma chave de tag (Key) e um valor de tag (Value). Você pode usar tags para filtrar instâncias. Nota Os parâmetros Key e Value de uma tag devem ser especificados como um par.	test-value

Ao chamar esta API, você deve incluir tanto os parâmetros de solicitação específicos da API quanto os parâmetros de solicitação comuns da Alibaba Cloud. Para mais informações, consulte Parâmetros comuns.

Para o formato da solicitação, consulte a solicitação de exemplo na seção Exemplos.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de instâncias encontradas.	1
RequestId	string	O ID da solicitação. A Alibaba Cloud gera este ID exclusivo para a solicitação. Use-o para localizar e solucionar problemas.	A0AF40CC-814A-5A86-AEAA-6F19E88B8A39
Instances	array<object>	Uma lista de detalhes das instâncias.
	object
Status	integer	O status da instância. Valores válidos: 1: Normal 2: Expirado	1
IpMode	string	O modo de encaminhamento de IP da instância. Valores válidos: fnat: As versões de IP do cliente e do servidor de origem são iguais. Por exemplo, solicitações de clientes IPv4 são encaminhadas para servidores de origem IPv4, e solicitações de clientes IPv6 são encaminhadas para servidores de origem IPv6. v6tov4: Solicitações de clientes IPv6 são encaminhadas para servidores de origem IPv4.	fnat
DebtStatus	integer	O status de pagamento em atraso da instância. O valor é fixo em 0, o que indica que não há pagamentos em atraso. Isso ocorre porque tanto o Anti-DDoS Pro (Chinese Mainland) quanto o Anti-DDoS Proxy (Outside Chinese Mainland) são baseados em assinatura.	0
Edition	integer	A edição da instância. Valores válidos: 0: Anti-DDoS Proxy (Outside Chinese Mainland) Insurance 1: Anti-DDoS Proxy (Outside Chinese Mainland) Unlimited 2: Anti-DDoS Proxy (Outside Chinese Mainland) CMA 9: Anti-DDoS Pro (Chinese Mainland) Professional Edition	9
IpVersion	string	A versão do protocolo IP da instância. Valores válidos: Ipv4: IPv4 Ipv6: IPv6	Ipv4
ExpireTime	integer	O horário de expiração da instância, fornecido como um carimbo de data/hora UNIX em milissegundos.	1640361600000
Remark	string	A observação da instância.	doc-test
CreateTime	integer	O horário de criação da instância, fornecido como um carimbo de data/hora UNIX em milissegundos.	1637751953000
Enabled	integer	O status de encaminhamento de tráfego de serviço da instância. Valores válidos: 0: O encaminhamento de tráfego de serviço está interrompido. 1: O encaminhamento de tráfego de serviço está ativo.	1
InstanceId	string	O ID da instância.	ddoscoo-cn-7pp2g9ed****
IsFirstOpenBw	integer	Especifica se o método de cobrança de largura de banda limpa com capacidade de expansão no percentil 95 foi ativado anteriormente. Valores válidos: 0: Não 1: Indica que foi ativado.	0
IsFirstOpenQps	integer	Especifica se o método de cobrança de QPS com capacidade de expansão no percentil 95 foi ativado anteriormente. Valores válidos: 0: Não 1: Ativado.	0
Ip	string	O endereço IP da instância.	203.199.XX.XX

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "RequestId": "A0AF40CC-814A-5A86-AEAA-6F19E88B8A39",
  "Instances": [
    {
      "Status": 1,
      "IpMode": "fnat",
      "DebtStatus": 0,
      "Edition": 9,
      "IpVersion": "Ipv4",
      "ExpireTime": 1640361600000,
      "Remark": "doc-test",
      "CreateTime": 1637751953000,
      "Enabled": 1,
      "InstanceId": "ddoscoo-cn-7pp2g9ed****",
      "IsFirstOpenBw": 0,
      "IsFirstOpenQps": 0,
      "Ip": "203.199.XX.XX"
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.