Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Database and Account Management (Microsoft SQL Server)/ Adding Host Addresses for MSDTC
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Adding Host Addresses for MSDTC

Function

This API is used to add host addresses for Microsoft Distributed Transaction Coordinator (MSDTC).

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:SetMsdtcHosts

write

instance

- g:EnterpriseProjectId

- g:ResourceTag/<tag-key>

-

-

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/msdtc/host

  • 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

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

hosts

No

Array of objects

Definition

Host information.

For details on the element structure, see Table 3.
Table 3 hosts data structure description

Parameter

Mandatory

Type

Description

host_name

Yes

String

Definition

Host name.

Constraints

N/A

Range

N/A

Default Value

N/A

ip

Yes

String

Definition

Host IP address.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Request

Add host addresses for MSDTC. 
POST https://{endpoint}/v3/054b93101a00d3a02fe3c01fb31462ac/instances/463a6520abc345888850ea5bfb245e4fin04/msdtc/host

{
   "hosts" : [ {
     "host_name" : "pc1",
     "ip" : "127.0.0.1"
   } ]
 }

Response

  • Normal response
    Table 4 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Definition

    Task ID.

    Range

    N/A
  • Example normal response 
    {
   "job_id" : "603d87db-9a91-411e-b369-ca4d72007e27"
 }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.