jdcloud_sdk.services.nativecontainer.models package

Submodules

jdcloud_sdk.services.nativecontainer.models.Container module

class jdcloud_sdk.services.nativecontainer.models.Container.Container(containerId=None, status=None, instanceType=None, az=None, name=None, hostAliases=None, hostname=None, ag=None, command=None, args=None, envs=None, image=None, secret=None, tty=None, workingDir=None, rootVolume=None, dataVolumes=None, vpcId=None, subnetId=None, privateIpAddress=None, elasticIpId=None, elasticIpAddress=None, primaryNetworkInterface=None, secondaryNetworkInterfaces=None, logConfiguration=None, tags=None, charge=None, launchTime=None, reason=None, description=None, resourceGroupId=None)[source]

Bases: object

Parameters:
  • containerId – (Optional) 容器ID
  • status – (Optional) 容器状态
  • instanceType – (Optional) 实例类型
  • az – (Optional) 可用区
  • name – (Optional) 容器名称
  • hostAliases – (Optional) 域名和IP映射的信息
  • hostname – (Optional) 主机名
  • ag – (Optional) 高可用组
  • command – (Optional) 容器执行命令
  • args – (Optional) 容器执行命令的参数
  • envs – (Optional) 动态指定的容器执行的环境变量
  • image – (Optional) 镜像名称
  • secret – (Optional) 镜像仓库认证信息名称
  • tty – (Optional) 容器是否分配tty
  • workingDir – (Optional) 容器的工作目录
  • rootVolume – (Optional) 根Volume信息
  • dataVolumes – (Optional) 挂载的数据Volume信息
  • vpcId – (Optional) 主网卡所属VPC的ID
  • subnetId – (Optional) 主网卡所属子网的ID
  • privateIpAddress – (Optional) 主网卡主IP地址
  • elasticIpId – (Optional) 主网卡主IP绑定弹性IP的ID
  • elasticIpAddress – (Optional) 主网卡主IP绑定弹性IP的地址
  • primaryNetworkInterface – (Optional) 主网卡配置信息
  • secondaryNetworkInterfaces – (Optional) 辅助网卡配置信息
  • logConfiguration – (Optional) 容器日志配置信息
  • tags – (Optional)
  • charge – (Optional) 计费配置信息
  • launchTime – (Optional) 创建时间
  • reason – (Optional) 容器终止原因
  • description – (Optional) 容器描述
  • resourceGroupId – (Optional) 资源组ID

jdcloud_sdk.services.nativecontainer.models.ContainerNetworkInterfaceAttachmentSpec module

class jdcloud_sdk.services.nativecontainer.models.ContainerNetworkInterfaceAttachmentSpec.ContainerNetworkInterfaceAttachmentSpec(networkInterface, autoDelete=None, deviceIndex=None)[source]

Bases: object

Parameters:
  • autoDelete – (Optional) 指明删除容器时是否删除网卡，默认True；当前只能是True
  • deviceIndex – (Optional) 设备Index，主网卡为1，暂不提供辅助网卡index
  • networkInterface – 网卡接口规范

jdcloud_sdk.services.nativecontainer.models.ContainerSpec module

class jdcloud_sdk.services.nativecontainer.models.ContainerSpec.ContainerSpec(instanceType, az, name, image, rootVolume, primaryNetworkInterface, hostAliases=None, hostname=None, command=None, args=None, envs=None, secret=None, tty=None, workingDir=None, dataVolumes=None, elasticIp=None, logConfiguration=None, description=None, charge=None, userTags=None, resourceGroupId=None)[source]

Bases: object

