Queries the details of the subtasks in a distributed change tracking task for a DRDS instance.

  • When DTS tracks data changes from a DRDS instance, data is distributed across the attached ApsaraDB RDS for MySQL instances. DTS runs a subtask for each ApsaraDB RDS for MySQL instance. You can call this operation to query the details of the subtasks in a distributed change tracking task.
  • You can call the DescribeDtsJobs operation to query the ID of the change tracking instance and the ID of the consumer group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSubscriptionMeta

The operation that you want to perform. Set the value to DescribeSubscriptionMeta.

Sid String Yes z38m91gg2******

The ID of the consumer group.

DtsInstanceId String No dtsbr4m9luv2******

The ID of the change tracking instance.

SubMigrationJobIds Json No z38m91gg2******

The IDs of all subtasks in the distributed change tracking task. Separate multiple subtask IDs with commas (,).

Note You must specify at least one of the SubMigrationJobIds and Topics parameters. We recommend that you specify this parameter.
Topics Json No cn_hangzhou_rm_bp1n0x0x5tz******_dtstestdata_version2

The topics of all subtasks in the distributed change tracking task. Separate multiple topics with commas (,).

Note You must specify at least one of the SubMigrationJobIds and Topics parameters. We recommend that you specify the SubMigrationJobIds parameter.
RegionId String No cn-hangzhou

The ID of the region where the change tracking instance resides.

Response parameters

Parameter Type Example Description
ErrCode String InternalError

The error code returned if the call failed.

ErrMessage String The Value of Input Parameter %s is not valid.

The error message returned if the call failed.

HttpStatusCode String 200

The HTTP status code.

RequestId String C12E7A51-09A4-5796-94BE-08B6DA******

The ID of the request.

SubscriptionMetaList Array of SubscriptionMetaList

The details of the subtasks.

Checkpoint Long 1610524452

The consumer offset of the subtask. It is a UNIX timestamp that is generated when the client consumes the first data record.

Note You can use a search engine to obtain a UNIX timestamp converter.
DBList String {\"dtstestdata\":{\"name\":\"dtstestdata\",\"all\":false,\"Table\":{\"order\":{\"name\":\"order\",\"all\":true}}}}

The objects of the subtask. For more information, see Objects of DTS tasks.

DProxyUrl String dts-cn-hangzhou.aliyuncs.com:18001

The network address and port number of the change tracking instance.

Sid String z38m91gg2******

The consumer group ID of the subtask.

Topic String cn_hangzhou_rm_bp1n0x0x5tz******_dtstestdata_version2

The topic of the subtask.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeSubscriptionMeta
&Sid=z38m91gg2******
&DtsInstanceId=dtsbr4m9luv2******
&SubMigrationJobIds=z38m91gg2******
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeSubscriptionMetaResponse>
      <SubscriptionMetaList>
            <Checkpoint>1610524452</Checkpoint>
            <DBList>{\"dtstestdata\":{\"name\":\"dtstestdata\",\"all\":false,\"Table\":{\"order\":{\"name\":\"order\",\"all\":true}}}}</DBList>
            <DProxyUrl>dts-cn-hangzhou.aliyuncs.com:18001</DProxyUrl>
            <Topic>cn_hangzhou_rm_bp1n0x0x5tz******_dtstestdata_version2</Topic>
            <Sid>z38m91gg2******</Sid>
      </SubscriptionMetaList>
      <RequestId>C12E7A51-09A4-5796-94BE-08B6DA******</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</DescribeSubscriptionMetaResponse>

JSON format

{
    "SubscriptionMetaList": [
        {
            "Checkpoint": "1610524452",
            "DBList": "{\\\"dtstestdata\\\":{\\\"name\\\":\\\"dtstestdata\\\",\\\"all\\\":false,\\\"Table\\\":{\\\"order\\\":{\\\"name\\\":\\\"order\\\",\\\"all\\\":true}}}}",
            "DProxyUrl": "dts-cn-hangzhou.aliyuncs.com:18001",
            "Topic": "cn_hangzhou_rm_bp1n0x0x5tz******_dtstestdata_version2",
            "Sid": "z38m91gg2******"
        }
    ],
    "RequestId": "C12E7A51-09A4-5796-94BE-08B6DA*******",
    "HttpStatusCode": "200",
    "Success": "true"
}

Error codes

For a list of error codes, visit the API Error Center.