Help Center/ Data Replication Service/ API Reference/ APIs V3.0 (Deprecated)/ Public API Management/ Setting Definers in Batches
Updated on 2024-08-23 GMT+08:00
View PDF

Setting Definers in Batches

Function

The API is used to set whether to migrate Definers to the user in batches.

  • If you select Yes, the Definers of all source database objects will be migrated to the user. Other users do not have permissions on database objects unless they are authorized.
  • If you select No, the Definers of all source database objects will not be changed. You need to migrate all accounts and permissions of the source database in the next step.

Constraints

This API can be called only when the task status is CONFIGURATION.

URI

POST /v3/{project_id}/jobs/batch-replace-definer

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

The content type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

X-Language

No

String

Request language type

Default value: en-us

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

jobs

Yes

Array of objects

List of requests for setting replaceDefiners in batches.

For details, see Table 4.
Table 4 Data structure description of field jobs

Parameter

Mandatory

Type

Description

job_id

Yes

String

Task ID.

replace_definer

Yes

Boolean

Whether to replace the definer with the destination database user.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

count

Integer

Total number.

results

Array of objects

List of tasks that are modified in batches.

For details, see Table 6.
Table 6 Data structure description of field results

Parameter

Type

Description

id

String

Task ID.

status

String

Status Values:

  • success: The task is successful.
  • failed: The task fails.

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Setting definers for specified tasks in batches

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-replace-definer

{
  "jobs" : [ {
    "job_id" : "7c685701-bfb5-4bb9-89f1-d0567f5jb502",
    "replace_definer" : true
  } ]
}

Example Response

Status code: 200

OK

{
  "count" : 1,
  "results" : [ {
    "id" : "7c685701-bfb5-4bb9-89f1-d0567f5jb502",
    "status" : "success"
  } ]
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Public API Management