Parameters:
  • instanceType – 实例类型；参考[文档](https://www.jdcloud.com/help/detail/1992/isCatalog/1)
  • az – 容器所属可用区，指定agId时非必传<br> 容器、已有云盘的az必须相同，且包含在AG中
  • name – 容器名称，不可为空，只支持中文、数字、大小写字母、英文下划线“_”及中划线“-”，且不能超过32字符
  • hostAliases – (Optional) 域名和IP映射的信息；</br> 最大10个alias
  • hostname – (Optional) 主机名，规范请参考说明文档；默认容器ID
  • command – (Optional) 容器执行命令，如果不指定默认是docker镜像的ENTRYPOINT
  • args – (Optional) 容器执行命令的参数，如果不指定默认是docker镜像的CMD
  • envs – (Optional) 容器执行的环境变量；如果和镜像中的环境变量Key相同，会覆盖镜像中的值；</br> 最大100对
  • image – 镜像名称 </br> 1. Docker Hub官方镜像通过类似nginx, mysql/mysql-server的名字指定 </br> </br> repository长度最大256个字符，tag最大128个字符，registry最大255个字符
  • secret – (Optional) 镜像仓库认证信息；使用Docker Hub和京东云CR的镜像不需要secret
  • tty – (Optional) 容器是否分配tty。默认不分配
  • workingDir – (Optional) 容器的工作目录。如果不指定，默认是根目录（/）；必须是绝对路径
  • rootVolume – 根Volume信息
  • dataVolumes – (Optional) 挂载的数据Volume信息；最多7个
  • elasticIp – (Optional) 主网卡主IP关联的弹性IP规格
  • primaryNetworkInterface – 主网卡配置信息
  • logConfiguration – (Optional) 容器日志配置信息；默认会在本地分配10MB的存储空间
  • description – (Optional) 容器描述
  • charge – (Optional) 计费配置；如不指定，默认计费类型是后付费-按使用时常付费
  • userTags – (Optional) 用户普通标签集合
  • resourceGroupId – (Optional) 资源组ID

jdcloud_sdk.services.nativecontainer.models.DockerRegistryData module

class jdcloud_sdk.services.nativecontainer.models.DockerRegistryData.DockerRegistryData(server, username, password, email=None)[source]

Bases: object

Parameters:
  • server – registry服务器地址
  • username – 用户名
  • password – 密码
  • email – (Optional) 邮件地址

jdcloud_sdk.services.nativecontainer.models.ElasticIpSpec module

class jdcloud_sdk.services.nativecontainer.models.ElasticIpSpec.ElasticIpSpec(bandwidthMbps, provider=None, chargeSpec=None)[source]

Bases: object

Parameters:
  • bandwidthMbps – 弹性公网IP的限速 单位：MB
  • provider – (Optional) IP服务商，取值为bgp或no_bgp
  • chargeSpec – (Optional) 计费配置

jdcloud_sdk.services.nativecontainer.models.EnvVar module

class jdcloud_sdk.services.nativecontainer.models.EnvVar.EnvVar(name, value=None)[source]

Bases: object

Parameters:
  • name – 环境变量名称
  • value – (Optional) 环境变量的值

jdcloud_sdk.services.nativecontainer.models.HostAlias module

class jdcloud_sdk.services.nativecontainer.models.HostAlias.HostAlias(hostnames=None, ip=None)[source]

Bases: object

Parameters:
  • hostnames – (Optional) 域名列表
  • ip – (Optional) IP地址

jdcloud_sdk.services.nativecontainer.models.InstanceCloudDisk module

class jdcloud_sdk.services.nativecontainer.models.InstanceCloudDisk.InstanceCloudDisk(diskId=None, az=None, name=None, description=None, diskType=None, diskSize=None, iops=None, status=None, createTime=None)[source]

Bases: object

Parameters:
  • diskId – (Optional) 云硬盘ID
  • az – (Optional) 所属AZ
  • name – (Optional) 硬盘名称
  • description – (Optional) 硬盘描述
  • diskType – (Optional) 磁盘类型
  • diskSize – (Optional) 磁盘大小（GiB）
  • iops – (Optional) 用户指定购买的iops值，目前只支持 ssd.io1 类型云盘
  • status – (Optional) 云硬盘状态，取值为 creating、available、in-use、extending、restoring、deleting、deleted、error_creating、error_deleting、error_restoring、error_extending 之一
  • createTime – (Optional) 创建时间

jdcloud_sdk.services.nativecontainer.models.InstanceNetworkInterface module

class jdcloud_sdk.services.nativecontainer.models.InstanceNetworkInterface.InstanceNetworkInterface(networkInterfaceId=None, macAddress=None, vpcId=None, subnetId=None, description=None, securityGroups=None, sanityCheck=None, primaryIp=None, secondaryIps=None)[source]

Bases: object

Parameters:
  • networkInterfaceId – (Optional) 弹性网卡ID
  • macAddress – (Optional) 以太网地址
  • vpcId – (Optional) 虚拟网络ID
  • subnetId – (Optional) 子网ID
  • description – (Optional) 描述
  • securityGroups – (Optional) 安全组列表
  • sanityCheck – (Optional) 源和目标IP地址校验，取值为0或者1
  • primaryIp – (Optional) 网卡主IP
  • secondaryIps – (Optional) null

jdcloud_sdk.services.nativecontainer.models.InstanceNetworkInterfaceAttachment module

class jdcloud_sdk.services.nativecontainer.models.InstanceNetworkInterfaceAttachment.InstanceNetworkInterfaceAttachment(autoDelete=None, deviceIndex=None, attachStatus=None, attachTime=None, networkInterface=None)[source]

Bases: object

Parameters:
  • autoDelete – (Optional) 指明删除实例时是否删除网卡
  • deviceIndex – (Optional) 设备Index，暂不提供辅助网卡index
  • attachStatus – (Optional) 绑定状态
  • attachTime – (Optional) 绑定时间
  • networkInterface – (Optional) 弹性网卡信息

jdcloud_sdk.services.nativecontainer.models.LogConfiguration module

class jdcloud_sdk.services.nativecontainer.models.LogConfiguration.LogConfiguration(logDriver=None)[source]

Bases: object

Parameters:logDriver – (Optional) 日志Driver名称 default：默认在本地分配10MB的存储空间，自动rotate

jdcloud_sdk.services.nativecontainer.models.LogOption module

class jdcloud_sdk.services.nativecontainer.models.LogOption.LogOption(key=None, value=None)[source]

Bases: object

Parameters:
  • key – (Optional) null
  • value – (Optional) null

jdcloud_sdk.services.nativecontainer.models.NetworkInterfacePrivateIp module

class jdcloud_sdk.services.nativecontainer.models.NetworkInterfacePrivateIp.NetworkInterfacePrivateIp(privateIpAddress=None, elasticIpId=None, elasticIpAddress=None)[source]

Bases: object

Parameters:
  • privateIpAddress – (Optional) 私有IP的IPV4地址
  • elasticIpId – (Optional) 弹性IP实例ID
  • elasticIpAddress – (Optional) 弹性IP实例地址

jdcloud_sdk.services.nativecontainer.models.NetworkInterfaceSpec module

class jdcloud_sdk.services.nativecontainer.models.NetworkInterfaceSpec.NetworkInterfaceSpec(subnetId, az, primaryIpAddress=None, secondaryIpAddresses=None, secondaryIpCount=None, securityGroups=None, sanityCheck=None, description=None)[source]

Bases: object

Parameters:
  • subnetId – 子网ID
  • az – 可用区，用户的默认可用区，暂不支持
  • primaryIpAddress – (Optional) 网卡主IP
  • secondaryIpAddresses – (Optional) 网卡辅助IP，暂不支持
  • secondaryIpCount – (Optional) 自动分配的辅助Ip数量，暂不支持
  • securityGroups – (Optional) 要绑定的安全组ID列表，最多指定5个安全组
  • sanityCheck – (Optional) 源和目标IP地址校验，取值为0或者1，默认为1，暂不支持此功能
  • description – (Optional) 描述，最大长度256字符

jdcloud_sdk.services.nativecontainer.models.Quota module

class jdcloud_sdk.services.nativecontainer.models.Quota.Quota(resourceType=None, limit=None, used=None)[source]

Bases: object

Parameters:
  • resourceType – (Optional) 类型
  • limit – (Optional) 配额
  • used – (Optional) 已使用的数目

jdcloud_sdk.services.nativecontainer.models.Secret module

class jdcloud_sdk.services.nativecontainer.models.Secret.Secret(name=None, secretType=None, createdAt=None, data=None)[source]

Bases: object

Parameters:
  • name – (Optional) 机密数据名称
  • secretType – (Optional) 私密数据的类型，目前仅支持如下类型：docker-registry：用来和docker registry认证的类型
  • createdAt – (Optional) 创建时间
  • data – (Optional) 机密的数据

jdcloud_sdk.services.nativecontainer.models.SecurityGroupSimple module

class jdcloud_sdk.services.nativecontainer.models.SecurityGroupSimple.SecurityGroupSimple(groupId=None, groupName=None)[source]

Bases: object

Parameters:
  • groupId – (Optional) 安全组ID
  • groupName – (Optional) 安全组名称

jdcloud_sdk.services.nativecontainer.models.Tag module

class jdcloud_sdk.services.nativecontainer.models.Tag.Tag(key=None, value=None)[source]

Bases: object

Parameters:
  • key – (Optional) Tag键
  • value – (Optional) Tag值

jdcloud_sdk.services.nativecontainer.models.TagFilter module

class jdcloud_sdk.services.nativecontainer.models.TagFilter.TagFilter(key, values=None)[source]

Bases: object

Parameters:
  • key – Tag键
  • values – (Optional) Tag值

jdcloud_sdk.services.nativecontainer.models.VolumeMount module

class jdcloud_sdk.services.nativecontainer.models.VolumeMount.VolumeMount(category=None, autoDelete=None, mountPath=None, readOnly=None, cloudDisk=None, localDisk=None, fsType=None)[source]

Bases: object

Parameters:
  • category – (Optional) 磁盘分类
  • autoDelete – (Optional) 自动删除，删除容器时自动删除此volume
  • mountPath – (Optional) 容器内的挂载目录
  • readOnly – (Optional) 只读，默认false；只针对data volume有效，root volume为false
  • cloudDisk – (Optional) 云硬盘规格
  • localDisk – (Optional) 云硬盘规格
  • fsType – (Optional) 指定volume文件系统类型，目前支持[xfs, ext4]

jdcloud_sdk.services.nativecontainer.models.VolumeMountSpec module

class jdcloud_sdk.services.nativecontainer.models.VolumeMountSpec.VolumeMountSpec(category, autoDelete=None, mountPath=None, readOnly=None, cloudDiskSpec=None, cloudDiskId=None, fsType=None, formatVolume=None)[source]

Bases: object

Parameters:
  • category – 磁盘分类 cloud：基于云硬盘的卷 local：本地盘（需工单申请）
  • autoDelete – (Optional) 自动删除，删除容器时自动删除此volume，默认为True；只支持磁盘是云硬盘的场景
  • mountPath – (Optional) 容器内的挂载目录；root volume不需要指定，挂载目录是（/）；data volume必须指定；必须是绝对路径，不能包含(:)
  • readOnly – (Optional) 只读，默认false；只针对data volume有效；root volume为false，也就是可读可写
  • cloudDiskSpec – (Optional) 云硬盘规格；随容器自动创建的云硬盘，不会对磁盘分区，只会格式化文件系统 <br>注：其中az、chargeSpec、multiAttachable、encrypt字段无效
  • cloudDiskId – (Optional) 云硬盘ID，使用已有的云硬盘，必须同时指定fsType
  • fsType – (Optional) 指定volume文件系统类型，目前支持[xfs, ext4]；如果新创建的盘，不指定文件系统类型默认格式化成xfs
  • formatVolume – (Optional) 随容器自动创建的新盘，会自动格式化成指定的文件系统类型；挂载已有的盘，默认不会格式化，只会按照指定的fsType去挂载；如果希望格式化，必须设置此字段为true

Module contents