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

Consulta a lista de nomes de domínio 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:DescribeHybridCloudResources

get

*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.	waf_v3prepaid_public_cn-***********
Domain	string	Não	O nome de domínio a ser consultado.	www.aliyundoc.com
Backend	string	Não	O endereço IP ou nome de domínio do servidor de origem que corresponde ao nome de domínio.	1.1.XX.XX
PageNumber	integer	Não	O número da página a ser retornado em uma consulta paginada. Valor padrão: 1, que indica a primeira página.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor padrão: 10, que indica 10 entradas por página.	10
CnameEnabled	boolean	Não	Especifica se a recuperação de desastres em nuvem pública está ativada. Valores válidos:	true
RegionId	string	Não	A região onde a instância do WAF reside. Valores válidos:	cn-hangzhou
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfmvtc5z52****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Domains	array<object>	A lista de nomes de domínio retornados.
	array<object>	Os detalhes da configuração do site.
Status	integer	O status do nome de domínio. Valores válidos:	1
ResourceManagerResourceGroupId	string	O ID do grupo de recursos do Alibaba Cloud.	rg-acfmvtc5z52****
Uid	string	O ID do usuário.	130715431409****
Listen	object	A configuração de escuta.
HttpsPorts	array	A lista de portas HTTPS.
	integer	A porta HTTPS.	443
ProtectionResource	string	O tipo de recurso de proteção a ser usado. Valores válidos: share: cluster compartilhado. gslb: balanceamento de carga inteligente do cluster compartilhado.	share
CustomCiphers	array	As suítes de criptografia personalizadas específicas a serem adicionadas. Nota Este parâmetro é retornado apenas quando CipherSuite está definido como 99.
	string	A suíte de criptografia personalizada.	ECDHE-ECDSA-AES128-GCM-SHA256
TLSVersion	string	A versão do TLS. Valores válidos: tlsv1 tlsv1.1 tlsv1.2	tlsv1.2
Http2Enabled	boolean	Indica se o HTTP/2 está ativado. Valores válidos: true: Ativado. false: Desativado.	false
CertId	string	O ID do certificado.	72***76-cn-hangzhou
CipherSuite	integer	O tipo de suíte de criptografia. Valores válidos: 1: todas as suítes de criptografia. 2: suítes de criptografia fortes. 99: suítes de criptografia personalizadas.	1
EnableTLSv3	boolean	Indica se o TLS 1.3 é suportado. Valores válidos: true: Suportado. false: Não suportado.	true
IPv6Enabled	boolean	Indica se o IPv6 está ativado. Valores válidos: true: Ativado. false: Desativado.	false
FocusHttps	boolean	Indica se o redirecionamento forçado de HTTPS está ativado. Valores válidos: true: Ativado. false: Desativado.	false
XffHeaders	array	A lista de campos de cabeçalho personalizados usados para obter o endereço IP do cliente, no formato ["header1","header2",...]. Nota Este parâmetro é retornado apenas quando XffHeaderMode está definido como 2, o que indica que o WAF lê o valor de um campo de cabeçalho personalizado especificado por você no cabeçalho da solicitação como o endereço IP do cliente.
	string	O campo de cabeçalho personalizado usado para obter o endereço IP do cliente.	Client-ip
XffHeaderMode	integer	O método que o WAF usa para obter o endereço IP de origem do cliente. Valores válidos: 0: Nenhum proxy de camada 7 está implantado na frente do WAF. 1: O WAF lê o primeiro valor do campo de cabeçalho X-Forwarded-For (XFF) como o endereço IP do cliente. 2: O WAF lê o valor de um campo de cabeçalho personalizado especificado por você como o endereço IP do cliente.	0
ExclusiveIp	boolean	Indica se um endereço IP exclusivo é suportado. Valores válidos: true: Suportado. false: Não suportado.	true
HttpPorts	array	A lista de portas de escuta HTTP.
	integer	A porta de escuta HTTP.	80
Id	integer	O ID de acesso.	12345
Redirect	object	A configuração de encaminhamento.
ConnectTimeout	integer	O período de tempo limite de conexão. Unidade: segundos. Valores válidos: 5 a 120.	120
Keepalive	boolean	Indica se as conexões persistentes estão ativadas. Valores válidos: true: Ativado. false: Desativado.	true
SniEnabled	boolean	Indica se a Server Name Indication (SNI) de back-to-origin está ativada. Valores válidos: true: Ativado. false: Desativado.	true
CnameEnabled	boolean	Especifica se a recuperação de desastres em nuvem pública deve ser ativada. Valores válidos: true: Ativado. false: Desativado.	true
KeepaliveTimeout	integer	O período de tempo limite ocioso para conexões persistentes. Valores válidos: 1 a 60. Valor padrão: 15. Unidade: segundos. Nota Especifica por quanto tempo uma conexão persistente reutilizada e ociosa é mantida antes de ser liberada.	15
ReadTimeout	integer	O período de tempo limite de leitura. Unidade: segundos. Valores válidos: 5 a 1800.	200
Backends	array	O endereço IP ou nome de domínio do servidor de origem que corresponde ao nome de domínio.
	string	O endereço IP ou nome de domínio do servidor de origem que corresponde ao nome de domínio.	1.1.XX.XX
