Merge pull request #144 from jdcloud-apigateway/master

publish jdcloud-sdk-python 1.6.115

Author: jdcloud-apigateway

jdcloud_sdk/services/vm/ChangeLog.md

@@ -1,8 +1,10 @@
 # 更新历史 #
-API版本：1.3.4
+API版本：1.3.7
 
 |发布时间|版本号|更新|说明|
 |---|---|---|---|
+|2021-07-29   |1.3.7   |文档完善       |* 完善文档描述，针对逻辑不清楚的地方补充描述 |
+|2021-04-22   |1.3.5   |新增接口       |* 新增虚机修改VPC接口 |
 |2020-10-23   |1.3.4   |新增参数       |* 实例接口新增hostname、K-V形式元数据等参数；实例模板接口新增userdata、K-V形式元数据等参数 |
 |2020-05-28   |1.3.2   |新增参数       |* 实例接口/实例模板接口新增云硬盘快照策略参数 |
 |2020-04-20   |1.2.8   |新增参数       |* 实例接口/实例模板接口增加停机不计费参数 |

jdcloud_sdk/services/vm/apis/AssociateElasticIpRequest.py

@@ -21,8 +21,15 @@
 
 class AssociateElasticIpRequest(JDCloudRequest):
     """
-    为云主机主网卡的主内网IP绑定弹性公网IP。<br>
-一台云主机的主网卡的主内网IP只能绑定一个弹性公网IP，若已绑定弹性公网IP，操作绑定会返回错误。<br>
+    
+为云主机绑定弹性公网IP。
+
+详细操作说明请参考帮助文档：[绑定弹性公网IP](https://docs.jdcloud.com/cn/virtual-machines/associate-elastic-ip)
+
+## 接口说明
+- 该接口只支持在实例的主网卡的主内网IP上绑定弹性公网IP。
+- 一台云主机的主网卡的主内网IP只能绑定一个弹性公网IP，若已绑定弹性公网IP，操作绑定会返回错误。
+- 弹性公网IP所在的可用区需要与云主机的可用区保持一致，或者弹性公网IP是全可用区类型的，才允许绑定操作。
 
     """
 
@@ -36,9 +43,9 @@ class AssociateElasticIpParameters(object):
 
     def __init__(self, regionId, instanceId, elasticIpId):
         """
-        :param regionId: 地域ID
-        :param instanceId: 云主机ID
-        :param elasticIpId: 弹性公网IP的ID
+        :param regionId: 地域ID。
+        :param instanceId: 云主机ID。
+        :param elasticIpId: 弹性公网IP的ID。
         """
 
         self.regionId = regionId

jdcloud_sdk/services/vm/apis/AttachDiskRequest.py

@@ -21,9 +21,18 @@
 
 class AttachDiskRequest(JDCloudRequest):
     """
-    为一台云主机挂载一块云硬盘，云主机和云硬盘没有正在进行中的的任务时才可挂载。<br>
-云主机状态必须是<b>running</b>或<b>stopped</b>状态。<br>
-本地盘(local类型)做系统盘的云主机可挂载8块云硬盘，云硬盘(cloud类型)做系统盘的云主机可挂载除系统盘外7块云硬盘。
+    
+为一台云主机挂载云硬盘。
+
+详细操作说明请参考帮助文档：[挂载云硬盘](https://docs.jdcloud.com/cn/virtual-machines/attach-cloud-disk)
+
+## 接口说明
+- 云主机和云硬盘都没有正在进行中的的任务时才可以操作。
+- 云主机状态必须是 `running` 或 `stopped` 状态。操作系统盘时必须先停止实例。
+- 实例挂载云硬盘的数量，不能超过实例规格的限制。可查询  [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes)  接口获得指定规格可挂载云硬盘的数量上限。
+- 云硬盘作为系统盘时，容量不能小于40GB，并且不能超过500GB。
+- 待挂载的云硬盘与云主机实例必须在同一个可用区下。
+- 共享型云硬盘最多可挂载16个云主机实例，并且只能用作数据盘，不能用于系统盘。非共享型云盘最多只能挂载一个云主机实例。
 
     """
 
@@ -37,9 +46,9 @@ class AttachDiskParameters(object):
 
     def __init__(self, regionId, instanceId, diskId, ):
         """
-        :param regionId: 地域ID
-        :param instanceId: 云主机ID
-        :param diskId: 云硬盘ID
+        :param regionId: 地域ID。
+        :param instanceId: 云主机ID。
+        :param diskId: 云硬盘ID。
         """
 
         self.regionId = regionId
