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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que também 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	DescribeInstances	Operação a ser executada. Defina o valor como DescribeInstances.
PageNumber	Integer	Não	1	Número da página a retornar. Valor padrão: 1.
PageSize	Integer	Não	10	Quantidade de entradas por página. Valor padrão: 10.
RegionId	String	Não	cn-hangzhou	ID da região da instância do PAI.
InstanceStatus	String	Não	RUNNING	Estado da instância do PAI. Valores válidos: PENDING: Instância não inicializada. CREATING: Instância em criação. RUNNING: Instância em execução. EXPIRED: Instância expirada. CREATE_FAILED: Falha na criação da instância. UPGRADING: Configurações da instância em alteração. UPGRADE_FAILED: Falha na alteração das configurações da instância.
ResourceGroupId	String	Não	rg-acfm26ougi****	ID do grupo de recursos ao qual a instância do PAI pertence.
InstanceId.N	String	Não	2	ID da instância do PAI.
Tag.N.Key	String	Não	test	Chave da tag da instância do PAI.
Tag.N.Value	String	Não	testapi	Valor da tag da instância do PAI.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalCount	Long	4	Total de instâncias do PAI consultadas.
RequestId	String	61D36C55-AAFC-4678-8FAD-34FEF9E7182E	ID da solicitação, usado para localizar e solucionar problemas.
Instances	Array of Instance		Matriz com as instâncias do PAI consultadas.
VpcId	String	vpc-bp1c85tzgqu1bf5b****	ID da Virtual Private Cloud (VPC) à qual a instância do PAI pertence.
VswitchId	String	vsw-bp1xfwzzfti0kjbf****	ID do vSwitch ao qual a instância do PAI pertence.
ImageVersion	String	3.0.0	Versão da imagem da instância do PAI.
PlanCode	String	cloudbastion_ha	Edição da instância do PAI. Valores válidos: cloudbastion: Basic cloudbastion_ha: Enterprise
Description	String	Test an operation.	Descrição da instância do PAI.
ExpireTime	Long	1578326400000	Timestamp de expiração da instância do PAI. Unidade: milissegundos.
Legacy	Boolean	false	Indica se a instância do PAI executa uma versão anterior. Valores válidos: true: A instância executa a versão V2 ou V3.1. false: A instância executa a versão V3.2.
InstanceId	String	bastionhost-cn-78v1gh****	ID da instância do PAI.
InternetEndpoint	String	drawvxalwb-public.bastionhost.aliyuncs.com	Endereço público de O&M da instância do PAI.
RegionId	String	cn-hangzhou	ID da região da instância do PAI.
IntranetEndpoint	String	drawvxalwb.bastionhost.aliyuncs.com	Endereço privado de O&M da instância do PAI.
StartTime	Long	1577681345000	Timestamp de compra ou renovação da instância do PAI. Unidade: milissegundos.
ResourceGroupId	String	g-acfm26ougi****	ID do grupo de recursos ao qual a instância do PAI pertence.
InstanceStatus	String	RUNNING	Estado da instância do PAI. Valores válidos: PENDING: Instância não inicializada. CREATING: Instância em criação. RUNNING: Instância em execução. EXPIRED: Instância expirada. CREATE_FAILED: Falha na criação da instância. UPGRADING: Configurações da instância em alteração. UPGRADE_FAILED: Falha na alteração das configurações da instância.
LicenseCode	String	bhah_ent_50_asset	Código de licença da instância do PAI.
PublicNetworkAccess	Boolean	true	Indica se a instância do PAI permite acesso pela Internet. Valores válidos: true: Acesso permitido pela Internet. false: Acesso bloqueado pela Internet.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeInstances
&PageNumber=1
&PageSize=10
&RegionId=cn-hangzhou
&InstanceStatus=RUNNING
&ResourceGroupId=rg-acfm26ougi****
&InstanceId=["2"]
&Tag=[{"Key":"test","Value":"testapi"}]
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DescribeInstancesResponse>
    <TotalCount>4</TotalCount>
    <RequestId>61D36C55-AAFC-4678-8FAD-34FEF9E7182E</RequestId>
    <Instances>
        <VpcId>vpc-bp1c85tzgqu1bf5b****</VpcId>
        <VswitchId>vsw-bp1xfwzzfti0kjbf****</VswitchId>
        <ImageVersion>3.0.0</ImageVersion>
        <PlanCode>cloudbastion_ha</PlanCode>
        <Description>Test an operation.</Description>
        <ExpireTime>1578326400000</ExpireTime>
        <Legacy>false</Legacy>
        <InstanceId>bastionhost-cn-78v1gh****</InstanceId>
        <InternetEndpoint>drawvxalwb-public.bastionhost.aliyuncs.com</InternetEndpoint>
        <RegionId>cn-hangzhou</RegionId>
        <IntranetEndpoint>drawvxalwb.bastionhost.aliyuncs.com</IntranetEndpoint>
        <StartTime>1577681345000</StartTime>
        <ResourceGroupId>g-acfm26ougi****</ResourceGroupId>
        <InstanceStatus>RUNNING</InstanceStatus>
        <LicenseCode>bhah_ent_50_asset</LicenseCode>
        <PublicNetworkAccess>true</PublicNetworkAccess>
    </Instances>
</DescribeInstancesResponse>

Formato JSON

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

{
  "TotalCount" : 4,
  "RequestId" : "61D36C55-AAFC-4678-8FAD-34FEF9E7182E",
  "Instances" : [ {
    "VpcId" : "vpc-bp1c85tzgqu1bf5b****",
    "VswitchId" : "vsw-bp1xfwzzfti0kjbf****",
    "ImageVersion" : "3.0.0",
    "PlanCode" : "cloudbastion_ha",
    "Description" : "Test an operation.",
    "ExpireTime" : 1578326400000,
    "Legacy" : false,
    "InstanceId" : "bastionhost-cn-78v1gh****",
    "InternetEndpoint" : "drawvxalwb-public.bastionhost.aliyuncs.com",
    "RegionId" : "cn-hangzhou",
    "IntranetEndpoint" : "drawvxalwb.bastionhost.aliyuncs.com",
    "StartTime" : 1577681345000,
    "ResourceGroupId" : "g-acfm26ougi****",
    "InstanceStatus" : "RUNNING",
    "LicenseCode" : "bhah_ent_50_asset",
    "PublicNetworkAccess" : true
  } ]
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.