DescribeSubscriptionInstances - Data Transmission Service: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para facilitar, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera automaticamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Yes	DescribeSubscriptionInstances	A operação que você deseja executar. Defina o valor como DescribeSubscriptionInstances.
Tag.N.Key	String	Yes	testkey1	A chave da tag. Nota N especifica o número de série da tag. Por exemplo, Tag.1.Key especifica a chave da primeira tag e Tag.2.Key especifica a chave da segunda tag. É possível especificar de 1 a 20 chaves de tag por vez. Este parâmetro não pode ser uma string vazia.
RegionId	String	No	cn-hangzhou	O ID da região em que a instância de rastreamento de alterações está. Para mais informações, consulte Lista de regiões compatíveis.
PageSize	Integer	No	30	O número de entradas a retornar em cada página. Valores válidos: 30, 50 e 100. Valor padrão: 30.
PageNum	Integer	No	1	O número da página a retornar. O valor deve ser um número inteiro maior que 0 e não deve exceder o valor máximo do tipo de dado Integer. Valor padrão: 1.
SubscriptionInstanceName	String	No	MySQL Change Tracking	O nome da instância de rastreamento de alterações. Nota Ao especificar este parâmetro, o DTS retorna todas as instâncias de rastreamento de alterações que correspondem ao nome especificado.
ClientToken	String	No	0c593ea1-3bea-11e9-b96b-88e9fe63****	O token de cliente usado para garantir a idempotência da solicitação. O cliente pode gerar o valor, mas é necessário garantir que ele seja único entre diferentes solicitações. O parâmetro ClientToken pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento.
AccountId	String	No	12323344****	O ID da conta do Alibaba Cloud. Não é necessário especificar este parâmetro, pois ele será removido no futuro.
Tag.N.Value	String	No	testvalue1	O valor da tag. Nota N especifica o número de série da tag. Por exemplo, Tag.1.Value especifica o valor da primeira tag e Tag.2.Value especifica o valor da segunda tag. É possível especificar de 1 a 20 valores de tag por vez. Este parâmetro pode ser uma string vazia.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
ErrCode	String	InternalError	O código de erro retornado se a chamada falhar.
ErrMessage	String	The request processing has failed due to some unknown error.	A mensagem de erro retornada se a chamada falhar.
PageNumber	Integer	1	O número da página retornada.
PageRecordCount	Integer	30	O número máximo de entradas que podem ser exibidas na página atual.
RequestId	String	FC3BAAF2-74E3-4471-8EB5-96202D6A****	O ID da solicitação.
SubscriptionInstances	Array of SubscriptionInstance		A lista de instâncias de rastreamento de alterações e os detalhes de cada instância.
SubscriptionInstance
BeginTimestamp	String	2021-06-21T08:25:43Z	O início do intervalo de tempo para rastreamento de alterações. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ em UTC.
ConsumptionCheckpoint	String	2021-06-21T09:30:31Z	O ponto de verificação de consumo da instância de rastreamento de alterações. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ em UTC.
ConsumptionClient	String	114.*..:dts*******	As informações do cliente downstream, no seguinte formato: <Endereço IP do cliente downstream>:<ID aleatório gerado pelo DTS>.
EndTimestamp	String	2021-06-21T10:17:21Z	O fim do intervalo de tempo para rastreamento de alterações. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ em UTC.
ErrorMessage	String	xxxxxxxx	A mensagem de erro retornada se o rastreamento de alterações falhar.
InstanceCreateTime	String	2021-06-21T02:48:20Z	A hora em que a instância de rastreamento de alterações foi criada. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.
JobCreateTime	String	2021-06-21T02:48:20Z	A hora em que a tarefa de rastreamento de alterações foi criada. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ em UTC.
PayType	String	PrePaid	O método de faturamento da instância de rastreamento de alterações. Valores válidos: PrePaid: assinatura PostPaid: pagamento conforme o uso
SourceEndpoint	Struct		As configurações de conexão da instância de origem.
InstanceID	String	rm-bp1162kryivb8****	O ID da instância de origem.
InstanceType	String	RDS	O tipo da instância de origem. Nota Este parâmetro é retornado apenas para instâncias de rastreamento de alterações da nova versão.
Status	String	Normal	O status da tarefa de rastreamento de alterações. Valores válidos: NotStarted: A tarefa não foi iniciada. Prechecking: A tarefa está em verificação prévia. PrecheckFailed: A tarefa não passou na verificação prévia. Starting: A tarefa está sendo iniciada. Normal: A tarefa está em execução conforme o esperado. Abnormal: A tarefa não está em execução conforme o esperado.
SubscribeTopic	String	cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2	O tópico da instância de rastreamento de alterações. Nota Este parâmetro é retornado apenas se as instâncias de rastreamento de alterações forem da nova versão e você tiver chamado a operação CreateConsumerGroup para criar um grupo de consumidores.
SubscriptionDataType	Struct		Os tipos de operações rastreadas pela tarefa.
DDL	Boolean	true	Indica se as operações de linguagem de definição de dados (DDL) são rastreadas. Valores válidos: true: sim false: não
DML	Boolean	true	Indica se as operações de linguagem de manipulação de dados (DML) são rastreadas. Valores válidos: true: sim false: não
SubscriptionHost	Struct		O endpoint da instância de rastreamento de alterações.
PrivateHost	String	dts-cn-****-internal.aliyuncs.com:18002	O endpoint privado da instância de rastreamento de alterações. O formato é `<Address>:<Port number>`.
PublicHost	String	dts-cn-****.aliyuncs.com:18001	O endpoint público da instância de rastreamento de alterações. O formato é `<Address>:<Port number>`.
VPCHost	String	dts-cn-****-vpc.aliyuncs.com:18003	O endpoint de VPC (virtual private cloud) da instância de rastreamento de alterações. O formato é `<Address>:<Port number>`.
SubscriptionInstanceID	String	rm-bp1162kryivb8****	O ID da instância de rastreamento de alterações.
SubscriptionInstanceName	String	MySQL Change Tracking	O nome da instância de rastreamento de alterações.
SubscriptionObject	Array of SynchronousObject		Os objetos para rastreamento de alterações.
SynchronousObject
DatabaseName	String	dtstestdata	O nome do banco de dados ao qual o objeto pertence.
TableList	List	test1	O nome da tabela.
WholeDatabase	String	false	Indica se os dados de um banco de dados inteiro são rastreados. Valores válidos: true: sim false: não
Tags	Array of Tag		A coleção de tags.
Tag
Key	String	testkey1	A chave da tag.
Value	String	testvalue1	O valor da tag que corresponde à chave da tag.
Success	String	true	Indica se a chamada foi bem-sucedida.
TotalRecordCount	Long	1	O número total de instâncias de rastreamento de alterações pertencentes à sua conta do Alibaba Cloud.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas bem-sucedidas

XML formato

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

JSON formato

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

Para ver uma lista de códigos de erro, acesse a Central de Erros da API.