diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/dts/2018-08-01/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/dts/2018-08-01/api-docs.php')
| -rw-r--r-- | data/zh_cn/dts/2018-08-01/api-docs.php | 3318 |
1 files changed, 3318 insertions, 0 deletions
diff --git a/data/zh_cn/dts/2018-08-01/api-docs.php b/data/zh_cn/dts/2018-08-01/api-docs.php new file mode 100644 index 0000000..732c502 --- /dev/null +++ b/data/zh_cn/dts/2018-08-01/api-docs.php @@ -0,0 +1,3318 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dts', + 'version' => '2018-08-01', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'ConfigureMigrationJob', + 'ConfigureSubscriptionInstance', + 'CreateConsumerGroup', + 'CreateMigrationJob', + 'CreateSubscriptionInstance', + 'CreateSynchronizationJob', + 'DeleteConsumerGroup', + 'DeleteMigrationJob', + 'DeleteSynchronizationJob', + 'DescribeConsumerGroup', + 'DescribeMigrationJobStatus', + 'DescribeMigrationJobs', + 'DescribeSubscriptionInstanceStatus', + 'DescribeSubscriptionInstances', + 'DescribeSynchronizationJobStatus', + 'DescribeSynchronizationJobs', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ConfigureMigrationJob' => [ + 'summary' => '老版配置数据迁移任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdts4VPC0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'MigrationJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据迁移任务的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dtsxxxxxxxx', + 'docRequired' => true, + ], + ], + [ + 'name' => 'MigrationJobName', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移任务名称，不超过32个字符。建议配置具有业务意义的名称（无唯一性要求），便于后续识别。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL_TO_RDS', + 'docRequired' => true, + ], + ], + [ + 'name' => 'SourceEndpoint.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源库的实例类型，取值：'."\n" + .'- **RDS**：阿里云RDS实例。'."\n" + .'- **ECS**：ECS上的自建数据库。'."\n" + .'- **LocalInstance**：有公网IP的自建数据库。'."\n" + .'- **Express**：通过专线接入的自建数据库。'."\n" + .'- **MongoDB**：阿里云MongoDB实例。'."\n" + .'- **POLARDB**：阿里云PolarDB MySQL集群。', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + 'docRequired' => true, + ], + ], + [ + 'name' => 'SourceEndpoint.InstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => '源库的实例ID。'."\n" + .'> - 当**SourceEndpoint.InstanceType**取值为**RDS**、**ECS**、**Express**、**MongoDB**或**POLARDB**时，本参数才可用且必须传入对应的实例ID（例如取值为**ECS**，则本参数传入ECS实例ID）。'."\n" + .'- 当**SourceEndpoint.InstanceType**取值为**Express**时，本参数传入VPC ID（即专有网络ID）。', + 'type' => 'string', + 'required' => false, + 'example' => 'bp-rmxxxxxxxx', + ], + ], + [ + 'name' => 'SourceEndpoint.EngineName', + 'in' => 'query', + 'schema' => [ + 'description' => '源库的数据库类型，取值：**MySQL**、**SQLServer**、**PostgreSQL**、**Oracle**、**MongoDB**、**Redis**。 '."\n" + .'> 当**SourceEndpoint.InstanceType**取值为**ECS**、**LocalInstance**或**Express**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'SourceEndpoint.Region', + 'in' => 'query', + 'schema' => [ + 'description' => '源库所属的地域ID。'."\n" + .'> 当**SourceEndpoint.InstanceType**取值为**LocalInstance**时，您可以选择离本地数据库地理位置最近的地域，详情请参见[支持的地域列表](~~141033~~)。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceEndpoint.IP', + 'in' => 'query', + 'schema' => [ + 'description' => '源库的连接地址。'."\n" + .'> 当**SourceEndpoint.InstanceType**取值为**LocalInstance**或**Express**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.88.xxx', + ], + ], + [ + 'name' => 'SourceEndpoint.Port', + 'in' => 'query', + 'schema' => [ + 'description' => '源库的服务端口。'."\n" + .'> 当**SourceEndpoint.InstanceType**取值为**ECS**、**LocalInstance**或**Express**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'SourceEndpoint.OracleSID', + 'in' => 'query', + 'schema' => [ + 'description' => 'Oracle数据库的SID信息。'."\n" + .'> 当**SourceEndpoint.EngineName**取值为**Oracle**，且Oracle数据库为非RAC实例时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'testsid', + ], + ], + [ + 'name' => 'SourceEndpoint.DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '待迁移的数据库名称或鉴权数据库名称。'."\n" + .'> - 当**SourceEndpoint.EngineName**取值为**PostgreSQL**或**MongoDB**时，本参数才可用且必须传入。'."\n" + .'- 当**SourceEndpoint.EngineName**取值为**PostgreSQL**时，传入待迁移的数据库名称；取值为**MongoDB**时，传入数据库账号的鉴权数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'dtstestdatabase', + ], + ], + [ + 'name' => 'SourceEndpoint.UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '源库的数据库账号。'."\n" + .'> 迁移不同的数据库所需的权限有所差异，详情请参见[DTS数据迁移方案概览](~~125233~~)中对应的配置案例。', + 'type' => 'string', + 'required' => false, + 'example' => 'dtstestaccount', + ], + ], + [ + 'name' => 'SourceEndpoint.Password', + 'in' => 'query', + 'schema' => [ + 'description' => '源库数据库账号对应的密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test123456', + ], + ], + [ + 'name' => 'SourceEndpoint.OwnerID', + 'in' => 'query', + 'schema' => [ + 'description' => '源RDS实例所属的阿里云账号ID。'."\n" + .'> 仅在配置跨阿里云账号的数据迁移时本参数才可用，且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '11xxxxxxxx', + ], + ], + [ + 'name' => 'SourceEndpoint.Role', + 'in' => 'query', + 'schema' => [ + 'description' => '源RDS实例所属阿里云账号配置的角色名称。 '."\n" + .'> 该角色所需的权限及授权方式请参见[跨阿里云账号数据迁移/同步时如何配置RAM授权](~~48468~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ram-for-dts', + ], + ], + [ + 'name' => 'DestinationEndpoint.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标库的实例类型，取值：'."\n" + .'- **RDS**：阿里云RDS实例。'."\n" + .'- **DRDS**：阿里云DRDS实例。'."\n" + .'- **ECS**：ECS上的自建数据库。'."\n" + .'- **LocalInstance**：有公网IP的自建数据库。'."\n" + .'- **MongoDB**：阿里云MongoDB实例。'."\n" + .'- **Redis**：阿里云Redis实例。'."\n" + .'- **PetaData**：阿里云PetaData实例。'."\n" + .'- **OceanBase**：阿里云OceanBase实例。'."\n" + .'- **POLARDB**：阿里云PolarDB MySQL集群。', + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + 'docRequired' => true, + ], + ], + [ + 'name' => 'DestinationEndpoint.InstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实例ID。 '."\n" + .'> 当**DestinationEndpoint.InstanceType**取值为**RDS**、**ECS**、**MongoDB**、**Redis**、**DRDS**、**PetaData**、**OceanBase**或**POLARDB**时，本参数才可用且必须传入对应的实例ID（例如取值为**ECS**，则需要传入ECS实例ID）。', + 'type' => 'string', + 'required' => false, + 'example' => 'bp-rmxxxxxxxx', + ], + ], + [ + 'name' => 'DestinationEndpoint.EngineName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标库的数据库类型。取值：**MySQL**、**DRDS**、**SQLServer**、**PostgreSQL**、**PPAS**、**MongoDB**或**Redis**。'."\n" + .'> 当**DestinationEndpoint.InstanceType**取值为**RDS**、**ECS**、**LocalInstance**或**Express**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DestinationEndpoint.Region', + 'in' => 'query', + 'schema' => [ + 'description' => '目标库所属的地域ID。'."\n" + .'> 当**DestinationEndpoint.InstanceType**取值为**LocalInstance**时，您可以选择离本地数据库地理位置最近的地域，详情请参见[支持的地域列表](~~141033~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DestinationEndpoint.IP', + 'in' => 'query', + 'schema' => [ + 'description' => '目标库的连接地址。'."\n" + .'> 当**DestinationEndpoint.InstanceType**取值为**LocalInstance**或**Express**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.88.xxx', + ], + ], + [ + 'name' => 'DestinationEndpoint.Port', + 'in' => 'query', + 'schema' => [ + 'description' => '目标库的服务端口。 '."\n" + .'> 当**DestinationEndpoint.InstanceType**取值为**ECS**、**LocalInstance**或**Express**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'DestinationEndpoint.DataBaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '待迁入的数据库名称或鉴权数据库名称。 '."\n" + .'> - 当**DestinationEndpoint.EngineName**取值为**PostgreSQL**、**DRDS**或**MongoDB**时，本参数才可用且必须传入。'."\n" + .'- 当**DestinationEndpoint.EngineName**取值为**PostgreSQL**或**DRDS**时，传入待迁移的数据库名称；取值为**MongoDB**时，传入数据库账号的鉴权数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'dtstestdatabase', + ], + ], + [ + 'name' => 'DestinationEndpoint.UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标库的数据库账号。'."\n" + .'> 迁移不同的数据库所需的权限有所差异，详情请参见[DTS数据迁移方案概览](~~125233~~)中对应的配置案例。', + 'type' => 'string', + 'required' => false, + 'example' => 'dtstestaccount', + ], + ], + [ + 'name' => 'DestinationEndpoint.Password', + 'in' => 'query', + 'schema' => [ + 'description' => '目标库数据库账号对应的密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test123456', + ], + ], + [ + 'name' => 'MigrationMode.StructureIntialization', + 'in' => 'query', + 'schema' => [ + 'description' => '设置结构迁移选项，取值：'."\n" + .'- **true**：执行结构迁移。'."\n" + .'- **false**：不执行结构迁移。'."\n" + ."\n" + .'> DTS对结构迁移的支持情况因数据库类型不同而有所差异，详情请参见支[持的数据库和迁移类型](~~26618~~)。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'docRequired' => true, + ], + ], + [ + 'name' => 'MigrationMode.DataIntialization', + 'in' => 'query', + 'schema' => [ + 'description' => '设置全量数据迁移选项，取值：'."\n" + .'- **true**：执行全量数据迁移。'."\n" + .'- **false**：不执行全量数据迁移。'."\n" + ."\n" + .'> DTS对全量数据迁移的支持情况因数据库类型不同而有所差异，详情请参见支[持的数据库和迁移类型](~~26618~~)。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'docRequired' => true, + ], + ], + [ + 'name' => 'MigrationMode.DataSynchronization', + 'in' => 'query', + 'schema' => [ + 'description' => '设置增量数据迁移选项，取值：'."\n" + .'- **true**：执行增量数据迁移。'."\n" + .'- **false**：不执行增量数据迁移。'."\n" + ."\n" + .'> DTS对增量数据迁移的支持情况因数据库类型不同而有所差异，详情请参见支[持的数据库和迁移类型](~~26618~~)。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'docRequired' => true, + ], + ], + [ + 'name' => 'MigrationObject', + 'in' => 'query', + 'schema' => [ + 'description' => '待迁移的对象，格式为JSON串，且支持一定的正则表达式。'."\n" + .'> 更多相关介绍和示例请参见[迁移对象配置说明](~~141227~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]', + 'docRequired' => true, + ], + ], + [ + 'name' => 'MigrationReserved', + 'in' => 'query', + 'schema' => [ + 'description' => '1', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Checkpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '1', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1583461905002-EyTDX', + ], + 'ErrCode' => [ + 'description' => '1', + 'type' => 'string', + 'example' => '1', + ], + 'Success' => [ + 'description' => '接口是否调用成功，返回值：'."\n" + .'- true：调用成功。'."\n" + .'- flase：调用失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '1', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1583461905002-EyTDX\\",\\n \\"ErrCode\\": \\"1\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1583461905002-EyTDX</RequestId>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '配置数据迁移任务', + 'description' => '> - 调用本接口前，您需要调用[CreateMigrationJob](~~49427~~)接口来创建一个数据迁移实例。'."\n" + .'- 本接口调用成功后，将自动执行预检查并启动数据迁移任务，无需调用[StartMigrationJob](~~49429~~)接口来启动。'."\n" + .'- 如果数据迁移任务没有被成功启动，可能是预检查失败，您可以调用[DescribeMigrationJobStatus](~~49433~~)接口查询相关错误提示并修复。修复完成后，您可以调用[StartMigrationJob](~~49429~~)接口来启动数据迁移任务。', + 'requestParamsDescription' => '## MigrationReserved参数的补充说明'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConfigureSubscriptionInstance' => [ + 'summary' => '配置订阅任务', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdts4VPC0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'SubscriptionInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SubscriptionInstanceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.InstanceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.InstanceID', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SubscriptionDataType.DDL', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SubscriptionDataType.DML', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SubscriptionObject', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SourceEndpoint.IP', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.Port', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.UserName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.Password', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.OracleSID', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.DatabaseName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.OwnerID', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.Role', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SubscriptionInstanceNetworkType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SubscriptionInstance.VPCId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SubscriptionInstance.VSwitchId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '', + ], + 'CreateConsumerGroup' => [ + 'summary' => '创建消费者组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '96225', + 'abilityTreeNodes' => [ + 'FEATUREdts4VPC0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'SubscriptionInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ConsumerGroupName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ConsumerGroupUserName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ConsumerGroupPassword', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ConsumerGroupID' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + 'CreateMigrationJob' => [ + 'summary' => '创建迁移任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '96226', + 'abilityTreeNodes' => [ + 'FEATUREdts4VPC0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'MigrationJobClass', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'MigrationJobId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + 'CreateSubscriptionInstance' => [ + 'summary' => '创建订阅任务', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdts4VPC0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'SourceEndpoint.InstanceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'SubscriptionInstanceId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '', + ], + 'CreateSynchronizationJob' => [ + 'summary' => '创建同步任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '96228', + 'abilityTreeNodes' => [ + 'FEATUREdts4VPC0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceRegion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Topology', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SynchronizationJobClass', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpoint.InstanceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DestinationEndpoint.InstanceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'networkType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'SynchronizationJobId' => [ + 'type' => 'string', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + 'DeleteConsumerGroup' => [ + 'summary' => '删除消费组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '96229', + 'abilityTreeNodes' => [ + 'FEATUREdtsPBF0VZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SubscriptionInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ConsumerGroupID', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + 'DeleteMigrationJob' => [ + 'summary' => '删除迁移任务', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '96230', + 'abilityTreeNodes' => [ + 'FEATUREdtsPBF0VZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'MigrationJobId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + 'DeleteSynchronizationJob' => [ + 'summary' => '删除同步任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '96232', + 'abilityTreeNodes' => [ + 'FEATUREdtsPBF0VZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SynchronizationJobId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + 'DescribeConsumerGroup' => [ + 'summary' => '查询消费者组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '96233', + 'abilityTreeNodes' => [ + 'FEATUREdtsDW6WLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SubscriptionInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageRecordCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalRecordCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ConsumerChannels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DescribeConsumerChannel' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConsumerGroupUserName' => [ + 'type' => 'string', + ], + 'ConsumerGroupID' => [ + 'type' => 'string', + ], + 'MessageDelay' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ConsumerGroupName' => [ + 'type' => 'string', + ], + 'ConsumptionCheckpoint' => [ + 'type' => 'string', + ], + 'UnconsumedData' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + 'DescribeMigrationJobStatus' => [ + 'summary' => '老版查询数据迁移任务的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '96239', + 'abilityTreeNodes' => [ + 'FEATUREdtsDW6WLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'MigrationJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dtsxxxxxxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '111', + ], + 'MigrationJobName' => [ + 'description' => '迁移任务名称。', + 'type' => 'string', + 'example' => '迁移测试', + ], + 'MigrationJobStatus' => [ + 'description' => '迁移任务状态，返回值：'."\n" + .'- **NotStarted**：未启动。'."\n" + .'- **Prechecking**：预检查中。'."\n" + .'- **PrecheckFailed**：预检查失败。'."\n" + .'- **Migrating**：迁移中。'."\n" + .'- **Suspending**：暂停中。'."\n" + .'- **MigrationFailed**：迁移失败。'."\n" + .'- **Finished**：迁移完成。', + 'type' => 'string', + 'example' => 'Migrating', + ], + 'PayType' => [ + 'description' => '迁移任务的付费类型，返回值固定为**PostPaid**（按量付费）。', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'MigrationJobId' => [ + 'description' => '迁移任务ID。', + 'type' => 'string', + 'example' => 'dtsxxxxxxxx', + ], + 'MigrationObject' => [ + 'description' => '迁移对象。', + 'type' => 'string', + 'example' => '[{\\"DBName\\":\\"dtstestdata\\",\\"TableIncludes\\":[{\\"TableName\\":\\"customer\\"}]}]', + ], + 'MigrationJobClass' => [ + 'description' => '数据迁移链路的规格。', + 'type' => 'string', + 'example' => 'large', + ], + 'SourceEndpoint' => [ + 'description' => '源库连接信息。', + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => [ + 'description' => '数据库名称。'."\n" + .'> 当迁移的源库为PostgreSQL或MongoDB时，才会返回本参数。', + 'type' => 'string', + 'example' => 'dtstestdatabase', + ], + 'InstanceId' => [ + 'description' => '源库的实例ID。'."\n" + .'> - 当迁移的源库为阿里云的云数据库或**通过专线/VPN网关/智能网关接入的自建数据库**时，才会返回本参数。'."\n" + .'- 当迁移的源库为**通过专线/VPN网关/智能网关接入的自建数据库**时，本参数返回VPC ID（即专有网络ID）。', + 'type' => 'string', + 'example' => 'rm-bpxxxxxxxx', + ], + 'InstanceType' => [ + 'description' => '源库的实例类型，返回值：'."\n" + ."\n" + .'- **RDS**：阿里云RDS实例。'."\n" + .'- **ECS**：ECS上的自建数据库。'."\n" + .'- **LocalInstance**：有公网IP的自建数据库。'."\n" + .'- **Express**：通过专线/VPN网关/智能网关接入的自建数据库。'."\n" + .'- **MongoDB**：阿里云MongoDB实例。'."\n" + .'- **POLARDB**：阿里云POLARDB for MySQL集群（该值仅适用于中国站）。', + 'type' => 'string', + 'example' => 'RDS', + ], + 'IP' => [ + 'description' => '源库的连接地址。'."\n" + .'> 当迁移的源库类型为**通过专线/VPN网关/智能网关接入的自建数据库**或有**公网IP的自建数据库**时，才会返回本参数。', + 'type' => 'string', + 'example' => '172.16.88.xxx', + ], + 'Port' => [ + 'description' => '源库的服务端口。', + 'type' => 'string', + 'example' => '3306', + ], + 'UserName' => [ + 'description' => '源库的数据库账号。', + 'type' => 'string', + 'example' => 'dtstest', + ], + 'oracleSID' => [ + 'description' => 'Oracle数据库的SID信息。'."\n" + .'> 当迁移的源库的数据库类型为Oracle时，才会返回本参数。', + 'type' => 'string', + 'example' => 'testsid', + ], + 'EngineName' => [ + 'description' => '源库的数据库类型。 '."\n" + ."\n" + .'> 当迁移的源库类型为自建数据库时，才会返回本参数。', + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + 'DestinationEndpoint' => [ + 'description' => '目标库连接信息。', + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => [ + 'description' => '数据库名称。'."\n" + .'> 当迁移的目标库为PostgreSQL或MongoDB时，才会返回本参数。', + 'type' => 'string', + 'example' => 'dtstestdatabase', + ], + 'InstanceId' => [ + 'description' => '目标库的实例ID。'."\n" + .'> - 当迁移的目标库为阿里云的云数据库或**通过专线/VPN网关/智能网关接入的自建数据库**时，才会返回本参数。'."\n" + .'- 当迁移的目标库为**通过专线/VPN网关/智能网关接入的自建数据库**时，本参数返回VPC ID（即专有网络ID）。', + 'type' => 'string', + 'example' => 'rm-bpxxxxxxxx', + ], + 'InstanceType' => [ + 'description' => '目标库的实例类型，取值：'."\n" + .'- **RDS**：阿里云RDS实例。'."\n" + .'- **ECS**：ECS上的自建数据库。'."\n" + .'- **LocalInstance**：有公网IP的自建数据库。'."\n" + .'- **MongoDB**：阿里云MongoDB实例。'."\n" + .'- **Redis**：阿里云Redis实例。'."\n" + .'- **PetaData**：阿里云PetaData实例。'."\n" + .'- **OceanBase**：阿里云OceanBase实例。'."\n" + .'- **POLARDB**：阿里云POLARDB for MySQL集群。', + 'type' => 'string', + 'example' => 'RDS', + ], + 'IP' => [ + 'description' => '目标库的连接地址。'."\n" + .'> 当迁移的目标库类型为**通过专线/VPN网关/智能网关接入的自建数据库**或有**公网IP的自建数据库**时，才会返回本参数。', + 'type' => 'string', + 'example' => '172.16.88.xxx', + ], + 'Port' => [ + 'description' => '目标库的服务端口。', + 'type' => 'string', + 'example' => '3306', + ], + 'UserName' => [ + 'description' => '目标库的数据库账号。', + 'type' => 'string', + 'example' => 'dtstest', + ], + 'oracleSID' => [ + 'description' => 'Oracle数据库的SID信息。'."\n" + .'> 当迁移的目标库的数据库类型为Oracle时，才会返回本参数。', + 'type' => 'string', + 'example' => 'testsid', + ], + 'EngineName' => [ + 'description' => '目标库的数据库类型。 ', + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + 'MigrationMode' => [ + 'description' => '迁移类型信息。', + 'type' => 'object', + 'properties' => [ + 'dataInitialization' => [ + 'description' => '是否执行了全量数据迁移，返回值为**true**|**false**。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'dataSynchronization' => [ + 'description' => '是否执行了增量数据迁移，返回值为**true**|**false**。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'structureInitialization' => [ + 'description' => '是否执行了结构数据迁移，返回值为**true**|**false**。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'PrecheckStatus' => [ + 'description' => '预检查状态信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '预检查状态，返回值：'."\n" + .'- **NotStarted**：未启动。'."\n" + .'- **Checking**：检查中。'."\n" + .'- **Failed**：预检查失败。'."\n" + .'- **Finished**：预检查成功。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'Percent' => [ + 'description' => '预检查进度，单位为百分比。', + 'type' => 'string', + 'example' => '100', + ], + 'Detail' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CheckItem' => [ + 'description' => '各预检查项的检查情况。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckStatus' => [ + 'description' => '预检查状态，返回值：'."\n" + .'- **NotStarted**：未启动。'."\n" + .'- **Checking**：检查中。'."\n" + .'- **Failed**：预检查失败。'."\n" + .'- **Success**：预检查成功。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ErrorMessage' => [ + 'description' => '预检查失败的错误提示。', + 'type' => 'string', + 'example' => 'CHECK_ERROR_DEST_USER_PSW##DTS##DTS-002006 Connect db jdbc:mysql://100.100.64.101:17557?characterEncoding=utf8 failure, db user dtstes no connect permission, Please vaild user info. Original error: Access denied for user \'dtstes\'@\'100.104.52.253\' (using password: YES)', + ], + 'ItemName' => [ + 'description' => '预检查项目名称。', + 'type' => 'string', + 'example' => 'CHECK_CONN_DEST', + ], + 'RepairMethod' => [ + 'description' => '预检查失败对应的修复方法。', + 'type' => 'string', + 'example' => 'CHECK_ERROR_DEST_CONN_REPAIR2', + ], + ], + ], + ], + ], + ], + ], + ], + 'StructureInitializationStatus' => [ + 'description' => '结构迁移状态信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '迁移状态，返回值：'."\n" + .'- **NotStarted**：未启动。'."\n" + .'- **Migrating** ：迁移中。'."\n" + .'- **Failed**：迁移失败。'."\n" + .'- **Finished**：迁移完成。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'Percent' => [ + 'description' => '结构迁移进度，单位为百分比。', + 'type' => 'string', + 'example' => '100', + ], + 'Progress' => [ + 'description' => '已迁移的记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'ErrorMessage' => [ + 'description' => '结构迁移失败的错误提示。', + 'type' => 'string', + 'example' => 'DTS-1020042 Execute sql error sql: DTS-1020042 Execute sql error sql: CREATE command denied to user \'dtstest80\'@\'100.104.xx.xx\' for table \'customer\' .', + ], + ], + ], + 'DataInitializationStatus' => [ + 'description' => '全量数据迁移的状态信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '迁移状态，返回值：'."\n" + .'- **NotStarted**：未启动。'."\n" + .'- **Migrating** ：迁移中。'."\n" + .'- **Failed**：迁移失败。'."\n" + .'- **Finished**：迁移完成。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'Percent' => [ + 'description' => '全量数据迁移进度，单位为百分比。', + 'type' => 'string', + 'example' => '100', + ], + 'Progress' => [ + 'description' => '已迁移的记录数。', + 'type' => 'string', + 'example' => '10000', + ], + 'ErrorMessage' => [ + 'description' => '全量数据迁移失败的错误提示。', + 'type' => 'string', + 'example' => 'xxxxxxxx', + ], + ], + ], + 'DataSynchronizationStatus' => [ + 'description' => '增量数据迁移的状态信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '迁移状态，返回值：'."\n" + .'- **NotStarted**：未启动。'."\n" + .'- **Migrating**：迁移中。'."\n" + .'- **Failed**：迁移失败。'."\n" + .'- **Finished**：迁移完成。'."\n" + .'- **Catched**：无延迟。', + 'type' => 'string', + 'example' => 'Catched', + ], + 'Delay' => [ + 'description' => '迁移延迟，单位为毫秒。', + 'type' => 'string', + 'example' => '0', + ], + 'Percent' => [ + 'description' => '增量数据迁移进度，单位为百分比。', + 'type' => 'string', + 'example' => '95', + ], + 'ErrorMessage' => [ + 'description' => '增量数据迁移失败的错误提示。', + 'type' => 'string', + 'example' => 'xxxxxxxx', + ], + 'Checkpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1571040679', + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"111\\",\\n \\"MigrationJobName\\": \\"迁移测试\\",\\n \\"MigrationJobStatus\\": \\"Migrating\\",\\n \\"PayType\\": \\"PostPaid\\",\\n \\"MigrationJobId\\": \\"dtsxxxxxxxx\\",\\n \\"MigrationObject\\": \\"[{\\\\\\\\\\\\\\"DBName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"dtstestdata\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TableIncludes\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"TableName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"customer\\\\\\\\\\\\\\"}]}]\\",\\n \\"MigrationJobClass\\": \\"large\\",\\n \\"SourceEndpoint\\": {\\n \\"DatabaseName\\": \\"dtstestdatabase\\",\\n \\"InstanceId\\": \\"rm-bpxxxxxxxx\\",\\n \\"InstanceType\\": \\"RDS\\",\\n \\"IP\\": \\"172.16.88.xxx\\",\\n \\"Port\\": \\"3306\\",\\n \\"UserName\\": \\"dtstest\\",\\n \\"oracleSID\\": \\"testsid\\",\\n \\"EngineName\\": \\"MySQL\\"\\n },\\n \\"DestinationEndpoint\\": {\\n \\"DatabaseName\\": \\"dtstestdatabase\\",\\n \\"InstanceId\\": \\"rm-bpxxxxxxxx\\",\\n \\"InstanceType\\": \\"RDS\\",\\n \\"IP\\": \\"172.16.88.xxx\\",\\n \\"Port\\": \\"3306\\",\\n \\"UserName\\": \\"dtstest\\",\\n \\"oracleSID\\": \\"testsid\\",\\n \\"EngineName\\": \\"MySQL\\"\\n },\\n \\"MigrationMode\\": {\\n \\"dataInitialization\\": true,\\n \\"dataSynchronization\\": true,\\n \\"structureInitialization\\": true\\n },\\n \\"PrecheckStatus\\": {\\n \\"Status\\": \\"Finished\\",\\n \\"Percent\\": \\"100\\",\\n \\"Detail\\": {\\n \\"CheckItem\\": [\\n {\\n \\"CheckStatus\\": \\"Success\\",\\n \\"ErrorMessage\\": \\"CHECK_ERROR_DEST_USER_PSW##DTS##DTS-002006 Connect db jdbc:mysql://100.100.64.101:17557?characterEncoding=utf8 failure, db user dtstes no connect permission, Please vaild user info. Original error: Access denied for user \'dtstes\'@\'100.104.52.253\' (using password: YES)\\",\\n \\"ItemName\\": \\"CHECK_CONN_DEST\\",\\n \\"RepairMethod\\": \\"CHECK_ERROR_DEST_CONN_REPAIR2\\"\\n }\\n ]\\n }\\n },\\n \\"StructureInitializationStatus\\": {\\n \\"Status\\": \\"Finished\\",\\n \\"Percent\\": \\"100\\",\\n \\"Progress\\": \\"1\\",\\n \\"ErrorMessage\\": \\"DTS-1020042 Execute sql error sql: DTS-1020042 Execute sql error sql: CREATE command denied to user \'dtstest80\'@\'100.104.xx.xx\' for table \'customer\' .\\"\\n },\\n \\"DataInitializationStatus\\": {\\n \\"Status\\": \\"Finished\\",\\n \\"Percent\\": \\"100\\",\\n \\"Progress\\": \\"10000\\",\\n \\"ErrorMessage\\": \\"xxxxxxxx\\"\\n },\\n \\"DataSynchronizationStatus\\": {\\n \\"Status\\": \\"Catched\\",\\n \\"Delay\\": \\"0\\",\\n \\"Percent\\": \\"95\\",\\n \\"ErrorMessage\\": \\"xxxxxxxx\\",\\n \\"Checkpoint\\": \\"1571040679\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<StructureInitializationStatus>\\n <Status>Finished</Status>\\n <Percent>100</Percent>\\n <Progress>1</Progress>\\n</StructureInitializationStatus>\\n<MigrationMode>\\n <dataInitialization>true</dataInitialization>\\n <structureInitialization>true</structureInitialization>\\n <dataSynchronization>true</dataSynchronization>\\n</MigrationMode>\\n<MigrationJobId>dtsxxxxxxxx</MigrationJobId>\\n<MigrationObject>[{\\"DBName\\":\\"dtstestdata\\",\\"TableIncludes\\":[{\\"TableName\\":\\"customer\\"}]}]</MigrationObject>\\n<MigrationJobClass>large</MigrationJobClass>\\n<MigrationJobStatus>Migrating</MigrationJobStatus>\\n<PrecheckStatus>\\n <Status>Finished</Status>\\n <Detail>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_CONN_SRC</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_AUTH_SRC</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_CONN_DEST</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_AUTH_DEST</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_BINLOG_ON</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_BINLOG_MODE</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_BINLOG_ROW_IMAGE</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_SERVER_ID</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_BINLOG_EXIST</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_ENGINE</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_MYSQL_PASSOWRD_FORMAT</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_SRC</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_SAME_OBJ</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_DB_AVA</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_SAME_USER</ItemName>\\n </CheckItem>\\n <CheckItem>\\n <CheckStatus>Success</CheckStatus>\\n <ItemName>CHECK_TOPOLOGY</ItemName>\\n </CheckItem>\\n </Detail>\\n <Percent>100</Percent>\\n</PrecheckStatus>\\n<SourceEndpoint>\\n <EngineName>MySQL</EngineName>\\n <InstanceId>rm-bpxxxxxxxx</InstanceId>\\n <UserName>dtstest</UserName>\\n <InstanceType>RDS</InstanceType>\\n</SourceEndpoint>\\n<DestinationEndpoint>\\n <EngineName>MySQL</EngineName>\\n <InstanceId>rm-bpxxxxxxxx</InstanceId>\\n <UserName>dtstest</UserName>\\n <InstanceType>RDS</InstanceType>\\n</DestinationEndpoint>\\n<DataInitializationStatus>\\n <Status>Finished</Status>\\n <Percent>100</Percent>\\n <Progress>10000</Progress>\\n</DataInitializationStatus>\\n<MigrationJobName>API测试</MigrationJobName>\\n<DataSynchronizationStatus>\\n <Status>Catched</Status>\\n <Delay>0</Delay>\\n <Percent>95</Percent>\\n <Checkpoint>1571040679</Checkpoint>\\n</DataSynchronizationStatus>\\n<PayType>PostPaid</PayType>","errorExample":""}]', + 'title' => '查询数据迁移任务的状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMigrationJobs' => [ + 'summary' => '列举迁移任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdtsDW6WLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'MigrationJobName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'PageRecordCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalRecordCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MigrationJobs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MigrationJob' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MigrationJobName' => [ + 'type' => 'string', + ], + 'MigrationJobStatus' => [ + 'type' => 'string', + ], + 'MigrationJobClass' => [ + 'type' => 'string', + ], + 'MigrationJobID' => [ + 'type' => 'string', + ], + 'PayType' => [ + 'type' => 'string', + ], + 'MigrationObject' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SynchronousObject' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => [ + 'type' => 'string', + ], + 'WholeDatabase' => [ + 'type' => 'string', + ], + 'TableList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'SourceEndpoint' => [ + 'type' => 'object', + 'properties' => [ + 'OracleSID' => [ + 'type' => 'string', + ], + 'DatabaseName' => [ + 'type' => 'string', + ], + 'InstanceID' => [ + 'type' => 'string', + ], + 'InstanceType' => [ + 'type' => 'string', + ], + 'IP' => [ + 'type' => 'string', + ], + 'Port' => [ + 'type' => 'string', + ], + 'UserName' => [ + 'type' => 'string', + ], + 'EngineName' => [ + 'type' => 'string', + ], + ], + ], + 'DestinationEndpoint' => [ + 'type' => 'object', + 'properties' => [ + 'OracleSID' => [ + 'type' => 'string', + ], + 'DatabaseName' => [ + 'type' => 'string', + ], + 'InstanceID' => [ + 'type' => 'string', + ], + 'InstanceType' => [ + 'type' => 'string', + ], + 'IP' => [ + 'type' => 'string', + ], + 'Port' => [ + 'type' => 'string', + ], + 'UserName' => [ + 'type' => 'string', + ], + 'EngineName' => [ + 'type' => 'string', + ], + ], + ], + 'MigrationMode' => [ + 'type' => 'object', + 'properties' => [ + 'DataInitialization' => [ + 'type' => 'boolean', + ], + 'DataSynchronization' => [ + 'type' => 'boolean', + ], + 'StructureInitialization' => [ + 'type' => 'boolean', + ], + ], + ], + 'Precheck' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + ], + ], + 'StructureInitialization' => [ + 'type' => 'object', + 'properties' => [ + 'Percent' => [ + 'type' => 'string', + ], + 'Progress' => [ + 'type' => 'string', + ], + 'status' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + ], + ], + 'DataInitialization' => [ + 'type' => 'object', + 'properties' => [ + 'Percent' => [ + 'type' => 'string', + ], + 'Progress' => [ + 'type' => 'string', + ], + 'status' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + ], + ], + 'DataSynchronization' => [ + 'type' => 'object', + 'properties' => [ + 'Delay' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + 'status' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + ], + ], + 'InstanceCreateTime' => [ + 'type' => 'string', + ], + 'JobCreateTime' => [ + 'type' => 'string', + ], + 'JobFinishTime' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + 'DescribeSubscriptionInstanceStatus' => [ + 'summary' => '查询订阅任务状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdtsDW6WLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SubscriptionInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'SubscribeTopic' => [ + 'type' => 'string', + ], + 'BeginTimestamp' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'PayType' => [ + 'type' => 'string', + ], + 'ConsumptionClient' => [ + 'type' => 'string', + ], + 'SubscriptionInstanceName' => [ + 'type' => 'string', + ], + 'SubscriptionInstanceID' => [ + 'type' => 'string', + ], + 'EndTimestamp' => [ + 'type' => 'string', + ], + 'ConsumptionCheckpoint' => [ + 'type' => 'string', + ], + 'SourceEndpoint' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + 'InstanceID' => [ + 'type' => 'string', + ], + ], + ], + 'SubscriptionDataType' => [ + 'type' => 'object', + 'properties' => [ + 'DML' => [ + 'type' => 'boolean', + ], + 'DDL' => [ + 'type' => 'boolean', + ], + ], + ], + 'SubscriptionHost' => [ + 'type' => 'object', + 'properties' => [ + 'VPCHost' => [ + 'type' => 'string', + ], + 'PublicHost' => [ + 'type' => 'string', + ], + 'PrivateHost' => [ + 'type' => 'string', + ], + ], + ], + 'SubscriptionObject' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SynchronousObject' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => [ + 'type' => 'string', + ], + 'WholeDatabase' => [ + 'type' => 'string', + ], + 'TableList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '', + ], + 'DescribeSubscriptionInstances' => [ + 'summary' => '列举订阅任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdtsDW6WLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SubscriptionInstanceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageRecordCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalRecordCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'SubscriptionInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubscriptionInstance' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'SubscribeTopic' => [ + 'type' => 'string', + ], + 'BeginTimestamp' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'PayType' => [ + 'type' => 'string', + ], + 'ConsumptionClient' => [ + 'type' => 'string', + ], + 'SubscriptionInstanceName' => [ + 'type' => 'string', + ], + 'SubscriptionInstanceID' => [ + 'type' => 'string', + ], + 'EndTimestamp' => [ + 'type' => 'string', + ], + 'ConsumptionCheckpoint' => [ + 'type' => 'string', + ], + 'SubscriptionObject' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SynchronousObject' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => [ + 'type' => 'string', + ], + 'WholeDatabase' => [ + 'type' => 'string', + ], + 'TableList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'SourceEndpoint' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + 'InstanceID' => [ + 'type' => 'string', + ], + ], + ], + 'SubscriptionDataType' => [ + 'type' => 'object', + 'properties' => [ + 'DML' => [ + 'type' => 'boolean', + ], + 'DDL' => [ + 'type' => 'boolean', + ], + ], + ], + 'SubscriptionHost' => [ + 'type' => 'object', + 'properties' => [ + 'VPCHost' => [ + 'type' => 'string', + ], + 'PublicHost' => [ + 'type' => 'string', + ], + 'PrivateHost' => [ + 'type' => 'string', + ], + ], + ], + 'InstanceCreateTime' => [ + 'type' => 'string', + ], + 'JobCreateTime' => [ + 'type' => 'string', + ], + 'JobFinishTime' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + 'DescribeSynchronizationJobStatus' => [ + 'summary' => '获取同步任务的状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '96247', + 'abilityTreeNodes' => [ + 'FEATUREdtsDW6WLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SynchronizationJobId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SynchronizationDirection', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SynchronizationJobName' => [ + 'type' => 'string', + ], + 'DataInitialization' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'Delay' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'ExpireTime' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + 'PayType' => [ + 'type' => 'string', + ], + 'StructureInitialization' => [ + 'type' => 'string', + ], + 'SynchronizationJobClass' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'SynchronizationJobId' => [ + 'type' => 'string', + ], + 'SynchronizationDirection' => [ + 'type' => 'string', + ], + 'Checkpoint' => [ + 'type' => 'string', + ], + 'SourceEndpoint' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'type' => 'string', + ], + 'InstanceType' => [ + 'type' => 'string', + ], + 'IP' => [ + 'type' => 'string', + ], + 'Port' => [ + 'type' => 'string', + ], + 'UserName' => [ + 'type' => 'string', + ], + 'EngineName' => [ + 'type' => 'string', + ], + ], + ], + 'DestinationEndpoint' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'type' => 'string', + ], + 'InstanceType' => [ + 'type' => 'string', + ], + 'IP' => [ + 'type' => 'string', + ], + 'Port' => [ + 'type' => 'string', + ], + 'UserName' => [ + 'type' => 'string', + ], + 'EngineName' => [ + 'type' => 'string', + ], + ], + ], + 'PrecheckStatus' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + 'Detail' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckStatus' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'ItemName' => [ + 'type' => 'string', + ], + 'RepairMethod' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'StructureInitializationStatus' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + 'Progress' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + ], + ], + 'DataInitializationStatus' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + 'Progress' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + ], + ], + 'DataSynchronizationStatus' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Delay' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'Checkpoint' => [ + 'type' => 'string', + ], + ], + ], + 'Performance' => [ + 'type' => 'object', + 'properties' => [ + 'RPS' => [ + 'type' => 'string', + ], + 'FLOW' => [ + 'type' => 'string', + ], + ], + ], + 'SynchronizationObjects' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NewSchemaName' => [ + 'type' => 'string', + ], + 'SchemaName' => [ + 'type' => 'string', + ], + 'TableIncludes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TableExcludes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + 'DescribeSynchronizationJobs' => [ + 'summary' => '列举同步任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '96246', + 'abilityTreeNodes' => [ + 'FEATUREdtsDW6WLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SynchronizationJobName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'PageRecordCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalRecordCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ErrMessage' => [ + 'type' => 'string', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SynchronizationInstances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'DataInitialization' => [ + 'type' => 'string', + ], + 'SynchronizationJobName' => [ + 'type' => 'string', + ], + 'Delay' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'ExpireTime' => [ + 'type' => 'string', + ], + 'SynchronizationJobId' => [ + 'type' => 'string', + ], + 'StructureInitialization' => [ + 'type' => 'string', + ], + 'PayType' => [ + 'type' => 'string', + ], + 'SynchronizationJobClass' => [ + 'type' => 'string', + ], + 'SynchronizationDirection' => [ + 'type' => 'string', + ], + 'SynchronizationObjects' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NewSchemaName' => [ + 'type' => 'string', + ], + 'SchemaName' => [ + 'type' => 'string', + ], + 'TableIncludes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TableExcludes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'SourceEndpoint' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'type' => 'string', + ], + 'InstanceType' => [ + 'type' => 'string', + ], + 'IP' => [ + 'type' => 'string', + ], + 'Port' => [ + 'type' => 'string', + ], + 'UserName' => [ + 'type' => 'string', + ], + 'EngineName' => [ + 'type' => 'string', + ], + ], + ], + 'DestinationEndpoint' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'type' => 'string', + ], + 'InstanceType' => [ + 'type' => 'string', + ], + 'IP' => [ + 'type' => 'string', + ], + 'Port' => [ + 'type' => 'string', + ], + 'UserName' => [ + 'type' => 'string', + ], + 'EngineName' => [ + 'type' => 'string', + ], + ], + ], + 'PrecheckStatus' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + 'Detail' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckStatus' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'ItemName' => [ + 'type' => 'string', + ], + 'RepairMethod' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'StructureInitializationStatus' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + 'Progress' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + ], + ], + 'DataInitializationStatus' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + 'Progress' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + ], + ], + 'DataSynchronizationStatus' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Delay' => [ + 'type' => 'string', + ], + 'Percent' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + ], + ], + 'Performance' => [ + 'type' => 'object', + 'properties' => [ + 'RPS' => [ + 'type' => 'string', + ], + 'FLOW' => [ + 'type' => 'string', + ], + ], + ], + 'InstanceCreateTime' => [ + 'type' => 'string', + ], + 'JobCreateTime' => [ + 'type' => 'string', + ], + 'JobFinishTime' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'dts.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'dts.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'dts.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'dts.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'dts.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'dts.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'dts.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'dts.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'dts.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'dts.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'dts.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'dts.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'dts.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'dts.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'dts.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'dts.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'dts.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'dts.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'dts.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'dts.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'dts.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2-pop', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'dts.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-pop', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-nu16-b01', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'dts.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-edge-1', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-2', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-3', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-test-306', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong-finance-pop', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote-nebula-1', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'dts.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'dts.ap-northeast-1.aliyuncs.com', + ], + ], +]; |