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

Observações de uso

Atente-se aos seguintes pontos:

As informações básicas dos grupos de segurança incluem seus IDs e descrições. A resposta retorna os grupos de segurança em ordem decrescente de ID.
Recomendamos o uso dos parâmetros MaxResults e NextToken para consultas paginadas. Use MaxResults para definir o número máximo de entradas retornadas em cada solicitação. O valor retornado em NextToken funciona como um token de paginação, aplicável na próxima requisição para obter uma nova página de resultados. Ao realizar a consulta seguinte, defina NextToken com o valor obtido na chamada anterior e use MaxResults para limitar a quantidade de itens desta nova requisição. Caso o retorno de NextToken esteja vazio, a página atual é a última e não há mais resultados disponíveis.
Ao utilizar a CLI do Alibaba Cloud para chamar uma operação de API, especifique os valores dos parâmetros de solicitação nos formatos exigidos para cada tipo de dado. Para mais detalhes, consulte Visão geral do formato de parâmetros.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeSecurityGroups	A operação que você deseja executar. Defina o valor como DescribeSecurityGroups.
RegionId	String	Sim	cn-hangzhou	O ID da região do grupo de segurança. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
SecurityGroupIds	String	Não	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]	Os IDs dos grupos de segurança. O valor é um array JSON composto por até 100 IDs de grupos de segurança. Separe os IDs com vírgulas (,).
VpcId	String	Não	vpc-bp67acfmxazb4p****	O ID da Virtual Private Cloud (VPC) à qual o grupo de segurança pertence.
SecurityGroupType	String	Não	normal	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 este parâmetro não for especificado, tanto os grupos de segurança básicos quanto os avançados serão consultados.
NextToken	String	Não	e71d8a535bd9cc11	Token de paginação utilizado na próxima solicitação para recuperar uma nova página de resultados. Não é necessário especificar este parâmetro na primeira requisição. Nas chamadas subsequentes, utilize o token obtido na consulta anterior como valor de NextToken.
MaxResults	Integer	Não	10	Número máximo de entradas por página. Ao definir MaxResults, os parâmetros `MaxResults` e `NextToken` habilitam a consulta paginada. Valores válidos: 1 a 100. Valor padrão: 10.
NetworkType	String	Não	vpc	Tipo de rede do grupo de segurança. Valores válidos: vpc classic
SecurityGroupName	String	Não	SGTestName	Nome do grupo de segurança.
IsQueryEcsCount	Boolean	Não	null	Define se a capacidade do grupo de segurança deve ser consultada. Se definido como True, os valores `EcsCount` e `AvailableInstanceAmount` na resposta serão válidos. Nota Este parâmetro está descontinuado.
ResourceGroupId	String	Não	rg-bp67acfmxazb4p****	ID do grupo de recursos ao qual o grupo de segurança pertence. Quando este parâmetro é usado para filtrar recursos, a resposta pode exibir até 1.000 itens associados ao grupo de recursos especificado. Chame a operação ListResourceGroups para obter a lista atualizada de grupos de recursos. Nota Os recursos do grupo de recursos padrão aparecem na resposta independentemente da configuração deste parâmetro.
Tag.N.key	String	Não	testkey	Chave da tag N do grupo de segurança. Nota Este parâmetro será removido futuramente. Recomendamos usar o parâmetro Tag.N.Key para garantir compatibilidade futura.
Tag.N.Key	String	Não	TestKey	Chave da tag N do grupo de segurança. Valores válidos para N: 1 a 20. Ao filtrar por uma única tag, até 1.000 recursos com essa tag são retornados. Na busca por múltiplas tags, o limite também é de 1.000 recursos que possuam todas as tags especificadas simultaneamente. Para listar mais de 1.000 recursos com as tags desejadas, chame a operação ListTagResources.
Tag.N.Value	String	Não	TestValue	Valor da tag. Valores válidos para N: 1 a 20.
Tag.N.value	String	Não	testvalue	Valor da tag N do grupo de segurança. Nota Este parâmetro será descontinuado futuramente. Recomendamos usar o parâmetro Tag.N.Value para garantir compatibilidade futura.
DryRun	Boolean	Não	false	Indica se apenas uma simulação (dry run) será executada, sem efetuar a solicitação real. Valores válidos: true: executa apenas a simulação. O sistema valida o par de AccessKey, as permissões do usuário do Resource Access Management (RAM) e os parâmetros obrigatórios. Se a validação falhar, uma mensagem de erro é retornada. Caso contrário, o código de erro DryRunOperation é devolvido. false: realiza a simulação e, se aprovada, executa a solicitação real. Um código de status HTTP 2xx indica sucesso e a operação é processada. Valor padrão: false.
SecurityGroupId	String	Não	sg-bp67acfmxazb4p****	ID do grupo de segurança.
FuzzyQuery	Boolean	Não	null	Nota Este parâmetro está descontinuado.
PageNumber	Integer	Não	1	Número da página. A numeração começa em 1. Valor padrão: 1. Nota Este parâmetro será removido futuramente. Recomendamos usar os parâmetros NextToken e MaxResults para consultas paginadas.
PageSize	Integer	Não	10	Quantidade de entradas por página. Valores válidos: 1 a 50. Valor padrão: 10. Nota Este parâmetro será removido futuramente. Recomendamos usar os parâmetros NextToken e MaxResults para consultas paginadas.
ServiceManaged	Boolean	Não	false	Define se grupos de segurança gerenciados devem ser consultados. Valores válidos: true false

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID da solicitação.
RegionId	String	cn-hangzhou	ID da região do grupo de segurança.
NextToken	String	e71d8a535bd9cc11	Token de paginação. Pode ser usado na próxima solicitação para recuperar uma nova página de resultados. Se o valor deste parâmetro estiver vazio durante uma consulta paginada com MaxResults e NextToken, não há mais resultados a serem retornados.
SecurityGroups	Array of SecurityGroup		Detalhes sobre os grupos de segurança.
SecurityGroup
SecurityGroupId	String	sg-bp67acfmxazb4p****	ID do grupo de segurança.
SecurityGroupName	String	SGTestName	Nome do grupo de segurança.
Description	String	TestDescription	Descrição do grupo de segurança.
SecurityGroupType	String	normal	Tipo do grupo de segurança. Valores válidos: normal: grupo de segurança básico enterprise: grupo de segurança avançado
VpcId	String	vpc-bp67acfmxazb4p****	ID da VPC à qual o grupo de segurança pertence.
CreationTime	String	2021-08-31T03:12:29Z	Horário de criação do grupo de segurança. Segue o padrão ISO 8601 no formato yyyy-MM-ddThh:mmZ, exibido em UTC.
EcsCount	Integer	0	Quantidade de endereços IP privados contidos no grupo de segurança. Para mais informações, consulte a seção "Capacidade do grupo de segurança" em Grupos de segurança básicos e avançados. Se IsQueryEcsCount for definido como True, o valor deste parâmetro na resposta será válido. Nota Este parâmetro está descontinuado. A quantidade retornada serve apenas como referência e pode divergir do valor real.
AvailableInstanceAmount	Integer	0	Número de endereços IP privados que ainda podem ser adicionados ao grupo de segurança. Consulte a seção "Capacidade do grupo de segurança" em Grupos de segurança básicos e avançados para detalhes. Se IsQueryEcsCount for definido como True, o valor deste parâmetro na resposta será válido. Nota Este parâmetro está descontinuado. A quantidade retornada serve apenas como referência e pode divergir do valor real.
ResourceGroupId	String	rg-bp67acfmxazb4p****	ID do grupo de recursos ao qual o grupo de segurança pertence.
ServiceManaged	Boolean	false	Indica se o usuário do grupo de segurança é um serviço do Alibaba Cloud ou um distribuidor.
ServiceID	Long	12345678910	ID do distribuidor ao qual o grupo de segurança pertence.
Tags	Array of Tag		Tags do grupo de segurança.
Tag
TagValue	String	TestValue	Valor da tag.
TagKey	String	TestKey	Chave da tag.
TotalCount	Integer	20	Total de grupos de segurança. Se `MaxResults` e `NextToken` forem especificados na solicitação, este parâmetro não será retornado.
PageNumber	Integer	1	Número da página. Nota Este parâmetro será removido futuramente. Recomendamos usar os parâmetros NextToken e MaxResults para consultas paginadas.
PageSize	Integer	10	Quantidade de entradas por página. Nota Este parâmetro será removido futuramente. Recomendamos usar os parâmetros NextToken e MaxResults para consultas paginadas.

