Consulta de configurações de LTS de uma instância
Função
Essa API é usada para consultar configurações de LTS de uma instância. 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}/logs/lts-configs
|
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. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
enterprise_project_id |
Não |
String |
ID do projeto empresarial. |
|
instance_id |
Não |
String |
ID da instância. |
|
instance_name |
Não |
String |
Nome da instância. |
|
limit |
Não |
String |
Número de registros a serem consultados. Intervalo de valores: 1 a 100. Valor padrão: 10 |
|
offset |
Não |
String |
Deslocamento do índice. Se offset for definido como N, a consulta começará a partir da parte N+1 dos dados. Se action for definido como filter, offset será 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Token do usuário. Para obter o valor, chame a API para obtenção de 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 |
|---|---|---|
|
instance_lts_configs |
Array of LtsConfigsV3 objects |
Configurações de LTS de uma instância. |
|
total_count |
Integer |
Número total. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
lts_configs |
Array of LtsConfig objects |
Configurações de LTS. |
|
instance |
InstanceLtsBasicInfo object |
Informações da instância. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
log_type |
String |
Tipo de registro. |
|
lts_group_id |
String |
ID do grupo de log. |
|
lts_stream_id |
String |
ID do fluxo de log. |
|
enabled |
Boolean |
Se as configurações de LTS estão habilitadas. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID da instância. |
|
name |
String |
Nome da instância. |
|
mode |
String |
Tipo de instância. |
|
engine_name |
String |
Nome do mecanismo. |
|
engine_version |
String |
Versão do mecanismo. |
|
status |
String |
Estado. |
|
enterprise_project_id |
String |
ID do projeto empresarial. |
|
enterprise_project_name |
String |
Nome do projeto empresarial. |
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
null
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663//logs/lts-configs
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{
"total_count" : 1,
"instance_lts_configs" : [ {
"lts_configs" : [ {
"log_type" : "error_log",
"lts_group_id" : "c3dd5233-24a1-443c-6b40-310b3ad85382",
"lts_stream_id" : "9b476e31-b745-4e76-8d78-2081168651f7",
"enabled" : true
} ],
"instance" : {
"id" : "61a4ea66210545909d74a05c27a7179ein07",
"name" : "gaussdb-mysql-instance01",
"mode" : "ha",
"engine_name" : "gaussdb-mysql",
"engine_version" : 2.0,
"status" : "normal",
"enterprise_project_id" : 0,
"enterprise_project_name" : "eps"
}
} ]
}
Código de status
|
Código de status |
Descrição |
|---|---|
|
200 |
Bem-sucedido. |
|
400 |
Erro do cliente. |
|
500 |
Erro no servidor. |
Código de erro
Para obter detalhes, consulte Códigos de erro.