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

Consulta as informações básicas sobre grupos de segurança. Você pode filtrar os resultados por região, ID do grupo de segurança, tipo de grupo de segurança e outros parâmetros por meio de consulta de parâmetros.

Descrição da operação

Consulta paginada: Use MaxResults e NextToken para consulta paginada.
- Se NextToken não for retornado, a página atual é a última página.
- Para a primeira página, defina apenas MaxResults para limitar o número de entradas a retornar. O valor de NextToken na resposta é usado para consultar as páginas subsequentes.
- Para páginas subsequentes, defina NextToken com o valor de NextToken retornado na resposta anterior e defina MaxResults para limitar o número de entradas a retornar.
Ao invocar uma operação de API usando o Cloud Assistant CLI, especifique os parâmetros de solicitação no formato exigido. Para mais informações, consulte Formato de parâmetros de comandos CLI.

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:DescribeSecurityGroups

get

SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/*

SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}

ecs:tag
ecs:tag
ecs:tag
ecs:tag

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-hangzhou
SecurityGroupIds	string	Não	Os IDs dos grupos de segurança. Você pode especificar até 100 IDs de grupos de segurança. Separe múltiplos IDs com vírgulas (,) em formato de array JSON.	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]
VpcId	string	Não	O ID da virtual private cloud (VPC) à qual o grupo de segurança pertence.	vpc-bp67acfmxazb4p****
SecurityGroupType	string	Não	O tipo do grupo de segurança. Valores válidos: normal: grupo de segurança básico. enterprise: grupo de segurança avançado. Nota Se você não especificar este parâmetro, grupos de segurança de todos os tipos serão consultados.	normal
NextToken	string	Não	O token de paginação. Defina este parâmetro com o valor de NextToken retornado na solicitação anterior. Você não precisa definir este parâmetro para a primeira solicitação.	e71d8a535bd9cc11
MaxResults	integer	Não	O número máximo de entradas por página para consulta paginada. Se você definir este parâmetro, o método de paginação `MaxResults` e `NextToken` será usado. Valor máximo: 100. Valor padrão: 10.	10
NetworkType	string	Não	O tipo de rede do grupo de segurança. Valores válidos: vpc: VPC. classic: rede clássica. A rede clássica está descontinuada. Para mais informações, consulte Aviso de descontinuação.	vpc
SecurityGroupName	string	Não	O nome do grupo de segurança.	SGTestName
IsQueryEcsCount	boolean	Não	Especifica se as informações de capacidade do grupo de segurança devem ser consultadas. Se você definir este parâmetro como True, os valores de `EcsCount` e `AvailableInstanceAmount` na resposta serão válidos. Nota Este parâmetro está descontinuado.	null
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o grupo de segurança pertence. Ao usar este parâmetro para filtrar recursos, a contagem de recursos não pode exceder 1.000. Você pode invocar ListResourceGroups para consultar grupos de recursos. Nota A filtragem pelo grupo de recursos padrão não é suportada.	rg-bp67acfmxazb4p****
Tag	array<object>	Não	As tags.
	object	Não	As tags.
key	string	Não	A chave de tag do grupo de segurança. Nota Para melhor compatibilidade, use o parâmetro Tag.N.Key.	testkey
Key	string	Não	A chave de tag do grupo de segurança. Valores válidos de N: 1 a 20. Se você usar uma única tag para filtrar recursos, a contagem de recursos com a tag especificada não pode exceder 1.000. Se você usar múltiplas tags para filtrar recursos, a contagem de recursos que possuem todas as tags especificadas anexadas não pode exceder 1.000. Se a contagem de recursos exceder 1.000, chame ListTagResources para consultar recursos.	TestKey
Value	string	Não	O valor de tag do grupo de segurança. Valores válidos de N: 1 a 20.	TestValue
value	string	Não	O valor de tag do grupo de segurança. Nota Para melhor compatibilidade, use o parâmetro Tag.N.Value.	testvalue
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run. Valores válidos: true: realiza apenas um dry run. O sistema verifica a solicitação quanto a possíveis problemas, incluindo pares de AccessKey inválidos, usuários Resource Access Management (RAM) não autorizados e valores de parâmetros ausentes. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro DryRunOperation será retornado. false: realiza um dry run e envia a solicitação Normal. Se a solicitação passar no dry run, um código de status HTTP 2xx será retornado e a autorização será verificada. Valor padrão: false.	false
SecurityGroupId	string	Não	O ID do grupo de segurança.	sg-bp67acfmxazb4p****
FuzzyQuery	boolean	Não	Nota Este parâmetro está descontinuado.	null
PageNumber	integer	Não	Nota Este parâmetro será descontinuado. Use NextToken e MaxResults para paginação.	1
PageSize	integer	Não	Nota Este parâmetro será descontinuado. Use NextToken e MaxResults para paginação.	10
ServiceManaged	boolean	Não	Especifica se o grupo de segurança gerenciado é gerenciado. Valores válidos: true: o grupo de segurança gerenciado é gerenciado. false: o grupo de segurança gerenciado não é gerenciado.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RegionId	string	O ID da região do grupo de segurança.	cn-hangzhou
NextToken	string	O token de paginação retornado nesta chamada. Se este valor estiver vazio ao usar MaxResults e NextToken para paginação, não há mais dados disponíveis.	e71d8a535bd9cc11
SecurityGroups	object
SecurityGroup	array<object>	A coleção de informações de grupos de segurança.
	array<object>	As informações do grupo de segurança.
SecurityGroupId	string	O ID do grupo de segurança.	sg-bp67acfmxazb4p****
SecurityGroupName	string	O nome do grupo de segurança.	SGTestName
Description	string	A descrição do grupo de segurança.	TestDescription
SecurityGroupType	string	O tipo do grupo de segurança. Valores válidos: normal: grupo de segurança básico. enterprise: grupo de segurança avançado.	normal
VpcId	string	A VPC à qual o grupo de segurança pertence.	vpc-bp67acfmxazb4p****
CreationTime	string	A hora em que o grupo de segurança foi criado. A hora segue o padrão ISO 8601 em UTC. Formato: yyyy-MM-ddThh:mmZ.	2021-08-31T03:12:29Z
EcsCount	integer	O número de endereços IP privados acomodados no grupo de segurança. Para mais informações, consulte Capacidade do grupo de segurança. Este parâmetro é válido apenas quando o parâmetro de solicitação IsQueryEcsCount é definido como True. Nota Este parâmetro foi descontinuado. A quantidade na resposta é apenas para referência e não é consistente em tempo real.	0
AvailableInstanceAmount	integer	O número de endereços IP privados que ainda podem ser adicionados ao grupo de segurança. Para mais informações, consulte Capacidade do grupo de segurança. Este parâmetro é válido apenas quando o parâmetro de solicitação IsQueryEcsCount é definido como True. Nota Este parâmetro foi descontinuado. A quantidade na resposta é apenas para referência e não é consistente em tempo real.	0
ResourceGroupId	string	O ID do grupo de recursos ao qual o grupo de segurança pertence.	rg-bp67acfmxazb4p****
ServiceManaged	boolean	Indica se o grupo de segurança é usado por um serviço de nuvem ou um distribuidor.	false
ServiceID	integer	O ID do distribuidor associado ao grupo de segurança.	12345678910
Tags	object
Tag	array<object>	A coleção de tags do grupo de segurança.
	object	A tag do grupo de segurança.
TagValue	string	O valor da tag do grupo de segurança.	TestValue
TagKey	string	A chave da tag do grupo de segurança.	TestKey
RuleCount	integer	O número de regras no grupo de segurança.	100
GroupToGroupRuleCount	integer	O número de regras que autorizam o acesso de outros grupos de segurança.	5
TotalCount	integer	O número total de grupos de segurança. Este parâmetro não é retornado quando você usa `MaxResults` e `NextToken` para consulta de parâmetros.	20
PageNumber	integer	O número da página atual. Nota Este parâmetro será descontinuado. Use NextToken e MaxResults para paginação.	1
PageSize	integer	O número de entradas por página. Nota Este parâmetro será descontinuado. Use NextToken e MaxResults para paginação.	10

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "RegionId": "cn-hangzhou",
  "NextToken": "e71d8a535bd9cc11",
  "SecurityGroups": {
    "SecurityGroup": [
      {
        "SecurityGroupId": "sg-bp67acfmxazb4p****",
        "SecurityGroupName": "SGTestName",
        "Description": "TestDescription",
        "SecurityGroupType": "normal",
        "VpcId": "vpc-bp67acfmxazb4p****",
        "CreationTime": "2021-08-31T03:12:29Z",
        "EcsCount": 0,
        "AvailableInstanceAmount": 0,
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ServiceManaged": false,
        "ServiceID": 12345678910,
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "RuleCount": 100,
        "GroupToGroupRuleCount": 5
      }
    ]
  },
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	NotSupported.PageNumberAndPageSize	The parameters PageNumber and PageSize are currently not supported, please use NextToken and MaxResults instead.	Os parâmetros PageNumber e PageSize não são mais suportados. Use os parâmetros NextToken e MaxResults em vez disso.
400	InValidParameter.NextToken	The parameter NextToken is invalid.	O parâmetro NextToken especificado é inválido.
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	O parâmetro obrigatório RegionId está vazio.
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	O parâmetro SecurityGroupType especificado é inválido. Verifique se o valor está correto.
400	InvalidSecurityGroupId.Malformed	The specified parameter SecurityGroupId is not valid.	O parâmetro SecurityGroupId especificado é inválido.
400	InvalidSecurityGroupName.Malformed	The specified parameter SecurityGroupName is not valid.	O formato do nome do grupo de segurança especificado é inválido. O nome deve ter de 2 a 128 caracteres, começar com uma letra ou caractere chinês, e pode conter dígitos, pontos (.), underscores (_) ou hífens (-). O nome do grupo de segurança é exibido no console. O nome não pode começar com http:// ou https://.
500	InternalError	The request processing has failed due to some unknown error.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.