DescribeSubscriptionInstances - Data Transmission Service - Centro de documentación de Alibaba Cloud

Consulta la lista de instancias de seguimiento de cambios y los detalles de cada instancia.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera automáticamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeSubscriptionInstances	La operación que desea ejecutar. Establezca el valor en DescribeSubscriptionInstances.
Tag.N.Key	String	Sí	testkey1	La clave de la etiqueta. Nota N indica el número de serie de la etiqueta. Por ejemplo, Tag.1.Key especifica la clave de la primera etiqueta y Tag.2.Key especifica la clave de la segunda etiqueta. Especifique de 1 a 20 claves de etiqueta a la vez. Este parámetro no puede ser una cadena vacía.
RegionId	String	No	cn-hangzhou	El ID de la región donde reside la instancia de seguimiento de cambios. Para obtener más información, consulte Lista de regiones compatibles.
PageSize	Integer	No	30	El número de entradas que se devuelven en cada página. Valores válidos: 30, 50 y 100. Valor predeterminado: 30.
PageNum	Integer	No	1	El número de la página que se devuelve. El valor debe ser un número entero mayor que 0 y no debe superar el valor máximo del tipo de datos Integer. Valor predeterminado: 1.
SubscriptionInstanceName	String	No	MySQL Change Tracking	El nombre de la instancia de seguimiento de cambios. Nota Si especifica este parámetro, DTS devuelve todas las instancias de seguimiento de cambios que coinciden con el nombre indicado.
ClientToken	String	No	0c593ea1-3bea-11e9-b96b-88e9fe63****	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Use el cliente para generar el valor, pero asegúrese de que sea único entre distintas solicitudes. El parámetro ClientToken solo puede contener caracteres ASCII y no debe superar los 64 caracteres de longitud.
AccountId	String	No	12323344****	El ID de la cuenta de Alibaba Cloud. No es necesario especificar este parámetro porque se eliminará en el futuro.
Tag.N.Value	String	No	testvalue1	El valor de la etiqueta. Nota N indica el número de serie de la etiqueta. Por ejemplo, Tag.1.Value especifica el valor de la primera etiqueta y Tag.2.Value especifica el valor de la segunda etiqueta. Especifique de 1 a 20 valores de etiqueta a la vez. Este parámetro puede ser una cadena vacía.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
ErrCode	String	InternalError	El código de error que se devuelve si la llamada falla.
ErrMessage	String	The request processing has failed due to some unknown error.	El mensaje de error que se devuelve si la llamada falla.
PageNumber	Integer	1	El número de la página devuelta.
PageRecordCount	Integer	30	El número máximo de entradas que se pueden mostrar en la página actual.
RequestId	String	FC3BAAF2-74E3-4471-8EB5-96202D6A****	El ID de la solicitud.
SubscriptionInstances	Array of SubscriptionInstance		La lista de instancias de seguimiento de cambios y los detalles de cada instancia.
SubscriptionInstance
BeginTimestamp	String	2021-06-21T08:25:43Z	El inicio del intervalo de tiempo del seguimiento de cambios. La hora se muestra en formato yyyy-MM-ddTHH:mm:ssZ en UTC.
ConsumptionCheckpoint	String	2021-06-21T09:30:31Z	El punto de control de consumo de la instancia de seguimiento de cambios. La hora se muestra en formato yyyy-MM-ddTHH:mm:ssZ en UTC.
ConsumptionClient	String	114.*..:dts*******	La información del cliente descendente, con el siguiente formato: <dirección IP del cliente descendente>:<ID aleatorio generado por DTS>.
EndTimestamp	String	2021-06-21T10:17:21Z	El final del intervalo de tiempo del seguimiento de cambios. La hora se muestra en formato yyyy-MM-ddTHH:mm:ssZ en UTC.
ErrorMessage	String	xxxxxxxx	El mensaje de error que se devuelve si el seguimiento de cambios falla.
InstanceCreateTime	String	2021-06-21T02:48:20Z	La hora en que se creó la instancia de seguimiento de cambios. La hora se muestra en formato yyyy-MM-ddTHH:mm:ssZ. Debe estar en UTC.
JobCreateTime	String	2021-06-21T02:48:20Z	La hora en que se creó la tarea de seguimiento de cambios. La hora se muestra en formato yyyy-MM-ddTHH:mm:ssZ en UTC.
PayType	String	PrePaid	El método de facturación de la instancia de seguimiento de cambios. Valores válidos: PrePaid: suscripción PostPaid: pay-as-you-go
SourceEndpoint	Struct		La configuración de conexión de la instancia de origen.
InstanceID	String	rm-bp1162kryivb8****	El ID de la instancia de origen.
InstanceType	String	RDS	El tipo de la instancia de origen. Nota Este parámetro solo se devuelve para las instancias de seguimiento de cambios de la nueva versión.
Status	String	Normal	El estado de la tarea de seguimiento de cambios. Valores válidos: NotStarted: la tarea no se ha iniciado. Prechecking: se está ejecutando la comprobación previa de la tarea. PrecheckFailed: la tarea no superó la comprobación previa. Starting: la tarea se está iniciando. Normal: la tarea se ejecuta según lo esperado. Abnormal: la tarea no se ejecuta según lo esperado.
SubscribeTopic	String	cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2	El tema de la instancia de seguimiento de cambios. Nota Este parámetro solo se devuelve si sus instancias de seguimiento de cambios son de la nueva versión y llamó a la operación CreateConsumerGroup para crear un grupo de consumidores.
SubscriptionDataType	Struct		Los tipos de operaciones que rastrea la tarea.
DDL	Boolean	true	Indica si se rastrean las operaciones de lenguaje de definición de datos (DDL). Valores válidos: true: sí false: no
DML	Boolean	true	Indica si se rastrean las operaciones de lenguaje de manipulación de datos (DML). Valores válidos: true: sí false: no
SubscriptionHost	Struct		El endpoint de la instancia de seguimiento de cambios.
PrivateHost	String	dts-cn-****-internal.aliyuncs.com:18002	El endpoint privado de la instancia de seguimiento de cambios. El formato es `<Address>:<Port number>`.
PublicHost	String	dts-cn-****.aliyuncs.com:18001	El endpoint público de la instancia de seguimiento de cambios. El formato es `<Address>:<Port number>`.
VPCHost	String	dts-cn-****-vpc.aliyuncs.com:18003	El endpoint de nube privada virtual (VPC) de la instancia de seguimiento de cambios. El formato es `<Address>:<Port number>`.
SubscriptionInstanceID	String	rm-bp1162kryivb8****	El ID de la instancia de seguimiento de cambios.
SubscriptionInstanceName	String	MySQL Change Tracking	El nombre de la instancia de seguimiento de cambios.
SubscriptionObject	Array of SynchronousObject		Los objetos del seguimiento de cambios.
SynchronousObject
DatabaseName	String	dtstestdata	El nombre de la base de datos a la que pertenece el objeto.
TableList	List	test1	El nombre de la tabla.
WholeDatabase	String	false	Indica si se rastrean los datos de una base de datos completa. Valores válidos: true: sí false: no
Tags	Array of Tag		La colección de etiquetas.
Tag
Key	String	testkey1	La clave de la etiqueta.
Value	String	testvalue1	El valor de la etiqueta que corresponde a la clave de la etiqueta.
Success	String	true	Indica si la llamada fue exitosa.
TotalRecordCount	Long	1	El número total de instancias de seguimiento de cambios que pertenecen a su cuenta de Alibaba Cloud.