Exemplos

Exemplos de solicitações

http(s)://ecs.aliyuncs.com/?Action=DescribeSecurityGroups
&RegionId=cn-hangzhou
&MaxResults=10
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSecurityGroupsResponse>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TotalCount>20</TotalCount>
    <RegionId>cn-hangzhou</RegionId>
    <SecurityGroups>
        <CreationTime>2021-08-31T03:12:29Z</CreationTime>
        <VpcId>vpc-bp67acfmxazb4p****</VpcId>
        <ServiceManaged>false</ServiceManaged>
        <Description>TestDescription</Description>
        <SecurityGroupId>sg-bp67acfmxazb4p****</SecurityGroupId>
        <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
        <SecurityGroupName>SGTestName</SecurityGroupName>
        <EcsCount>0</EcsCount>
        <ServiceID>12345678910</ServiceID>
        <SecurityGroupType>normal</SecurityGroupType>
        <AvailableInstanceAmount>0</AvailableInstanceAmount>
        <Tags>
            <TagValue>TestValue</TagValue>
            <TagKey>TestKey</TagKey>
        </Tags>
    </SecurityGroups>
    <NextToken>e71d8a535bd9cc11</NextToken>
</DescribeSecurityGroupsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

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.	PageNumber e PageSize não são suportados. Use NextToken e MaxResults.
400	InValidParameter.NextToken	The parameter NextToken is invalid.	Valor de NextToken inválido.
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	RegionId é obrigatório.
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	Valor de SecurityGroupType inválido.
500	InternalError	The request processing has failed due to some unknown error.	Ocorreu um erro interno. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.