Skip to content

Commit f75c340

Browse files
ucloud-botucloud-bot
authored
auto codegen for UDTS
1 parent 793a1ad commit f75c340

File tree

3 files changed

+202
-159
lines changed

3 files changed

+202
-159
lines changed

‎ucloud/services/udts/client.py‎

Lines changed: 94 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def check_udts_task(
2222
2323
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
2424
- **MaxRetryCount** (str) - (Required) 重试次数，最大为 5。 默认为0
25-
- **Name** (str) - (Required) task 名称，长度不能超过 128
25+
- **Name** (str) - (Required) 任务名称，长度不能超过 128
2626
- **Type** (str) - (Required) 任务类型，值为 transfer 或 integration， transfer 时任务为 数据迁移，integration 时任务为 数据集成。
2727
- **Query** (str) - 废弃
2828
- **Source** (list) - 见 **CheckUDTSTaskParamSource** 模型定义
@@ -37,16 +37,38 @@ def check_udts_task(
3737
3838
**Request Model**
3939
40+
**CheckUDTSTaskParamSourceMySQLNodeQueryData**
41+
- **DBName** (str) - 数据集成时需要迁移的 DB 名
42+
- **NewDBName** (str) - 数据集成时迁移后的 DB 名
43+
44+
45+
**CheckUDTSTaskParamSourceMySQLNode**
46+
- **DataRegion** (str) - 数据库地域，比如 cn-bj2
47+
- **Database** (str) - 需要迁移的 DB 名称
48+
- **Host** (str) - 源数据库地址， 比如 10.9.37.200
49+
- **Password** (str) - 源 MySQL 密码
50+
- **Port** (int) - 源 MySQL 端口，如 3306
51+
- **QueryData** (list) - 见 **CheckUDTSTaskParamSourceMySQLNodeQueryData** 模型定义
52+
- **SubnetId** (str) - 子网 ID，可以从 https://console.ucloud.cn/vpc/subnet，比如 subnet-2sloxs
53+
- **SyncData** (dict) - 见 **CheckUDTSTaskParamSourceMySQLNodeSyncData** 模型定义
54+
- **Table** (str) - 需要迁移的 table 名
55+
- **User** (str) - 源 MySQL 用户名，如 root
56+
- **VPCId** (str) - VPC ID, 可以从 https://console.ucloud.cn/vpc/vpc 获取，比如 uvnet-u0ecace
57+
58+
4059
**CheckUDTSTaskParamSourceMySQLNodeSyncData**
4160
- **BinlogGTID** (str) - 增量时需要指定的 binlog gtid，可以通过 show master status 获取，或者全量+增量任务会自动设置
4261
- **BinlogName** (str) - 增量时需要指定的 binlog name，可以通过 show master status 获取，或者全量+增量任务会自动设置
4362
- **BinlogPos** (int) - 增量时需要指定的 binlog pos，可以通过 show master status 获取，或者全量+增量任务会自动设置
4463
- **ServerID** (int) - 增量时需要指定的 serverID，不能和现有的 slave 重复，预检查时会检查该值
4564
4665
47-
**CheckUDTSTaskParamSourceMySQLNodeQueryData**
48-
- **DBName** (str) - 数据集成时需要迁移的 DB 名
49-
- **NewDBName** (str) - 数据集成时迁移后的 DB 名
66+
**CheckUDTSTaskParamSource**
67+
- **DataType** (str) - 数据库类型，比如 mysql
68+
- **Mode** (str) - 任务模式，值可以是 full, incremental, full+incremental, bidirectional
69+
- **MySQLNode** (dict) - 见 **CheckUDTSTaskParamSourceMySQLNode** 模型定义
70+
- **NWType** (str) - 源网络类型，可以是 public,user,dedicated_line
71+
- **ServiceType** (str) - 服务类型，值可以是 small、medium、large，分别对应 “基础版”、“轻量版” 和 “旗舰版”
5072
5173
5274
**CheckUDTSTaskParamTargetMySQLNode**
@@ -59,38 +81,17 @@ def check_udts_task(
5981
- **VPCId** (str) - 目标数据库 VPC,比如 uvnet-1wz5rqte
6082
6183
62-
**CheckUDTSTaskParamSourceMySQLNode**
63-
- **DataRegion** (str) - 数据库地域，比如 cn-bj2
64-
- **Database** (str) - 需要迁移的 DB 名称
65-
- **Host** (str) - 源数据库地址， 比如 10.9.37.200
66-
- **Password** (str) - 源 MySQL 密码
67-
- **Port** (int) - 源 MySQL 端口，如 3306
68-
- **QueryData** (list) - 见 **CheckUDTSTaskParamSourceMySQLNodeQueryData** 模型定义
69-
- **SubnetId** (str) - 子网 ID
70-
- **SyncData** (dict) - 见 **CheckUDTSTaskParamSourceMySQLNodeSyncData** 模型定义
71-
- **Table** (str) - 需要迁移的 table 名
72-
- **User** (str) - 源 MySQL 用户名，如 root
73-
- **VPCId** (str) - VPC
74-
75-
7684
**CheckUDTSTaskParamTarget**
7785
- **DataType** (str) - 目标数据库类型，比如 mysql
7886
- **MySQLNode** (dict) - 见 **CheckUDTSTaskParamTargetMySQLNode** 模型定义
7987
- **NWType** (str) - 目标 db 网络类型，目前进支持 user
8088
8189
82-
**CheckUDTSTaskParamSource**
83-
- **DataType** (str) - 数据库类型
84-
- **Mode** (str) - // 任务类型，值可以是 full, incremental, full+incremental, bidirectional
85-
- **MySQLNode** (dict) - 见 **CheckUDTSTaskParamSourceMySQLNode** 模型定义
86-
- **NWType** (str) - 源网络类型，可以是 public,user,dedicated_line
87-
88-
8990
**Response Model**
9091
91-
**CheckResultItem**
92-
- **ErrMessage** (str) -
93-
- **State** (str) - 状态
92+
**CheckUDTSTaskResult**
93+
- **Source** (dict) - 见 **CheckResult** 模型定义
94+
- **Target** (dict) - 见 **CheckResult** 模型定义
9495
9596
9697
**CheckResult**
@@ -99,9 +100,9 @@ def check_udts_task(
99100
- **Privileges** (dict) - 见 **CheckResultItem** 模型定义
100101
101102
102-
**CheckUDTSTaskResult**
103-
- **Source** (dict) - 见 **CheckResult** 模型定义
104-
- **Target** (dict) - 见 **CheckResult** 模型定义
103+
**CheckResultItem**
104+
- **ErrMessage** (str) -
105+
- **State** (str) - 状态
105106
106107
107108
"""
@@ -123,10 +124,13 @@ def create_udts_task(
123124
**Request**
124125
125126
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
126-
- **Name** (str) - (Required) task 名称，长度不能超过 128
127+
- **Name** (str) - (Required) 任务名称，长度不能超过 128
127128
- **Type** (str) - (Required) 任务类型，transfer(数据传输) 或 integration(数据集成)
129+
- **ChargeType** (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费；Dynamic, 按需付费(需开启权限)；默认为按月付费
130+
- **CouponId** (str) - 代金券ID, 默认不使用
128131
- **IsUnidirection** (str) - 暂时未使用该字段
129132
- **MaxRetryCount** (str) - 重试次数，最大为 5。 默认为0
133+
- **Quantity** (int) - 购买时长, 默认: 1
130134
- **Query** (str) - 暂时未使用该字段
131135
- **Remark** (str) - 备注信息，长度不能大于 255
132136
- **Source** (list) - 见 **CreateUDTSTaskParamSource** 模型定义
@@ -136,9 +140,17 @@ def create_udts_task(
136140
137141
- **Data** (dict) -
138142
- **Message** (str) - 返回消息
143+
- **TaskId** (str) - 任务ID，目前用于控制台操作日志
139144
140145
**Request Model**
141146
147+
**CreateUDTSTaskParamSourceMySQLNodeQueryData**
148+
- **DBName** (str) - 数据集成时需要迁移的 DB 名
149+
- **NewDBName** (str) - 数据集成时迁移后的 DB 名
150+
- **TableData** (dict) - 见 **CreateUDTSTaskParamSourceMySQLNodeQueryDataTableData** 模型定义
151+
- **TableMaps** (list) - 见 **CreateUDTSTaskParamSourceMySQLNodeQueryDataTableMaps** 模型定义
152+
153+
142154
**CreateUDTSTaskParamSourceMySQLNodeQueryDataTableData**
143155
- **ExcludeTables** (bool) - 暂时未使用该字段
144156
- **TableNames** (str) - 暂时未使用该字段
@@ -149,20 +161,6 @@ def create_udts_task(
149161
- **TableName** (str) - 数据集成时需要迁移的 Table 名
150162
151163
152-
**CreateUDTSTaskParamSourceMySQLNodeSyncData**
153-
- **BinlogGTID** (str) - 增量时需要指定的 binlog gtid，可以通过 show master status 获取，或者全量+增量任务会自动设置
154-
- **BinlogName** (str) - 增量时需要指定的 binlog name，可以通过 show master status 获取，或者全量+增量任务会自动设置
155-
- **BinlogPos** (int) - 增量时需要指定的 binlog pos，可以通过 show master status 获取，或者全量+增量任务会自动设置
156-
- **ServerID** (int) - 增量时需要指定的 serverID，不能和现有的 slave 重复，预检查时会检查该值
157-
158-
159-
**CreateUDTSTaskParamSourceMySQLNodeQueryData**
160-
- **DBName** (str) - 数据集成时需要迁移的 DB 名
161-
- **NewDBName** (str) - 数据集成时迁移后的 DB 名
162-
- **TableData** (dict) - 见 **CreateUDTSTaskParamSourceMySQLNodeQueryDataTableData** 模型定义
163-
- **TableMaps** (list) - 见 **CreateUDTSTaskParamSourceMySQLNodeQueryDataTableMaps** 模型定义
164-
165-
166164
**CreateUDTSTaskParamSourceMySQLNode**
167165
- **DataRegion** (str) - 数据库地域，比如 cn-bj2
168166
- **Database** (str) - 需要迁移的 DB 名称
@@ -172,11 +170,28 @@ def create_udts_task(
172170
- **Password** (str) - 源数据库密码
173171
- **Port** (int) - 源数据库端口
174172
- **QueryData** (list) - 见 **CreateUDTSTaskParamSourceMySQLNodeQueryData** 模型定义
175-
- **SubnetId** (str) - 源数据库子网 ID，当网络类型为 user 时需要填写
173+
- **SSLSecurity** (dict) - 见 **CreateUDTSTaskParamSourceMySQLNodeSSLSecurity** 模型定义
174+
- **SubnetId** (str) - 源数据库子网 ID，当网络类型为 user 时需要填写，可以从 https://console.ucloud.cn/vpc/subnet，比如 subnet-2sloxs
176175
- **SyncData** (dict) - 见 **CreateUDTSTaskParamSourceMySQLNodeSyncData** 模型定义
177176
- **Table** (str) - 需要迁移的 table 名
178177
- **User** (str) - 源数据库用户名
179-
- **VPCId** (str) - 源数据库 VPC ID，当网络类型为 user 时需要填写
178+
- **VPCId** (str) - 源数据库 VPC ID，当网络类型为 user 时需要填写，可以从 https://console.ucloud.cn/vpc/vpc 获取，比如 uvnet-u0ecace
179+
180+
181+
**CreateUDTSTaskParamSourceMySQLNodeSyncData**
182+
- **BinlogGTID** (str) - 增量时需要指定的 binlog gtid，可以通过 show master status 获取，或者全量+增量任务会自动设置
183+
- **BinlogName** (str) - 增量时需要指定的 binlog name，可以通过 show master status 获取，或者全量+增量任务会自动设置
184+
- **BinlogPos** (int) - 增量时需要指定的 binlog pos，可以通过 show master status 获取，或者全量+增量任务会自动设置
185+
- **ServerID** (int) - 增量时需要指定的 serverID，不能和现有的 slave 重复，预检查时会检查该值
186+
187+
188+
**CreateUDTSTaskParamSource**
189+
- **BandwidthLimit** (int) - 源端限速值，单位为 MB/s
190+
- **DataType** (str) - 数据库类型，比如 mysql
191+
- **Mode** (str) - 任务模式，值可以是 full, incremental, full+incremental, bidirectional
192+
- **MySQLNode** (dict) - 见 **CreateUDTSTaskParamSourceMySQLNode** 模型定义
193+
- **NWType** (str) - 源网络类型，可以是 public,user,dedicated_line
194+
- **ServiceType** (str) - 服务类型，值可以是small、medium、large，分别对应“基础版”、“轻量版”和“旗舰版”
180195
181196
182197
**CreateUDTSTaskParamTargetMySQLNode**
@@ -190,14 +205,6 @@ def create_udts_task(
190205
- **VPCId** (str) - 目标数据库 VPC,比如 uvnet-1wz5rqte
191206
192207
193-
**CreateUDTSTaskParamSource**
194-
- **BandwidthLimit** (int) - 源端限速值，单位为 MB/s
195-
- **DataType** (str) - 数据库类型，比如 mysql
196-
- **Mode** (str) - 任务类型，值可以是 full, incremental, full+incremental, bidirectional
197-
- **MySQLNode** (dict) - 见 **CreateUDTSTaskParamSourceMySQLNode** 模型定义
198-
- **NWType** (str) - 源网络类型，可以是 public,user,dedicated_line
199-
200-
201208
**CreateUDTSTaskParamTarget**
202209
- **BandwidthLimit** (str) - 目标端限速，单位为 MB/s
203210
- **DataType** (str) - 目标数据库类型，比如 mysql
@@ -206,6 +213,12 @@ def create_udts_task(
206213
- **NWType** (str) - 目标 db 网络类型，目前仅支持 user
207214
208215
216+
**CreateUDTSTaskParamSourceMySQLNodeSSLSecurity**
217+
- **SSLCA** (str) - ca 证书，目前仅支持 pem 格式; 需要将文件内容 base64
218+
- **SSLCert** (str) - 客户端证书; 需要将文件内容 base64
219+
- **SSLKey** (str) - 客户端私钥， 需要将文件内容 base64
220+
221+
209222
"""
210223
# build request
211224
d = {
@@ -273,11 +286,13 @@ def get_udts_task_status(
273286
274287
**Response Model**
275288
276-
**SyncData**
277-
- **BinlogGTID** (str) - GTID
278-
- **BinlogName** (str) - Binlog 文件名， 长度不超过128字符
279-
- **BinlogPos** (int) - Binlog Pos
280-
- **ServerId** (int) - 分配给UDTS task的server ID, 必须在MySQL集群中唯一
289+
**StatusData**
290+
- **CurRetryCount** (int) - 当前失败重试次数
291+
- **FailedMessage** (str) - 当Status为Failed时, 显示失败原因
292+
- **MaxRetryCount** (int) - 用户设置的最大失败重试次数
293+
- **Progress** (dict) - 见 **Progress** 模型定义
294+
- **Status** (str) - 任务状态, 状态有 Created:已创建,Checking:检查中,Dumping:转储中,Loading:加载中,Syncing:同步中,Synced:已同步,Done:完成,Failed:失败,Stopping:停止中,Stopped:停止,RetryPending:重试等待中,Starting:启动中,FailedUnrecoverable:异常,StoppedUnrecoverable:异常,Success:成功,Started:已启动
295+
- **Sync** (dict) - 见 **SyncData** 模型定义
281296
282297
283298
**Progress**
@@ -288,13 +303,10 @@ def get_udts_task_status(
288303
- **TotalDuration** (int) - 估算总耗时间（单位秒）
289304
290305
291-
**StatusData**
292-
- **CurRetryCount** (int) - 当前失败重试次数
293-
- **FailedMessage** (str) - 当Status为Failed时, 显示失败原因
294-
- **MaxRetryCount** (int) - 用户设置的最大失败重试次数
295-
- **Progress** (dict) - 见 **Progress** 模型定义
296-
- **Status** (str) - 任务状态, 状态有 Created:已创建,Checking:检查中,Dumping:转储中,Loading:加载中,Syncing:同步中,Synced:已同步,Done:完成,Failed:失败,Stopping:停止中,Stopped:停止,RetryPending:重试等待中,Starting:启动中,FailedUnrecoverable:异常,StoppedUnrecoverable:异常,Success:成功,Started:已启动
297-
- **Sync** (dict) - 见 **SyncData** 模型定义
306+
**SyncData**
307+
- **BinlogGTID** (str) - GTID
308+
- **BinlogName** (str) - Binlog 文件名， 长度不超过128字符
309+
- **BinlogPos** (int) - Binlog Pos
298310
299311
300312
"""
@@ -315,7 +327,7 @@ def list_udts_task(
315327
316328
**Request**
317329
318-
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list.html>`_
330+
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
319331
- **Limit** (str) - 请求数量，默认为 20
320332
- **Offset** (str) - 偏移量，默认为 0
321333
- **Type** (str) - 任务类型
@@ -327,25 +339,30 @@ def list_udts_task(
327339
328340
**Response Model**
329341
330-
**Progress**
331-
- **CurCount** (int) - 已迁移条目数
332-
- **CurDuration** (int) - 已耗时间（单位秒）
333-
- **Percentage** (float) - 完成进度
334-
- **TotalCount** (int) - 总条目数
335-
- **TotalDuration** (int) - 估算总耗时间（单位秒）
336-
337-
338342
**ListDataItem**
343+
- **AutoRenew** (str) - 是否自动续费，枚举：Yes/ No
344+
- **ChargeType** (str) - 资源付费类型，枚举：Dynamic/ Month/ Year/ Trial/ Day
339345
- **CreateTime** (int) - 创建时间
340346
- **CurRetryCount** (int) - 当前失败重试次数
347+
- **ExpireTime** (int) - 资源有效期时间戳
348+
- **IsExpire** (str) - 资源是否过期，枚举：Yes/ No
341349
- **MaxRetryCount** (int) - 最大失败重试次数
342350
- **Name** (str) - 任务名称
343351
- **Progress** (dict) - 见 **Progress** 模型定义
352+
- **ServiceType** (str) - 服务类型， small, medium, large
344353
- **Status** (str) - 任务状态
345354
- **TaskId** (str) - 任务 ID
346355
- **Type** (str) - 任务类型, full全量, incremental增量，full+incremental全量+增量。
347356
348357
358+
**Progress**
359+
- **CurCount** (int) - 已迁移条目数
360+
- **CurDuration** (int) - 已耗时间（单位秒）
361+
- **Percentage** (float) - 完成进度
362+
- **TotalCount** (int) - 总条目数
363+
- **TotalDuration** (int) - 估算总耗时间（单位秒）
364+
365+
349366
"""
350367
# build request
351368
d = {

0 commit comments

Comments
 (0)