@@ -50,13 +59,20 @@ def __init__(self, regionId, instanceId, diskId, ):
 
     def setDeviceName(self, deviceName):
         """
-        :param deviceName: (Optional) 设备名[vda,vdb,vdc,vdd,vde,vdf,vdg,vdh,vdi,vmj,vdk,vdl,vdm]，挂载系统盘时必传，且需传vda
+        :param deviceName: (Optional) 磁盘逻辑挂载点。
+**系统盘**：必须指定并且只能是vda。
+**数据盘**：取值范围：`[vdb~vdbm]`。
+
         """
         self.deviceName = deviceName
 
     def setAutoDelete(self, autoDelete):
         """
-        :param autoDelete: (Optional) 随云主机删除自动删除此云硬盘，默认为False。仅按配置计费云硬盘支持修改此参数，包年包月云硬盘不可修改。
+        :param autoDelete: (Optional) 是否随实例一起删除，即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。
+可选值：
+`true`：随实例删除。
+`false`（默认值）：不随实例删除。
+
         """
         self.autoDelete = autoDelete
 

jdcloud_sdk/services/vm/apis/AttachKeypairRequest.py

@@ -21,7 +21,14 @@
 
 class AttachKeypairRequest(JDCloudRequest):
     """
-    绑定ssh密钥对。
+    
+为云主机实例绑定密钥。
+
+详细操作说明请参考帮助文档：[绑定密钥](https://docs.jdcloud.com/cn/virtual-machines/bind-keypair)
+
+## 接口说明
+- 只支持为 linux 云主机实例绑定密钥。
+- 每台云主机实例只支持绑定一个密钥。如果云主机绑定的密钥被删除了，那么该云主机还可以再次绑定密钥。
 
     """
 
@@ -35,10 +42,12 @@ class AttachKeypairParameters(object):
 
     def __init__(self, regionId, keyName, instanceIds, passWordAuth):
         """
-        :param regionId: 地域ID
-        :param keyName: 密钥名称
-        :param instanceIds: 虚机Id
-        :param passWordAuth: 密码授权，绑定密钥后，根据此参数决定是否使用密码登录，"yes"为使用，"no"为不使用
+        :param regionId: 地域ID。
+        :param keyName: 密钥名称。
+        :param instanceIds: 要绑定的云主机Id列表。
+        :param passWordAuth: 绑定密钥后，根据此参数决定是否允许使用密码登录。可选范围：
+`yes`：允许SSH密码登录。
+`no`：禁止SSH密码登录。
 
         """
 

jdcloud_sdk/services/vm/apis/AttachNetworkInterfaceRequest.py

@@ -21,11 +21,19 @@
 
 class AttachNetworkInterfaceRequest(JDCloudRequest):
     """
-    云主机绑定一块弹性网卡。<br>
-云主机状态必须为<b>running</b>或<b>stopped</b>状态，并且没有正在进行中的任务才可操作。<br>
-弹性网卡上如果绑定了弹性公网IP，那么其所在az需要与云主机的az保持一致，或者为全可用区型弹性公网IP，才可挂载该网卡。<br>
-云主机挂载弹性网卡的数量，不能超过实例规格的限制。可查询<a href="http://docs.jdcloud.com/virtual-machines/api/describeinstancetypes">DescribeInstanceTypes</a>接口获得指定规格可挂载弹性网卡的数量上限。<br>
-弹性网卡与云主机必须在相同vpc下。
+    
+为云主机绑定弹性网卡。
+
+详细操作说明请参考帮助文档：[绑定弹性网卡](https://docs.jdcloud.com/cn/virtual-machines/attach-eni)
+
+## 接口说明
+- 实例状态必须为 `running` 或 `stopped` 状态，同时实例没有正在进行中的任务时才可以操作。
+- 实例中的主网卡是不可以解绑和绑定的，绑定弹性网卡只支持绑定辅助网卡。
+- 目标弹性网卡上如果绑定了弹性公网IP，那么其所在的可用区需要与云主机的可用区保持一致，或者弹性公网IP是全可用区类型的，才允许绑定该弹性网卡。
+- 弹性网卡与云主机必须在相同vpc下。
+- 对于受管网卡，授权中不能含有 `instance-attach` 用户才可以挂载。
+- 对于授信网卡，授权中必须含有 `instance-attach` 用户才可以挂载。
+- 实例挂载弹性网卡的数量，不能超过实例规格的限制。可查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得指定规格可挂载弹性网卡的数量上限。
 
     """
 
@@ -39,9 +47,9 @@ class AttachNetworkInterfaceParameters(object):
 
     def __init__(self, regionId, instanceId, networkInterfaceId, ):
         """
-        :param regionId: 地域ID
-        :param instanceId: 云主机ID
-        :param networkInterfaceId: 弹性网卡ID
+        :param regionId: 地域ID。
+        :param instanceId: 云主机ID。
+        :param networkInterfaceId: 弹性网卡ID。
         """
 
         self.regionId = regionId
