Parada de una tarea de sincronización de datos para una instancia de StarRocks
Función
Esta API se utiliza para detener una tarea de sincronización de datos para una instancia de StarRocks. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/pause
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
instance_id |
Sí |
String |
ID de instancia de StarRocks, que es compatible con el formato UUID. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. |
X-Language |
No |
String |
Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
task_name |
Sí |
String |
Nombre de la tarea de sincronización. El valor puede contener de 3 a 128 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_). |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
job_id |
String |
ID de la tarea para detener la sincronización de datos. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Ejemplo de la solicitud
POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/pause { "task_name" : "task_name" }
Ejemplo de la respuesta
Código de estado: 200
Operación exitosa
{ "job_id" : "123" }
Código de estado: 400
Error de cliente.
{ "error_code" : "DBS.200022", "error_msg" : "Instance not found." }
Código de estado
Código de estado |
Descripción |
---|---|
200 |
Operación exitosa |
400 |
Error de cliente. |
500 |
Error de servidor. |
Código de error
Para obtener más información, véase Códigos de error.