Consulta os detalhes de uma instância específica do ApsaraDB for HBase, incluindo status, edição, configuração de nós, definições de rede, método de faturamento e estados dos recursos.
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Exemplo |
Descrição |
|
Action |
String |
Sim |
DescribeInstance |
A operação a ser executada. Defina o valor como DescribeInstance. |
|
ClusterId |
String |
Sim |
ld-bp150tns0sjxs**** |
O ID da instância a ser consultada. |
Parâmetros de resposta
| Parâmetro | Tipo | Exemplo | Descrição |
|---|---|---|---|
| RequestId | String | 3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66 | O ID da solicitação. |
| ClusterId | String | ld-bp150tns0sjxs**** | O ID da instância. |
| InstanceId | String | ld-bp150tns0sjxs**** | O ID da instância. |
| ClusterName | String | testhbase | O nome da instância. |
| InstanceName | String | testhbase | O nome da instância. |
| ClusterType | String | cluster | O tipo da instância. Valores válidos: cluster (instância cluster), single (instância autônoma). |
| Engine | String | hbaseue | A edição da instância. Valores válidos: hbase (ApsaraDB for HBase Standard Edition ou Standalone Edition), hbaseue (ApsaraDB for HBase Performance-enhanced Edition), serverlesshbase (ApsaraDB for HBase Serverless Edition), bds (edição BDS que utiliza o Lindorm Tunnel Service (LTS)). |
| Status | String | ACTIVATION | O status da instância. Valores válidos: CREATING (a instância está sendo criada), ACTIVATION (a instância está em execução), DELETING (a instância está sendo excluída), RESTARTING (a instância está reiniciando), MINOR_VERSION_TRANSING (a versão secundária está sendo atualizada). |
| RegionId | String | cn-hangzhou | O ID da região onde a instância está implantada. |
| ZoneId | String | cn-hangzhou-f | O ID da zona onde a instância está implantada. |
| PayType | String | Prepaid | O método de faturamento. Valores válidos: Prepaid (assinatura), Postpaid (pagamento conforme o uso). |
| CreatedTime | String | 2021-07-19T11:23:22 | O horário de criação da instância. |
| CreatedTimeUTC | String | 2021-07-19T03:23:22Z | O horário de criação da instância. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e está em UTC. |
| ExpireTime | String | 2022-02-24T00:00:00 | O horário de expiração da instância. |
| ExpireTimeUTC | String | 2022-02-23T16:00:00Z | O horário de expiração da instância. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e está em UTC. |
| MajorVersion | String | 2.0 | A versão principal da instância. |
| MinorVersion | String | 2.2.9.1 | A versão secundária da instância. |
| IsLatestVersion | Boolean | true | Indica se a instância executa a versão mais recente. Valores válidos: true, false. |
| IsHa | Boolean | true | Indica se a instância possui alta disponibilidade. Valores válidos: true (alta disponibilidade), false (sem alta disponibilidade). Nota Por padrão, uma instância cluster possui dois nós mestres para garantir alta disponibilidade. Uma instância autônoma possui um único nó, e sua capacidade total de armazenamento é igual à capacidade de disco desse nó. |
| IsMultiModel | Boolean | true | Indica se a instância suporta múltiplos modelos de dados. Valores válidos: true (a instância é do tipo cluster e suporta múltiplos modelos de dados), false (não suporta múltiplos modelos de dados). |
| NetworkType | String | VPC | O tipo de rede. Valores válidos: VPC (virtual private cloud (VPC)), CLASSIC (rede clássica). Se o valor for VPC, os parâmetros VpcId e VswitchId também serão retornados. |
| VpcId | String | vpc-bp15s22y1a7sff5gj**** | O ID da VPC. Este parâmetro é retornado apenas quando NetworkType é VPC. |
| VswitchId | String | vsw-bp1foll427ze3d4ps**** | O ID do vSwitch. Este parâmetro é retornado apenas quando NetworkType é VPC. |
| MasterNodeCount | Integer | 2 | A categoria do nó mestre. Valores válidos: 0 (nó autônomo), 2 (nó de cluster). |
| MasterInstanceType | String | hbase.sn2.large | O tipo de instância dos nós mestres. |
| MasterDiskSize | Integer | 0 | A capacidade de disco de cada nó mestre, em GB. |
| MasterDiskType | String | cloud_efficiency | O tipo de disco dos nós mestres. Valores válidos: cloud_efficiency (ultra disk), cloud_ssd (SSD padrão). Nota Este parâmetro é retornado apenas para instâncias autônomas. |
| CoreNodeCount | Integer | 2 | A quantidade de nós principais. |
| CoreInstanceType | String | hbase.sn2.2xlarge | O tipo de instância dos nós principais. |
| CoreDiskCount | String | 4 | A quantidade de discos em cada nó principal. |
| CoreDiskSize | Integer | 100 | A capacidade de disco de cada nó principal, em GB. |
| CoreDiskType | String | cloud_ssd | O tipo de disco dos nós principais. Valores válidos: cloud_efficiency (ultra disk), cloud_ssd (SSD padrão), local_hdd (HDD local), local__ssd (SSD local). |
| BackupStatus | String | open | O status do recurso de backup. Valores válidos: open (ativado), close (desativado). |
| ColdStorageStatus | String | open | O status do recurso de cold storage. Valores válidos: open (ativado), close (desativado). |
| ColdStorageSize | Integer | 800 | A capacidade de cold storage, em GB. |
| MaintainStartTime | String | 18:00Z | O horário de início da janela de manutenção, em UTC. |
| MaintainEndTime | String | 22:00Z | O horário de término da janela de manutenção, em UTC. |
| ConfirmMaintainTime | String | true | Indica se a janela de manutenção foi confirmada. Valores válidos: true (confirmada), false (não confirmada). Nota A caixa de diálogo Confirm Maintenance Window aparece apenas na primeira vez que você abre a página Basic Information da sua instância. |
| IsDeletionProtection | Boolean | false | Indica se a proteção contra exclusão está ativada. Valores válidos: true (ativada), false (desativada). |
| EncryptionType | String | NoEncryption | O tipo de criptografia. Valores válidos: NoEncryption (criptografia de disco desativada), CloudDisk (criptografia de disco ativada; o parâmetro EncryptionKey também é retornado). Nota Não é possível desativar a criptografia de disco após ativá-la. |
| EncryptionKey | String | 0d2470df-da7b-4786-b981-9a164dae**** | A chave criptográfica. Este parâmetro é retornado apenas quando EncryptionType é CloudDisk. |
| AutoRenewal | Boolean | false | Indica se a renovação automática está ativada. Valores válidos: true (ativada), false (desativada). Nota Este parâmetro não é retornado para instâncias com pagamento conforme o uso. |
| Duration | Integer | 12 | O ciclo de renovação automática. Para assinaturas mensais, o ciclo é de 1 mês. Para assinaturas anuais, o ciclo é de 12 meses. Nota Este parâmetro não é retornado para instâncias com pagamento conforme o uso. |
| NeedUpgrade | Boolean | false | Indica se os componentes da instância podem ser atualizados. Valores válidos: true (atualizável), false (não atualizável). |
| NeedUpgradeComps | List | [lindorm, hdfs] | Os nomes dos componentes que podem ser atualizados. Este parâmetro é retornado apenas quando NeedUpgrade é true. |
| TaskProgress | String | 25.00 | O progresso da tarefa em execução na instância, em porcentagem. As tarefas incluem alteração de especificações, dimensionamento horizontal de nós, reinicialização da instância e atualização da versão secundária. |
| ResourceGroupId | String | rg-acfmyiu4ekp**** | O ID do grupo de recursos que contém a instância. |
| ModuleId | Integer | 0 | O ID do módulo. |
| ModuleStackVersion | String | phoenxi:4.0 | A versão da pilha do módulo. |
| ParentId | String | ld-uf699153o1m2l**** | O ID da instância pai. |
| Tags | Array of Tag | As tags associadas à instância. | |
| Tag | |||
| Key | String | test_key | A chave da tag. |
| Value | String | test_value | O valor da tag. |
Exemplos
Exemplo de solicitação
http(s)://hbase.aliyuncs.com/?Action=DescribeInstance
&ClusterId=ld-bp150tns0sjxs****
&<Common request parameters>Exemplos de respostas de sucesso
Formato XML
<DescribeInstanceResponse>
<CreatedTime>2021-07-19T11:23:22</CreatedTime>
<ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
<NeedUpgrade>false</NeedUpgrade>
<ModuleId>0</ModuleId>
<Engine>hbaseue</Engine>
<NeedUpgradeComps>
</NeedUpgradeComps>
<Tags>
</Tags>
<Status>ACTIVATION</Status>
<ColdStorageSize>800</ColdStorageSize>
<EncryptionType>NoEncryption</EncryptionType>
<MasterDiskSize>0</MasterDiskSize>
<ExpireTimeUTC>2022-02-23T16:00:00Z</ExpireTimeUTC>
<RequestId>3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66</RequestId>
<InstanceId>ld-bp150tns0sjxs****</InstanceId>
<PayType>Prepaid</PayType>
<VswitchId>vsw-bp1foll427ze3d4ps****</VswitchId>
<InstanceName>testhbase</InstanceName>
<MasterNodeCount>2</MasterNodeCount>
<VpcId>vpc-bp15s22y1a7sff5gj****</VpcId>
<AutoRenewal>false</AutoRenewal>
<CoreDiskType>cloud_ssd</CoreDiskType>
<ExpireTime>2022-02-24T00:00:00</ExpireTime>
<BackupStatus>open</BackupStatus>
<IsHa>true</IsHa>
<TaskProgress>25.00</TaskProgress>
<MasterInstanceType>hbase.sn1.2xlarge</MasterInstanceType>
<IsDeletionProtection>false</IsDeletionProtection>
<IsLatestVersion>true</IsLatestVersion>
<MaintainEndTime>22:00Z</MaintainEndTime>
<NetworkType>VPC</NetworkType>
<CoreInstanceType>hbase.sn2.2xlarge</CoreInstanceType>
<ClusterName>testhbase</ClusterName>
<MasterDiskType></MasterDiskType>
<MaintainStartTime>18:00Z</MaintainStartTime>
<MajorVersion>2.0</MajorVersion>
<CoreDiskCount>4</CoreDiskCount>
<ZoneId>cn-hangzhou-f</ZoneId>
<CoreNodeCount>2</CoreNodeCount>
<ClusterId>ld-bp150tns0sjxs****</ClusterId>
<ColdStorageStatus>open</ColdStorageStatus>
<MinorVersion>2.2.9.1</MinorVersion>
<CreatedTimeUTC>2021-07-19T03:23:22Z</CreatedTimeUTC>
<IsMultiModel>true</IsMultiModel>
<ClusterType>cluster</ClusterType>
<RegionId>cn-hangzhou</RegionId>
<CoreDiskSize>100</CoreDiskSize>
<ConfirmMaintainTime>true</ConfirmMaintainTime>
</DescribeInstanceResponse>Formato JSON
{
"CreatedTime": "2021-07-19T11:23:22",
"ResourceGroupId": "rg-acfmyiu4ekp****",
"NeedUpgrade": false,
"ModuleId": 0,
"Engine": "hbaseue",
"NeedUpgradeComps": {
"Comps": []
},
"Tags": {
"Tag": []
},
"Status": "ACTIVATION",
"ColdStorageSize": 800,
"EncryptionType": "NoEncryption",
"MasterDiskSize": 0,
"ExpireTimeUTC": "2022-02-23T16:00:00Z",
"RequestId": "3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66",
"InstanceId": "ld-bp150tns0sjxs****",
"PayType": "Prepaid",
"VswitchId": "vsw-bp1foll427ze3d4ps****",
"InstanceName": "testhbase",
"MasterNodeCount": 2,
"VpcId": "vpc-bp15s22y1a7sff5gj****",
"AutoRenewal": false,
"CoreDiskType": "cloud_ssd",
"ExpireTime": "2022-02-24T00:00:00",
"BackupStatus": "open",
"IsHa": true,
"TaskProgress": "25.00",
"MasterInstanceType": "hbase.sn1.2xlarge",
"IsDeletionProtection": false,
"IsLatestVersion": true,
"MaintainEndTime": "22:00Z",
"NetworkType": "VPC",
"CoreInstanceType": "hbase.sn2.2xlarge",
"ClusterName": "testhbase",
"MasterDiskType": "",
"MaintainStartTime": "18:00Z",
"MajorVersion": "2.0",
"CoreDiskCount": 4,
"ZoneId": "cn-hangzhou-f",
"CoreNodeCount": 2,
"ClusterId": "ld-bp150tns0sjxs****",
"ColdStorageStatus": "open",
"MinorVersion": "2.2.9.1",
"CreatedTimeUTC": "2021-07-19T03:23:22Z",
"IsMultiModel": true,
"ClusterType": "cluster",
"RegionId": "cn-hangzhou",
"ConfirmMaintainTime": true,
"CoreDiskSize": 100
}Códigos de erro
Para obter uma lista de códigos de erro, visite o API Error Center.