Ejemplos

Solicitudes de ejemplo

http(s)://dts.aliyuncs.com/?Action=DescribeSubscriptionInstances
&Tag.1.Key=testkey1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<DescribeSubscriptionInstancesResponse>
      <TotalRecordCount>1</TotalRecordCount>
      <PageRecordCount>30</PageRecordCount>
      <RequestId>FC3BAAF2-74E3-4471-8EB5-96202D6A****</RequestId>
      <PageNumber>1</PageNumber>
      <Success>true</Success>
      <SubscriptionInstances>
            <SubscriptionInstance>
                  <Status>Normal</Status>
                  <SubscriptionObject>
                        <SynchronousObject>
                              <DatabaseName>dtstestdata</DatabaseName>
                              <WholeDatabase>false</WholeDatabase>
                              <TableList>
                                    <Table>test1</Table>
                              </TableList>
                        </SynchronousObject>
                  </SubscriptionObject>
                  <SubscriptionDataType>
                        <DML>true</DML>
                        <DDL>true</DDL>
                  </SubscriptionDataType>
                  <SubscriptionInstanceName>MySQL Change Tracking</SubscriptionInstanceName>
                  <SubscriptionHost>
                        <PublicHost>dts-cn-hangzhou.aliyuncs.com:18001</PublicHost>
                        <PrivateHost>dts-cn-hangzhou-internal.aliyuncs.com:18002</PrivateHost>
                        <VPCHost>dts-cn-hangzhou-vpc.aliyuncs.com:18003</VPCHost>
                  </SubscriptionHost>
                  <SubscribeTopic>cn_hangzhou_rm_bp1162kryiv******_dtstest_version2</SubscribeTopic>
                  <SourceEndpoint>
                        <InstanceID>rm-bp1162kryivb8****</InstanceID>
                        <InstanceType>RDS</InstanceType>
                  </SourceEndpoint>
                  <InstanceCreateTime>2021-06-21T10:17:21Z</InstanceCreateTime>
                  <JobCreateTime>2021-06-21T10:17:21Z</JobCreateTime>
                  <EndTimestamp>2021-06-21T10:17:21Z</EndTimestamp>
                  <PayType>PrePaid</PayType>
                  <SubscriptionInstanceID>dtsy0zz3t13h******</SubscriptionInstanceID>
                  <BeginTimestamp>2021-06-21T08:25:43Z</BeginTimestamp>
                  <Tags></Tags>
            </SubscriptionInstance>
      </SubscriptionInstances>
