models

package
v1.54.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 15, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Ag 

type Ag struct {

	/* 高可用组名称 (Optional) */
	Name string `json:"name"`

	/* 高可用组id (Optional) */
	Id string `json:"id"`
}

type BriefInstance added in v1.25.0 

type BriefInstance struct {

	/* 云主机ID (Optional) */
	InstanceId string `json:"instanceId"`

	/* 云主机名称 (Optional) */
	InstanceName string `json:"instanceName"`

	/* 实例规格 (Optional) */
	InstanceType string `json:"instanceType"`

	/* 主网卡所属VPC的ID (Optional) */
	VpcId string `json:"vpcId"`

	/* 主网卡所属子网的ID (Optional) */
	SubnetId string `json:"subnetId"`

	/* 主网卡主IP地址 (Optional) */
	PrivateIpAddress string `json:"privateIpAddress"`

	/* 云主机状态，<a href="http://docs.jdcloud.com/virtual-machines/api/vm_status">参考云主机状态</a> (Optional) */
	Status string `json:"status"`

	/* 云主机描述 (Optional) */
	Description string `json:"description"`

	/* 镜像ID (Optional) */
	ImageId string `json:"imageId"`

	/* 系统盘配置 (Optional) */
	SystemDisk BriefInstanceDiskAttachment `json:"systemDisk"`

	/* 数据盘配置 (Optional) */
	DataDisks []BriefInstanceDiskAttachment `json:"dataDisks"`

	/* 主网卡配置 (Optional) */
	PrimaryNetworkInterface BriefInstanceNetworkInterfaceAttachment `json:"primaryNetworkInterface"`

	/* 辅助网卡配置 (Optional) */
	SecondaryNetworkInterfaces []BriefInstanceNetworkInterfaceAttachment `json:"secondaryNetworkInterfaces"`

	/* 创建时间 (Optional) */
	LaunchTime string `json:"launchTime"`

	/* 云主机所在可用区 (Optional) */
	Az string `json:"az"`

	/* 密钥对名称 (Optional) */
	KeyNames []string `json:"keyNames"`

	/* 高可用组中的错误域 (Optional) */
	FaultDomain string `json:"faultDomain"`

	/* 关机模式，只支持云盘做系统盘的按配置计费云主机。KeepCharging：关机后继续计费；StopCharging：关机后停止计费。 (Optional) */
	ChargeOnStopped string `json:"chargeOnStopped"`

	/* 实例所属的专有宿主机池 (Optional) */
	DedicatedPoolId string `json:"dedicatedPoolId"`

	/* 专有宿主机ID (Optional) */
	DedicatedHostId string `json:"dedicatedHostId"`
}

type BriefInstanceDiskAttachment added in v1.25.0 

type BriefInstanceDiskAttachment struct {

	/* 磁盘分类，取值为本地盘(local)或者数据盘(cloud)。
	系统盘支持本地盘(local)或者云硬盘(cloud)。系统盘选择local类型，必须使用localDisk类型的镜像；同理系统盘选择cloud类型，必须使用cloudDisk类型的镜像。
	数据盘仅支持云硬盘(cloud)。
	 (Optional) */
	DiskCategory string `json:"diskCategory"`

	/* 随云主机一起删除，删除主机时自动删除此磁盘，默认为true，本地盘(local)不能更改此值。
	如果云主机中的数据盘(cloud)是包年包月计费方式，此参数不生效。
	如果云主机中的数据盘(cloud)是共享型数据盘，此参数不生效。
	 (Optional) */
	AutoDelete bool `json:"autoDelete"`

	/* 本地磁盘配置 (Optional) */
	LocalDisk LocalDisk `json:"localDisk"`

	/* 云硬盘配置 (Optional) */
	CloudDisk LightCloudDiskInfo `json:"cloudDisk"`

	/* 数据盘逻辑挂载点，取值范围：vda,vdb,vdc,vdd,vde,vdf,vdg,vdh,vdi,vmj,vdk,vdl,vdm (Optional) */
	DeviceName string `json:"deviceName"`

	/* 数据盘挂载状态，取值范围：attaching,detaching,attached,detached,error_attach,error_detach (Optional) */
	Status string `json:"status"`
}

type BriefInstanceNetworkInterfaceAttachment added in v1.25.0 

type BriefInstanceNetworkInterfaceAttachment struct {

	/* 设备Index (Optional) */
	DeviceIndex int `json:"deviceIndex"`

	/* 指明删除实例时是否删除网卡，默认true；当前只能是true (Optional) */
	AutoDelete bool `json:"autoDelete"`
}

type ChargeEvent added in v1.25.0 

type ChargeEvent struct {

	/* 开机时间，格式 2020-03-19 00:24:02 (Optional) */
	StartTime string `json:"startTime"`

	/* 关机时间，格式 2020-03-19 00:24:02 (Optional) */
	StopTime string `json:"stopTime"`
}

type CopyImage added in v1.0.5 

type CopyImage struct {

	/* 复制后的目标镜像ID (Optional) */
	DestinationImageId string `json:"destinationImageId"`

	/* 源镜像ID (Optional) */
	SourceImageId string `json:"sourceImageId"`
}

type CustomData added in v1.51.0 

type CustomData struct {

	/* 云主机ID (Optional) */
	InstanceId string `json:"instanceId"`

	/* 用户自定义元数据信息 key-value对，key、value不区分大小写 (Optional) */
	Metadata []Metadata `json:"metadata"`

	/* 元数据信息，目前只支持传入一个key为"launch-script"，表示首次启动脚本。vaule以base64编码返回 (Optional) */
	Userdata []Userdata `json:"userdata"`
}

type Gpu added in v1.1.0 

type Gpu struct {

	/* GPU型号 (Optional) */
	Model string `json:"model"`

	/* GPU数量 (Optional) */
	Number int `json:"number"`
}

type Image 