@@ -51,7 +59,9 @@ def __init__(self, regionId, instanceId, networkInterfaceId, ):
 
     def setAutoDelete(self, autoDelete):
         """
-        :param autoDelete: (Optional) 随云主机删除而自动删除，默认为False
+        :param autoDelete: (Optional) 随云主机实例自动删除，默认为False。
+受管网卡或授信网卡默认为False并且不支持修改。
+
         """
         self.autoDelete = autoDelete
 

jdcloud_sdk/services/vm/apis/CopyImagesRequest.py

@@ -21,8 +21,15 @@
 
 class CopyImagesRequest(JDCloudRequest):
     """
-    镜像跨区复制，将私有镜像复制到其它地域下，只允许操作您的个人私有镜像。<br>
-只支持rootDeviceType为cloudDisk的云硬盘系统盘镜像操作。
+    
+镜像跨地域复制。
+
+详细操作说明请参考帮助文档：[镜像复制](https://docs.jdcloud.com/cn/virtual-machines/copy-image)
+
+## 接口说明
+- 调用该接口将私有镜像复制到其它地域下。
+- 只支持云盘系统盘的镜像。
+- 不支持带有加密快照的镜像。
 
     """
 
@@ -36,9 +43,9 @@ class CopyImagesParameters(object):
 
     def __init__(self, regionId, sourceImageIds, destinationRegion):
         """
-        :param regionId: 地域ID
-        :param sourceImageIds: 源镜像ID
-        :param destinationRegion: 目标区域
+        :param regionId: 地域ID。
+        :param sourceImageIds: 要复制的私有镜像ID列表，最多支持10个。
+        :param destinationRegion: 目标地域。
         """
 
         self.regionId = regionId

jdcloud_sdk/services/vm/apis/CreateImageRequest.py

@@ -21,10 +21,19 @@
 
 class CreateImageRequest(JDCloudRequest):
     """
-    为云主机创建私有镜像。云主机状态必须为<b>stopped</b>。<br>
-云主机没有正在进行中的任务才可制作镜像。<br>
-制作镜像以备份系统盘为基础，在此之上可选择全部或部分挂载数据盘制作整机镜像（如不做任何更改将默认制作整机镜像），制作镜像过程会为所挂载云硬盘创建快照并与镜像关联。<br>
-调用接口后，需要等待镜像状态变为<b>ready</b>后，才能正常使用镜像。
+    
+为云主机制作私有镜像。
+
+详细操作说明请参考帮助文档：[基于实例创建私有镜像](https://docs.jdcloud.com/cn/virtual-machines/create-private-image)
+
+## 接口说明
+- 云主机实例没有正在进行中的任务时才可制作镜像。
+- 本地系统盘的实例，仅支持关机（已停止）状态下制作私有镜像。
+- 云盘系统盘的实例，支持开机(运行中)/关机（已停止）状态下制作私有镜像。
+- 调用接口后，需要等待镜像状态变为 `ready` 后，才能正常使用镜像。
+- 若当前实例系统盘为本地盘，则创建完成后的私有镜像为本地盘系统盘镜像；若当前实例系统盘为云硬盘，则创建完成后的私有镜像为云硬盘系统盘镜像。您可通过镜像类型转换 [convertImage](https://docs.jdcloud.com/Image/api/convertimage) 将本地盘系统盘镜像转换为云硬盘系统盘镜像后使用。
+- 默认情况下，制作的镜像中包括数据盘中的云硬盘（制作快照），但是不包含本地数据盘。
+- 如果需要变更打包镜像中的一些数据盘、或排除一些数据盘不需要制作快照，可通过 `dataDisks` 中的参数进行控制。
 
     """
 
@@ -38,9 +47,10 @@ class CreateImageParameters(object):
 
     def __init__(self, regionId, instanceId, name, ):
         """
-        :param regionId: 地域ID
-        :param instanceId: 云主机ID
-        :param name: 镜像名称，<a href="http://docs.jdcloud.com/virtual-machines/api/general_parameters">参考公共参数规范</a>。
+        :param regionId: 地域ID。
+        :param instanceId: 云主机ID。
+        :param name: 镜像名称，长度为2\~32个字符，只允许中文、数字、大小写字母、英文下划线（\_）、连字符（-）及点（.）。
+
         """
 
         self.regionId = regionId
