Tous les produits
Search

Ce produit

    Data Transmission Service:DescribeSubscriptionInstances

    Centre de documentation

    Data Transmission Service:DescribeSubscriptionInstances

    Dernière mise à jour :Aug 10, 2026

    Répertorie les instances de suivi des modifications et leurs détails.

    Débogage

    OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère automatiquement des exemples de code pour différents SDK.

    Paramètres de requête

    Paramètre Type Obligatoire Exemple Description
    Action String Oui DescribeSubscriptionInstances

    Opération à effectuer. Définissez la valeur sur DescribeSubscriptionInstances.

    Tag.N.Key String Oui testkey1

    Clé du tag.

    Remarque
    • N représente le numéro de série du tag. Par exemple, Tag.1.Key spécifie la clé du premier tag et Tag.2.Key celle du deuxième. Vous pouvez spécifier de 1 à 20 clés de tag simultanément.
    • Ce paramètre ne peut pas être une chaîne vide.
    RegionId String Non cn-hangzhou

    ID de la région où réside l'instance de suivi des modifications. Pour plus d'informations, consultez la page Liste des régions prises en charge.

    PageSize Integer Non 30

    Nombre d'entrées à renvoyer par page. Valeurs possibles : 30, 50 et 100. Valeur par défaut : 30.

    PageNum Integer Non 1

    Numéro de la page à renvoyer. La valeur doit être un entier supérieur à 0 et inférieur ou égal à la valeur maximale du type Integer. Valeur par défaut : 1.

    SubscriptionInstanceName String Non MySQL Change Tracking

    Nom de l'instance de suivi des modifications.

    Remarque Si vous spécifiez ce paramètre, DTS renvoie toutes les instances de suivi des modifications correspondant au nom indiqué.
    ClientToken String Non 0c593ea1-3bea-11e9-b96b-88e9fe63****

    Jeton client utilisé pour garantir l'idempotence de la requête. Générez la valeur via le client, en veillant à son unicité pour chaque requête. Le paramètre ClientToken ne peut contenir que des caractères ASCII et ne doit pas dépasser 64 caractères.

    AccountId String Non 12323344****

    ID du compte Alibaba Cloud. Ce paramètre est appelé à disparaître ; il n'est donc pas nécessaire de le spécifier.

    Tag.N.Value String Non testvalue1

    Valeur du tag.

    Remarque
    • N représente le numéro de série du tag. Par exemple, Tag.1.Value spécifie la valeur du premier tag et Tag.2.Value celle du deuxième. Vous pouvez spécifier de 1 à 20 valeurs de tag simultanément.
    • Ce paramètre peut être une chaîne vide.

    Paramètres de réponse

    Paramètre Type Exemple Description
    ErrCode String InternalError

    Code d'erreur renvoyé en cas d'échec de l'appel.

    ErrMessage String The request processing has failed due to some unknown error.

    Message d'erreur renvoyé en cas d'échec de l'appel.

    PageNumber Integer 1

    Numéro de la page renvoyée.

    PageRecordCount Integer 30

    Nombre maximal d'entrées affichables sur la page actuelle.

    RequestId String FC3BAAF2-74E3-4471-8EB5-96202D6A****

    ID de la requête.

    SubscriptionInstances Array of SubscriptionInstance

    Liste des instances de suivi des modifications et détails de chaque instance.

    SubscriptionInstance
    BeginTimestamp String 2021-06-21T08:25:43Z

    Début de la plage de temps du suivi des modifications. L'heure est affichée au format yyyy-MM-ddTHH:mm:ssZ (UTC).

    ConsumptionCheckpoint String 2021-06-21T09:30:31Z

    Point de contrôle de consommation de l'instance de suivi des modifications. L'heure est affichée au format yyyy-MM-ddTHH:mm:ssZ (UTC).

    ConsumptionClient String 114.***.***.**:dts********

    Informations sur le client aval, au format suivant : <Adresse IP du client aval>:<ID aléatoire généré par DTS>.

    EndTimestamp String 2021-06-21T10:17:21Z

    Fin de la plage de temps du suivi des modifications. L'heure est affichée au format yyyy-MM-ddTHH:mm:ssZ (UTC).

    ErrorMessage String xxxxxxxx

    Message d'erreur renvoyé en cas d'échec du suivi des modifications.

    InstanceCreateTime String 2021-06-21T02:48:20Z

    Heure de création de l'instance de suivi des modifications. L'heure est affichée au format yyyy-MM-ddTHH:mm:ssZ (UTC).

    JobCreateTime String 2021-06-21T02:48:20Z

    Heure de création de la tâche de suivi des modifications. L'heure est affichée au format yyyy-MM-ddTHH:mm:ssZ (UTC).

    PayType String PrePaid

    Mode de facturation de l'instance de suivi des modifications. Valeurs possibles :

    • PrePaid : abonnement
    • PostPaid : paiement à l'utilisation
    SourceEndpoint Struct

    Paramètres de connexion de l'instance source.

    InstanceID String rm-bp1162kryivb8****

    ID de l'instance source.

    InstanceType String RDS

    Type de l'instance source.

    Remarque Ce paramètre n'est renvoyé que pour les instances de suivi des modifications de la nouvelle version.
    Status String Normal

    État de la tâche de suivi des modifications. Valeurs possibles :

    • NotStarted : la tâche n'a pas démarré.
    • Prechecking : précontrôle en cours.
    • PrecheckFailed : échec du précontrôle.
    • Starting : démarrage en cours.
    • Normal : la tâche s'exécute normalement.
    • Abnormal : la tâche rencontre des anomalies.
    SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

    Rubrique de l'instance de suivi des modifications.

    Remarque Ce paramètre n'est renvoyé que si vos instances de suivi des modifications sont de la nouvelle version et que vous avez appelé l'opération CreateConsumerGroup pour créer un groupe de consommateurs.
    SubscriptionDataType Struct

    Types d'opérations suivies par la tâche.

    DDL Boolean true

    Indique si les opérations DDL (Data Definition Language) sont suivies. Valeurs possibles :

    • true : oui
    • false : non
    DML Boolean true

    Indique si les opérations DML (Data Manipulation Language) sont suivies. Valeurs possibles :

    • true : oui
    • false : non
    SubscriptionHost Struct

    Endpoint de l'instance de suivi des modifications.

    PrivateHost String dts-cn-****-internal.aliyuncs.com:18002

    Endpoint privé de l'instance de suivi des modifications. Format : <Address>:<Port number>.

    PublicHost String dts-cn-****.aliyuncs.com:18001

    Endpoint public de l'instance de suivi des modifications. Format : <Address>:<Port number>.

    VPCHost String dts-cn-****-vpc.aliyuncs.com:18003

    Endpoint VPC (Virtual Private Cloud) de l'instance de suivi des modifications. Format : <Address>:<Port number>.

    SubscriptionInstanceID String rm-bp1162kryivb8****

    ID de l'instance de suivi des modifications.

    SubscriptionInstanceName String MySQL Change Tracking

    Nom de l'instance de suivi des modifications.

    SubscriptionObject Array of SynchronousObject

    Objets du suivi des modifications.

    SynchronousObject
    DatabaseName String dtstestdata

    Nom de la base de données à laquelle appartient l'objet.

    TableList List test1

    Nom de la table.

    WholeDatabase String false

    Indique si les données de toute la base de données sont suivies. Valeurs possibles :

    • true : oui
    • false : non
    Tags Array of Tag

    Collection de tags.

    Tag
    Key String testkey1

    Clé du tag.

    Value String testvalue1

    Valeur du tag associée à la clé.

    Success String true

    Indique si l'appel a réussi.

    TotalRecordCount Long 1

    Nombre total d'instances de suivi des modifications associées à votre compte Alibaba Cloud.

    Exemples

    Exemple de requête

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

    Exemple de réponse réussie

    Format 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>

    Format 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": []
				}
			}
		]
	}
}

    Codes d'erreur

    Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.