type Image struct {

	/* 镜像ID (Optional) */
	ImageId string `json:"imageId"`

	/* 镜像名称 (Optional) */
	Name string `json:"name"`

	/* 镜像的操作系统发行版。取值：Ubuntu,CentOS,Windows Server (Optional) */
	Platform string `json:"platform"`

	/* 镜像的操作系统版本。 (Optional) */
	OsVersion string `json:"osVersion"`

	/* 镜像架构。取值：i386,x86_64 (Optional) */
	Architecture string `json:"architecture"`

	/* 镜像系统盘大小 (Optional) */
	SystemDiskSizeGB int `json:"systemDiskSizeGB"`

	/* 镜像来源。取值：jcloud：官方镜像；marketplace：镜像市场镜像；self：用户自己的镜像；shared：其他用户分享的镜像 (Optional) */
	ImageSource string `json:"imageSource"`

	/* 镜像的操作系统类型。取值：windows,linux (Optional) */
	OsType string `json:"osType"`

	/* <a href="http://docs.jdcloud.com/virtual-machines/api/image_status">参考镜像状态</a> (Optional) */
	Status string `json:"status"`

	/* 创建时间 (Optional) */
	CreateTime string `json:"createTime"`

	/* 镜像文件实际大小 (Optional) */
	SizeMB int `json:"sizeMB"`

	/* 镜像描述 (Optional) */
	Desc string `json:"desc"`

	/* 该镜像所有者的用户PIN (Optional) */
	OwnerPin string `json:"ownerPin"`

	/* 镜像的使用权限，取值：all（所有人可用）， specifiedUsers（共享用户可用），ownerOnly（镜像所有者自己可用） (Optional) */
	LaunchPermission string `json:"launchPermission"`

	/* 镜像系统盘配置 (Optional) */
	SystemDisk InstanceDiskAttachment `json:"systemDisk"`

	/* 镜像数据盘映射信息 (Optional) */
	DataDisks []InstanceDiskAttachment `json:"dataDisks"`

	/* 创建云盘系统盘所使用的云硬盘快照ID。系统盘类型为本地盘的镜像，此参数为空。 (Optional) */
	SnapshotId string `json:"snapshotId"`

	/* 镜像支持的系统盘类型。取值：localDisk：本地盘系统盘；cloudDisk：云盘系统盘。 (Optional) */
	RootDeviceType string `json:"rootDeviceType"`

	/* 镜像复制和转换时的进度，仅显示数值，单位为百分比 (Optional) */
	Progress string `json:"progress"`

	/* 该镜像的上下线状态 (Optional) */
	Offline bool `json:"offline"`

	/* 该镜像所属的产品线标识 (Optional) */
	ServiceCode string `json:"serviceCode"`
}

type ImageConstraint 

type ImageConstraint struct {

	/* 镜像ID (Optional) */
	ImageId string `json:"imageId"`

	/* 使用镜像创建实例的规格限制 (Optional) */
	ImageInstanceTypeConstraint ImageInstanceTypeConstraint `json:"imageInstanceTypeConstraint"`
}

type ImageInstanceTypeConstraint 

type ImageInstanceTypeConstraint struct {

	/* 限制类型。取值：excludes：不支持的实例类型；includes：支持的实例类型。 (Optional) */
	ConstraintsType string `json:"constraintsType"`

	/* 实例规格列表 (Optional) */
	InstanceTypes []string `json:"instanceTypes"`
}

type Instance 

type Instance struct {

	/* 云主机ID (Optional) */
	InstanceId string `json:"instanceId"`

	/* 云主机名称 (Optional) */
	InstanceName string `json:"instanceName"`

	/* 云主机hostname (Optional) */
	Hostname string `json:"hostname"`

	/* 实例规格 (Optional) */
	InstanceType string `json:"instanceType"`

	/* 主网卡所属VPC的ID (Optional) */
	VpcId string `json:"vpcId"`

	/* 主网卡所属子网的ID (Optional) */
	SubnetId string `json:"subnetId"`

	/* 主网卡主IP地址 (Optional) */
	PrivateIpAddress string `json:"privateIpAddress"`

	/* 主网卡主IP绑定弹性IP的ID (Optional) */
	ElasticIpId string `json:"elasticIpId"`

	/* 主网卡主IP绑定弹性IP的地址 (Optional) */
	ElasticIpAddress string `json:"elasticIpAddress"`

	/* 云主机状态，<a href="http://docs.jdcloud.com/virtual-machines/api/vm_status">参考云主机状态</a> (Optional) */
	Status string `json:"status"`

	/* 云主机描述 (Optional) */
	Description string `json:"description"`

	/* 镜像ID (Optional) */
	ImageId string `json:"imageId"`

	/* 系统盘配置 (Optional) */
	SystemDisk InstanceDiskAttachment `json:"systemDisk"`

	/* 数据盘配置 (Optional) */
	DataDisks []InstanceDiskAttachment `json:"dataDisks"`

	/* 主网卡配置 (Optional) */
	PrimaryNetworkInterface InstanceNetworkInterfaceAttachment `json:"primaryNetworkInterface"`

	/* 辅助网卡配置 (Optional) */
	SecondaryNetworkInterfaces []InstanceNetworkInterfaceAttachment `json:"secondaryNetworkInterfaces"`

	/* 创建时间 (Optional) */
	LaunchTime string `json:"launchTime"`

	/* 云主机所在可用区 (Optional) */
	Az string `json:"az"`

	/* 密钥对名称 (Optional) */
	KeyNames []string `json:"keyNames"`

	/* 计费信息 (Optional) */
	Charge charge.Charge `json:"charge"`

	/* 高可用组，如果创建云主机使用了高可用组，此处可展示高可用组名称 (Optional) */
	Ag Ag `json:"ag"`

	/* 高可用组中的错误域 (Optional) */
	FaultDomain string `json:"faultDomain"`

	/* Tag信息 (Optional) */
	Tags []disk.Tag `json:"tags"`

	/* 关机模式，只支持云盘做系统盘的按配置计费云主机。keepCharging：关机后继续计费；stopCharging：关机后停止计费。 (Optional) */
	ChargeOnStopped string `json:"chargeOnStopped"`

	/* 策略信息 (Optional) */
	Policies []Policy `json:"policies"`
}

type InstanceDiskAttachment 

