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

Consulta os detalhes das portas de instâncias de serviços em nuvem conectadas ao WAF.

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

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. Nota Você pode chamar DescribeInstance para consultar o ID da instância atual do WAF.	waf-cn-tl32ast****
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q
ResourceInstanceId	string	Sim	O ID da instância do recurso.	lb-2zeugkfj81jvo****4tqm
Port	string	Não	A porta do serviço em nuvem que está conectado ao WAF.	443
Protocol	string	Não	O tipo de protocolo. Valores válidos: http : Protocolo HTTP. https : Protocolo HTTPS.	https
PageNumber	integer	Não	O número da página da lista. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor padrão: 10.	10
ResourceProduct	string	Não	O tipo de serviço em nuvem. Valores válidos: clb4: CLB camada 4. clb7: CLB camada 7. ecs: ECS. nlb: NLB.	clb7
RegionId	string	Não	A região onde a instância do WAF reside. Valores válidos: cn-hangzhou: China continental. ap-southeast-1: fora da China continental.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	2EFCFE18-78F8-5079-B312-07***48B
TotalCount	integer	O número total de entradas retornadas.	10
AccessPortDetails	array<object>	Os detalhes das portas de instâncias de serviços em nuvem conectadas ao WAF.
	array<object>	Os detalhes das portas de instâncias de serviços em nuvem conectadas ao WAF.
Protocol	string	O tipo de protocolo. Valores válidos: http: Protocolo HTTP. https: Protocolo HTTPS.	https
Port	integer	A porta do serviço em nuvem que está conectado ao WAF.	443
Certificates	array<object>	A lista de certificados para a porta do serviço em nuvem conectada ao WAF.
	object	As informações do certificado para a porta do serviço em nuvem conectada ao WAF.
CertificateName	string	O nome do certificado.	cert-name1
CertificateId	string	O ID do certificado adicionado.	123-cn-hangzhou
AppliedType	string	O tipo de certificado para o protocolo HTTPS. Valores válidos:	default
XffHeaderMode	integer	O método que o WAF usa para obter o endereço IP de origem do cliente. Valores válidos: 0: O tráfego do cliente não passa por nenhum proxy de camada 7 antes de chegar ao WAF. 1: O WAF lê o primeiro valor no 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. 3: O WAF lê o Client IP do cabeçalho Proxy Protocol como o endereço IP do cliente.	0
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 é necessário apenas quando XffHeaderMode está definido como 2 (o WAF lê o valor de um campo de cabeçalho personalizado especificado por você como o endereço IP do cliente).
	string	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 é necessário apenas quando XffHeaderMode está definido como 2 (o WAF lê o valor de um campo de cabeçalho personalizado especificado por você como o endereço IP do cliente).	header1
LogHeaders	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. Nota Este parâmetro é retornado apenas quando o recurso de tag de tráfego está ativado para o nome de domínio.
	object	Os campos e valores de tags de tráfego do nome de domínio, usados para marcar o tráfego processado pelo WAF. Nota Este parâmetro é retornado apenas quando o recurso de tag de tráfego está ativado para o nome de domínio.
Key	string	O campo de cabeçalho de solicitação personalizado especificado.	key1
Value	string	O valor do campo de cabeçalho de solicitação personalizado especificado.	value1
Status	integer	O status do nome de domínio. Valores válidos: 1: A porta está em estado normal. 2: A porta está sendo criada. 3: A porta está sendo modificada. 4: A porta está sendo liberada.	1
TLSVersion	string	A versão do TLS. Valores válidos: tlsv1: Suporta TLS 1.0 e posterior. Maior compatibilidade, menor segurança. tlsv1.1: Suporta TLS 1.1 e posterior. Boa compatibilidade, boa segurança. tlsv1.2: Suporta TLS 1.2 e posterior. Boa compatibilidade, maior segurança. tlsv1.3: Suporta apenas TLS 1.3. Maior segurança, menor compatibilidade.	tlsv1
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. Nota Este parâmetro é usado apenas quando HttpsPorts não está vazio (o nome de domínio usa o protocolo HTTPS). Quando TLSVersion está definido como tlsv1.3, este valor deve ser true.	true
CipherSuite	integer	O tipo de conjunto de cifras. Valores válidos: 1: todos os conjuntos de cifras são adicionados. 2: conjuntos de cifras fortes são adicionados. Este valor está disponível apenas quando TLSVersion está definido como tlsv1.2. 99: conjuntos de cifras personalizados são adicionados. Este valor está disponível apenas quando TLSVersion não está definido como tlsv1.3.	1
CustomCiphers	array	Os conjuntos de cifras personalizados específicos a serem adicionados. Este parâmetro é usado apenas quando CipherSuite está definido como 99.
	string	O conjunto de cifras personalizado.	ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384
