Synchronizing SQL Throttling Tasks

Function

This API is used to synchronize SQL throttling tasks of an instance from the kernel plane to the management plane. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

POST /v3/{project_id}/instances/{instance_id}/sync-limit-task

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
result	String	Definition Synchronization result. Range success or fail
instance_id	String	Definition ID of the instance whose data is to be synchronized. Range N/A
node_id	String	Definition ID of the node whose data is to be synchronized. For a centralized instance, it indicates the ID of the primary node. For a distributed instance, it indicates the ID of the CN node. Range N/A
total_count	Integer	Definition Total number of synchronized data records. Range N/A

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/sync-limit-task
{
}

Example Response

{
    "result": "success",
    "instance_id": "ee95e4fd433d44a9b6dfa788149c8dd7in14",
    "node_id": "e37a7df4ec694a3cbfeae1aee583d70fno14",
    "total_count": 3
}