type InstanceDiskAttachment struct {

	/* 磁盘分类，取值为本地盘(local)或者数据盘(cloud)。
	系统盘支持本地盘(local)或者云硬盘(cloud)。系统盘选择local类型，必须使用localDisk类型的镜像；同理系统盘选择cloud类型，必须使用cloudDisk类型的镜像。
	数据盘仅支持云硬盘(cloud)。
	 (Optional) */
	DiskCategory string `json:"diskCategory"`

	/* 随云主机一起删除，删除主机时自动删除此磁盘，默认为true，本地盘(local)不能更改此值。
	如果云主机中的数据盘(cloud)是包年包月计费方式，此参数不生效。
	如果云主机中的数据盘(cloud)是共享型数据盘，此参数不生效。
	 (Optional) */
	AutoDelete bool `json:"autoDelete"`

	/* 本地磁盘配置 (Optional) */
	LocalDisk LocalDisk `json:"localDisk"`

	/* 云硬盘配置 (Optional) */
	CloudDisk disk.Disk `json:"cloudDisk"`

	/* 数据盘逻辑挂载点，取值范围：vda,vdb,vdc,vdd,vde,vdf,vdg,vdh,vdi,vmj,vdk,vdl,vdm (Optional) */
	DeviceName string `json:"deviceName"`

	/* 数据盘挂载状态，取值范围：attaching,detaching,attached,detached,error_attach,error_detach (Optional) */
	Status string `json:"status"`
}

type InstanceDiskAttachmentSpec 

type InstanceDiskAttachmentSpec struct {

	/* 磁盘分类，取值为本地盘(local)或者云硬盘(cloud)。
	系统盘支持本地盘(local)或者云硬盘(cloud)。系统盘选择local类型，必须使用localDisk类型的镜像；同理系统盘选择cloud类型，必须使用cloudDisk类型的镜像。
	数据盘仅支持云硬盘(cloud)。
	 (Optional) */
	DiskCategory *string `json:"diskCategory"`

	/* 是否随云主机一起删除，即删除主机时是否自动删除此磁盘，默认为true，本地盘(local)不能更改此值。
	如果云主机中的数据盘(cloud)是包年包月计费方式，此参数不生效。
	如果云主机中的数据盘(cloud)是共享型数据盘，此参数不生效。
	 (Optional) */
	AutoDelete *bool `json:"autoDelete"`

	/* 数据盘配置 (Optional) */
	CloudDiskSpec *disk.DiskSpec `json:"cloudDiskSpec"`

	/* 数据盘逻辑挂载点，取值范围：vda,vdb,vdc,vdd,vde,vdf,vdg,vdh,vdi,vmj,vdk,vdl,vdm (Optional) */
	DeviceName *string `json:"deviceName"`

	/* 排除设备，使用此参数noDevice配合deviceName一起使用。
	创建整机镜像：如deviceName:vdb、noDevice:true，则表示云主机中的数据盘vdb不参与创建镜像。
	创建模板：如deviceName:vdb、noDevice:true，则表示镜像中的数据盘vdb不参与创建主机。
	创建主机：如deviceName:vdb、noDevice:true，则表示镜像中的数据盘vdb，或者模板(使用模板创建主机)中的数据盘vdb不参与创建主机。
	 (Optional) */
	NoDevice *bool `json:"noDevice"`
}

type InstanceDiskAttribute added in v1.0.5 

type InstanceDiskAttribute struct {

	/* 云硬盘ID (Optional) */
	DiskId *string `json:"diskId"`

	/* 随云主机一起删除，删除主机时自动删除此磁盘，默认为false，本地盘(local)不能更改此值。
	如果云主机中的数据盘(cloud)是包年包月计费方式，此参数不生效。
	如果云主机中的数据盘(cloud)是共享型数据盘，此参数不生效。
	 (Optional) */
	AutoDelete *bool `json:"autoDelete"`
}

type InstanceNetworkAttribute added in v1.0.5 

type InstanceNetworkAttribute struct {

	/* 弹性网卡ID (Optional) */
	NetworkInterfaceId *string `json:"networkInterfaceId"`

	/* 随主机自动删除，默认为False (Optional) */
	AutoDelete *bool `json:"autoDelete"`
}

type InstanceNetworkInterface 

type InstanceNetworkInterface struct {

	/* 弹性网卡ID (Optional) */
	NetworkInterfaceId string `json:"networkInterfaceId"`

	/* 以太网地址 (Optional) */
	MacAddress string `json:"macAddress"`

	/* 虚拟网络ID (Optional) */
	VpcId string `json:"vpcId"`

	/* 子网ID (Optional) */
	SubnetId string `json:"subnetId"`

	/*  (Optional) */
	SecurityGroups []SecurityGroupSimple `json:"securityGroups"`

	/* 源和目标IP地址校验，取值为0或者1 (Optional) */
	SanityCheck int `json:"sanityCheck"`

	/* 网卡主IP (Optional) */
	PrimaryIp vpc.NetworkInterfacePrivateIp `json:"primaryIp"`

	/* 网卡辅IP (Optional) */
	SecondaryIps []vpc.NetworkInterfacePrivateIp `json:"secondaryIps"`
}

type InstanceNetworkInterfaceAttachment 

type InstanceNetworkInterfaceAttachment struct {

	/* 设备Index (Optional) */
	DeviceIndex int `json:"deviceIndex"`

	/* 指明删除实例时是否删除网卡，默认true；当前只能是true (Optional) */
	AutoDelete bool `json:"autoDelete"`

	/* 网卡接口规范 (Optional) */
	NetworkInterface InstanceNetworkInterface `json:"networkInterface"`
}

type InstanceNetworkInterfaceAttachmentSpec 

type InstanceNetworkInterfaceAttachmentSpec struct {

	/* 网卡设备Index，主网卡只能是1 (Optional) */
	DeviceIndex *int `json:"deviceIndex"`

	/* 网卡接口规范 (Optional) */
	NetworkInterface *vpc.NetworkInterfaceSpec `json:"networkInterface"`
}

type InstancePrivateIpAddress added in v1.0.11 

