Documentation
¶
Index ¶
- type AvailablityGroup
- type BindInfo
- type Container
- type ContainerNetworkInterfaceAttachmentSpec
- type ContainerSpec
- type DockerRegistryData
- type ElasticIpSpec
- type EnvVar
- type HostAlias
- type HostAliasSpec
- type InstanceCloudDisk
- type InstanceInfo
- type InstanceLocalDisk
- type InstanceNetworkInterface
- type InstanceNetworkInterfaceAttachment
- type InstanceType
- type InstanceTypeState
- type LocalDiskSpec
- type LogConfiguration
- type LogOption
- type NetworkInterfacePrivateIp
- type NetworkInterfaceSpec
- type Quota
- type Secret
- type SecurityGroupSimple
- type Status
- type Tag
- type TagFilter
- type UserConfigure
- type VolumeMount
- type VolumeMountSpec
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AvailablityGroup ¶ added in v1.60.0
type AvailablityGroup struct {
/* 高可用组ID (Optional) */
Id string `json:"id"`
}
type Container ¶
type Container struct {
/* 容器ID (Optional) */
ContainerId string `json:"containerId"`
/* 容器状态 (Optional) */
Status string `json:"status"`
/* 实例类型 (Optional) */
InstanceType string `json:"instanceType"`
/* 可用区 (Optional) */
Az string `json:"az"`
/* 容器名称 (Optional) */
Name string `json:"name"`
/* 域名和IP映射的信息 (Optional) */
HostAliases []HostAlias `json:"hostAliases"`
/* 主机名 (Optional) */
Hostname string `json:"hostname"`
/* 高可用组 (Optional) */
Ag AvailablityGroup `json:"ag"`
/* 容器执行命令 (Optional) */
Command []string `json:"command"`
/* 容器执行命令的参数 (Optional) */
Args []string `json:"args"`
/* 动态指定的容器执行的环境变量 (Optional) */
Envs []EnvVar `json:"envs"`
/* 镜像名称 (Optional) */
Image string `json:"image"`
/* 镜像仓库认证信息名称 (Optional) */
Secret string `json:"secret"`
/* 容器是否分配tty (Optional) */
Tty bool `json:"tty"`
/* 容器的工作目录 (Optional) */
WorkingDir string `json:"workingDir"`
/* 根Volume信息 (Optional) */
RootVolume VolumeMount `json:"rootVolume"`
/* 挂载的数据Volume信息 (Optional) */
DataVolumes []VolumeMount `json:"dataVolumes"`
/* 主网卡所属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"`
/* 主网卡配置信息 (Optional) */
PrimaryNetworkInterface InstanceNetworkInterfaceAttachment `json:"primaryNetworkInterface"`
/* 辅助网卡配置信息 (Optional) */
SecondaryNetworkInterfaces []InstanceNetworkInterfaceAttachment `json:"secondaryNetworkInterfaces"`
/* 容器日志配置信息 (Optional) */
LogConfiguration LogConfiguration `json:"logConfiguration"`
/* (Optional) */
Tags []Tag `json:"tags"`
/* 计费配置信息 (Optional) */
Charge charge.Charge `json:"charge"`
/* 创建时间 (Optional) */
LaunchTime string `json:"launchTime"`
/* 容器终止原因 (Optional) */
Reason string `json:"reason"`
/* 容器描述 (Optional) */
Description string `json:"description"`
/* 资源组ID (Optional) */
ResourceGroupId string `json:"resourceGroupId"`
}
type ContainerNetworkInterfaceAttachmentSpec ¶
type ContainerNetworkInterfaceAttachmentSpec struct {
/* 指明删除容器时是否删除网卡,默认True;当前只能是True (Optional) */
AutoDelete *bool `json:"autoDelete"`
/* 设备Index,主网卡为1,暂不提供辅助网卡index (Optional) */
DeviceIndex *int `json:"deviceIndex"`
/* 网卡接口规范 */
NetworkInterface *NetworkInterfaceSpec `json:"networkInterface"`
}
type ContainerSpec ¶
type ContainerSpec struct {
/* 实例类型;参考[文档](https://www.jdcloud.com/help/detail/1992/isCatalog/1) */
InstanceType string `json:"instanceType"`
/* 容器所属可用区,指定agId时非必传<br> 容器、已有云盘的az必须相同,且包含在AG中 */
Az string `json:"az"`
/* 容器名称,不可为空,只支持中文、数字、大小写字母、英文下划线“_”及中划线“-”,且不能超过32字符 */
Name string `json:"name"`
/* 域名和IP映射的信息;</br> 最大10个alias (Optional) */
HostAliases []HostAliasSpec `json:"hostAliases"`
/* 主机名,规范请参考说明文档;默认容器ID (Optional) */
Hostname *string `json:"hostname"`
/* 容器执行命令,如果不指定默认是docker镜像的ENTRYPOINT (Optional) */
Command []string `json:"command"`
/* 容器执行命令的参数,如果不指定默认是docker镜像的CMD (Optional) */
Args []string `json:"args"`
/* 容器执行的环境变量;如果和镜像中的环境变量Key相同,会覆盖镜像中的值;</br> 最大100对 (Optional) */
Envs []EnvVar `json:"envs"`
/* 镜像名称 </br> 1. Docker Hub官方镜像通过类似nginx, mysql/mysql-server的名字指定 </br> </br> repository长度最大256个字符,tag最大128个字符,registry最大255个字符 (Optional) */
Image *string `json:"image"`
/* 镜像仓库认证信息;使用Docker Hub和京东云CR的镜像不需要secret (Optional) */
Secret *string `json:"secret"`
/* 容器是否分配tty。默认不分配 (Optional) */
Tty *bool `json:"tty"`
/* 容器的工作目录。如果不指定,默认是根目录(/);必须是绝对路径 (Optional) */
WorkingDir *string `json:"workingDir"`
/* 根Volume信息 */
RootVolume *VolumeMountSpec `json:"rootVolume"`
/* 挂载的数据Volume信息;最多7个 (Optional) */
DataVolumes []VolumeMountSpec `json:"dataVolumes"`
/* 主网卡主IP关联的弹性IP规格 (Optional) */
ElasticIp *ElasticIpSpec `json:"elasticIp"`
/* 主网卡配置信息 */
PrimaryNetworkInterface *ContainerNetworkInterfaceAttachmentSpec `json:"primaryNetworkInterface"`
/* 容器日志配置信息;默认会在本地分配10MB的存储空间 (Optional) */
LogConfiguration *LogConfiguration `json:"logConfiguration"`
/* 容器描述 (Optional) */
Description *string `json:"description"`
/* 计费配置;如不指定,默认计费类型是后付费-按使用时常付费 (Optional) */
Charge *charge.ChargeSpec `json:"charge"`
/* 用户普通标签集合 (Optional) */
UserTags []Tag `json:"userTags"`
/* 资源组ID (Optional) */
ResourceGroupId *string `json:"resourceGroupId"`
/* 镜像缓存ID,与镜像名称至少指定一个 (Optional) */
ImageCacheId *string `json:"imageCacheId"`
/* 是否自动匹配镜像缓存,默认不开启 (Optional) */
AutoMatchImageCache *bool `json:"autoMatchImageCache"`
/* 匹配失败后,是否自动创建镜像缓存,默认不创建 (Optional) */
AutoCreateImageCache *bool `json:"autoCreateImageCache"`
}
type DockerRegistryData ¶
type ElasticIpSpec ¶
type ElasticIpSpec struct {
/* 弹性公网IP的限速 单位:MB */
BandwidthMbps int `json:"bandwidthMbps"`
/* IP服务商,取值为bgp或no_bgp (Optional) */
Provider *string `json:"provider"`
/* 计费配置 (Optional) */
ChargeSpec *charge.ChargeSpec `json:"chargeSpec"`
}
type HostAliasSpec ¶ added in v1.11.0
type InstanceCloudDisk ¶
type InstanceCloudDisk struct {
/* 云硬盘ID (Optional) */
DiskId string `json:"diskId"`
/* 所属AZ (Optional) */
Az string `json:"az"`
/* 硬盘名称 (Optional) */
Name string `json:"name"`
/* 硬盘描述 (Optional) */
Description string `json:"description"`
/* 磁盘类型 (Optional) */
DiskType string `json:"diskType"`
/* 磁盘大小(GiB) (Optional) */
DiskSize int `json:"diskSize"`
/* 用户指定购买的iops值,目前只支持 ssd.io1 类型云盘 (Optional) */
Iops int `json:"iops"`
/* 云硬盘状态,取值为 creating、available、in-use、extending、restoring、deleting、deleted、error_creating、error_deleting、error_restoring、error_extending 之一 (Optional) */
Status string `json:"status"`
/* 创建时间 (Optional) */
CreateTime string `json:"createTime"`
}
type InstanceInfo ¶ added in v1.8.0
type InstanceLocalDisk ¶ added in v1.20.0
type InstanceLocalDisk struct {
/* 本地盘大小(GB) (Optional) */
DiskSize int `json:"diskSize"`
}
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) */
Description string `json:"description"`
/* 安全组列表 (Optional) */
SecurityGroups []SecurityGroupSimple `json:"securityGroups"`
/* 源和目标IP地址校验,取值为0或者1 (Optional) */
SanityCheck bool `json:"sanityCheck"`
/* 网卡主IP (Optional) */
PrimaryIp NetworkInterfacePrivateIp `json:"primaryIp"`
/* null (Optional) */
SecondaryIps []NetworkInterfacePrivateIp `json:"secondaryIps"`
}
type InstanceNetworkInterfaceAttachment ¶
type InstanceNetworkInterfaceAttachment struct {
/* 指明删除实例时是否删除网卡 (Optional) */
AutoDelete bool `json:"autoDelete"`
/* 设备Index,暂不提供辅助网卡index (Optional) */
DeviceIndex int `json:"deviceIndex"`
/* 绑定状态 (Optional) */
AttachStatus string `json:"attachStatus"`
/* 绑定时间 (Optional) */
AttachTime string `json:"attachTime"`
/* 弹性网卡信息 (Optional) */
NetworkInterface InstanceNetworkInterface `json:"networkInterface"`
}
type InstanceType ¶ added in v1.11.0
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"`
/* 支持的云盘类型 (Optional) */
CloudDiskTypes []string `json:"cloudDiskTypes"`
}
type InstanceTypeState ¶ added in v1.11.0
type LocalDiskSpec ¶ added in v1.20.0
type LocalDiskSpec struct {
/* 本地盘大小(GB) (Optional) */
DiskSize int `json:"diskSize"`
}
type LogConfiguration ¶
type LogConfiguration struct {
/* 日志Driver名称 default:默认在本地分配10MB的存储空间,自动rotate (Optional) */
LogDriver *string `json:"logDriver"`
}
type NetworkInterfaceSpec ¶
type NetworkInterfaceSpec struct {
/* 子网ID */
SubnetId string `json:"subnetId"`
/* 可用区,用户的默认可用区,暂不支持 */
Az string `json:"az"`
/* 网卡主IP (Optional) */
PrimaryIpAddress *string `json:"primaryIpAddress"`
/* 网卡辅助IP,暂不支持 (Optional) */
SecondaryIpAddresses []string `json:"secondaryIpAddresses"`
/* 自动分配的辅助Ip数量,暂不支持 (Optional) */
SecondaryIpCount *int `json:"secondaryIpCount"`
/* 要绑定的安全组ID列表,最多指定5个安全组 (Optional) */
SecurityGroups []string `json:"securityGroups"`
/* 源和目标IP地址校验,取值为0或者1,默认为1,暂不支持此功能 (Optional) */
SanityCheck *bool `json:"sanityCheck"`
/* 描述,最大长度256字符 (Optional) */
Description *string `json:"description"`
}
type Secret ¶
type Secret struct {
/* 机密数据名称 (Optional) */
Name string `json:"name"`
/* 私密数据的类型,目前仅支持如下类型:docker-registry:用来和docker registry认证的类型 (Optional) */
SecretType string `json:"secretType"`
/* 创建时间 (Optional) */
CreatedAt string `json:"createdAt"`
/* 机密的数据 (Optional) */
Data DockerRegistryData `json:"data"`
}
type SecurityGroupSimple ¶
type UserConfigure ¶ added in v1.27.0
type UserConfigure struct {
/* 用户 pin (Optional) */
Pin string `json:"pin"`
/* 本地盘容量 (Optional) */
LocalDiskSize int `json:"localDiskSize"`
/* 创建时间 (Optional) */
CreateTime string `json:"createTime"`
/* 更新时间 (Optional) */
UpdateTime string `json:"updateTime"`
/* 配置状态 (Optional) */
Status int `json:"status"`
}
type VolumeMount ¶
type VolumeMount struct {
/* 磁盘分类 (Optional) */
Category string `json:"category"`
/* 自动删除,删除容器时自动删除此volume (Optional) */
AutoDelete bool `json:"autoDelete"`
/* 容器内的挂载目录 (Optional) */
MountPath string `json:"mountPath"`
/* 只读,默认false;只针对data volume有效,root volume为false (Optional) */
ReadOnly bool `json:"readOnly"`
/* 云硬盘规格 (Optional) */
CloudDisk InstanceCloudDisk `json:"cloudDisk"`
/* 云硬盘规格 (Optional) */
LocalDisk InstanceLocalDisk `json:"localDisk"`
/* 指定volume文件系统类型,目前支持[xfs, ext4] (Optional) */
FsType string `json:"fsType"`
}
type VolumeMountSpec ¶
type VolumeMountSpec struct {
/* 磁盘分类 cloud:基于云硬盘的卷 local:本地盘(需工单申请) */
Category string `json:"category"`
/* 自动删除,删除容器时自动删除此volume,默认为True;只支持磁盘是云硬盘的场景 (Optional) */
AutoDelete *bool `json:"autoDelete"`
/* 容器内的挂载目录;root volume不需要指定,挂载目录是(/);data volume必须指定;必须是绝对路径,不能包含(:) (Optional) */
MountPath *string `json:"mountPath"`
/* 只读,默认false;只针对data volume有效;root volume为false,也就是可读可写 (Optional) */
ReadOnly *bool `json:"readOnly"`
/* 云硬盘规格;随容器自动创建的云硬盘,不会对磁盘分区,只会格式化文件系统 <br>注:其中az、chargeSpec、multiAttachable、encrypt字段无效 (Optional) */
CloudDiskSpec *disk.DiskSpec `json:"cloudDiskSpec"`
/* 云硬盘ID,使用已有的云硬盘,必须同时指定fsType (Optional) */
CloudDiskId *string `json:"cloudDiskId"`
/* 指定volume文件系统类型,目前支持[xfs, ext4];如果新创建的盘,不指定文件系统类型默认格式化成xfs (Optional) */
FsType *string `json:"fsType"`
/* 随容器自动创建的新盘,会自动格式化成指定的文件系统类型;挂载已有的盘,默认不会格式化,只会按照指定的fsType去挂载;如果希望格式化,必须设置此字段为true (Optional) */
FormatVolume *bool `json:"formatVolume"`
}
Source Files
¶
- AvailablityGroup.go
- BindInfo.go
- Container.go
- ContainerNetworkInterfaceAttachmentSpec.go
- ContainerSpec.go
- DockerRegistryData.go
- ElasticIpSpec.go
- EnvVar.go
- HostAlias.go
- HostAliasSpec.go
- InstanceCloudDisk.go
- InstanceInfo.go
- InstanceLocalDisk.go
- InstanceNetworkInterface.go
- InstanceNetworkInterfaceAttachment.go
- InstanceType.go
- InstanceTypeState.go
- LocalDiskSpec.go
- LogConfiguration.go
- LogOption.go
- NetworkInterfacePrivateIp.go
- NetworkInterfaceSpec.go
- Quota.go
- Secret.go
- SecurityGroupSimple.go
- Status.go
- Tag.go
- TagFilter.go
- UserConfigure.go
- VolumeMount.go
- VolumeMountSpec.go
Click to show internal directories.
Click to hide internal directories.