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

Consulta os detalhes de um nome 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:DescribeHybridCloudResourceDetail

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 WAF.	waf-cn-0xldbqt****
Domain	string	Sim	O nome do domínio.	www.*****.com
Backend	string	Não	O endereço de back-to-origin.	1.1.XX.XX
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página.	10
CnameEnabled	boolean	Não	Especifica se a recuperação de desastres em nuvem pública deve ser ativada. Valores válidos:	true
RegionId	string	Não	A região onde a instância WAF reside. Valores válidos:	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
RequestId	string	O ID da solicitação.	66A98669-CC6E-4F3E-80A6-3014697B11AE
Domain	object	As informações do nome de domínio.
Status	integer	O status do recurso.	1
ResourceManagerResourceGroupId	string	O ID do grupo de recursos.	rg-***aby
Uid	string	O ID do usuário.	1046011128270720
Listen	object	As informações de escuta.
HttpsPorts	array	As portas para o protocolo HTTPS.
	integer	As portas para o protocolo HTTPS.	443
ProtectionResource	string	O tipo de recurso de proteção a ser usado. Valores válidos: share: cluster compartilhado. gslb: cluster compartilhado com balanceamento de carga inteligente.	share
CustomCiphers	array	Os conjuntos de cifras personalizados.
	string	Os conjuntos de cifras personalizados.	ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384
TLSVersion	string	A versão do TLS. Valores válidos: tlsv1 tlsv1.1 tlsv1.2	tlsv1
Http2Enabled	boolean	Indica se o HTTP/2 está ativado. Valores válidos: true: O HTTP/2 está ativado. false: O HTTP/2 está desativado.	true
CertId	string	O ID do certificado.	19312542-cn-hangzhou
CipherSuite	integer	O tipo de conjunto de cifras. Valores válidos: 1: todos os conjuntos de cifras. 2: conjuntos de cifras fortes. 99: conjuntos de cifras personalizados.	0
EnableTLSv3	boolean	Indica se o TLS 1.3 é suportado. Valores válidos: true: O TLS 1.3 é suportado. false: O TLS 1.3 não é suportado.	true
IPv6Enabled	boolean	Indica se o IPv6 está ativado. Valores válidos: true: O IPv6 está ativado. false: O IPv6 está desativado.	true
FocusHttps	boolean	Indica se o redirecionamento forçado para HTTPS está ativado. Valores válidos: true: O redirecionamento forçado para HTTPS está ativado. false: O redirecionamento forçado para HTTPS está desativado.	true
XffHeaders	array	Os campos de cabeçalho personalizados usados para obter o endereço IP do cliente, no formato ["header1","header2",……]. Nota Este parâmetro é necessário 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	Os campos de cabeçalho personalizados usados para obter o endereço IP do cliente, no formato ["header1","header2",……]. Nota Este parâmetro é necessário 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.	["test"]
XffHeaderMode	integer	O método que o WAF usa para obter o endereço IP real 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.	1
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 disponíveis para o protocolo HTTP. O valor é uma string. Quando várias portas estão disponíveis, elas são retornadas no formato porta1,porta2,porta3.
	integer	A lista de portas disponíveis para o protocolo HTTP. O valor é uma string. Quando várias portas estão disponíveis, elas são retornadas no formato porta1,porta2,porta3.	80
Id	integer	O ID de acesso.	31323
Redirect	object	As regras para retornar valores de cabeçalho de resposta.
ConnectTimeout	integer	O período de tempo limite de conexão. Unidade: milissegundos.	1
Keepalive	boolean	Indica se as conexões persistentes estão ativadas. Valores válidos: true (padrão): As conexões persistentes estão ativadas. false: As conexões persistentes estão desativadas.	true
SniEnabled	boolean	Indica se o Server Name Indication (SNI) de back-to-origin está ativado. Valores válidos: true: O SNI de back-to-origin está ativado. false: O SNI de back-to-origin está desativado.	true
CnameEnabled	boolean	Especifica se a recuperação de desastres em nuvem pública deve ser ativada. Valores válidos: true: A recuperação de desastres em nuvem pública está ativada. false: A recuperação de desastres em nuvem pública está desativada.	true
KeepaliveTimeout	integer	O período de tempo limite ocioso das conexões persistentes.	1
ReadTimeout	integer	O período de tempo limite de leitura da solicitação.	1
Backends	array	O endereço IP do servidor de origem ou o nome de domínio usado para back-to-origin.
	string	O endereço IP do servidor de origem ou o nome de domínio usado para back-to-origin.	1.1.1.1