type InstancePrivateIpAddress struct {

	/* 云主机ID (Optional) */
	InstanceId string `json:"instanceId"`

	/* 主网卡内网主IP地址 (Optional) */
	PrivateIpAddress string `json:"privateIpAddress"`
}

type InstanceSpec 

type InstanceSpec struct {

	/* 高可用组Id。指定了此参数后，只能通过高可用组关联的实例模板创建虚机，并且实例模板中的参数不可覆盖替换。实例模板以外的参数还可以指定。 (Optional) */
	AgId *string `json:"agId"`

	/* 实例模板id，如果没有使用高可用组，那么对于实例模板中没有的信息，需要使用创建虚机的参数进行补充，或者选择覆盖启动模板中的参数。 (Optional) */
	InstanceTemplateId *string `json:"instanceTemplateId"`

	/* 云主机所属的可用区。 (Optional) */
	Az *string `json:"az"`

	/* 实例规格。可查询<a href="http://docs.jdcloud.com/virtual-machines/api/describeinstancetypes">DescribeInstanceTypes</a>接口获得指定地域或可用区的规格信息。 (Optional) */
	InstanceType *string `json:"instanceType"`

	/* 镜像ID。可查询<a href="http://docs.jdcloud.com/virtual-machines/api/describeimages">DescribeImages</a>接口获得指定地域的镜像信息。 (Optional) */
	ImageId *string `json:"imageId"`

	/* 云主机名称，不为空且只允许中文、数字、大小写字母、英文下划线（_）、连字符（-）及点（.），不能以（.）作为首尾，长度为2~128个字符。
	批量创建多台云主机时，可在name中非首位位置以[start_number]格式来设置有序name。start_number为起始序号，取值范围[0,9999]。例如：name设置为“instance-[000]-ops”，则第一台主机name为“instance-000-ops”，第二台主机name为“instance-001-ops”。再如：name设置为“instance-[0]-ops”，则第一台主机name为“instance-0-ops”，第二台主机name为“instance-1-ops”。
	*/
	Name string `json:"name"`

	/* 云主机hostname，若不指定hostname，则hostname默认使用云主机名称name，但是会以RFC 952和RFC 1123命名规范做一定转义。
	Windows Server系统：长度为2-15个字符，允许大小写字母、数字或连字符（-）。不能以连字符（-）开头或结尾，不能连续使用连字符（-），也不能全部使用数字。不支持点号（.）。
	Linux系统：长度为2-64个字符，允许支持多个点号，点之间为一段，每段允许使用大小写字母、数字或连字符（-），但不能连续使用点号（.）或连字符（-），不能以点号（.）或连字符（-）开头或结尾。
	批量创建多台云主机时，可在hostname中非首位位置以[start_number]格式来设置有序hostname。start_number为起始序号，取值范围[0,9999]。例如：hostname设置为“instance-[000]-ops”，则第一台主机hostname为“instance-000-ops”，第二台主机hostname为“instance-001-ops”。再如：hostname设置为“instance-[0]-ops”，则第一台主机hostname为“instance-0-ops”，第二台主机hostname为“instance-1-ops”。批量创建时若不指定起始序号，则会默认追加从1开始的数字，例如批量创建两台虚拟机，且指定hostname是test，则hostname默认是test1，test2。
	 (Optional) */
	Hostname *string `json:"hostname"`

	/* 密码，<a href="http://docs.jdcloud.com/virtual-machines/api/general_parameters">参考公共参数规范</a>。 (Optional) */
	Password *string `json:"password"`

	/* 密钥对名称，当前只支持传入一个。 (Optional) */
	KeyNames []string `json:"keyNames"`

	/* 主网卡主IP关联的弹性IP规格 (Optional) */
	ElasticIp *vpc.ElasticIpSpec `json:"elasticIp"`

	/* 主网卡配置信息 (Optional) */
	PrimaryNetworkInterface *InstanceNetworkInterfaceAttachmentSpec `json:"primaryNetworkInterface"`

	/* 系统盘配置信息 (Optional) */
	SystemDisk *InstanceDiskAttachmentSpec `json:"systemDisk"`

	/* 数据盘配置信息，本地盘(local类型)做系统盘的云主机可挂载8块数据盘，云硬盘(cloud类型)做系统盘的云主机可挂载7块数据盘。 (Optional) */
	DataDisks []InstanceDiskAttachmentSpec `json:"dataDisks"`

	/* 计费配置
	云主机不支持按用量方式计费，默认为按配置计费。
	打包创建数据盘的情况下，数据盘的计费方式只能与云主机保持一致。
	打包创建弹性公网IP的情况下，若公网IP的计费方式没有指定为按用量计费，那么公网IP计费方式只能与云主机保持一致。
	 (Optional) */
	Charge *charge.ChargeSpec `json:"charge"`

	/* 用户自定义元数据信息，key-value键值对总数量不超过40对，其中有效键值对数量不超过20，无效键值对数量不超过20对。不区分大小写。
	注意：key不要以连字符(-)结尾，否则此key不生效。
	 (Optional) */
	Metadata []Metadata `json:"metadata"`

	/* 元数据信息，目前只支持传入一个key为"launch-script"，表示首次启动脚本。value为base64格式，编码前数据不能大于16KB。
	launch-script：linux系统支持bash和python，编码前须分别以 #!/bin/bash 和 #!/usr/bin/env python 作为内容首行;
	launch-script：windows系统支持bat和powershell，编码前须分别以 <cmd></cmd> 和 <powershell></powershell> 作为内容首、尾行。
	 (Optional) */
	Userdata []Userdata `json:"userdata"`

	/* 主机描述，<a href="http://docs.jdcloud.com/virtual-machines/api/general_parameters">参考公共参数规范</a>。 (Optional) */
	Description *string `json:"description"`

	/* 不使用模板中的密码。
	仅当不使用Ag，并且使用了模板，并且password参数为空时，此参数(值为true)生效。
	若使用模板创建虚机时，又指定了password参数时，此参数无效，以新指定的为准。
	 (Optional) */
	NoPassword *bool `json:"noPassword"`

	/* 不使用模板中的密钥。
	仅当不使用Ag，并且使用了模板，并且keynames参数为空时，此参数(值为true)生效。
	若使用模板创建虚机时，又指定了keynames参数时，此参数无效，以新指定的为准。
	 (Optional) */
	NoKeyNames *bool `json:"noKeyNames"`

	/* 不使用模板中的弹性公网IP。
	仅当不使用Ag，并且使用了模板，并且elasticIp参数为空时，此参数(值为true)生效。
	若使用模板创建虚机时，又指定了elasticIp参数时，此参数无效，以新指定的为准。
	 (Optional) */
	NoElasticIp *bool `json:"noElasticIp"`

	/* 用户普通标签集合 (Optional) */
	UserTags []disk.Tag `json:"userTags"`

	/* 关机模式，只支持云盘做系统盘的按配置计费云主机。keepCharging：关机后继续计费；stopCharging：关机后停止计费。 (Optional) */
	ChargeOnStopped *string `json:"chargeOnStopped"`

	/* 自动镜像策略ID。 (Optional) */
	AutoImagePolicyId *string `json:"autoImagePolicyId"`

	/* 当存在密钥时，是否同时使用密码登录，"yes"为使用，"no"为不使用，""默认为"yes" (Optional) */
	PasswordAuth *string `json:"passwordAuth"`

	/* 继承镜像中的登录验证方式，"yes"为使用，"no"为不使用，""默认为"no" (Optional) */
	ImageInherit *string `json:"imageInherit"`
}

