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

Consulta a lista de ativos de serviço em nuvem sincronizados.

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

get

*All Resource

*

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. Nota Você pode chamar a operação DescribeInstance para consultar o ID da instância WAF atual.	waf_v3prepaid_public_cn-zxu****9d02
ResourceInstanceId	string	Não	O ID da instância do serviço em nuvem.	lb-2zeugkfj81jvo****4tqm
ResourceName `deprecated`	string	Não	O nome da instância do serviço em nuvem.	exampleResourceName
ResourceRegionId	string	Não	O ID da região do serviço em nuvem. Valores válidos: cn-chengdu: China Southwest 1 (Chengdu). cn-beijing: China North 2 (Pequim). cn-zhangjiakou: China North 3 (Zhangjiakou). cn-hangzhou: China East 1 (Hangzhou). cn-shanghai: China East 2 (Xangai). cn-shenzhen: China South 1 (Shenzhen). cn-qingdao: China North 1 (Qingdao). cn-hongkong: Hong Kong (China). ap-southeast-3: Malásia (Kuala Lumpur). ap-southeast-5: Indonésia (Jacarta).	cn-hangzhou
ResourceProduct	string	Não	O tipo do serviço em nuvem. Valores válidos: clb4: CLB camada 4. clb7: CLB camada 7. ecs: ECS. nlb: NLB. ddos: Anti-DDoS.	clb7
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 durante a paginação. Valor padrão: 10.	10
ResourceIp `deprecated`	string	Não	O endereço IP público do serviço em nuvem.	1.X.X.1
OwnerUserId	string	Não	O UID do usuário proprietário do recurso.	1704********9107
ResourceInstanceIp	string	Não	O endereço IP da instância adicionada ao WAF.	1.X.X.1
ResourceInstanceName	string	Não	O nome da instância adicionada ao WAF.	demoInstanceName
ResourceInstanceAccessStatus	string	Não	O status de proteção do WAF. Valores válidos: all : Proteção total. part : Proteção parcial. non : Não protegido. any : Protegido.	all
RegionId	string	Não	A região onde a instância WAF reside. 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-aekz6ql****5uzi
ResourceDomain	string	Não	O nome de domínio adicionado ao WAF. Nota Este parâmetro é suportado apenas quando o tipo de serviço em nuvem é ddos.	www.c**sw.net

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	FDCBAE1E-2B3F-5C13-AD20-844B9473****
TotalCount	integer	O número total de entradas retornadas.	100
ProductInstances	array<object>	A lista de informações do serviço em nuvem.
	array<object>	As informações do serviço em nuvem.
ResourceInstanceId	string	O ID da instância do serviço em nuvem.	i-2ze1tm4pvghp****cluv
ResourceName `deprecated`	string	O nome da instância do serviço em nuvem.	ecs-test
ResourceRegionId	string	O ID da região do serviço em nuvem. Valores válidos: cn-chengdu: China Southwest 1 (Chengdu). cn-beijing: China North 2 (Pequim). cn-zhangjiakou: China North 3 (Zhangjiakou). cn-hangzhou: China East 1 (Hangzhou). cn-shanghai: China East 2 (Xangai). cn-shenzhen: China South 1 (Shenzhen). cn-qingdao: China North 1 (Qingdao). cn-hongkong: Hong Kong (China). ap-southeast-3: Malásia (Kuala Lumpur). ap-southeast-5: Indonésia (Jacarta).	cn-beijing
ResourceProduct	string	O tipo do serviço em nuvem. Valores válidos: clb4: CLB camada 4. clb7: CLB camada 7. ecs: ECS. nlb: NLB.	clb4
ResourcePorts	array<object>	A lista de informações de porta.
	array<object>	As informações da porta.
Port	integer	A porta.	443
Protocol	string	O tipo de protocolo de rede. Valores válidos: http: HTTP. https: HTTPS.	https
Certificates	array<object>	A lista de informações de certificado.
	object	As informações do certificado.
CertificateName	string	O nome do certificado SSL.	demoCertName
CertificateId	string	O ID do certificado.	1234567
Domain	string	O nome de domínio vinculado ao certificado.	www.test.com
AppliedType	string	O tipo de certificado para o protocolo HTTPS. Valores válidos: default: Certificado padrão. extension: Certificado de extensão.	default
ResourceIp `deprecated`	string	O endereço IP público do serviço em nuvem.	1.X.X.1
OwnerUserId	string	O UID do usuário proprietário do recurso.	1704********9107
ResourceInstanceIp	string	O endereço IP da instância do serviço em nuvem.	1.X.X.1
ResourceInstanceName	string	O nome da instância do serviço em nuvem.	demoInstanceName
AccessPorts	array	A lista de portas adicionadas ao WAF.
	integer	A porta adicionada ao WAF.	80
ResourceInstanceAccessStatus	string	O status de proteção do WAF. Valores válidos: all: Proteção total. any: Protegido. part: Proteção parcial. non: Não protegido.	all
AccessPortAndProtocols	array<object>	As informações de porta e protocolo do serviço em nuvem adicionado ao WAF.
	object	As informações de porta e protocolo do serviço em nuvem adicionado ao WAF.
Port	integer	A porta do serviço em nuvem adicionado ao WAF.	443
Protocol	string	O tipo de protocolo. Valores válidos: http: HTTP. https: HTTPS.	http
CertificateIds	array	A lista de IDs de certificados.
	string	O ID do certificado.	5379758
AccessInstanceId	string	O ID da instância adicionada ao WAF.	i-2ze1tm4pvghp****cluv
ResourceInstanceEdition	string	A edição da instância do serviço em nuvem.	ecs.e-c1m1.large
ResourceDomain	string	O nome de domínio adicionado ao WAF.	www.c**sw.net

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "FDCBAE1E-2B3F-5C13-AD20-844B9473****",
  "TotalCount": 100,
  "ProductInstances": [
    {
      "ResourceInstanceId": "i-2ze1tm4pvghp****cluv",
      "ResourceName": "ecs-test",
      "ResourceRegionId": "cn-beijing",
      "ResourceProduct": "clb4",
      "ResourcePorts": [
        {
          "Port": 443,
          "Protocol": "https",
          "Certificates": [
            {
              "CertificateName": "demoCertName",
              "CertificateId": "1234567",
              "Domain": "www.test.com",
              "AppliedType": "default"
            }
          ]
        }
      ],
      "ResourceIp": "1.X.X.1",
      "OwnerUserId": "1704********9107",
      "ResourceInstanceIp": "1.X.X.1",
      "ResourceInstanceName": "demoInstanceName",
      "AccessPorts": [
        80
      ],
      "ResourceInstanceAccessStatus": "all",
      "AccessPortAndProtocols": [
        {
          "Port": 443,
          "Protocol": "http",
          "CertificateIds": [
            "5379758"
          ]
        }
      ],
      "AccessInstanceId": "i-2ze1tm4pvghp****cluv\n",
      "ResourceInstanceEdition": "ecs.e-c1m1.large",
      "ResourceDomain": "www.c**sw.net"
    }
  ]
}

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.