Updated on 2025-08-20 GMT+08:00

Querying MSDTC Hosts

Function

This API is used to query MSDTC hosts.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/msdtc/hosts?offset={offset}&limit={limit}

  • Parameter description
    Table 1 Parameters

    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

    N/A

    Default Value

    N/A

    instance_id

    Yes

    String

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    offset

    No

    Integer

    Definition

    Index offset. The query starts from the next piece of data indexed by this parameter.

    Constraints

    N/A

    Range

    The value must be a non-negative number.

    Default Value

    The default value is 0, indicating that the query starts from the first data record.

    limit

    No

    Integer

    Definition

    Number of records returned by a query.

    Constraints

    N/A

    Range

    1–100

    Default Value

    10

Request

  • Request parameters

    None

  • URI example

    GET https://{endpoint}/v3/054b93101a00d3a02fe3c01fb31462ac/instances/8ef19e30cbf44c79b63c7e6b2168a400in04/msdtc/hosts

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    total_count

    Integer

    Definition

    Total number of hosts.

    Range

    N/A

    hosts

    Array of objects

    Definition

    Host list.

    For details, see Table 3.

    Table 3 hosts element structure description

    Parameter

    Type

    Description

    id

    String

    Definition

    Host ID.

    Range

    N/A

    host

    String

    Definition

    Host address.

    Range

    N/A

    host_name

    String

    Definition

    Host name.

    Range

    N/A

  • Example normal response
    {
       "total_count" : 1,
       "hosts" : [ {
         "id" : "527dd9ca-cc2c-4bac-8707-f9b4f55343f4",
         "host" : "192.168.0.90",
         "host_name" : "MSSQL-00E5FB7A"
       } ]
     }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.