調用DescribeSubscriptionInstanceStatus API查詢資料訂閱執行個體的詳細資料與狀態-Data Transmission Service-阿里雲

調試

您可以在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	訂閱執行個體的Virtual Private Cloud（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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。