</DescribeSubscriptionInstancesResponse>

Formato JSON

{
	"TotalRecordCount": 1,
	"PageRecordCount": 30,
	"RequestId": "FC3BAAF2-74E3-4471-8EB5-96202D6A****",
	"PageNumber": 1,
	"Success": true,
	"SubscriptionInstances": {
		"SubscriptionInstance": [
			{
				"Status": "Normal",
				"SubscriptionObject": {
					"SynchronousObject": [
						{
							"DatabaseName": "dtstestdata",
							"WholeDatabase": false,
							"TableList": {
								"Table": [
									"test1"
								]
							}
						}
					]
				},
				"SubscriptionDataType": {
					"DML": true,
					"DDL": true
				},
				"SubscriptionInstanceName": "MySQL Change Tracking",
				"SubscriptionHost": {
					"PublicHost": "dts-cn-hangzhou.aliyuncs.com:18001",
					"PrivateHost": "dts-cn-hangzhou-internal.aliyuncs.com:18002",
					"VPCHost": "dts-cn-hangzhou-vpc.aliyuncs.com:18003"
				},
				"SubscribeTopic": "cn_hangzhou_rm_bp1162kryiv******_dtstest_version2",
				"SourceEndpoint": {
					"InstanceID": "rm-bp1162kryivb8****",
					"InstanceType": "RDS"
				},
				"InstanceCreateTime": "2021-06-21T10:17:21Z",
				"JobCreateTime": "2021-06-21T10:17:21Z",
                "EndTimestamp": "2021-06-21T10:17:21Z",
				"PayType": "PrePaid",
				"SubscriptionInstanceID": "dtsy0zz3t13h******",
				"BeginTimestamp": "2021-06-21T08:25:43Z",
				"Tags": {
					"Tag": []
				}
			}
		]
	}
}

Códigos de error

Para consultar la lista de códigos de error, visite el centro de errores de API.