查询PolarDB-X 1.0分布式订阅任务的子任务信息 - 数据传输服务 DTS

由于DRDS的订阅任务为分布式订阅，其下挂的一个RDS MySQL对应一个订阅子任务，您可调用本接口查询订阅子任务的信息。
DRDS订阅任务的实例ID、消费组ID等信息，均可以通过调用DescribeDtsJobs接口查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSubscriptionMeta	系统规定参数。取值：DescribeSubscriptionMeta。
Sid	String	是	z38m91gg2******	消费组ID。
DtsInstanceId	String	否	dtsbr4m9luv2******	分布式订阅的实例ID。
SubMigrationJobIds	Map	否	z38m91gg2******	分布式订阅任务下所有的子订阅任务ID。多个子订阅任务ID间以英文逗号（,）分隔。说明本参数和参数Topics两者中至少传入一个。推荐填入本参数。
Topics	Map	否	cn_hangzhou_rm_bp1n0x0x5tz******_dtstestdata_version2	分布式订阅任务下所有的订阅Topic。多个订阅Topic间以英文逗号（,）分隔。说明本参数和参数SubMigrationJobIds两者中至少传入一个。推荐填入参数SubMigrationJobIds。
RegionId	String	否	cn-hangzhou	订阅实例所在地域。

返回数据


名称	类型	示例值	描述
HttpStatusCode	String	200	状态码。
RequestId	String	C12E7A51-09A4-5796-94BE-08B6DA******	请求ID。
ErrCode	String	InternalError	调用出错时返回的错误码。
Success	String	true	请求是否成功。
ErrMessage	String	The Value of Input Parameter %s is not valid.	调用错误时返回的错误信息。
SubscriptionMetaList	Array of SubscriptionMetaList		订阅子任务的数据信息。
Sid	String	z38m91gg2******	子任务的消费组ID。
Checkpoint	Long	1610524452	子任务的消费位点，即客户端消费第一条数据的时间戳。格式为Unix时间戳，单位为秒。说明 Unix时间戳转换工具可用搜索引擎获取。
DProxyUrl	String	dts-cn-hangzhou.aliyuncs.com:18001	数据订阅通道的网络地址及端口号信息。
DBList	String	{\"dtstestdata\":{\"name\":\"dtstestdata\",\"all\":false,\"Table\":{\"order\":{\"name\":\"order\",\"all\":true}}}}	子任务的订阅对象。详细定义说明，请参见迁移、同步或订阅对象说明。
Topic	String	cn_hangzhou_rm_bp1n0x0x5tz******_dtstestdata_version2	子任务的订阅Topic。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeSubscriptionMeta
&Sid=z38m91gg2******
&DtsInstanceId=dtsbr4m9luv2******
&SubMigrationJobIds=z38m91gg2******
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<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格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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"
}

错误码


HttpCode	错误码	错误信息	描述
400	Throttling.User	Request was denied due to user flow control.	由于请求频次达到阈值，请求被拒绝，请稍后重试。
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	签名已经过期，请更新签名
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。

访问错误中心查看更多错误码。