@@ -51,13 +61,19 @@ def __init__(self, regionId, instanceId, name, ):
 
     def setDescription(self, description):
         """
-        :param description: (Optional) 镜像描述，<a href="http://docs.jdcloud.com/virtual-machines/api/general_parameters">参考公共参数规范</a>。
+        :param description: (Optional) 镜像描述。256字符以内。
+
         """
         self.description = description
 
     def setDataDisks(self, dataDisks):
         """
-        :param dataDisks: (Optional) 数据盘列表，可以在实例已挂载数据盘的基础上，额外增加新的快照、空盘、或排除云主机中的数据盘。
+        :param dataDisks: (Optional) 数据盘列表。
+在不指定该参数的情况下，制作镜像的过程中会将该实例中的所有云盘数据盘制作快照，并与系统盘一起，制作成打包镜像。
+如果不希望将实例中的某个云盘数据盘制作快照，可使用 `noDevice` 的方式排除，例如：`deviceName=vdb`、`noDevice=true` 就不会将 `vdb` 制作快照。
+如果希望在打包镜像中插入一块新盘，该盘不在实例中，可通过指定新的 `deviceName` 的方式实现，例如：`deviceName=vdx` 将会在打包镜像中插入一块盘符为 `vdx` 的新盘，支持新盘使用或不使用快照都可以。
+如果使用 `deviceName` 指定了与实例中相同的盘符，那么实例中对应的云盘数据盘也不会制作快照，并使用新指定的参数进行替换。
+
         """
         self.dataDisks = dataDisks
 

jdcloud_sdk/services/vm/apis/CreateInstanceTemplateRequest.py

@@ -21,10 +21,21 @@
 
 class CreateInstanceTemplateRequest(JDCloudRequest):
     """
-    创建一个指定参数的启动模板，启动模板中包含创建云主机时的大部分配置参数，避免每次创建云主机时的重复性工作。<br>
-如果是使用启动模板创建云主机，如果指定了某些参数与模板中的参数相冲突，那么新指定的参数会替换模板中的参数。<br>
-如果是使用启动模板创建云主机，如果指定了镜像ID与模板中的镜像ID不一致，那么模板中的dataDisks参数会失效。<br>
-如果使用高可用组(Ag)创建云主机，那么Ag所关联的模板中的参数都不可以被调整，只能以模板为准。
+    
+创建实例模板。
+
+实例模板是创建云主机实例的配置信息模板，包括镜像、实例规格、系统盘及数据盘类型和容量、私有网络及子网配置、安全组及登录信息等。实例模板可用于创建实例及用于配置高可用组，创建高可用组时必须指定实例模板。您每次创建实例时无需重新指定实例模板已包括的参数，缩短您的部署时间。
+
+请注意：实例模板一经创建后其属性将不能编辑。
+
+详细操作说明请参考帮助文档：[创建实例模板](https://docs.jdcloud.com/cn/virtual-machines/create-instance-template)
+
+## 接口说明
+- 创建实例模板的限制基本与创建云主机一致，可参考 [创建云主机](https://docs.jdcloud.com/cn/virtual-machines/create-instance-template)。
+- 实例模板中包含创建云主机的大部分配置参数，可以避免每次创建云主机时的重复性配置参数的工作。
+- 使用实例模板创建云主机时，如果再次指定了某些参数，并且与实例模板中的参数相冲突，那么新指定的参数会替换模板中的参数，以新指定的参数为准。
+- 使用实例模板创建云主机时，如果再次指定了镜像ID，并且与模板中的镜像ID不一致，那么模板中的 `systemDisk` 和 `dataDisks` 配置会失效，以新指定的镜像为准。
+- 如果使用高可用组(Ag)创建云主机，那么Ag所关联的模板中的参数都不可以被调整，只能以模板为准。
 
     """
 
@@ -38,9 +49,9 @@ class CreateInstanceTemplateParameters(object):
 
     def __init__(self, regionId, instanceTemplateData, name, ):
         """
-        :param regionId: 地域ID
-        :param instanceTemplateData: 启动模板的数据
-        :param name: 启动模板的名称，<a href="http://docs.jdcloud.com/virtual-machines/api/general_parameters">参考公共参数规范</a>。
+        :param regionId: 地域ID。
+        :param instanceTemplateData: 实例模板配置信息。
+        :param name: 实例模板的名称，参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。
         """
 
         self.regionId = regionId
@@ -50,7 +61,7 @@ def __init__(self, regionId, instanceTemplateData, name, ):
 
     def setDescription(self, description):
         """
-        :param description: (Optional) 启动模板的描述，<a href="http://docs.jdcloud.com/virtual-machines/api/general_parameters">参考公共参数规范</a>。
+        :param description: (Optional) 实例模板的描述，参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。
         """
         self.description = description