Consulta de recursos do mecanismo HTAP
Função
Essa API é usada para consultar recursos do mecanismo HTAP. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/htap/datastores/{engine_name}
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
|
engine_name |
Sim |
String |
Nome do mecanismo HTAP. Valores:
|
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Token do usuário. Para obter esse valor, chame a API do IAM para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. |
|
Content-Type |
Sim |
String |
Tipo de conteúdo. Valor: application/json |
|
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valores:
|
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
datastores |
Array of datastores objects |
Lista de informações do banco de dados. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID da versão do BD. O valor é único. |
|
name |
String |
Número da versão do BD. Somente o número da versão principal com dois dígitos é retornado. |
|
kernel_version |
String |
Versão do kernel do BD. Uma versão completa de quatro números é retornada. |
Código de status: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Consulta de informações sobre a versão do BD StarRocks
GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/htap/datastores/star-rock
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{
"datastores" : [ {
"id" : "38197973-8895-36ed-b853-52daeefb6d3a",
"name" : "3.1",
"kernel_version" : "3.1.6.0"
} ]
}
Código de status: 400
Erro do cliente.
{
"error_msg" : "Invalid database type.",
"error_code" : "DBS.280235"
}
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.