SniHost	string	O valor personalizado do campo de extensão SNI. Um valor vazio indica que nenhum valor SNI personalizado foi definido. Por padrão, o valor do campo Host no cabeçalho da solicitação é usado como o valor do campo de extensão SNI. Nota Este parâmetro é retornado apenas quando SniEnabled está definido como true, o que indica que a SNI de back-to-origin está ativada.	www.aliyundoc.com
FocusHttpBackend	boolean	Indica se o back-to-origin forçado via HTTP está ativado. Valores válidos: true: Ativado. false: Desativado.	true
WriteTimeout	integer	O período de tempo limite de gravação. Unidade: segundos. Valores válidos: 5 a 1800.	200
RoutingRules	string	As regras de encaminhamento de nuvem híbrida, representadas como uma string convertida de um array JSON. Cada elemento no array JSON é uma estrutura que contém os seguintes campos: rs: Tipo array. A lista de endereços IP de back-to-origin ou CNAMEs de back-to-origin. location: Tipo string. O nome do nó de proteção. locationId: Tipo long. O ID do nó de proteção.	[ { "rs": [ "1.1.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Retry	boolean	Indica se o WAF tenta novamente quando o back-to-origin falha. Valores válidos: true: Tenta novamente. false: Não tenta novamente.	true
RequestHeaders	array<object>	Os campos e valores de tags de tráfego do nome de domínio, usados para marcar o tráfego processado pelo WAF.
	object	Os campos e valores de tags de tráfego do nome de domínio, usados para marcar o tráfego processado pelo WAF.
Value	string	O valor do campo de cabeçalho de solicitação personalizado especificado.	bbb
Key	string	O campo de cabeçalho de solicitação personalizado especificado.	aaa
KeepaliveRequests	integer	O número de solicitações que reutilizam conexões persistentes. Valores válidos: 60 a 1000. Nota O número de conexões persistentes a serem reutilizadas após a ativação das conexões persistentes.	1000
Loadbalance	string	O algoritmo de balanceamento de carga usado para back-to-origin. Valores válidos: iphash: Algoritmo IP Hash. roundRobin: Algoritmo round-robin. leastTime: Algoritmo Least Time.	iphash
Domain	string	O nome de domínio.	www.aliyundoc.com
Cname	string	O CNAME atribuído pelo WAF ao nome de domínio.	50fqmu1ci7g0xtiyxnrhgx6qdhmn****.yundunwaf5.com
TotalCount	integer	O número total de entradas retornadas.	24
RequestId	string	O ID da solicitação.	98D2AA9A-5959-5CCD-83E3-B6606232A2BE

Exemplos

Resposta de sucesso

JSON formato

{
  "Domains": [
    {
      "Status": 1,
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
      "Uid": "130715431409****",
      "Listen": {
        "HttpsPorts": [
          443
        ],
        "ProtectionResource": "share",
        "CustomCiphers": [
          "ECDHE-ECDSA-AES128-GCM-SHA256"
        ],
        "TLSVersion": "tlsv1.2",
        "Http2Enabled": false,
        "CertId": "72***76-cn-hangzhou",
        "CipherSuite": 1,
        "EnableTLSv3": true,
        "IPv6Enabled": false,
        "FocusHttps": false,
        "XffHeaders": [
          "Client-ip"
        ],
        "XffHeaderMode": 0,
        "ExclusiveIp": true,
        "HttpPorts": [
          80
        ]
      },
      "Id": 12345,
      "Redirect": {
        "ConnectTimeout": 120,
        "Keepalive": true,
        "SniEnabled": true,
        "CnameEnabled": true,
        "KeepaliveTimeout": 15,
        "ReadTimeout": 200,
        "Backends": [
          "1.1.XX.XX"
        ],
        "SniHost": "www.aliyundoc.com",
        "FocusHttpBackend": true,
        "WriteTimeout": 200,
        "RoutingRules": "[\n      {\n            \"rs\": [\n                  \"1.1.XX.XX\"\n            ],\n            \"locationId\": 535,\n            \"location\": \"test1111\"\n      }\n]",
        "Retry": true,
        "RequestHeaders": [
          {
            "Value": "bbb",
            "Key": "aaa"
          }
        ],
        "KeepaliveRequests": 1000,
        "Loadbalance": "iphash"
      },
      "Domain": "www.aliyundoc.com",
      "Cname": "50fqmu1ci7g0xtiyxnrhgx6qdhmn****.yundunwaf5.com"
    }
  ],
  "TotalCount": 24,
  "RequestId": "98D2AA9A-5959-5CCD-83E3-B6606232A2BE"
}

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.