DescribeHaVips - : Central de Documentação do Alibaba Cloud

Depuração

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeHaVips	A operação a ser executada. Defina o valor como DescribeHaVips.
RegionId	String	Sim	cn-hangzhou	O ID da região à qual o HAVIP pertence. Chame a operação DescribeRegions para consultar a lista mais recente de regiões.
PageNumber	Integer	Não	1	O número da página a retornar. Valor padrão: 1.
PageSize	Integer	Não	10	O número de entradas a retornar por página. Valor máximo: 50. Valor padrão: 10.
Filter.N.Key	String	Não	HaVipId	As chaves de filtro. Especifique até cinco chaves. Valores válidos de N: 1 a 5. Chaves de filtro compatíveis: VpcId: ID da Virtual Private Cloud (VPC) VSwitchId: ID do vSwitch Status: status do endereço IP virtual de alta disponibilidade (HAVIP) HaVipId: ID do HAVIP HaVipAddress: endereço ip do HAVIP Especifique vários valores para cada chave de filtro. O operador lógico entre múltiplos valores é OR. A correspondência de um único valor valida a chave de filtro. O operador lógico entre múltiplas chaves de filtro é AND. A consulta retorna HAVIPs apenas se todas as chaves de filtro corresponderem.
Filter.N.Value.N	String	Não	Active	Os valores de filtro para as chaves. Especifique vários valores para uma única chave. O operador lógico entre os valores é OR. A correspondência de um único valor valida a chave de filtro.
ResourceGroupId	String	Não	rg-bp67acfmxazb4ph****	O ID do grupo de recursos ao qual o HAVIP pertence.
Tags.N.Key	String	Não	FinanceDept	A chave da tag N a adicionar ao recurso. Especifique até 20 chaves de tag. A chave não pode ser uma string vazia. A chave da tag aceita no máximo 128 caracteres. Não pode começar com `aliyun` ou `acs:`, nem conter `http://` ou `https://`.
Tags.N.Value	String	Não	FinanceJoshua	O valor da tag N a adicionar ao recurso. Especifique até 20 valores de tag. O valor pode ser uma string vazia. O valor da tag aceita até 128 caracteres e não pode começar com `acs:` ou `aliyun`. Também não pode conter `http://` ou `https://`.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	10	O número de entradas por página.
RequestId	String	33E480C5-B46F-4CA5-B6FD-D77C746E86AB	O ID da solicitação.
PageNumber	Integer	1	O número da página retornada.
TotalCount	Integer	1	O número total de entradas retornadas.
HaVips	Array of HaVip		Os detalhes do HAVIP.
HaVip
VpcId	String	vpc-bp1kcm36tevkpms97****	O ID da VPC à qual o HAVIP pertence.
Status	String	Available	O status do HAVIP. Valores válidos: Creating Available Deleting
HaVipId	String	havip-bp149uyvut73dpld****	O ID do HAVIP.
AssociatedInstanceType	String	EcsInstance	O tipo de instância associada ao HAVIP. Valores válidos: EcsInstance: instância do Elastic Compute Service (ECS) NetworkInterface: elastic network interface (ENI)
CreateTime	String	2021-07-03T14:25:26Z	A hora de criação do HAVIP.
ChargeType	String	none	Parâmetro inválido. Nenhum valor retornado.
RegionId	String	cn-hangzhou	O ID da região à qual o HAVIP pertence.
VSwitchId	String	vsw-bp1pkt1fba8e824ez****	O ID do vSwitch ao qual o HAVIP pertence.
IpAddress	String	192.168.24.5	O endereço ip privado do HAVIP.
Description	String	My HaVip	A descrição do HAVIP.
MasterInstanceId	String	i-bp145q7glnuzdvz****	O ID da instância ativa associada ao HAVIP.
Name	String	test	O nome do HAVIP.
AssociatedEipAddresses	Array of String	121.12.XX.XX	O Elastic IP Address (EIP) associado ao HAVIP.
AssociatedInstances	Array of String	i-bp145q7glnuzdvzu21****	O ID da instância associada ao HAVIP.
ResourceGroupId	String	rg-bp67acfmxazb4ph****	O ID do grupo de recursos ao qual o HAVIP pertence.
Tags	Array of Tag		A lista de tags.
Tag
Key	String	FinanceDept	A chave da tag N.
Value	String	FinanceJoshua	O valor da tag N.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeHaVips
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&Filter=[{"Key":"HaVipId","Value":["Active"]}]
&ResourceGroupId=rg-bp67acfmxazb4ph****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

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

<DescribeHaVipsResponse>
    <PageSize>10</PageSize>
    <RequestId>33E480C5-B46F-4CA5-B6FD-D77C746E86AB</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <HaVips>
        <VpcId>vpc-bp1kcm36tevkpms97****</VpcId>
        <Status>Available</Status>
        <HaVipId>havip-bp149uyvut73dpld****</HaVipId>
        <AssociatedInstanceType>EcsInstance</AssociatedInstanceType>
        <CreateTime>2021-07-03T14:25:26Z</CreateTime>
        <ChargeType>none</ChargeType>
        <RegionId>cn-hangzhou</RegionId>
        <VSwitchId>vsw-bp1pkt1fba8e824ez****</VSwitchId>
        <IpAddress>192.168.24.5</IpAddress>
        <Description>My HaVip</Description>
        <MasterInstanceId>i-bp145q7glnuzdvz****</MasterInstanceId>
        <Name>test</Name>
        <AssociatedEipAddresses>121.12.XX.XX</AssociatedEipAddresses>
        <AssociatedInstances>i-bp145q7glnuzdvzu21****</AssociatedInstances>
        <ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
    </HaVips>
</DescribeHaVipsResponse>

Formato JSON

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

{
  "PageSize" : 10,
  "RequestId" : "33E480C5-B46F-4CA5-B6FD-D77C746E86AB",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "HaVips" : [ {
    "VpcId" : "vpc-bp1kcm36tevkpms97****",
    "Status" : "Available",
    "HaVipId" : "havip-bp149uyvut73dpld****",
    "AssociatedInstanceType" : "EcsInstance",
    "CreateTime" : "2021-07-03T14:25:26Z",
    "ChargeType" : "none",
    "RegionId" : "cn-hangzhou",
    "VSwitchId" : "vsw-bp1pkt1fba8e824ez****",
    "IpAddress" : "192.168.24.5",
    "Description" : "My HaVip",
    "MasterInstanceId" : "i-bp145q7glnuzdvz****",
    "Name" : "test",
    "AssociatedEipAddresses" : [ "121.12.XX.XX" ],
    "AssociatedInstances" : [ "i-bp145q7glnuzdvzu21****" ],
    "ResourceGroupId" : "rg-bp67acfmxazb4ph****",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    } ]
  } ]
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.	Erro retornado devido à falta de permissões para gerenciar o HAVIP. Acesse a página do Quota Center para solicitar as permissões.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	Erro retornado porque Filter.X.key não é compatível.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.