DescribeSecurityGroups - ENS: Central de Documentação do Alibaba Cloud

Consulta os detalhes dos grupos de segurança criados.

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

ens:DescribeSecurityGroups

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SecurityGroupId	string	Não	O ID do grupo de segurança.	sg-bp67acfmxazb4ph***
SecurityGroupName	string	Não	O nome do grupo de segurança.	DocTest
PageSize	integer	Não	O número de entradas por página. Valor máximo: 50. Valor padrão: 10	10
PageNumber	integer	Não	O número da página. As páginas começam na página 1. Valor padrão: 1	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageSize	integer	O número de entradas por página.	10
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de entradas retornadas.	49
SecurityGroups	object
SecurityGroup	array<object>	Os detalhes dos grupos de segurança.
	array<object>
CreationTime	string	The creation time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2019-11-01T06:08:46Z
InstanceCount	integer	The number of associated instances.	5
Description	string	The description of the security group.	TestDescription
SecurityGroupId	string	The ID of the security group.	sg-bp67acfmxazb4ph***
SecurityGroupName	string	The name of the security group.	DocTest
InstanceIds	object
InstanceId	array	The IDs of the instances that are associated with the security group.
	string	The ID of instance.	i-5****
NetworkInterfaceIds	object
NetworkInterfaceId	array	The IDs of the ENIs that are associated with the security group.
	string	The ID of the ENI.	eni-5****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 49,
  "SecurityGroups": {
    "SecurityGroup": [
      {
        "CreationTime": "2019-11-01T06:08:46Z",
        "InstanceCount": 5,
        "Description": "TestDescription",
        "SecurityGroupId": "sg-bp67acfmxazb4ph***",
        "SecurityGroupName": "DocTest",
        "InstanceIds": {
          "InstanceId": [
            "i-5****"
          ]
        },
        "NetworkInterfaceIds": {
          "NetworkInterfaceId": [
            "eni-5****"
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	ens.interface.error	Failed to call API.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.