jdcloud_sdk.services.vm.apis package

Submodules

jdcloud_sdk.services.vm.apis.AssociateElasticIpRequest module

class jdcloud_sdk.services.vm.apis.AssociateElasticIpRequest.AssociateElasticIpParameters(regionId, instanceId, elasticIpId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
  • elasticIpId – 弹性公网IP的ID。
class jdcloud_sdk.services.vm.apis.AssociateElasticIpRequest.AssociateElasticIpRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

为云主机绑定弹性公网IP。

详细操作说明请参考帮助文档：[绑定弹性公网IP](https://docs.jdcloud.com/cn/virtual-machines/associate-elastic-ip)

## 接口说明 - 该接口只支持在实例的主网卡的主内网IP上绑定弹性公网IP。 - 一台云主机的主网卡的主内网IP只能绑定一个弹性公网IP，若已绑定弹性公网IP，操作绑定会返回错误。 - 弹性公网IP所在的可用区需要与云主机的可用区保持一致，或者弹性公网IP是全可用区类型的，才允许绑定操作。

jdcloud_sdk.services.vm.apis.AttachDiskRequest module

class jdcloud_sdk.services.vm.apis.AttachDiskRequest.AttachDiskParameters(regionId, instanceId, diskId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
  • diskId – 云硬盘ID。
setAutoDelete(autoDelete)[source]
param autoDelete:
 (Optional) 是否随实例一起删除，即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。

可选值： true：随实例删除。 `false`（默认值）：不随实例删除。

setDeviceName(deviceName)[source]
param deviceName:
 (Optional) 磁盘逻辑挂载点。

系统盘：必须指定并且只能是vda。 数据盘：取值范围：[vdb~vdbm]。

class jdcloud_sdk.services.vm.apis.AttachDiskRequest.AttachDiskRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

为一台云主机挂载云硬盘。

详细操作说明请参考帮助文档：[挂载云硬盘](https://docs.jdcloud.com/cn/virtual-machines/attach-cloud-disk)

## 接口说明 - 云主机和云硬盘都没有正在进行中的的任务时才可以操作。 - 云主机状态必须是 running 或 stopped 状态。操作系统盘时必须先停止实例。 - 实例挂载云硬盘的数量，不能超过实例规格的限制。可查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得指定规格可挂载云硬盘的数量上限。 - 实例可挂载的云硬盘类型，受实例规格限制。可查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得指定规格支持挂载的云硬盘类型。 - 云硬盘作为系统盘时，容量不能小于40GB，并且不能超过500GB。 - 待挂载的云硬盘与云主机实例必须在同一个可用区下。 - 共享型云硬盘最多可挂载16个云主机实例，并且只能用作数据盘，不能用于系统盘。非共享型云盘最多只能挂载一个云主机实例。

jdcloud_sdk.services.vm.apis.AttachNetworkInterfaceRequest module

class jdcloud_sdk.services.vm.apis.AttachNetworkInterfaceRequest.AttachNetworkInterfaceParameters(regionId, instanceId, networkInterfaceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
  • networkInterfaceId – 弹性网卡ID。
setAutoDelete(autoDelete)[source]
param autoDelete:
 (Optional) 随云主机实例自动删除，默认为False。

受管网卡或授信网卡默认为False并且不支持修改。

class jdcloud_sdk.services.vm.apis.AttachNetworkInterfaceRequest.AttachNetworkInterfaceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

为云主机绑定弹性网卡。

详细操作说明请参考帮助文档：[绑定弹性网卡](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) 接口获得指定规格可挂载弹性网卡的数量上限。

jdcloud_sdk.services.vm.apis.CopyImagesRequest module

class jdcloud_sdk.services.vm.apis.CopyImagesRequest.CopyImagesParameters(regionId, sourceImageIds, destinationRegion)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • sourceImageIds – 要复制的私有镜像ID列表，最多支持10个。
  • destinationRegion – 目标地域。
class jdcloud_sdk.services.vm.apis.CopyImagesRequest.CopyImagesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

镜像跨地域复制。

详细操作说明请参考帮助文档：[镜像复制](https://docs.jdcloud.com/cn/virtual-machines/copy-image)

## 接口说明 - 调用该接口将私有镜像复制到其它地域下。 - 只支持云盘系统盘的镜像。 - 不支持带有加密快照的镜像。

jdcloud_sdk.services.vm.apis.CreateImageRequest module

class jdcloud_sdk.services.vm.apis.CreateImageRequest.CreateImageParameters(regionId, instanceId, name)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
  • name – 镜像名称，长度为2~32个字符，只允许中文、数字、大小写字母、英文下划线（_）、连字符（-）及点（.）。
setDataDisks(dataDisks)[source]
param dataDisks:
 (Optional) 数据盘列表。

在不指定该参数的情况下，制作镜像的过程中会将该实例中的所有云盘数据盘制作快照，并与系统盘一起，制作成打包镜像。 如果不希望将实例中的某个云盘数据盘制作快照，可使用 noDevice 的方式排除，例如：deviceName=vdb、noDevice=true 就不会将 vdb 制作快照。 如果希望在打包镜像中插入一块新盘，该盘不在实例中，可通过指定新的 deviceName 的方式实现，例如：deviceName=vdx 将会在打包镜像中插入一块盘符为 vdx 的新盘，支持新盘使用或不使用快照都可以。 如果使用 deviceName 指定了与实例中相同的盘符，那么实例中对应的云盘数据盘也不会制作快照，并使用新指定的参数进行替换。

setDescription(description)[source]
Parameters:description – (Optional) 镜像描述。256字符以内。
class jdcloud_sdk.services.vm.apis.CreateImageRequest.CreateImageRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

为云主机制作私有镜像。

详细操作说明请参考帮助文档：[基于实例创建私有镜像](https://docs.jdcloud.com/cn/virtual-machines/create-private-image)

## 接口说明 - 云主机实例没有正在进行中的任务时才可制作镜像。 - 本地系统盘的实例，仅支持关机（已停止）状态下制作私有镜像。 - 云盘系统盘的实例，支持开机(运行中)/关机（已停止）状态下制作私有镜像。 - 调用接口后，需要等待镜像状态变为 ready 后，才能正常使用镜像。 - 若当前实例系统盘为本地盘，则创建完成后的私有镜像为本地盘系统盘镜像；若当前实例系统盘为云硬盘，则创建完成后的私有镜像为云硬盘系统盘镜像。您可通过镜像类型转换 [convertImage](https://docs.jdcloud.com/Image/api/convertimage) 将本地盘系统盘镜像转换为云硬盘系统盘镜像后使用。 - 默认情况下，制作的镜像中包括数据盘中的云硬盘（制作快照），但是不包含本地数据盘。 - 如果需要变更打包镜像中的一些数据盘、或排除一些数据盘不需要制作快照，可通过 dataDisks 中的参数进行控制。

jdcloud_sdk.services.vm.apis.CreateInstancesRequest module

class jdcloud_sdk.services.vm.apis.CreateInstancesRequest.CreateInstancesParameters(regionId, instanceSpec)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceSpec – 实例配置。
setClientToken(clientToken)[source]
Parameters:clientToken – (Optional) 用于保证请求的幂等性。由客户端生成，并确保不同请求中该参数唯一，长度不能超过64个字符。
setIsManaged(isManaged)[source]
Parameters:isManaged – (Optional) 是否托管实例的生命周期，默认为false；若为包年包月实例，可加入但不支持托管；该字段仅AG开启AS时生效。托管实例将在缩容或健康检查失败时被删除，非托管实例仅移出伸缩组
setMaxCount(maxCount)[source]
param maxCount:(Optional) 创建实例的数量，不能超过用户配额。

取值范围：[1,100]；默认值：1。 如果在弹性网卡中指定了内网IP地址，那么单次创建 maxCount 只能是 1。

class jdcloud_sdk.services.vm.apis.CreateInstancesRequest.CreateInstancesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建一台或多台指定配置的云主机实例。

实例有三种创建方式，不同方式下传参详见下方的请求[参数说明](createInstance#requestparameters)，也可参考请求[示例](createInstance#examples)。

1、自定义创建：按配置要求逐一指定参数创建； 2、使用实例模板创建：[实例模板](https://docs.jdcloud.com/virtual-machines/instance-template-overview)是实例配置信息的预配置，通过实例模板可快速创建实例，省去逐一配置参数的步骤。指定实例模板创建时，如不额外指定模板包含的参数将以模板为准创建实例，模板中未包含的参数，如可用区、内网IPv4地址、名称等仍需指定； 3、基于高可用组创建：[高可用组](https://docs.jdcloud.com/availability-group/product-overview)是一种高可用部署解决方案，提供了组内实例在数据中心内横跨多个故障域均衡部署的机制。高可用组须搭配实例模板使用，基于高可用组创建的实例将在其指定的可用区内以实例模板配置按一定分散机制创建实例。此创建方式下，实例创建参数除内网IPv4地址、名称等外均以实例模板为准且不支持再次指定。

详细操作说明请参考帮助文档：[创建实例](https://docs.jdcloud.com/cn/virtual-machines/create-instance)

## 接口说明 - 创建实例前，请参考 [创建前准备](https://docs.jdcloud.com/virtual-machines/account-preparation-linux) 完成实名认证、支付方式确认、计费类型选择等准备工作。 - 创建实例的配置说明和选择指导，请参考 [配置项说明](https://docs.jdcloud.com/cn/virtual-machines/select-configuration-linux)。 - 各地域下实例及关联资源（云硬盘、弹性公网IP）的可创建数量受配额限制，创建前请通过 [DescribeQuotas](https://docs.jdcloud.com/cn/virtual-machines/api/describequotas?content=API) 确认配额，如须提升请[提交工单](https://ticket.jdcloud.com/applyorder/submit)或联系京东云客服。 - 不同地域及可用区下售卖的实例规格有差异，可通过 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes?content=API) 查询在售规格及规格详细信息。 - 通过本接口创建包年包月实例时将自动从账户扣款（代金券优先），如需使用第三方支付方式请通过控制台创建。 - 单次请求最多支持创建 100 台实例。 - 本接口为异步接口，请求下发成功后会返回RequestId和实例ID，此时实例处于 `Pending`（创建中）状态。如创建成功则实例自动变为 `Running`（运行中）状态；如创建失败则短暂处于 `Error`（错误）状态，随后将自动删除（创建失败的实例不会收费且会自动释放占用的配额）。实例状态可以通过 [describeInstanceStatus](https://docs.jdcloud.com/virtual-machines/api/describeinstancestatus?content=API) 接口查询。 - 批量创建多台实例时系统将尽可能完成目标创建数量，但受底层资源、配额等因素影响，可能存在部分成功部分失败的情况，还请关注最终完成数量，如有失败情况请尝试重新申请或联系客服。

jdcloud_sdk.services.vm.apis.CreateKeypairRequest module

class jdcloud_sdk.services.vm.apis.CreateKeypairRequest.CreateKeypairParameters(regionId, keyName)[source]

Bases: object

param regionId:地域ID。
param keyName:密钥对名称，需要全局唯一。

只允许数字、大小写字母、下划线“_”及中划线“-”，不超过32个字符。

class jdcloud_sdk.services.vm.apis.CreateKeypairRequest.CreateKeypairRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建密钥。

公钥和私钥都由京东云生成，公钥保存在京东云，私钥返回给用户，由用户保存。

详细操作说明请参考帮助文档：[创建密钥](https://docs.jdcloud.com/cn/virtual-machines/create-keypair)

## 接口说明 - 调用该接口创建密钥后，公钥部分存储在京东云，并返回未加密的 PEM 编码的 PKCS#8 格式私钥，您只有一次机会保存您的私钥。请妥善保管。

jdcloud_sdk.services.vm.apis.DeleteImageRequest module

class jdcloud_sdk.services.vm.apis.DeleteImageRequest.DeleteImageParameters(regionId, imageId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • imageId – 镜像ID。
setDeleteSnapshot(deleteSnapshot)[source]
Parameters:deleteSnapshot – (Optional) 删除镜像时是否删除关联的快照。默认为 false；如果指定为 true, 将会删除镜像关联的快照。
class jdcloud_sdk.services.vm.apis.DeleteImageRequest.DeleteImageRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除一个私有镜像。

详细操作说明请参考帮助文档：[删除私有镜像](https://docs.jdcloud.com/cn/virtual-machines/delete-private-image)

## 接口说明 - 已共享的私有镜像在取消共享关系前不可以删除，如私有镜像已共享给其他用户，请取消共享后再进行删除。 - 本地系统盘镜像在有基于其创建的云主机时，将无法删除。 - 只能操作私有镜像。 - 私有镜像没有正在处理中的任务时才可以删除。

jdcloud_sdk.services.vm.apis.DeleteInstanceRequest module

class jdcloud_sdk.services.vm.apis.DeleteInstanceRequest.DeleteInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
setDeletePrimaryNetworkInterfaceAllElasticIp(deletePrimaryNetworkInterfaceAllElasticIp)[source]
param deletePrimaryNetworkInterfaceAllElasticIp:
 (Optional) 是否删除主机的主网卡绑定的所有弹性公网IP，默认为否。可选值：true，false。

当回收站功能关闭的时候，此参数生效。 当回收站功能开启的时候，且参数 destroy 为 true 的时候，此参数生效。 当回收站功能开启的时候，且参数 destroy 为 false 的时候，此参数不生效。

class jdcloud_sdk.services.vm.apis.DeleteInstanceRequest.DeleteInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除一台云主机实例。

详细操作说明请参考帮助文档：[删除实例](https://docs.jdcloud.com/cn/virtual-machines/delete-instance)

## 接口说明 - 不可以删除包年包月未到期的云主机。如果云主机为包年包月已到期的，并且用户处于白名单中，也不允许删除。 - 不可以删除没有计费信息的云主机，该情况只限于创建过程中出现了异常。 - 云主机状态必须为运行 running、停止 stopped、错误 error、状态，同时云主机没有正在进行中的任务才可以删除。 - 如果云主机中挂载的数据盘为按配置计费的云硬盘且 AutoDelete 属性为 true，那么数据盘会随云主机一起删除。 - 云主机中绑定的弹性公网IP可以选择是否随云主机一起删除。 - 如出现不能删除的情况请 [提交工单](https://ticket.jdcloud.com/applyorder/submit) 或联系京东云客服。

[MFA enabled]

jdcloud_sdk.services.vm.apis.DeleteKeypairRequest module

class jdcloud_sdk.services.vm.apis.DeleteKeypairRequest.DeleteKeypairParameters(regionId, keyName)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • keyName – 密钥名称。
class jdcloud_sdk.services.vm.apis.DeleteKeypairRequest.DeleteKeypairRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除密钥。

详细操作说明请参考帮助文档：[删除密钥](https://docs.jdcloud.com/cn/virtual-machines/delete-keypair)

## 接口说明 - 密钥删除后，使用该密钥的实例仍可正常使用与之匹配的本地私钥登录，且密钥仍会显示在实例详情中。 - 密钥删除后，与之关联的实例模板将变为不可用，并且与该实例模板关联的高可用组也会变为不可用。

jdcloud_sdk.services.vm.apis.DescribeImageConstraintsBatchRequest module

class jdcloud_sdk.services.vm.apis.DescribeImageConstraintsBatchRequest.DescribeImageConstraintsBatchParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域ID。
setIds(ids)[source]
Parameters:ids – (Optional) 要查询的镜像ID列表，只支持官方镜像和第三方镜像。
class jdcloud_sdk.services.vm.apis.DescribeImageConstraintsBatchRequest.DescribeImageConstraintsBatchRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

批量查询镜像的实例规格限制。

详细操作说明请参考帮助文档：[镜像概述](https://docs.jdcloud.com/cn/virtual-machines/image-overview)

## 接口说明 - 通过此接口可以查询镜像的实例规格限制信息。 - 只有官方镜像、第三方镜像有实例规格的限制，用户的私有镜像没有此限制。

jdcloud_sdk.services.vm.apis.DescribeImageConstraintsRequest module

class jdcloud_sdk.services.vm.apis.DescribeImageConstraintsRequest.DescribeImageConstraintsParameters(regionId, imageId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • imageId – 镜像ID。
class jdcloud_sdk.services.vm.apis.DescribeImageConstraintsRequest.DescribeImageConstraintsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询单个镜像的实例规格限制。

详细操作说明请参考帮助文档：[镜像概述](https://docs.jdcloud.com/cn/virtual-machines/image-overview)

## 接口说明 - 该接口与批量查询镜像的实例规格限制返回的信息一致。 - 通过此接口可以查询镜像的实例规格限制信息。 - 只有官方镜像、第三方镜像有实例规格的限制，用户的私有镜像没有此限制。

jdcloud_sdk.services.vm.apis.DescribeImageMembersRequest module

class jdcloud_sdk.services.vm.apis.DescribeImageMembersRequest.DescribeImageMembersParameters(regionId, imageId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • imageId – 镜像ID。
class jdcloud_sdk.services.vm.apis.DescribeImageMembersRequest.DescribeImageMembersRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询私有镜像共享给哪些京东云帐户。

详细操作说明请参考帮助文档：[共享私有镜像](https://docs.jdcloud.com/cn/virtual-machines/share-image)

## 接口说明 - 只允许查询用户的私有镜像。

jdcloud_sdk.services.vm.apis.DescribeImageRequest module

class jdcloud_sdk.services.vm.apis.DescribeImageRequest.DescribeImageParameters(regionId, imageId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • imageId – 镜像ID。
class jdcloud_sdk.services.vm.apis.DescribeImageRequest.DescribeImageRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询镜像详情。

详细操作说明请参考帮助文档：[镜像概述](https://docs.jdcloud.com/cn/virtual-machines/image-overview)

## 接口说明 - 该接口与查询镜像信息列表返回的信息一致。 - 只需要查询单个镜像信息的时候可以调用该接口。

jdcloud_sdk.services.vm.apis.DescribeImagesRequest module

class jdcloud_sdk.services.vm.apis.DescribeImagesRequest.DescribeImagesParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域ID。
setArchitecture(architecture)[source]
Parameters:architecture – (Optional) CPU架构。支持范围：x86_64、arm64。
setIds(ids)[source]
Parameters:ids – (Optional) 指定镜像ID查询，如果指定了此参数，其它参数可以不传。
setImageName(imageName)[source]
Parameters:imageName – (Optional) 根据镜像名称模糊查询。
setImageSource(imageSource)[source]
param imageSource:
 (Optional) 镜像来源，如果没有指定 ids 参数，此参数必传。取值范围：

public：官方镜像。 thirdparty：镜像市场镜像。 private：用户自己的私有镜像。 shared：其他用户分享的镜像。 community：社区镜像。

setLaunchPermission(launchPermission)[source]
param launchPermission:
 (Optional) 根据镜像的使用权限查询，可选参数，仅当 imageSource 为 private 时有效。取值范围：

all：没有限制，所有人均可以使用。 specifiedUsers：只有共享用户可以使用。 ownerOnly：镜像拥有者自己可以使用。

setOffline(offline)[source]
param offline:(Optional) 查询已经下线的镜像时使用。

只有查询 官方镜像 或者 镜像市场镜像 时，此参数才有意义，其它情况下此参数无效。 指定 ids 查询时，此参数无效。

setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码；默认为1。
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；<br>默认为20；取值范围[10, 100]。
setPlatform(platform)[source]
param platform:(Optional) 根据镜像的操作系统发行版查询。

取值范围：Ubuntu、CentOS、Windows Server。

setRootDeviceType(rootDeviceType)[source]
Parameters:rootDeviceType – (Optional) 根据镜像支持的系统盘类型查询。支持范围：localDisk 本地系统盘镜像；cloudDisk 云盘系统盘镜像。
setServiceCode(serviceCode)[source]
Parameters:serviceCode – (Optional) 已废弃。
setStatus(status)[source]
Parameters:status – (Optional) 根据镜像状态查询。参考 [镜像状态](https://docs.jdcloud.com/virtual-machines/api/image_status)
class jdcloud_sdk.services.vm.apis.DescribeImagesRequest.DescribeImagesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询镜像信息列表。

详细操作说明请参考帮助文档：[镜像概述](https://docs.jdcloud.com/cn/virtual-machines/image-overview)

## 接口说明 - 通过此接口可以查询到京东云官方镜像、第三方镜像、镜像市场、私有镜像、或其他用户共享给您的镜像。 - 请求参数即过滤条件，每个条件之间的关系为逻辑与（AND）的关系。 - 如果使用子帐号查询，只会查询到该子帐号有权限的镜像。关于资源权限请参考 [IAM概述](https://docs.jdcloud.com/cn/iam/product-overview)。 - 单次查询最大可查询100条镜像信息。 - 尽量一次调用接口查询多条数据，不建议使用该批量查询接口一次查询一条数据，如果使用不当导致查询过于密集，可能导致网关触发限流。 - 由于该接口为 GET 方式请求，最终参数会转换为 URL 上的参数，但是 HTTP 协议下的 GET 请求参数长度是有大小限制的，使用者需要注意参数超长的问题。

jdcloud_sdk.services.vm.apis.DescribeInstancePrivateIpAddressRequest module

class jdcloud_sdk.services.vm.apis.DescribeInstancePrivateIpAddressRequest.DescribeInstancePrivateIpAddressParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域ID。
setFilters(filters)[source]
param filters:(Optional) <b>filters 中支持使用以下关键字进行过滤</b>

instanceId: 云主机ID，精确匹配，支持多个 privateIpAddress: 主网卡内网主IP地址，模糊匹配，支持多个 vpcId: 私有网络ID，精确匹配，支持多个 status: 云主机状态，精确匹配，支持多个，参考 [云主机状态](https://docs.jdcloud.com/virtual-machines/api/vm_status) name: 云主机名称，模糊匹配，支持单个 imageId: 镜像ID，精确匹配，支持多个 agId: 使用可用组id，支持单个 faultDomain: 错误域，支持多个 networkInterfaceId: 弹性网卡ID，精确匹配，支持多个 subnetId: 子网ID，精确匹配，支持多个

setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码；默认为1。
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；<br>默认为20；取值范围[10, 100]。
class jdcloud_sdk.services.vm.apis.DescribeInstancePrivateIpAddressRequest.DescribeInstancePrivateIpAddressRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询一台或多台云主机实例的主网卡内网主IP地址。

弹性网卡说明请参考帮助文档：[弹性网卡](https://docs.jdcloud.com/cn/virtual-machines/attach-eni)

## 接口说明 - 使用 filters 过滤器进行条件筛选，每个 filter 之间的关系为逻辑与（AND）的关系。 - 单次查询最大可查询100条云主机实例数据。 - 尽量一次调用接口查询多条数据，不建议使用该批量查询接口一次查询一条数据，如果使用不当导致查询过于密集，可能导致网关触发限流。 - 由于该接口为 GET 方式请求，最终参数会转换为 URL 上的参数，但是 HTTP 协议下的 GET 请求参数长度是有大小限制的，使用者需要注意参数超长的问题。

jdcloud_sdk.services.vm.apis.DescribeInstanceRequest module

class jdcloud_sdk.services.vm.apis.DescribeInstanceRequest.DescribeInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
class jdcloud_sdk.services.vm.apis.DescribeInstanceRequest.DescribeInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询一台云主机实例的详细信息。

详细操作说明请参考帮助文档：[查找实例](https://docs.jdcloud.com/cn/virtual-machines/search-instance)

## 接口说明 - 该接口与查询云主机列表返回的信息一致。 - 只需要查询单个云主机实例详细信息的时候可以调用该接口。

jdcloud_sdk.services.vm.apis.DescribeInstanceStatusRequest module

class jdcloud_sdk.services.vm.apis.DescribeInstanceStatusRequest.DescribeInstanceStatusParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域ID。
setFilters(filters)[source]
param filters:(Optional) <b>filters 中支持使用以下关键字进行过滤</b>

instanceId: 云主机ID，精确匹配，支持多个 privateIpAddress: 主网卡内网主IP地址，模糊匹配，支持多个 vpcId: 私有网络ID，精确匹配，支持多个 status: 云主机状态，精确匹配，支持多个，参考 [云主机状态](https://docs.jdcloud.com/virtual-machines/api/vm_status) name: 云主机名称，模糊匹配，支持单个 imageId: 镜像ID，精确匹配，支持多个 agId: 使用可用组id，支持单个 faultDomain: 错误域，支持多个 networkInterfaceId: 弹性网卡ID，精确匹配，支持多个 subnetId: 子网ID，精确匹配，支持多个

setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码；默认为1。
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；<br>默认为20；取值范围[10, 100]。
class jdcloud_sdk.services.vm.apis.DescribeInstanceStatusRequest.DescribeInstanceStatusRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询一台或多台云主机实例的状态。

云主机实例的状态说明请参考帮助文档：[云主机状态](https://docs.jdcloud.com/cn/virtual-machines/api/vm_status)

## 接口说明 - 使用 filters 过滤器进行条件筛选，每个 filter 之间的关系为逻辑与（AND）的关系。 - 单次查询最大可查询100条云主机状态。 - 尽量一次调用接口查询多条数据，不建议使用该批量查询接口一次查询一条数据，如果使用不当导致查询过于密集，可能导致网关触发限流。 - 由于该接口为 GET 方式请求，最终参数会转换为 URL 上的参数，但是 HTTP 协议下的 GET 请求参数长度是有大小限制的，使用者需要注意参数超长的问题。

jdcloud_sdk.services.vm.apis.DescribeInstanceTypesRequest module

class jdcloud_sdk.services.vm.apis.DescribeInstanceTypesRequest.DescribeInstanceTypesParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域ID。
setChargeMode(chargeMode)[source]
Parameters:chargeMode – (Optional) 目前支持postpaid_by_spot：抢占式实例(后付费)。
setFilters(filters)[source]
param filters:(Optional) <b>filters 中支持使用以下关键字进行过滤</b>

instanceTypes: 实例规格，精确匹配，支持多个 az: 可用区，精确匹配，支持多个 architecture: CPU架构，精确匹配，支持单个，可选范围:x86_64或arm64

setServiceName(serviceName)[source]
Parameters:serviceName – (Optional) 产品线类型，默认为 vm。支持范围：vm 云主机，nc 原生容器。
class jdcloud_sdk.services.vm.apis.DescribeInstanceTypesRequest.DescribeInstanceTypesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询实例规格列表。

详细操作说明请参考帮助文档：[实例规格类型](https://docs.jdcloud.com/cn/virtual-machines/instance-type-family)

## 接口说明 - 调用该接口可查询全量实例规格信息。 - 可查询实例规格的CPU、内存大小、可绑定的弹性网卡数量、可挂载的云硬盘数量，是否售卖等信息。 - GPU 或 本地存储型的规格可查询 GPU型号、GPU卡数量、本地盘数量。 - 尽量使用过滤器查询关心的实例规格，并适当缓存这些信息。否则全量查询可能响应较慢。

jdcloud_sdk.services.vm.apis.DescribeInstanceVncUrlRequest module

class jdcloud_sdk.services.vm.apis.DescribeInstanceVncUrlRequest.DescribeInstanceVncUrlParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
class jdcloud_sdk.services.vm.apis.DescribeInstanceVncUrlRequest.DescribeInstanceVncUrlRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取云主机vnc地址。

详细操作说明请参考帮助文档：[连接实例](https://docs.jdcloud.com/cn/virtual-machines/connect-to-instance)

## 接口说明 - 实例仅 running 状态时才可获取到 vnc 地址。 - 调用该接口可获取云主机 vnc 地址，用于远程连接管理云主机。 - vnc 地址的有效期为1个小时，调用接口获取vnc地址后如果1个小时内没有使用，vnc 地址将自动失效，再次使用需要重新获取。 - 裸金属实例目前不支持通过 vnc 登录。

jdcloud_sdk.services.vm.apis.DescribeInstancesRequest module

class jdcloud_sdk.services.vm.apis.DescribeInstancesRequest.DescribeInstancesParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域ID。
setFilters(filters)[source]
param filters:(Optional) <b>filters 中支持使用以下关键字进行过滤</b>

instanceId: 云主机ID，精确匹配，支持多个 privateIpAddress: 云主机挂载的网卡内网主IP地址，模糊匹配，支持多个 az: 可用区，精确匹配，支持多个 vpcId: 私有网络ID，精确匹配，支持多个 status: 云主机状态，精确匹配，支持多个，参考 [云主机状态](https://docs.jdcloud.com/virtual-machines/api/vm_status) name: 云主机名称，模糊匹配，支持单个 imageId: 镜像ID，精确匹配，支持多个 networkInterfaceId: 弹性网卡ID，精确匹配，支持多个 subnetId: 子网ID，精确匹配，支持多个 agId: 使用可用组id，支持单个 faultDomain: 错误域，支持多个 dedicatedHostId: 专有宿主机ID，精确匹配，支持多个 dedicatedPoolId: 专有宿主机池ID，精确匹配，支持多个 instanceType: 实例规格，精确匹配，支持多个，可通过查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得实例规格 elasticIpAddress: 公网IP地址，精确匹配，支持单个。该条件会将公网IP转换成 networkInterfaceId 进行查询，所以与 networkInterfaceId 为或者的关系。

setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码；默认为1。
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；<br>默认为20；取值范围[10, 100]。
setTags(tags)[source]
Parameters:tags – (Optional) Tag筛选条件。
class jdcloud_sdk.services.vm.apis.DescribeInstancesRequest.DescribeInstancesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询一台或多台云主机实例的详细信息。

详细操作说明请参考帮助文档：[查找实例](https://docs.jdcloud.com/cn/virtual-machines/search-instance)

## 接口说明 - 使用 filters 过滤器进行条件筛选，每个 filter 之间的关系为逻辑与（AND）的关系。 - 如果使用子帐号查询，只会查询到该子帐号有权限的云主机实例。关于资源权限请参考 [IAM概述](https://docs.jdcloud.com/cn/iam/product-overview)。 - 单次查询最大可查询100条云主机实例数据。 - 尽量一次调用接口查询多条数据，不建议使用该批量查询接口一次查询一条数据，如果使用不当导致查询过于密集，可能导致网关触发限流。 - 由于该接口为 GET 方式请求，最终参数会转换为 URL 上的参数，但是 HTTP 协议下的 GET 请求参数长度是有大小限制的，使用者需要注意参数超长的问题。

jdcloud_sdk.services.vm.apis.DescribeKeypairsRequest module

class jdcloud_sdk.services.vm.apis.DescribeKeypairsRequest.DescribeKeypairsParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域ID。
setFilters(filters)[source]
param filters:(Optional) <b>filters 中支持使用以下关键字进行过滤</b>

keyNames: 密钥对名称，精确匹配，支持多个

setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码；默认为1。
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；<br>默认为20；取值范围[10, 100]。
class jdcloud_sdk.services.vm.apis.DescribeKeypairsRequest.DescribeKeypairsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

批量查询密钥对。

详细操作说明请参考帮助文档：[密钥概述](https://docs.jdcloud.com/cn/virtual-machines/keypair-overview)

## 接口说明 - 使用 filters 过滤器进行条件筛选，每个 filter 之间的关系为逻辑与（AND）的关系。 - 单次查询最大可查询100条密钥数据。

jdcloud_sdk.services.vm.apis.DescribeQuotasRequest module

class jdcloud_sdk.services.vm.apis.DescribeQuotasRequest.DescribeQuotasParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域ID。
setFilters(filters)[source]
param filters:(Optional) <b>filters 中支持使用以下关键字进行过滤</b>

resourceTypes: 资源类型，支持多个，可选范围：instance、instance_cpu、instance_memory、instance_local_disk、keypair、image、instanceTemplate、imageShare

setImageId(imageId)[source]
param imageId:(Optional) 私有镜像Id。

查询镜像共享 imageShare 的配额时，此参数必传。

class jdcloud_sdk.services.vm.apis.DescribeQuotasRequest.DescribeQuotasRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询资源配额。

## 接口说明 - 调用该接口可查询 云主机、云主机的CPU、云主机的内存、云主机的本地盘、镜像、密钥、实例模板、镜像共享 的配额。

jdcloud_sdk.services.vm.apis.DetachDiskRequest module

class jdcloud_sdk.services.vm.apis.DetachDiskRequest.DetachDiskParameters(regionId, instanceId, diskId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
  • diskId – 云硬盘ID。
setForce(force)[source]
param force:(Optional) 是否强制缷载，默认False。

如果此参数传值为True，数据盘的IO会被强制断掉。

class jdcloud_sdk.services.vm.apis.DetachDiskRequest.DetachDiskRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

为一台云主机缷载云硬盘

详细操作说明请参考帮助文档：[缷载云硬盘](https://docs.jdcloud.com/cn/virtual-machines/detach-cloud-disk)

## 接口说明 - 云主机和云硬盘都没有正在进行中的的任务时才可以操作。 - 云主机状态必须是 running 或 stopped 状态。操作系统盘时必须先停止实例。

jdcloud_sdk.services.vm.apis.DetachNetworkInterfaceRequest module

class jdcloud_sdk.services.vm.apis.DetachNetworkInterfaceRequest.DetachNetworkInterfaceParameters(regionId, instanceId, networkInterfaceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
  • networkInterfaceId – 弹性网卡ID
class jdcloud_sdk.services.vm.apis.DetachNetworkInterfaceRequest.DetachNetworkInterfaceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

为云主机解绑弹性网卡。

详细操作说明请参考帮助文档：[解绑弹性网卡](https://docs.jdcloud.com/cn/virtual-machines/detach-eni)

## 接口说明 - 实例状态必须为 running 或 stopped 状态，同时实例没有正在进行中的任务时才可以操作。 - 实例中的主网卡是不可以解绑和绑定的，解绑弹性网卡只支持解绑辅助网卡。

jdcloud_sdk.services.vm.apis.DisassociateElasticIpRequest module

class jdcloud_sdk.services.vm.apis.DisassociateElasticIpRequest.DisassociateElasticIpParameters(regionId, instanceId, elasticIpId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
  • elasticIpId – 弹性公网IP的ID。
class jdcloud_sdk.services.vm.apis.DisassociateElasticIpRequest.DisassociateElasticIpRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

为云主机解绑弹性公网IP。

详细操作说明请参考帮助文档：[解绑弹性公网IP](https://docs.jdcloud.com/cn/virtual-machines/disassociate-elastic-ip)

## 接口说明 - 该接口只支持解绑实例的主网卡的主内网IP上的弹性公网IP。

jdcloud_sdk.services.vm.apis.ImportKeypairRequest module

class jdcloud_sdk.services.vm.apis.ImportKeypairRequest.ImportKeypairParameters(regionId, keyName, publicKey)[source]

Bases: object

param regionId:地域ID。
param keyName:密钥对名称，需要全局唯一。

只允许数字、大小写字母、下划线“_”及中划线“-”，不超过32个字符。

param publicKey:
 密钥对的公钥部分。
class jdcloud_sdk.services.vm.apis.ImportKeypairRequest.ImportKeypairRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

导入密钥。

与创建密钥不同的是，导入的密钥是由用户生成的。生成之后将公钥部分导入到京东云。

详细操作说明请参考帮助文档：[创建密钥](https://docs.jdcloud.com/cn/virtual-machines/create-keypair)

## 接口说明 - 调用该接口导入由其他工具生成的密钥对的公钥部分。

jdcloud_sdk.services.vm.apis.ModifyImageAttributeRequest module

class jdcloud_sdk.services.vm.apis.ModifyImageAttributeRequest.ModifyImageAttributeParameters(regionId, imageId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • imageId – 镜像ID。
setDescription(description)[source]
Parameters:description – (Optional) 镜像描述。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。
setName(name)[source]
Parameters:name – (Optional) 镜像名称。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。
class jdcloud_sdk.services.vm.apis.ModifyImageAttributeRequest.ModifyImageAttributeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改镜像属性。

详细操作说明请参考帮助文档：[镜像概述](https://docs.jdcloud.com/cn/virtual-machines/image-overview)

## 接口说明 - 只支持修改镜像名称或描述。

jdcloud_sdk.services.vm.apis.ModifyInstanceAttributeRequest module

class jdcloud_sdk.services.vm.apis.ModifyInstanceAttributeRequest.ModifyInstanceAttributeParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
setDescription(description)[source]
Parameters:description – (Optional) 实例描述。256字符以内。
setHostname(hostname)[source]
param hostname:(Optional) 实例hostname。

Windows系统：长度为2~15个字符，允许大小写字母、数字或连字符（-），不能以连字符（-）开头或结尾，不能连续使用连字符（-），也不能全部使用数字。不支持点号（.）。 Linux系统：长度为2-64个字符，允许支持多个点号，点之间为一段，每段允许使用大小写字母、数字或连字符（-），但不能连续使用点号（.）或连字符（-），不能以点号（.）或连字符（-）开头或结尾。

setMetadata(metadata)[source]
param metadata:(Optional) 用户自定义元数据。

以 key-value 键值对形式指定，可在实例系统内通过元数据服务查询获取。最多支持40对键值对，且 key 不超过256字符，value 不超过16KB，不区分大小写。 注意：key 不要以连字符(-)结尾，否则此 key 不生效。

setName(name)[source]
Parameters:name – (Optional) 实例名称。长度为2~128个字符，只允许中文、数字、大小写字母、英文下划线（_）、连字符（-）及点（.），不能以（.）作为首尾。
setUserdata(userdata)[source]
param userdata:(Optional) 自定义脚本。

目前仅支持启动脚本，即 launch-script，须Base64编码且编码前数据长度不能超过16KB。 linux系统：支持bash和python，编码前须分别以 #!/bin/bash 和 #!/usr/bin/env python 作为内容首行。 Windows系统：支持 bat 和 powershell ，编码前须分别以 <cmd></cmd>和<powershell></powershell> 作为内容首、尾行。

class jdcloud_sdk.services.vm.apis.ModifyInstanceAttributeRequest.ModifyInstanceAttributeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改一台云主机的属性。

详细操作说明请参考帮助文档： [修改实例名称](https://docs.jdcloud.com/cn/virtual-machines/modify-instance-name) [自定义数据](https://docs.jdcloud.com/cn/virtual-machines/userdata) [实例元数据](https://docs.jdcloud.com/cn/virtual-machines/instance-metadata)

## 接口说明 - 支持修改实例的名称、描述、hostname、自定义数据、实例元数据。

jdcloud_sdk.services.vm.apis.ModifyInstanceDiskAttributeRequest module

class jdcloud_sdk.services.vm.apis.ModifyInstanceDiskAttributeRequest.ModifyInstanceDiskAttributeParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
setDataDisks(dataDisks)[source]
Parameters:dataDisks – (Optional) 云硬盘列表。
class jdcloud_sdk.services.vm.apis.ModifyInstanceDiskAttributeRequest.ModifyInstanceDiskAttributeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改一台云主机中的云硬盘属性。

详细操作说明请参考帮助文档：[配置云硬盘删除属性](https://docs.jdcloud.com/cn/virtual-machines/configurate-delete-attributes)

## 接口说明 - 该接口当前只能修改实例中的云硬盘随实例删除属性。 - 仅按配置计费、并且非共享型的云硬盘支持修改。 - 包年包月计费的云硬盘该属性不生效，实例删除时云硬盘将保留。

jdcloud_sdk.services.vm.apis.ModifyInstanceNetworkAttributeRequest module

class jdcloud_sdk.services.vm.apis.ModifyInstanceNetworkAttributeRequest.ModifyInstanceNetworkAttributeParameters(regionId, instanceId, networks)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
  • networks – 弹性网卡列表。
class jdcloud_sdk.services.vm.apis.ModifyInstanceNetworkAttributeRequest.ModifyInstanceNetworkAttributeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改云主机弹性网卡属性。

详细操作说明请参考帮助文档：[配置弹性网卡删除属性](https://docs.jdcloud.com/cn/virtual-machines/configurate-eni-delete-attributes)

## 接口说明 - 当前只支持修改随云主机实例删除的属性。 - 不支持修改主网卡。

jdcloud_sdk.services.vm.apis.ModifyInstancePasswordRequest module

class jdcloud_sdk.services.vm.apis.ModifyInstancePasswordRequest.ModifyInstancePasswordParameters(regionId, instanceId, password)[source]

Bases: object

param regionId:地域ID。
param instanceId:
 云主机ID。
param password:实例密码。

可用于SSH登录和VNC登录。 长度为8~30个字符，必须同时包含大、小写英文字母、数字和特殊符号中的三类字符。特殊符号包括：()`~!@#$%^&*_-+=|{}[ ]:”;’<>,.?/，。 更多密码输入要求请参见 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。

class jdcloud_sdk.services.vm.apis.ModifyInstancePasswordRequest.ModifyInstancePasswordRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改云主机密码。

详细操作说明请参考帮助文档：[重置密码](https://docs.jdcloud.com/cn/virtual-machines/reset-password)

## 接口说明 - 实例没有正在进行中的任务时才可操作。 - 重置密码后，需要重启云主机后生效。

jdcloud_sdk.services.vm.apis.RebootInstanceRequest module

class jdcloud_sdk.services.vm.apis.RebootInstanceRequest.RebootInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
class jdcloud_sdk.services.vm.apis.RebootInstanceRequest.RebootInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

重启云主机实例。

详细操作说明请参考帮助文档：[重启实例](https://docs.jdcloud.com/cn/virtual-machines/reboot-instance)

## 接口说明 - 实例状态必须为运行 running 状态，同时实例没有正在进行中的任务时才可以重启。 - 如果云主机实例已欠费或已到期，则无法重启。

jdcloud_sdk.services.vm.apis.RebuildInstanceRequest module

class jdcloud_sdk.services.vm.apis.RebuildInstanceRequest.RebuildInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
setHostname(hostname)[source]
param hostname:(Optional) 实例hostname。

若不指定hostname，则默认以实例名称`name`作为hostname，但是会以RFC 952和RFC 1123命名规范做一定转义。 Windows系统：长度为2~15个字符，允许大小写字母、数字或连字符（-），不能以连字符（-）开头或结尾，不能连续使用连字符（-），也不能全部使用数字。不支持点号（.）。 Linux系统：长度为2-64个字符，允许支持多个点号，点之间为一段，每段允许使用大小写字母、数字或连字符（-），但不能连续使用点号（.）或连字符（-），不能以点号（.）或连字符（-）开头或结尾。

setImageId(imageId)[source]
param imageId:(Optional) 镜像ID。

若不指定镜像ID，默认使用当前主机的原镜像重置系统。 可查询 [DescribeImages](https://docs.jdcloud.com/virtual-machines/api/describeimages) 接口获得指定地域的镜像信息。

setImageInherit(imageInherit)[source]
Parameters:imageInherit – (Optional) 继承镜像中的登录验证方式，”yes”为使用，”no”为不使用，””默认为”no”
setKeyNames(keyNames)[source]
Parameters:keyNames – (Optional) 密钥对名称。仅Linux系统下该参数生效，当前仅支持输入单个密钥。
setMetadata(metadata)[source]
param metadata:(Optional) 用户自定义元数据。

以 key-value 键值对形式指定，可在实例系统内通过元数据服务查询获取。最多支持40对键值对，且 key 不超过256字符，value 不超过16KB，不区分大小写。 注意：key 不要以连字符(-)结尾，否则此 key 不生效。

setPassWordAuth(passWordAuth)[source]
param passWordAuth:
 (Optional) 密码授权，若存在密匙，则根据此参数决定是否使用密码，若没有密匙，此参数无效，会强制使用密码。

若不使用密码，且密匙对解绑后，用户需重置密码，方可使用密码登录。 此参数在windows系统中必须为yes。

setPassword(password)[source]
param password:(Optional) 实例密码。

可用于SSH登录和VNC登录。 长度为8~30个字符，必须同时包含大、小写英文字母、数字和特殊符号中的三类字符。特殊符号包括：()`~!@#$%^&*_-+=|{}[ ]:”;’<>,.?/，。 更多密码输入要求请参见 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。

setUserdata(userdata)[source]
param userdata:(Optional) 自定义脚本。

目前仅支持启动脚本，即 launch-script，须Base64编码且编码前数据长度不能超过16KB。 linux系统：支持bash和python，编码前须分别以 #!/bin/bash 和 #!/usr/bin/env python 作为内容首行。 Windows系统：支持 bat 和 powershell，编码前须分别以 <cmd></cmd>和<powershell></powershell> 作为内容首、尾行。

class jdcloud_sdk.services.vm.apis.RebuildInstanceRequest.RebuildInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

重置云主机系统。

需要注意的是，重装系统会导致系统盘的内容全部丢失，数据盘的数据不受影响（但需要重新识别）。因此，在需要保留系统运行数据的情况下，强烈建议您在重置系统前制作私有镜像，之后重置时选择该私有镜像即可实现保留系统运行数据。

详细操作说明请参考帮助文档：[重置系统](https://docs.jdcloud.com/cn/virtual-machines/rebuild-instance)

## 接口说明 - 云主机的状态必须为 stopped 状态。 - 若实例基于私有镜像创建，而私有镜像已被删除，则无法使用原镜像重置系统，即无法恢复至刚创建时的系统状态，建议保留被实例引用的私有镜像。 - 重置系统需要重新指定密码，对于 Linux 系统您还可以重新指定 SSH密钥。 - 对于云盘作系统盘的实例，当前系统盘大小不能超过目标镜像对应系统盘快照的容量。 - 云主机系统盘类型必须与待更换镜像支持的系统盘类型保持一致，若当前云主机系统盘为 local 类型，则更换镜像的系统盘类型必须为 loaclDisk 类型；同理，若当前云主机系统盘为 cloud 类型，则更换镜像的系统盘类型必须为 cloudDisk 类型。可查询 [DescribeImages](https://docs.jdcloud.com/virtual-machines/api/describeimages) 接口获得指定地域的镜像信息。 - 指定的镜像必须能够支持当前主机的实例规格 instanceType，否则会返回错误。可查询 [DescribeImageConstraints](docs.jdcloud.com/virtual-machines/api/describeimageconstraints) 接口获得指定镜像支持的系统盘类型信息。

jdcloud_sdk.services.vm.apis.ResizeInstanceRequest module

class jdcloud_sdk.services.vm.apis.ResizeInstanceRequest.ResizeInstanceParameters(regionId, instanceId, instanceType)[source]

Bases: object

Parameters:
setForce(force)[source]
Parameters:force – (Optional) 是否强制调配，默认为 false。如果指定为 true, 将会清除本地数据盘。
class jdcloud_sdk.services.vm.apis.ResizeInstanceRequest.ResizeInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

变更云主机实例配置。

详细操作说明请参考帮助文档：[调整配置](https://docs.jdcloud.com/cn/virtual-machines/resize-instance)

## 接口说明
  • 云主机的状态必须为 stopped 状态。
  • 16年创建的云硬盘做系统盘的云主机，实例规格不允许跨代调配。
  • 若当前实例系统盘为本地盘，则不允许跨代调配，例如第一代云主机不允许与第二代云主机互相调配，且不允许调整至第一代存储优化大数据型 s.d1 及第二代存储优化大数据型 s.d2。
  • 若当前实例在高可用组内，则不允许调配至除GPU类型外的第一代云主机，受限于高可用组支持的规格情况。
  • 若当前实例已挂载加密云盘，则不允许调配至第一代云主机，受限于支持加密盘的规格情况。
  • 裸金属实例规格主机暂不支持调配，即不支持从其他规格调整为裸金属规格或从裸金属规格调整为其他规格。
  • 对于按配置计费实例，调整配置后将按照新规格计费，调整前规格会立即出账结算（即对上次整点结算时间至当前时间产生的费用进行结算）。
  • 若当前实例带有本地数据盘，需清除本地盘内数据才可调整配置，还请谨慎操作。
  • 对于包年包月计费云主机：
    • 若调配后规格价格低于调配前规格价格，则将延长云主机到期时间；
    • 若调配后规格价格高于调配前规格价格，需要支付到期前的差价。
  • 如果当前主机中的弹性网卡数量，超过了目标实例规格允许的弹性网卡数量，会返回错误。可查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得实例规格允许的弹性网卡数量。
  • 如果当前主机中的云硬盘数据，超过了目标实例规格允许的云硬盘数量，会返回错误。可查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得实例规格允许的云硬盘数量。
  • 当前主机所使用的镜像，需要支持目标实例规格，否则返回错误。可查询 [DescribeImageConstraints](docs.jdcloud.com/virtual-machines/api/describeimageconstraints) 接口获得指定镜像的实例规格限制信息。
  • 云主机欠费或到期时，无法更改实例规格。

jdcloud_sdk.services.vm.apis.ShareImageRequest module

class jdcloud_sdk.services.vm.apis.ShareImageRequest.ShareImageParameters(regionId, imageId, pins)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • imageId – 镜像ID。
  • pins – 共享的目标京东云帐户列表。
class jdcloud_sdk.services.vm.apis.ShareImageRequest.ShareImageRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

共享私有镜像。

详细操作说明请参考帮助文档：[共享私有镜像](https://docs.jdcloud.com/cn/virtual-machines/share-image)

## 接口说明 - 只允许共享用户的私有镜像。 - 单个镜像最多可以共享给20个京东云帐户、不可以共享给自己。 - 带有加密快照的打包镜像无法共享。

jdcloud_sdk.services.vm.apis.StartInstanceRequest module

class jdcloud_sdk.services.vm.apis.StartInstanceRequest.StartInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
class jdcloud_sdk.services.vm.apis.StartInstanceRequest.StartInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

启动云主机实例。

详细操作说明请参考帮助文档：[启动实例](https://docs.jdcloud.com/cn/virtual-machines/start-instance)

## 接口说明 - 实例状态必须为停止 stopped 状态，同时实例没有正在进行中的任务时才可以启动。 - 如果实例为停机不计费模式，启动时有可能因为库存资源不足而导致无法启动。 - 如果云主机实例已欠费或已到期，则无法启动。 - 如果实例系统盘是云硬盘，启动之前请确保系统盘处于正常挂载状态。

jdcloud_sdk.services.vm.apis.StopInstanceRequest module

class jdcloud_sdk.services.vm.apis.StopInstanceRequest.StopInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • instanceId – 云主机ID。
setChargeOnStopped(chargeOnStopped)[source]
param chargeOnStopped:
 (Optional) 停机不计费模式。

该参数仅对按配置计费且系统盘为云硬盘的实例生效，并且不是专有宿主机中的实例。 配置停机不计费且停机后，实例部分将停止计费，且释放实例自身包含的资源（CPU/内存/GPU/本地数据盘）。 可选值： keepCharging：停机后保持计费，不释放资源。 stopCharging：停机后停止计费，释放实例资源。默认值为空。

class jdcloud_sdk.services.vm.apis.StopInstanceRequest.StopInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

停止云主机实例。

详细操作说明请参考帮助文档：[停止实例](https://docs.jdcloud.com/cn/virtual-machines/stop-instance)

## 接口说明 - 实例状态必须为运行 running 状态，同时实例没有正在进行中的任务时才可停止。 - 如果云主机实例属性 chargeOnStopped 的值为 stopCharging，实例关机之后，实例部分将停止计费，且释放实例自身包含的资源（CPU/内存/GPU/本地数据盘）。需要使用者注意的是，实例一旦释放自身资源，再次启动时有可能因为库存资源不足而导致无法启动。 - chargeOnStopped 该参数仅对按配置计费且系统盘为云硬盘的实例生效，并且不是专有宿主机中的实例。

jdcloud_sdk.services.vm.apis.UnShareImageRequest module

class jdcloud_sdk.services.vm.apis.UnShareImageRequest.UnShareImageParameters(regionId, imageId, pins)[source]

Bases: object

Parameters:
  • regionId – 地域ID。
  • imageId – 镜像ID。
  • pins – 需要取消的京东云帐户列表。
class jdcloud_sdk.services.vm.apis.UnShareImageRequest.UnShareImageRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

取消共享私有镜像。

详细操作说明请参考帮助文档：[取消共享私有镜像](https://docs.jdcloud.com/cn/virtual-machines/cancel-share-image)

## 接口说明 - 只允许操作用户的私有镜像。 - 原被共享用户将无法再使用该镜像创建云主机实例，同时使用该镜像创建的云主机实例也无法重置为原始系统状态。

Module contents