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

Observações de uso

Obtenha informações sobre a instância do WAF, como ID, versão, status e data de expiração.

Limites

Esta operação tem limite de 50 chamadas por segundo por conta. Exceder esse limite aciona o throttling e pode afetar seu serviço.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeInstanceInfo	A operação a ser executada. Defina o valor como DescribeInstanceInfo.
InstanceId	String	Não	waf-cn-tl32ast\\\\	O ID da instância do WAF. Se você omitir este parâmetro, a operação retornará todas as instâncias do WAF na China continental ou fora dela.
ResourceGroupId	String	Não	rg-atstuj3rtop\\\\	O ID do grupo de recursos ao qual a instância do WAF pertence no Resource Management. Caso omita este parâmetro, o sistema usará o grupo de recursos padrão.

Para parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	D7861F61-5B61-46CE-A47C-6B19160D5EB0	O ID da solicitação.
InstanceInfo	Object		Os detalhes da instância do WAF.
InstanceInfo.PayType	Integer	1	O status de ativação do WAF. Valores válidos: 0: Nenhuma instância do WAF adquirida na conta Alibaba Cloud. 1: Instância do WAF por assinatura adquirida na conta Alibaba Cloud.
InstanceInfo.InstanceId	String	waf-cn-tl32ast\\\\	O ID da instância do WAF. Nota Não retornado se PayType for 0.
InstanceInfo.Version	String	version_pro_chinaversion_pro_china	A edição da instância do WAF. Nota Não retornado se PayType for 0. Valores válidos para contas criadas no site Internacional: version_pro_china: Instância WAF Pro na China continental. version_business_china: Instância WAF Business na China continental. version_enterprise_china: Instância WAF Enterprise na China continental. version_exclusive_china: Instância WAF Exclusive na China continental. version_hybrid_cloud_standard_china: Instância Hybrid Cloud WAF na China continental. version_pro_china: Instância WAF Pro fora da China continental. version_business: Instância WAF Business fora da China continental. version_enterprise: Instância WAF Enterprise fora da China continental. version_exclusive: Instância WAF Exclusive fora da China continental. version_hybrid_cloud_standard: Instância Hybrid Cloud WAF fora da China continental. Se o valor retornado não estiver nesta lista, verifique se sua conta foi criada no site Internacional. A lista anterior contém todas as edições de instâncias do WAF em contas criadas no site Internacional. Se a versão retornada não estiver na lista, verifique se sua conta foi criada no site Internacional. version_pro_china: uma instância WAF Pro na China continental version_business_china: uma instância WAF Business na China continental version_enterprise_china: uma instância WAF Enterprise na China continental version_exclusive_china: uma instância WAF Exclusive na China continental version_hybrid_cloud_standard_china: uma instância Hybrid Cloud WAF na China continental version_pro_china: uma instância WAF Pro fora da China continental version_business: uma instância WAF Business fora da China continental version_enterprise: uma instância WAF Enterprise fora da China continental version_exclusive: uma instância WAF Exclusive fora da China continental version_hybrid_cloud_standard: uma instância Hybrid Cloud WAF fora da China continental
InstanceInfo.Status	Integer	1	Indica se a instância do WAF expirou. Nota Não retornado se PayType for 0. Valores válidos: 0: A instância expirou. 1: A instância não expirou.
InstanceInfo.EndDate	Long	1512921600	A data de expiração da instância do WAF, expressa como timestamp UNIX em segundos. Nota Não retornado se PayType for 0.
InstanceInfo.Region	String	cn	A região da instância do WAF. Nota Não retornado se PayType for 0. Valores válidos: cn: China continental. cn-hongkong: Fora da China continental.
InstanceInfo.InDebt	Integer	1	Indica se a instância do WAF tem pagamentos pendentes. Nota Não retornado se PayType for 0. Valores válidos: 0: A instância tem pagamentos pendentes. 1: A instância não tem pagamentos pendentes.
InstanceInfo.SubscriptionType	String	Subscription	O método de faturamento da instância do WAF. O valor é fixo como Subscription. Nota Não retornado se PayType for 0. O método de faturamento da instância do WAF: O valor é fixo como Subscription.
InstanceInfo.Trial	Integer	1	Indica se há uma instância de teste gratuito do WAF ativada na conta Alibaba Cloud. Valores válidos: 0: Não. 1: Sim. Nota Retornado apenas se houver uma instância de teste gratuito do WAF ativada.
InstanceInfo.RemainDay	Integer	1	O número de dias restantes até o término do período de teste gratuito. Nota Retornado apenas se Trial for 1.

Exemplos

Solicitação de exemplo

http(s)://[Endpoint]/?Action=DescribeInstanceInfo
&<Common request parameters>

Resposta de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceInfoResponse>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
    <InstanceInfo>
        <Status>1</Status>
        <EndDate>1512921600</EndDate>
        <Version>version_3</Version>
        <Region>cn</Region>
        <PayType>1</PayType>
        <InDebt>1</InDebt>
        <InstanceId>waf-cn-tl32ast****</InstanceId>
        <SubscriptionType>Subscription</SubscriptionType>
    </InstanceInfo>
</DescribeInstanceInfoResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "InstanceInfo" : {
    "Status" : 1,
    "EndDate" : 1512921600,
    "Version" : "version_3",
    "Region" : "cn",
    "PayType" : 1,
    "InDebt" : 1,
    "InstanceId" : "waf-cn-tl32ast****",
    "SubscriptionType" : "Subscription"
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.