SniHost	string	O valor personalizado do campo de extensão SNI. Se o valor estiver vazio, o valor SNI não será personalizado e o valor do campo Host no cabeçalho da solicitação será usado como o valor do campo de extensão SNI por padrão. Nota Este parâmetro é retornado apenas quando SniStatus está definido como 1, o que indica que o SNI de back-to-origin está ativado.	eew111
FocusHttpBackend	boolean	Indica se o back-to-origin forçado para HTTP está ativado. Valores válidos: true: O back-to-origin forçado para HTTP está ativado. false: O back-to-origin forçado para HTTP está desativado.	true
WriteTimeout	integer	O período de tempo limite de gravação. Unidade: milissegundos.	1
RoutingRules	string	As regras de encaminhamento de nuvem híbrida, expressas como uma string convertida de um array JSON. Cada elemento no array JSON é uma estrutura que contém o seguinte campo: rs: Tipo array.	[{\"backupRs\":[],\"location\":\"v3-test\",\"locationId\":1148,\"rs\":[\"39.98.217.197\",\"2.2.2.2\"]}]
Retry	boolean	Indica se o WAF tenta novamente quando o back-to-origin falha. Valores válidos: true: O WAF tenta novamente. false: O WAF não tenta novamente.	true
RequestHeaders	array<object>	Os cabeçalhos de solicitação HTTP.
	object	O campo de cabeçalho de solicitação personalizado especificado.
Value	string	O valor.	9506360478730
Key	string	A chave da tag.	L2x1ZmZ5L2NvcmUvYXBwcy9tLnl1bmR1bi53YWYuMS9wbHVnaW5z
KeepaliveRequests	integer	O número de solicitações que reutilizam conexões persistentes. Valores válidos: 60 a 1000. Nota Isso especifica quantas conexões persistentes são 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 de hash de IP. roundRobin: algoritmo round-robin. leastTime: algoritmo de back-to-origin de menor tempo.	iphash
ProxyProtocol	boolean	Indica se o recurso de preservação do IP de origem do cliente está ativado. true: O recurso de preservação do IP de origem do cliente está ativado. Após a ativação desse recurso, o serviço de backend pode visualizar o endereço IP de origem do cliente. false: O recurso de preservação do IP de origem do cliente está desativado.	false
BackendPorts	array<object>	A configuração de porta personalizada. Por padrão, é igual à porta de escuta.
	object	A configuração de porta personalizada. Por padrão, é igual à porta de escuta.
ListenPort	integer	A porta de escuta.	80
BackendPort	integer	A porta de back-to-origin.	80
Protocol	string	O tipo de protocolo da porta de escuta. Valores válidos: http: protocolo HTTP. https: protocolo HTTPS.	http
Domain	string	O nome do domínio.	www.*****.com
Cname	string	O CNAME atribuído pelo WAF ao nome de domínio.	kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "Domain": {
    "Status": 1,
    "ResourceManagerResourceGroupId": "rg-***aby",
    "Uid": "1046011128270720",
    "Listen": {
      "HttpsPorts": [
        443
      ],
      "ProtectionResource": "share",
      "CustomCiphers": [
        "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384"
      ],
      "TLSVersion": "tlsv1",
      "Http2Enabled": true,
      "CertId": "19312542-cn-hangzhou",
      "CipherSuite": 0,
      "EnableTLSv3": true,
      "IPv6Enabled": true,
      "FocusHttps": true,
      "XffHeaders": [
        "[\"test\"]"
      ],
      "XffHeaderMode": 1,
      "ExclusiveIp": true,
      "HttpPorts": [
        80
      ]
    },
    "Id": 31323,
    "Redirect": {
      "ConnectTimeout": 1,
      "Keepalive": true,
      "SniEnabled": true,
      "CnameEnabled": true,
      "KeepaliveTimeout": 1,
      "ReadTimeout": 1,
      "Backends": [
        "1.1.1.1"
      ],
      "SniHost": "eew111",
      "FocusHttpBackend": true,
      "WriteTimeout": 1,
      "RoutingRules": "[{\\\"backupRs\\\":[],\\\"location\\\":\\\"v3-test\\\",\\\"locationId\\\":1148,\\\"rs\\\":[\\\"39.98.217.197\\\",\\\"2.2.2.2\\\"]}]",
      "Retry": true,
      "RequestHeaders": [
        {
          "Value": "9506360478730",
          "Key": "L2x1ZmZ5L2NvcmUvYXBwcy9tLnl1bmR1bi53YWYuMS9wbHVnaW5z"
        }
      ],
      "KeepaliveRequests": 1000,
      "Loadbalance": "iphash",
      "ProxyProtocol": false,
      "BackendPorts": [
        {
          "ListenPort": 80,
          "BackendPort": 80,
          "Protocol": "http"
        }
      ]
    },
    "Domain": "www.*****.com",
    "Cname": "kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com"
  }
}

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.