调用DescribeSubscriptionInstanceStatus接口查询一个数据订阅实例的状态

调试

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

调试

请求参数

名称	类型	是否必选	示例值	描述


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSubscriptionInstanceStatus	系统规定参数，取值：DescribeSubscriptionInstanceStatus。
SubscriptionInstanceId	String	是	dtsy0zz3t13h7d****	数据订阅实例ID，可以通过调用DescribeSubscriptionInstances接口查询。
RegionId	String	否	cn-hangzhou	数据订阅实例所在地域的ID，详情请参见支持的地域列表。
AccountId	String	否	12323344****	阿里云主账号ID，无需设置，该参数即将下线。

返回数据

名称	类型	示例值	描述


名称	类型	示例值	描述
BeginTimestamp	String	2021-03-15T08:25:34Z	订阅实例中保存的数据范围的起始时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ConsumptionCheckpoint	String	2021-03-23T07:30:31Z	订阅实例的下游消费时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ConsumptionClient	String	114.*..:dts*******	下游消费客户端信息，由IP地址和DTS随机生成的随机数组成。
EndTimestamp	String	2021-03-26T14:03:21Z	订阅实例中保存的数据范围的截止时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ErrCode	String	InternalError	调用出错时返回的错误码。
ErrMessage	String	The request processing has failed due to some unknown error.	调用错误时返回的错误信息。
ErrorMessage	String	******	数据订阅异常的错误提示。
ErrorMessage	String	******	数据订阅异常的错误提示。
PayType	String	PrePaid	订阅实例的付费类型，返回值： PrePaid：包年包月（预付费）。 PostPaid：按量付费（后付费）。
RequestId	String	E0845D0A-6D36-4EEB-BE26-CF191E1A****	请求ID。
SourceEndpoint	Struct		源实例的连接信息。
InstanceID	String	rm-bp1162kryivb8****	源库的实例ID。
InstanceType	String	RDS	源库的实例类型。说明当该订阅实例为新版时，才会返回该参数。
Status	String	Normal	订阅实例的状态，返回值： NotStarted：未启动。 Prechecking：预检查中。 PrecheckFailed：预检查失败。 Starting：启动中。 Normal：正常。 Abnormal：异常。
SubscribeTopic	String	cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2	订阅Topic。说明当该订阅实例为新版，且调用CreateConsumerGroup接口创建了消费组时，才会返回本参数。
SubscriptionDataType	Struct		订阅数据的类型。
DDL	Boolean	true	订阅数据是否包含DDL语句，返回值： true：是。 false：否。
DML	Boolean	true	订阅数据是否包含DML语句，返回值： true：是。 false：否。
SubscriptionHost	Struct		订阅实例的连接地址。
PrivateHost	String	dts-cn-****-internal.aliyuncs.com:18002	订阅实例的私网连接信息，格式为`地址：端口号`。
PublicHost	String	dts-cn-****.aliyuncs.com:18001	订阅实例的公网连接信息，格式为`地址：端口号`。
VPCHost	String	dts-cn-****-vpc.aliyuncs.com:18003	订阅实例的专有网络VPC（Virtual Private Cloud）连接信息，格式为`地址：端口号`。
SubscriptionInstanceID	String	rm-bp1162kryivb8****	数据订阅实例ID。
SubscriptionInstanceName	String	api测试	数据订阅实例名称。
SubscriptionObject	Array of SynchronousObject		订阅对象。
SynchronousObject
DatabaseName	String	dtstestdata	订阅对象所属数据库的名称。
TableList	List	test1	订阅对象的表名。
WholeDatabase	String	false	是否订阅整库，返回值： true：是。 false：否。
Success	String	true	请求是否成功。
TaskId	String	y0zz3t13h7d****	订阅任务ID。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeSubscriptionInstanceStatus
&SubscriptionInstanceId=dtsy0zz3t13h7d****
&<公共请求参数>

正常返回示例

XML格式

<DescribeSubscriptionInstanceStatusResponse>
      <Status>Normal</Status>
      <TaskId>y0zz3t13h7d****</TaskId>
      <RequestId>E0845D0A-6D36-4EEB-BE26-CF191E1A****</RequestId>
      <SubscriptionHost>
            <PublicHost>dts-cn-****.aliyuncs.com:18001</PublicHost>
            <PrivateHost>dts-cn-****-internal.aliyuncs.com:18002</PrivateHost>
            <VPCHost>dts-cn-****-vpc.aliyuncs.com:18003</VPCHost>
      </SubscriptionHost>
      <EndTimestamp>2021-03-26T14:03:21Z</EndTimestamp>
      <PayType>PrePaid</PayType>
      <SubscriptionInstanceID>dtsy0zz3t13h7d****</SubscriptionInstanceID>
      <Success>true</Success>
      <SubscriptionObject>
            <SynchronousObject>
                  <DatabaseName>dtstestdata</DatabaseName>
                  <WholeDatabase>false</WholeDatabase>
                  <TableList>
                        <Table>test1</Table>
                  </TableList>
            </SynchronousObject>
      </SubscriptionObject>
      <SubscriptionDataType>
            <DML>true</DML>
            <DDL>true</DDL>
      </SubscriptionDataType>
      <SubscriptionInstanceName>api测试</SubscriptionInstanceName>
      <SubscribeTopic>cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2</SubscribeTopic>
      <SourceEndpoint>
            <InstanceID>rm-bp1162kryivb8****</InstanceID>
            <InstanceType>RDS</InstanceType>
      </SourceEndpoint>
      <BeginTimestamp>2021-03-15T08:25:34Z</BeginTimestamp>
</DescribeSubscriptionInstanceStatusResponse>

JSON格式

{
	"Status": "Normal",
	"TaskId": "y0zz3t13h7d****",
	"RequestId": "E0845D0A-6D36-4EEB-BE26-CF191E1A****",
	"SubscriptionHost": {
		"PublicHost": "dts-cn-****.aliyuncs.com:18001",
		"PrivateHost": "dts-cn-****-internal.aliyuncs.com:18002",
		"VPCHost": "dts-cn-****-vpc.aliyuncs.com:18003"
	},
	"EndTimestamp": "2021-03-26T14:03:21Z",
	"PayType": "PrePaid",
	"SubscriptionInstanceID": "dtsy0zz3t13h7d****",
	"Success": true,
	"SubscriptionObject": {
		"SynchronousObject": [
			{
				"DatabaseName": "dtstestdata",
				"WholeDatabase": false,
				"TableList": {
					"Table": [
						"test1"
					]
				}
			}
		]
	},
	"SubscriptionDataType": {
		"DML": true,
		"DDL": true
	},
	"SubscriptionInstanceName": "api测试",
	"SubscribeTopic": "cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2",
	"SourceEndpoint": {
		"InstanceID": "rm-bp1162kryivb8****",
		"InstanceType": "RDS"
	},
	"BeginTimestamp": "2021-03-15T08:25:34Z"
}

错误码

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