type InstanceStatus added in v1.0.4 

type InstanceStatus struct {

	/* 云主机ID (Optional) */
	InstanceId string `json:"instanceId"`

	/* <a href="http://docs.jdcloud.com/virtual-machines/api/vm_status">参考云主机状态</a> (Optional) */
	Status string `json:"status"`
}

type InstanceTemplate 

type InstanceTemplate struct {

	/* 启动模板ID (Optional) */
	Id string `json:"id"`

	/* 启动模板名称 (Optional) */
	Name string `json:"name"`

	/* 启动模板描述 (Optional) */
	Description string `json:"description"`

	/* 启动模板的数据 (Optional) */
	InstanceTemplateData InstanceTemplateData `json:"instanceTemplateData"`

	/* 关联的高可用组(ag)信息 (Optional) */
	Ags []Ag `json:"ags"`

	/* 创建时间 (Optional) */
	CreatedTime string `json:"createdTime"`
}

type InstanceTemplateCustomData added in v1.51.0 

type InstanceTemplateCustomData struct {

	/* 模板ID (Optional) */
	Id string `json:"id"`

	/* 用户自定义元数据信息 key-value对，key、value不区分大小写 (Optional) */
	Metadata []Metadata `json:"metadata"`

	/* 元数据信息，目前只支持传入一个key为"launch-script"，表示首次启动脚本。value为base64格式 (Optional) */
	Userdata []Userdata `json:"userdata"`
}

type InstanceTemplateData 

type InstanceTemplateData struct {

	/* 实例规格 (Optional) */
	InstanceType string `json:"instanceType"`

	/* 主网卡所属VPC的ID (Optional) */
	VpcId string `json:"vpcId"`

	/* 镜像ID (Optional) */
	ImageId string `json:"imageId"`

	/* 启动模板中是否包含自定义密码，true：包含密码，false：不包含密码 (Optional) */
	IncludePassword bool `json:"includePassword"`

	/* 系统盘信息 (Optional) */
	SystemDisk InstanceTemplateDiskAttachment `json:"systemDisk"`

	/* 数据盘信息，本地盘(local类型)做系统盘的云主机可挂载8块数据盘，云硬盘(cloud类型)做系统盘的云主机可挂载7块数据盘。 (Optional) */
	DataDisks []InstanceTemplateDiskAttachment `json:"dataDisks"`

	/* 主网卡信息 (Optional) */
	PrimaryNetworkInterface InstanceTemplateNetworkInterfaceAttachment `json:"primaryNetworkInterface"`

	/* 主网卡主IP关联的弹性IP规格 (Optional) */
	ElasticIp InstanceTemplateElasticIp `json:"elasticIp"`

	/* 密钥对名称；当前只支持一个 (Optional) */
	KeyNames []string `json:"keyNames"`

	/* 停机不计费的标志， keepCharging(默认)：关机后继续计费；stopCharging：关机后停止计费。 (Optional) */
	ChargeOnStopped string `json:"chargeOnStopped"`

	/* 自动镜像策略ID (Optional) */
	AutoImagePolicyId string `json:"autoImagePolicyId"`

	/* 是否使用密码 (Optional) */
	PasswordAuth string `json:"passwordAuth"`

	/* 是否继承镜像密码密钥 (Optional) */
	ImageInherit string `json:"imageInherit"`
}

type InstanceTemplateDisk 

type InstanceTemplateDisk struct {

	/* 云硬盘类型，取值为 ssd、premium-hdd、hdd.std1、ssd.gp1、ssd.io1 (Optional) */
	DiskType string `json:"diskType"`

	/* 云硬盘大小，单位为 GiB；ssd 类型取值范围[20,1000]GB，步长为10G，premium-hdd 类型取值范围[20,3000]GB，步长为10G，hdd.std1、ssd.gp1、ssd.io1 类型取值范围[20-16000]GB，步长为10GB (Optional) */
	DiskSizeGB int `json:"diskSizeGB"`

	/* 创建云硬盘的快照ID (Optional) */
	SnapshotId string `json:"snapshotId"`

	/* 策略ID (Optional) */
	PolicyId string `json:"policyId"`

	/* 是否加密，false:(默认)不加密；true:加密 (Optional) */
	Encrypt bool `json:"encrypt"`

	/* 云硬盘的iops值 (Optional) */
	Iops int `json:"iops"`
}

type InstanceTemplateDiskAttachment 

type InstanceTemplateDiskAttachment struct {

	/* 磁盘分类，取值为本地盘(local)或者数据盘(cloud)。
	系统盘支持本地盘(local)或者云硬盘(cloud)。系统盘选择local类型，必须使用localDisk类型的镜像；同理系统盘选择cloud类型，必须使用cloudDisk类型的镜像。
	数据盘仅支持云硬盘(cloud)。
	 (Optional) */
	DiskCategory string `json:"diskCategory"`

	/* 随云主机一起删除，删除主机时自动删除此磁盘，默认为true，本地盘(local)不能更改此值。
	如果云主机中的数据盘(cloud)是包年包月计费方式，此参数不生效。
	如果云主机中的数据盘(cloud)是共享型数据盘，此参数不生效。
	 (Optional) */
	AutoDelete bool `json:"autoDelete"`

	/* 数据盘配置 (Optional) */
	InstanceTemplateDisk InstanceTemplateDisk `json:"instanceTemplateDisk"`

	/* 数据盘逻辑挂载点，取值范围：vda,vdb,vdc,vdd,vde,vdf,vdg,vdh,vdi,vmj,vdk,vdl,vdm。系统盘不需要使用，数据盘时才能够使用。 (Optional) */
	DeviceName string `json:"deviceName"`

	/* 排除设备，使用此参数noDevice配合deviceName一起使用。
	创建整机镜像：如deviceName:vdb、noDevice:true，则表示云主机中的数据盘vdb不参与创建镜像。
	创建模板：如deviceName:vdb、noDevice:true，则表示镜像中的数据盘vdb不参与创建主机。
	创建主机：如deviceName:vdb、noDevice:true，则表示镜像中的数据盘vdb，或者模板(使用模板创建主机)中的数据盘vdb不参与创建主机。
	 (Optional) */
	NoDevice bool `json:"noDevice"`
}

type InstanceTemplateDiskAttachmentSpec 

type InstanceTemplateDiskAttachmentSpec struct {

	/* 磁盘分类，取值为本地盘(local)或者数据盘(cloud)。
	系统盘支持本地盘(local)或者云硬盘(cloud)。系统盘选择local类型，必须使用localDisk类型的镜像；同理系统盘选择cloud类型，必须使用cloudDisk类型的镜像。
	数据盘仅支持云硬盘(cloud)。
	 (Optional) */
	DiskCategory *string `json:"diskCategory"`

	/* 随云主机一起删除，删除主机时自动删除此磁盘，默认为true，本地盘(local)不能更改此值。
	如果云主机中的数据盘(cloud)是包年包月计费方式，此参数不生效。
	如果云主机中的数据盘(cloud)是共享型数据盘，此参数不生效。
	 (Optional) */
	AutoDelete *bool `json:"autoDelete"`

	/* 数据盘规格 (Optional) */
	CloudDiskSpec *InstanceTemplateDiskSpec `json:"cloudDiskSpec"`

	/* 数据盘逻辑挂载点，取值范围：vda,vdb,vdc,vdd,vde,vdf,vdg,vdh,vdi,vmj,vdk,vdl,vdm (Optional) */
	DeviceName *string `json:"deviceName"`

	/* 排除设备，使用此参数noDevice配合deviceName一起使用。
	创建模板：如deviceName:vdb、noDevice:true，则表示镜像中的数据盘vdb不参与创建主机。
	 (Optional) */
	NoDevice *bool `json:"noDevice"`
}

type InstanceTemplateDiskSpec 

type InstanceTemplateDiskSpec struct {

	/* 云硬盘类型，取值为ssd、premium-hdd、hdd.std1、ssd.gp1、ssd.io1 (Optional) */
	DiskType *string `json:"diskType"`

	/* 云硬盘大小，单位为 GiB；ssd 类型取值范围[20,1000]GB，步长为10G，premium-hdd 类型取值范围[20,3000]GB，步长为10G，hdd.std1、ssd.gp1、ssd.io1 类型取值范围[20-16000]GB，步长为10GB (Optional) */
	DiskSizeGB *int `json:"diskSizeGB"`

	/* 用于创建云硬盘的快照ID (Optional) */
	SnapshotId *string `json:"snapshotId"`

	/* 策略ID (Optional) */
	PolicyId *string `json:"policyId"`

	/* 用于指定是否加密，false:(默认)不加密；true:加密，未指定快照时生效，只有打包创建2代主机的时候才允许创建加密数据盘。 (Optional) */
	Encrypt *bool `json:"encrypt"`

	/* 用于指定云硬盘的iops值，仅支持ssd.io1类型的云盘 (Optional) */
	Iops *int `json:"iops"`
}

type InstanceTemplateElasticIp 

type InstanceTemplateElasticIp struct {

	/* 弹性公网IP的限速（单位：MB）  */
	BandwidthMbps int `json:"bandwidthMbps"`

	/* IP服务商，取值为BGP,nonBGP (Optional) */
	Provider string `json:"provider"`

	/* 计费类型，支持按带宽计费(bandwith)，按流量计费(flow)  */
	ChargeMode string `json:"chargeMode"`
}

type InstanceTemplateElasticIpSpec 

type InstanceTemplateElasticIpSpec struct {

	/* 弹性公网IP的限速（单位：MB）  */
	BandwidthMbps int `json:"bandwidthMbps"`

	/* IP服务商，取值为BGP,nonBGP，不支持边缘可用区 (Optional) */
	Provider *string `json:"provider"`

	/* 计费类型，支持按带宽计费(bandwith)，按流量计费(flow)  */
	ChargeMode string `json:"chargeMode"`
}

type InstanceTemplateNetworkInterface added in v1.10.0 

type InstanceTemplateNetworkInterface struct {

	/* 子网ID  */
	SubnetId string `json:"subnetId"`

	/* 安全组ID列表 (Optional) */
	SecurityGroups []string `json:"securityGroups"`

	/* PortSecurity，取值为0或者1，默认为1 (Optional) */
	SanityCheck int `json:"sanityCheck"`
}

type InstanceTemplateNetworkInterfaceAttachment added in v1.10.0 

type InstanceTemplateNetworkInterfaceAttachment struct {

	/* 设备Index；主网卡的index必须为1；当前仅支持主网卡 (Optional) */
	DeviceIndex int `json:"deviceIndex"`

	/* 指明删除实例时是否删除网卡，默认true；当前只能是true (Optional) */
	AutoDelete bool `json:"autoDelete"`

	/* 网卡接口规范；此字段当前必填  */
	NetworkInterface InstanceTemplateNetworkInterface `json:"networkInterface"`
}

type InstanceTemplateNetworkInterfaceAttachmentSpec 

type InstanceTemplateNetworkInterfaceAttachmentSpec struct {

	/* 设备Index；主网卡的index必须为1；当前仅支持主网卡 (Optional) */
	DeviceIndex *int `json:"deviceIndex"`

	/* 指明删除实例时是否删除网卡，默认true；当前只能是true (Optional) */
	AutoDelete *bool `json:"autoDelete"`

	/* 网卡接口规范；此字段当前必填  */
	NetworkInterface *InstanceTemplateNetworkInterfaceSpec `json:"networkInterface"`
}

type InstanceTemplateNetworkInterfaceSpec 

type InstanceTemplateNetworkInterfaceSpec struct {

	/* 子网ID 仅支持中心可用区的子网  */
	SubnetId string `json:"subnetId"`

	/* 安全组ID列表 (Optional) */
	SecurityGroups []string `json:"securityGroups"`

	/* PortSecurity，取值为0或者1，默认为1 (Optional) */
	SanityCheck *int `json:"sanityCheck"`
}

type InstanceTemplateSpec 

type InstanceTemplateSpec struct {

	/* 实例规格，可查询<a href="http://docs.jdcloud.com/virtual-machines/api/describeinstancetypes">DescribeInstanceTypes</a>接口获得指定地域或可用区的规格信息。  */
	InstanceType string `json:"instanceType"`

	/* 镜像ID，可查询<a href="http://docs.jdcloud.com/virtual-machines/api/describeimages">DescribeImages</a>接口获得指定地域的镜像信息。  */
	ImageId string `json:"imageId"`

	/* 密码，<a href="http://docs.jdcloud.com/virtual-machines/api/general_parameters">参考公共参数规范</a>。 (Optional) */
	Password *string `json:"password"`

	/* 密钥对名称；当前只支持一个 (Optional) */
	KeyNames []string `json:"keyNames"`

	/* 用户自定义元数据信息，key-value 键值对数量不超过20。key、value不区分大小写。
	注意：key不要以连字符(-)结尾，否则此key不生效。
	 (Optional) */
	Metadata []Metadata `json:"metadata"`

	/* 元数据信息，目前只支持传入一个key为"launch-script"，表示首次启动脚本。value为base64格式。
	launch-script：linux系统支持bash和python，编码前须分别以 #!/bin/bash 和 #!/usr/bin/env python 作为内容首行;
	launch-script：windows系统支持bat和powershell，编码前须分别以 <cmd></cmd> 和 <powershell></powershell> 作为内容首、尾行。
	 (Optional) */
	Userdata []Userdata `json:"userdata"`

	/* 主网卡主IP关联的弹性IP规格 (Optional) */
	ElasticIp *InstanceTemplateElasticIpSpec `json:"elasticIp"`

	/* 主网卡配置信息  */
	PrimaryNetworkInterface *InstanceTemplateNetworkInterfaceAttachmentSpec `json:"primaryNetworkInterface"`

	/* 系统盘配置信息 (Optional) */
	SystemDisk *InstanceTemplateDiskAttachmentSpec `json:"systemDisk"`

	/* 数据盘配置信息 (Optional) */
	DataDisks []InstanceTemplateDiskAttachmentSpec `json:"dataDisks"`

	/* 停机不计费的标志， keepCharging(默认)：关机后继续计费；stopCharging：关机后停止计费。 (Optional) */
	ChargeOnStopped *string `json:"chargeOnStopped"`

	/* 自动镜像策略ID。 (Optional) */
	AutoImagePolicyId *string `json:"autoImagePolicyId"`

	/* 当存在密钥时，是否同时使用密码登录，"yes"为使用，"no"为不使用，""默认为"yes" (Optional) */
	PassWordAuth *string `json:"passWordAuth"`

	/* 继承镜像中的登录验证方式，"yes"为使用，"no"为不使用，""默认为"no" (Optional) */
	ImageInherit *string `json:"imageInherit"`
}

type InstanceType 

type InstanceType struct {

	/* 实例规格类型 (Optional) */
	Family string `json:"family"`

	/* 实例规格，比如g.b1.2xlarge (Optional) */
	InstanceType string `json:"instanceType"`

	/* cpu个数 (Optional) */
	Cpu int `json:"cpu"`

	/* 内存大小 (Optional) */
	MemoryMB int `json:"memoryMB"`

	/* 支持弹性网卡的数量 (Optional) */
	NicLimit int `json:"nicLimit"`

	/* 描述 (Optional) */
	Desc string `json:"desc"`

	/* 规格状态 (Optional) */
	State []InstanceTypeState `json:"state"`

	/* Gpu配置 (Optional) */
	Gpu Gpu `json:"gpu"`

	/* 本地缓存盘配置，目前只有Gpu规格上才有 (Optional) */
	LocalDisks []LocalDisk `json:"localDisks"`

	/* 实例规格代数 (Optional) */
	Generation int `json:"generation"`
}

type InstanceTypeState added in v1.0.2 

type InstanceTypeState struct {

	/* 可用区 (Optional) */
	Az string `json:"az"`

	/* 可售卖情况，true:可售卖、false:已售罄不可用 (Optional) */
	InStock bool `json:"inStock"`

	/* 可用库存数量，预留字段，敬请期待。 (Optional) */
	AvailableCount int `json:"availableCount"`
}

type InternalInstance added in v1.25.0 

type InternalInstance struct {

	/* 云主机ID (Optional) */
	InstanceId string `json:"instanceId"`

	/* 云主机名称 (Optional) */
	InstanceName string `json:"instanceName"`

	/* 实例规格 (Optional) */
	InstanceType string `json:"instanceType"`

	/* 主网卡所属VPC的ID (Optional) */
	VpcId string `json:"vpcId"`

	/* 主网卡所属子网的ID (Optional) */
	SubnetId string `json:"subnetId"`

	/* 主网卡主IP地址 (Optional) */
	PrivateIpAddress string `json:"privateIpAddress"`

	/* 云主机状态，<a href="http://docs.jdcloud.com/virtual-machines/api/vm_status">参考云主机状态</a> (Optional) */
	Status string `json:"status"`

	/* 云主机描述 (Optional) */
	Description string `json:"description"`

	/* 镜像ID (Optional) */
	ImageId string `json:"imageId"`

	/* 系统盘配置 (Optional) */
	SystemDisk BriefInstanceDiskAttachment `json:"systemDisk"`

	/* 数据盘配置 (Optional) */
	DataDisks []BriefInstanceDiskAttachment `json:"dataDisks"`

	/* 主网卡配置 (Optional) */
	PrimaryNetworkInterface BriefInstanceNetworkInterfaceAttachment `json:"primaryNetworkInterface"`

	/* 辅助网卡配置 (Optional) */
	SecondaryNetworkInterfaces []BriefInstanceNetworkInterfaceAttachment `json:"secondaryNetworkInterfaces"`

	/* 创建时间 (Optional) */
	LaunchTime string `json:"launchTime"`

	/* 云主机所在可用区 (Optional) */
	Az string `json:"az"`

	/* 密钥对名称 (Optional) */
	KeyNames []string `json:"keyNames"`

	/* 高可用组中的错误域 (Optional) */
	FaultDomain string `json:"faultDomain"`

	/* 关机模式，只支持云盘做系统盘的按配置计费云主机。KeepCharging：关机后继续计费；StopCharging：关机后停止计费。 (Optional) */
	ChargeOnStopped string `json:"chargeOnStopped"`

	/* 实例所属的专有宿主机池 (Optional) */
	DedicatedPoolId string `json:"dedicatedPoolId"`

	/* 专有宿主机ID (Optional) */
	DedicatedHostId string `json:"dedicatedHostId"`

	/* 实例的物理机 IP (Optional) */
	HostIp string `json:"hostIp"`

	/* 机架信息 (Optional) */
	Rack string `json:"rack"`
}

type Keypair added in v1.0.11 

type Keypair struct {

	/* 密钥对名称 (Optional) */
	KeyName string `json:"keyName"`

	/* 密钥对的指纹，根据 RFC4716 定义的公钥指纹格式，采用 MD5 信息摘要算法。 (Optional) */
	KeyFingerprint string `json:"keyFingerprint"`

	/* 创建时间 (Optional) */
	CreateTime string `json:"createTime"`

	/* 绑定了此密钥的所有虚机id (Optional) */
	InstanceIds []string `json:"instanceIds"`
}

type LightCloudDiskInfo added in v1.51.0 

type LightCloudDiskInfo struct {

	/* 云硬盘ID (Optional) */
	DiskId string `json:"diskId"`

	/* 云硬盘类型，取值为 ssd,premium-hdd,ssd.gp1,ssd.io1,hdd.std1 (Optional) */
	DiskType string `json:"diskType"`

	/* 云硬盘大小，单位为 GiB (Optional) */
	DiskSizeGB int `json:"diskSizeGB"`
}

type LocalDisk 

type LocalDisk struct {

	/* 磁盘类型，取值范围{ssd、premium-hdd、hdd.std1、ssd.gp1、ssd.io1} (Optional) */
	DiskType string `json:"diskType"`

	/* 磁盘大小 (Optional) */
	DiskSizeGB int `json:"diskSizeGB"`
}

type Metadata added in v1.51.0 

type Metadata struct {

	/* 键，最大长度256，支持全字符 (Optional) */
	Key *string `json:"key"`

	/* 值，最大长度16k，支持全字符 (Optional) */
	Value *string `json:"value"`
}

type Policy added in v1.51.0 

type Policy struct {

	/* 策略ID。 (Optional) */
	PolicyId string `json:"policyId"`

	/* 策略类型。 (Optional) */
	PolicyType string `json:"policyType"`
}

type Quota 

type Quota struct {

	/* 资源类型[instance，keypair，image，instanceTemplate] (Optional) */
	ResourceType string `json:"resourceType"`

	/* 配额上限 (Optional) */
	Limit int `json:"limit"`

	/* 已用配额 (Optional) */
	Used int `json:"used"`
}

type SecurityGroupSimple 

type SecurityGroupSimple struct {

	/* 安全组ID (Optional) */
	GroupId string `json:"groupId"`

	/* 安全组名称 (Optional) */
	GroupName string `json:"groupName"`
}

type TagFilter added in v1.0.2 

type TagFilter struct {

	/* Tag键 (Optional) */
	Key *string `json:"key"`

	/* Tag值 (Optional) */
	Values []string `json:"values"`
}

type TaskInfo added in v1.10.0 

type TaskInfo struct {

	/* 任务id (Optional) */
	TaskId int `json:"taskId"`

	/* 任务操作类型 (Optional) */
	Action string `json:"action"`

	/* 任务状态，pending,running,failed,finished (Optional) */
	TaskStatus string `json:"taskStatus"`

	/* 任务进度，0-100 (Optional) */
	Progress int `json:"progress"`

	/* 额外信息 (Optional) */
	Message string `json:"message"`

	/* 任务创建时间 (Optional) */
	CreatedTime string `json:"createdTime"`

	/* 任务完成时间 (Optional) */
	FinishedTime string `json:"finishedTime"`
}

type UserSysDisk added in v1.10.0 

type UserSysDisk struct {

	/* 用户pin (Optional) */
	Pin string `json:"pin"`

	/* 地域 (Optional) */
	Region string `json:"region"`

	/* 系统类型 (Optional) */
	SystemType string `json:"systemType"`

	/* 默认本地盘系统盘大小 (Optional) */
	SystemDiskSize int `json:"systemDiskSize"`

	/* 逗号分隔的规格列表，*代表所有。 (Optional) */
	Flavors string `json:"flavors"`
}

type Userdata added in v1.10.0 

type Userdata struct {

	/* 键，最大长度48字符 (Optional) */
	Key *string `json:"key"`

	/* 值，最大长度21848字符 (Optional) */
	Value *string `json:"value"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.