ReadTimeout	integer	O período de tempo limite de leitura, em segundos.	5
WriteTimeout	integer	O período de tempo limite de gravação, em segundos.	1
Keepalive	boolean	Indica se as conexões keep-alive estão ativadas. Valores válidos: true (padrão): As conexões keep-alive estão ativadas. false: As conexões keep-alive estão desativadas.	true
KeepaliveRequests	integer	O número de solicitações que podem reutilizar uma conexão keep-alive. Valores válidos: 60 a 1000. Nota Especifica quantas solicitações podem reutilizar uma conexão keep-alive após a ativação do keep-alive.	1000
KeepaliveTimeout	integer	O período de tempo limite de ociosidade para conexões keep-alive. Valores válidos: 10 a 3600. Valor padrão: 15. Unidade: segundos. Nota Especifica por quanto tempo uma conexão keep-alive ociosa permanece aberta antes de ser liberada.	10
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
XffProto	boolean	Especifica se o cabeçalho X-Forward-For-Proto transmite o protocolo do WAF. Valores válidos: true (padrão): O protocolo do WAF é transmitido. false: O protocolo do WAF não é transmitido.	true
OwnerUserId	string	O UID da propriedade do recurso do serviço em nuvem.	123
SubStatus	string	O status de exceção de proteção. Valores válidos: InvalidCert: certificado inválido. ClientCertOpend: a autenticação mútua está ativada. NetworkConfigLost: exceção de configuração de rede do serviço em nuvem.	InvalidCert
SubStatusDetails	array<object>	Os motivos específicos para o status de exceção de proteção. Este parâmetro tem um valor apenas quando SubStatus está definido como InvalidCert.
	object	Os motivos específicos para o status de exceção de proteção. Este parâmetro tem um valor apenas quando SubStatus está definido como InvalidCert.
CertName	string	O nome do certificado no SSL Certificates Service.	test-name
Domain	string	O nome de domínio vinculado ao certificado.	test.aliyun.com
CertId	string	O ID do certificado no SSL Certificates Service.	123-cn-hangzhou
AppliedType	string	O tipo de certificado para o protocolo HTTPS. Valores válidos:	default
ProductCertName	string	O nome do certificado armazenado no serviço em nuvem.	test-name
ProductCertId	string	O ID do certificado armazenado no serviço em nuvem.	123
CommonName	string	O nome comum (CN).	test.aliyun.com
ReasonCode	string	O motivo específico para o status de exceção de proteção. Valores válidos:	CertNotExistInCertCenter
ExpireTime	integer	A hora de expiração do certificado, no formato de timestamp UNIX. Unidade: segundos.	1746328456000
CloudResourceId	string	O ID do recurso conectado, gerado automaticamente pelo WAF.	i-bp1**************7ey-80-ecs
MaxBodySize	integer	O tamanho máximo do corpo da solicitação. Valores válidos: 2 a 10. Valor padrão: 2. Unidade: GB.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "TotalCount": 10,
  "AccessPortDetails": [
    {
      "Protocol": "https",
      "Port": 443,
      "Certificates": [
        {
          "CertificateName": "cert-name1",
          "CertificateId": "123-cn-hangzhou",
          "AppliedType": "default"
        }
      ],
      "XffHeaderMode": 0,
      "XffHeaders": [
        "header1"
      ],
      "LogHeaders": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "Status": 1,
      "TLSVersion": "tlsv1",
      "EnableTLSv3": true,
      "CipherSuite": 1,
      "CustomCiphers": [
        "ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384"
      ],
      "ReadTimeout": 5,
      "WriteTimeout": 1,
      "Keepalive": true,
      "KeepaliveRequests": 1000,
      "KeepaliveTimeout": 10,
      "Http2Enabled": true,
      "XffProto": true,
      "OwnerUserId": "123",
      "SubStatus": "InvalidCert",
      "SubStatusDetails": [
        {
          "CertName": "test-name",
          "Domain": "test.aliyun.com",
          "CertId": "123-cn-hangzhou",
          "AppliedType": "default",
          "ProductCertName": "test-name",
          "ProductCertId": "123",
          "CommonName": "test.aliyun.com",
          "ReasonCode": "CertNotExistInCertCenter",
          "ExpireTime": 1746328456000
        }
      ],
      "CloudResourceId": "i-bp1**************7ey-80-ecs",
      "MaxBodySize": 2
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Waf.Instance.ValidFaild	WAF instance check failed. Check whether the instance ID is correct.	A verificação da instância WAF falhou. Verifique se o ID da instância está correto.
400	Waf.Pullin.CloudProductParamEmpty	The resource Id of the cloud product accessing WAF is null or null values exist in the three input parameters of the cloud product name, port, and cloud product instance.	O ID do recurso para conexão em modo nativo da nuvem ao WAF está vazio, ou um dos seguintes parâmetros está vazio: nome do serviço em nuvem, porta ou instância do serviço em nuvem.
400	Waf.Pullin.CloudResourceInvalid	CloudResourceId parameter is illegal.	O parâmetro CloudResourceId é inválido.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.