Modifying Parameters for Data Redistribution

Function

This API is used to modify parameters for data redistribution. Before calling this API:

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

Debugging

You can debug this API in API Explorer.

URI

PUT /v3/{project_id}/instances/{instance_id}/redistribution-parameters

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	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	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. The value of X-Subject-Token in the response 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

**Table 3** Parameter description
Parameter	Mandatory	Type	Description
redis_join_tables	No	Array of Array	Definition Tables that have JOIN relationships. If this parameter is specified, the multi-table scale-out is enabled. This parameter takes effect before the scale-out. To disable the function, set this parameter to an empty array. Table names are in the format of "database-name, schema-1-name, table-1-name, schema-2-name, table-2-name, ..." A table name containing both uppercase and lowercase letters or special characters must be escaped by adding quotation marks "". Multiple arrays indicate that there are multiple join groups. Constraints The parameter settings are only applied for the current scale-out. You need to reconfigure it for the next scale-out.
redis_parallel_jobs	No	Integer	Definition Redistribution concurrency. Constraints N/A Range N/A Default Value N/A
redis_resource_level	No	String	Definition Resource control level during redistribution. Constraints N/A Range N/A Default Value N/A

Response Parameters

**Table 4** Parameter description
Parameter	Type	Description
result	String	Definition ID of the task for modifying redistribution parameters. Default Value N/A

Example Request

PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/redistribution-parameters
{
    "redis_join_tables":
    [
        ["database1","schema1","table1","schema2","table2"],
        ["database2","schema3","table3","schema4","table4"]
    ],
    "redis_parallel_jobs": 0,
    "redis_resource_level": "l"
}

Example Response

{
	"result": "e96bbb23-e053-4bd0-b0b7-16ad3f5d9b6d"
}

Status Codes

Normal
202
Abnormal
For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instance Management

Previous topic: Querying the Parameter Setting Template for Data Redistribution

Next topic: Changing the vCPUs and Memory of a DB Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot