Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Publications and Subscriptions (RDS for SQL Server)/ Creating a Distributor
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Creating a Distributor

Function

This API is used to create a distributor for a DB instance.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:update

write

-

-

rds:instance:modify

-

URI

  • URI format

    POST

  • Parameter description
    Table 1 Parameters

    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

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Description

distributor_instance_id

Yes

String

Definition

ID of the instance that is configured as the distributor.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Request

Create a distributor for a DB instance. 
PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/distribution
{
      "distributor_instance_id":"72ee4cc4607347049df9ad50f615bbd8in04"
}

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Definition

    Task flow ID.

    Range

    N/A
  • Example normal response 
    {
    "job_id":"12323-sdsf-sewewe-wewewewex1tg"
}

Status Code

Error Code

For details, see Error Codes.