Skip to content

Commit e83bd3d

Browse files
ucloud-botucloud-bot
authored
auto codegen for UDisk
1 parent b96a079 commit e83bd3d

File tree

2 files changed

+29
-15
lines changed

2 files changed

+29
-15
lines changed

‎ucloud/services/udisk/client.py‎

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,9 @@ def clone_udisk(self, req: typing.Optional[dict] = None, **kwargs) -> dict:
5858
- **ChargeType** (str) - Year , Month, Dynamic，Postpay，Trial 默认: Month
5959
- **Comment** (str) - Disk注释
6060
- **CouponId** (str) - 使用的代金券id
61+
- **HostId** (str) - Host实例ID。克隆出的云盘可直接挂载到该主机上。
6162
- **Quantity** (int) - 购买时长 默认: 1
62-
- **RdmaClusterId** (str) - RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
63+
- **RdmaClusterId** (str) - 【已废弃】RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
6364
- **SnapshotService** (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
6465
- **Tag** (str) - 业务组 默认：Default
6566
- **UDataArkMode** (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
@@ -95,8 +96,9 @@ def clone_udisk_snapshot(
9596
- **ChargeType** (str) - Year , Month, Dynamic，Postpay 默认: Dynamic
9697
- **Comment** (str) - Disk注释
9798
- **CouponId** (str) - 使用的代金券id
99+
- **HostId** (str) - Host实例ID。克隆出的云盘可直接挂载到该主机上。
98100
- **Quantity** (int) - 购买时长 默认: 1
99-
- **RdmaClusterId** (str) - RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
101+
- **RdmaClusterId** (str) - 【已废弃】RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
100102
- **Size** (int) - 购买UDisk大小,单位:GB,范围[1~8000]。(UDisk大小设定对本地盘快照有效，对云盘快照无效)
101103
- **SnapshotService** (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
102104
- **Tag** (str) - 业务组 默认：Default
@@ -134,8 +136,9 @@ def clone_udisk_udataark(
134136
- **ChargeType** (str) - Year , Month, Dynamic，Postpay 默认: Dynamic
135137
- **Comment** (str) - Disk注释
136138
- **CouponId** (str) - 使用的代金券id
139+
- **HostId** (str) - Host实例ID。克隆出的云盘可直接挂载到该主机上。
137140
- **Quantity** (int) - 购买时长 默认: 1
138-
- **RdmaClusterId** (str) - RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
141+
- **RdmaClusterId** (str) - 【已废弃】RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
139142
- **Size** (int) - 购买UDisk大小,单位:GB,范围[1~8000]。(UDisk大小设定对本地盘备份有效，对云盘备份无效)
140143
- **SnapshotService** (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
141144
- **Tag** (str) - 业务组 默认：Default
@@ -382,19 +385,22 @@ def describe_udisk(
382385
383386
**Request**
384387
385-
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list.html>`_
386-
- **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist.html>`_
387-
- **DiskType** (str) - ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:"CLOUD_NORMAL",IsBoot:"False"；普通系统盘：DiskType:"CLOUD_NORMAL",IsBoot:"True"；SSD数据盘：DiskType:"CLOUD_SSD",IsBoot:"False"；SSD系统盘：DiskType:"CLOUD_SSD",IsBoot:"True"；RSSD数据盘：DiskType:"CLOUD_RSSD",IsBoot:"False"；为空拉取所有。ProtocolVersion字段为0或没有该字段时，可设为以下几个值:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk；为空拉取所有。
388-
- **HostIdForAttachment** (str) - 根据传入的HostIdForAttachment，筛选出虚机在同一PodId下的云盘
388+
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
389+
- **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
390+
- **DiskType** (str) - ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:"CLOUD_NORMAL",IsBoot:"False"；普通系统盘：DiskType:"CLOUD_NORMAL",IsBoot:"True"；SSD数据盘：DiskType:"CLOUD_SSD",IsBoot:"False"；SSD系统盘：DiskType:"CLOUD_SSD",IsBoot:"True"；RSSD数据盘：DiskType:"CLOUD_RSSD",IsBoot:"False"；RSSD系统盘：DiskType:"CLOUD_RSSD",IsBoot:"True"；高效数据盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"False"；高效系统盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"True"；为空拉取所有。ProtocolVersion字段为0或没有该字段时，可设为以下几个值:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk；RSSD系统盘：RSSDSystemDisk：高效数据盘：EfficiencyDataDisk；高效系统盘：EfficiencySystemDisk；为空拉取所有。
391+
- **HostId** (str) - 根据传入的HostId，返回与该主机关联的云盘信息。
392+
- **HostIdForAttachment** (str) - 根据传入的HostIdForAttachment，筛选出能被挂载在该主机上的云盘。目前主要针对RSSD云盘。
389393
- **HostProduct** (str) - 宿主产品类型，可筛选挂载在该类型宿主上的云盘。可选值：uhost, uphost。为空拉取所有。（当HostIdForAttachment字段不为空时，该字段可以不填，若HostIdForAttachment与该字段宿主类型冲突，则以HostIdForAttachment字段为准。）
394+
- **IgnoreBackupMode** (str) - 是否忽略快照服务信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心快照服务信息，建议选填“Yes”，可降低请求延时）
390395
- **IgnoreUBillInfo** (str) - 是否忽略计费信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心账单信息，建议选填“Yes”，可降低请求延时）
391396
- **IsBoot** (str) - ProtocolVersion字段为1且DiskType不为空时，必须设置，设置规则请参照DiskType；ProtocolVersion字段为1且DiskType为空时，该字段无效。ProtocolVersion字段为0或没有该字段时，该字段无效。
392397
- **Limit** (int) - 返回数据长度, 默认为20
393398
- **Offset** (int) - 数据偏移量, 默认为0
394399
- **ProtocolVersion** (int) - 请求协议版本，建议升级为1，为1时DiskType与UHost磁盘类型定义一致；默认为0
400+
- **UDiskBasicInfo** (str) - 是否只返回云盘基础信息（只包含云盘及关联主机的资源信息）。Yes：是，No：否，默认值（No）。（如仅需要基础信息，建议选填“Yes”，可降低请求延时）
395401
- **UDiskId** (str) - UDisk Id(留空返回全部)
396-
- **UHostIdForAttachment** (str) - 根据传入的UHostIdForAttachment，筛选出虚机在同一PodId下的云盘【本字段即将废弃，建议使用HostIdForAttachment】
397-
- **Zone** (str) - 可用区。参见 `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist.html>`_
402+
- **UHostIdForAttachment** (str) - 根据传入的UHostIdForAttachment，筛选出能被挂载在该主机上的云盘【本字段即将废弃，建议使用HostIdForAttachment】
403+
- **Zone** (str) - 可用区。参见 `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
398404
399405
**Response**
400406
@@ -414,7 +420,7 @@ def describe_udisk(
414420
- **CreateTime** (int) - 创建时间
415421
- **DataKey** (str) - 该盘的密文密钥
416422
- **DeviceName** (str) - 挂载的设备名称
417-
- **DiskType** (str) - 请求中的ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:"CLOUD_NORMAL",IsBoot:"False"； 普通系统盘：DiskType:"CLOUD_NORMAL",IsBoot:"True"；SSD数据盘：DiskType:"CLOUD_SSD",IsBoot:"False"；SSD系统盘：DiskType:"CLOUD_SSD",IsBoot:"True"；RSSD数据盘：DiskType:"CLOUD_RSSD",IsBoot:"False"。请求中的ProtocolVersion字段为0或没有该字段时，云硬盘类型参照如下:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk。
423+
- **DiskType** (str) - 请求中的ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:"CLOUD_NORMAL",IsBoot:"False"； 普通系统盘：DiskType:"CLOUD_NORMAL",IsBoot:"True"；SSD数据盘：DiskType:"CLOUD_SSD",IsBoot:"False"；SSD系统盘：DiskType:"CLOUD_SSD",IsBoot:"True"；RSSD数据盘：DiskType:"CLOUD_RSSD",IsBoot:"False"；RSSD系统盘：DiskType:"CLOUD_RSSD",IsBoot:"True"；高效数据盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"False"；高效系统盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"True"。请求中的ProtocolVersion字段为0或没有该字段时，云硬盘类型参照如下:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk；RSSD系统盘：RSSDSystemDisk；高效数据盘：EfficiencyDataDisk；高效系统盘：EfficiencySystemDisk。
418424
- **ExpiredTime** (int) - 过期时间
419425
- **HostIP** (str) - 挂载的Host的IP
420426
- **HostId** (str) - 挂载的Host的Id
@@ -503,13 +509,13 @@ def describe_udisk_snapshot(
503509
504510
**Request**
505511
506-
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list.html>`_
507-
- **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist.html>`_
512+
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
513+
- **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
508514
- **Limit** (int) - 返回数据长度, 默认为20
509515
- **Offset** (int) - 数据偏移量, 默认为0
510516
- **SnapshotId** (str) - 快照id，SnapshotId , UDiskId 同时传SnapshotId优先
511517
- **UDiskId** (str) - UDiskId,返回该盘所做快照.(必须同时传Zone)
512-
- **Zone** (str) - 可用区。参见 `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist.html>`_
518+
- **Zone** (str) - 可用区。参见 `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
513519
514520
**Response**
515521
@@ -525,7 +531,7 @@ def describe_udisk_snapshot(
525531
- **Comment** (str) - 快照描述
526532
- **CreateTime** (int) - 创建时间
527533
- **DataKey** (str) - 该快照的密文密钥
528-
- **DiskType** (int) - 磁盘类型，0:数据盘，1:系统盘
534+
- **DiskType** (int) - 磁盘类型，0：普通数据盘；1：普通系统盘；2：SSD数据盘；3：SSD系统盘；4：RSSD数据盘；5：RSSD系统盘。
529535
- **ExpiredTime** (int) - 过期时间
530536
- **IsUDiskAvailable** (bool) - 对应磁盘是否处于可用状态
531537
- **Name** (str) - 快照名称
@@ -566,7 +572,7 @@ def describe_udisk_upgrade_price(
566572
- **Zone** (str) - (Required) 可用区。参见 `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
567573
- **DiskType** (str) - 【已废弃】UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），RSSDDataDisk(RSSD数据盘)，EfficiencyDataDisk（高效数据盘），SystemDisk（普通系统盘），SSDSystemDisk（SSD系统盘），RSSDSystemDisk(RSSD系统盘)，EfficiencySystemDisk（高效系统盘），默认值（DataDisk）
568574
- **MachineType** (str) - 【已废弃】云主机机型（V2.0），枚举值["N", "C", "G", "O", "OM"]。参考 `云主机机型说明 <https://docs.ucloud.cn/api/uhost-api/uhost_type>`_ 。
569-
- **SnapshotService** (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
575+
- **SnapshotService** (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No。仅支持查询开启快照服务的价格。
570576
- **UDataArkMode** (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
571577
572578
**Response**

‎ucloud/services/udisk/schemas/apis.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ class CloneUDiskRequestSchema(schema.RequestSchema):
5454
"ChargeType": fields.Str(required=False, dump_to="ChargeType"),
5555
"Comment": fields.Str(required=False, dump_to="Comment"),
5656
"CouponId": fields.Str(required=False, dump_to="CouponId"),
57+
"HostId": fields.Str(required=False, dump_to="HostId"),
5758
"Name": fields.Str(required=True, dump_to="Name"),
5859
"ProjectId": fields.Str(required=False, dump_to="ProjectId"),
5960
"Quantity": fields.Int(required=False, dump_to="Quantity"),
@@ -93,6 +94,7 @@ class CloneUDiskSnapshotRequestSchema(schema.RequestSchema):
9394
"ChargeType": fields.Str(required=False, dump_to="ChargeType"),
9495
"Comment": fields.Str(required=False, dump_to="Comment"),
9596
"CouponId": fields.Str(required=False, dump_to="CouponId"),
97+
"HostId": fields.Str(required=False, dump_to="HostId"),
9698
"Name": fields.Str(required=True, dump_to="Name"),
9799
"ProjectId": fields.Str(required=False, dump_to="ProjectId"),
98100
"Quantity": fields.Int(required=False, dump_to="Quantity"),
@@ -133,6 +135,7 @@ class CloneUDiskUDataArkRequestSchema(schema.RequestSchema):
133135
"ChargeType": fields.Str(required=False, dump_to="ChargeType"),
134136
"Comment": fields.Str(required=False, dump_to="Comment"),
135137
"CouponId": fields.Str(required=False, dump_to="CouponId"),
138+
"HostId": fields.Str(required=False, dump_to="HostId"),
136139
"Name": fields.Str(required=True, dump_to="Name"),
137140
"ProjectId": fields.Str(required=False, dump_to="ProjectId"),
138141
"Quantity": fields.Int(required=False, dump_to="Quantity"),
@@ -368,10 +371,14 @@ class DescribeUDiskRequestSchema(schema.RequestSchema):
368371

369372
fields = {
370373
"DiskType": fields.Str(required=False, dump_to="DiskType"),
374+
"HostId": fields.Str(required=False, dump_to="HostId"),
371375
"HostIdForAttachment": fields.Str(
372376
required=False, dump_to="HostIdForAttachment"
373377
),
374378
"HostProduct": fields.Str(required=False, dump_to="HostProduct"),
379+
"IgnoreBackupMode": fields.Str(
380+
required=False, dump_to="IgnoreBackupMode"
381+
),
375382
"IgnoreUBillInfo": fields.Str(
376383
required=False, dump_to="IgnoreUBillInfo"
377384
),
@@ -383,6 +390,7 @@ class DescribeUDiskRequestSchema(schema.RequestSchema):
383390
required=False, dump_to="ProtocolVersion"
384391
),
385392
"Region": fields.Str(required=True, dump_to="Region"),
393+
"UDiskBasicInfo": fields.Str(required=False, dump_to="UDiskBasicInfo"),
386394
"UDiskId": fields.Str(required=False, dump_to="UDiskId"),
387395
"UHostIdForAttachment": fields.Str(
388396
required=False, dump_to="UHostIdForAttachment"

0 commit comments

Comments
 (0)