DescribeHybridCloudGroups - Web Application Firewall: Central de Documentação do Alibaba Cloud

Consulta a lista de grupos de nós de nuvem híbrida adicionados ao Web Application Firewall (WAF).

Descrição da operação

Antes de chamar esta operação, certifique-se de que o recurso de nuvem híbrida esteja ativado para a instância do WAF. Chame a operação DescribeInstance para consultar os detalhes da instância. Se o parâmetro Details.HybridCloud retornado for true, o recurso de nuvem híbrida está ativado. Se não estiver ativado, faça login no console do WAF e atualize a instância para ativar o recurso de nuvem híbrida.

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-waf:DescribeHybridCloudGroups

list

*Todos os recursos.

*

acs:ResourceGroupId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância do WAF. Nota Chame a operação DescribeInstance para consultar o ID da instância atual do WAF.	waf_v3prepaid_public_cn-********w0b
ClusterId	integer	Não	O ID do cluster de nuvem híbrida.	428
GroupName `deprecated`	integer	Não	[Descontinuado] Use GroupDisplayName para consultas.	1
GroupDisplayName	string	Não	O nome do grupo de nós de nuvem híbrida a ser consultado.	testGroup
GroupType	string	Não	O tipo do grupo de nós de nuvem híbrida. Valores válidos: protect: proteção. control: gerenciamento. storage: armazenamento. controlStorage: gerenciamento e armazenamento.	protect
PageNumber	integer	Não	O número da página a ser retornado em uma consulta paginada. Valor padrão: 1, que indica que a primeira página é retornada.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor padrão: 10.	10
ClusterProxyType	string	Não	O tipo de proxy do cluster. Valores válidos: service: integração de SDK. cname: proxy reverso.	cname
RegionId	string	Não	A região onde a instância do WAF está implantada. Valores válidos: cn-hangzhou: China continental. ap-southeast-1: fora da China continental.	cn-hangzhou
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de entradas retornadas.	146
RequestId	string	O ID da solicitação, que é o identificador gerado pelo Alibaba Cloud para a solicitação.	045660E7-C4C6-5CD7-8182-7B337D95ADF4
Groups	array<object>	A coleção de grupos de nós de nuvem híbrida.
	object	As informações sobre um único nó de nuvem híbrida.
GroupName	string	O nome do grupo de nós de nuvem híbrida.	StorageGroup
RegionCodeValue	integer	O código da cidade do cluster de proteção. Nota Para obter a lista de valores de código, consulte a descrição complementar dos elementos de resposta.	0
LoadBalanceIp	string	O endereço IP de balanceamento de carga (servidor).	1.1.XX.XX
BackSourceMark	string	A marca de retorno à origem do cluster de proteção, no formato {Nome do ISP do Cluster de Proteção}-{Nome do Continente do Cluster de Proteção}-{Nome da Cidade do Cluster de Proteção}-{Identificador de Retorno à Origem do Cluster de Proteção} (opcional). Nota Para obter a lista de valores para o nome do ISP do cluster de proteção, nome do continente, nome da cidade e identificador de retorno à origem, consulte a descrição complementar dos elementos de resposta.	aliyun-asiapacific-beijing-56477821
GroupType	string	O tipo do grupo de nós de nuvem híbrida. Valores válidos: protect: proteção. control: gerenciamento. storage: armazenamento. controlStorage: gerenciamento e armazenamento.	protect
LocationId	integer	O ID do nó de proteção.	1312
Ports	string	As portas usadas pelo cluster de nuvem híbrida. O valor é uma string. Quando várias portas são usadas, elas são retornadas no formato porta1,porta2,porta3.	80,9200,20018
ContinentsValue	integer	O código do continente do cluster de proteção. Nota Para obter a lista de valores de código, consulte a descrição complementar dos elementos de resposta.	410
GroupId	integer	O ID do grupo de nós de nuvem híbrida.	123
Remark	string	As observações.	remarkTest
OperatorValue	integer	O código do ISP do cluster de proteção. Nota Para obter a lista de valores de código, consulte a descrição complementar dos elementos de resposta.	0

Códigos de ISP do cluster de proteção

Código do ISP	Tag do ISP	Descrição do ISP
0	aliyun	Alibaba Cloud
3	tencent	Tencent
100	google	Google
200	IDC	IDC

Códigos de continente do cluster de proteção

Código do Continente	Tag do Continente	Descrição do Continente
410	asiapacific	Ásia-Pacífico
411	euro	Europa

Códigos de cidade do cluster de proteção

Código do Continente	Código da Cidade	Tag da Cidade	Descrição da Cidade
411	0	frankfurt	Frankfurt
411	1	siliconvallery	Vale do Silício
411	2	Virginia	Virgínia
410	0	beijing	Pequim
410	1	shanghai	Xangai
410	2	hongkong	Hong Kong (China)
410	3	jakarta	Jacarta
410	4	hangzhou	Hangzhou
410	5	zhangjiakou	Zhangjiakou
410	6	shenzhen	Shenzhen
410	7	singapore	Singapura
410	8	Tokyo	Tóquio
410	9	changsha	Changsha
410	10	public_cloud	Nuvem Pública
410	11	nanjing	Nanjing

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 146,
  "RequestId": "045660E7-C4C6-5CD7-8182-7B337D95ADF4",
  "Groups": [
    {
      "GroupName": "StorageGroup",
      "RegionCodeValue": 0,
      "LoadBalanceIp": "1.1.XX.XX",
      "BackSourceMark": "aliyun-asiapacific-beijing-56477821",
      "GroupType": "protect",
      "LocationId": 1312,
      "Ports": "80,9200,20018",
      "ContinentsValue": 410,
      "GroupId": 123,
      "Remark": "remarkTest",
      "OperatorValue": 0
    }
  ]
}

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.