apis

package
v1.62.0 Latest Latest
Warning

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

Go to latest
Published: Aug 16, 2023 License: Apache-2.0 Imports: 3 Imported by: 13

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AssociateElasticIpRequest

type AssociateElasticIpRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 弹性公网IP的ID。  */
	ElasticIpId string `json:"elasticIpId"`
}

func NewAssociateElasticIpRequest

func NewAssociateElasticIpRequest(
	regionId string,
	instanceId string,
	elasticIpId string,
) *AssociateElasticIpRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param elasticIpId: 弹性公网IP的ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewAssociateElasticIpRequestWithAllParams added in v1.0.4

func NewAssociateElasticIpRequestWithAllParams(
	regionId string,
	instanceId string,
	elasticIpId string,
) *AssociateElasticIpRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param elasticIpId: 弹性公网IP的ID。 (Required)

func NewAssociateElasticIpRequestWithoutParam added in v1.0.4

func NewAssociateElasticIpRequestWithoutParam() *AssociateElasticIpRequest

This constructor has better compatible ability when API parameters changed

func (AssociateElasticIpRequest) GetRegionId

func (r AssociateElasticIpRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*AssociateElasticIpRequest) SetElasticIpId

func (r *AssociateElasticIpRequest) SetElasticIpId(elasticIpId string)

param elasticIpId: 弹性公网IP的ID。(Required)

func (*AssociateElasticIpRequest) SetInstanceId

func (r *AssociateElasticIpRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*AssociateElasticIpRequest) SetRegionId

func (r *AssociateElasticIpRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type AssociateElasticIpResponse

type AssociateElasticIpResponse struct {
	RequestID string                   `json:"requestId"`
	Error     core.ErrorResponse       `json:"error"`
	Result    AssociateElasticIpResult `json:"result"`
}

type AssociateElasticIpResult

type AssociateElasticIpResult struct {
}

type AttachDiskRequest

type AttachDiskRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 云硬盘ID。  */
	DiskId string `json:"diskId"`

	/* 磁盘逻辑挂载点。
	**系统盘**:必须指定并且只能是vda。
	**数据盘**:取值范围:`[vdb~vdbm]`。
	 (Optional) */
	DeviceName *string `json:"deviceName"`

	/* 是否随实例一起删除,即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。
	可选值:
	`true`:随实例删除。
	`false`(默认值):不随实例删除。
	 (Optional) */
	AutoDelete *bool `json:"autoDelete"`
}

func NewAttachDiskRequest

func NewAttachDiskRequest(
	regionId string,
	instanceId string,
	diskId string,
) *AttachDiskRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param diskId: 云硬盘ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewAttachDiskRequestWithAllParams added in v1.0.4

func NewAttachDiskRequestWithAllParams(
	regionId string,
	instanceId string,
	diskId string,
	deviceName *string,
	autoDelete *bool,
) *AttachDiskRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param diskId: 云硬盘ID。 (Required)
  • param deviceName: 磁盘逻辑挂载点。

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

(Optional)
* param autoDelete: 是否随实例一起删除,即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。

可选值: `true`:随实例删除。 `false`(默认值):不随实例删除。

(Optional)

func NewAttachDiskRequestWithoutParam added in v1.0.4

func NewAttachDiskRequestWithoutParam() *AttachDiskRequest

This constructor has better compatible ability when API parameters changed

func (AttachDiskRequest) GetRegionId

func (r AttachDiskRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*AttachDiskRequest) SetAutoDelete

func (r *AttachDiskRequest) SetAutoDelete(autoDelete bool)
param autoDelete: 是否随实例一起删除,即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。

可选值: `true`:随实例删除。 `false`(默认值):不随实例删除。 (Optional)

func (*AttachDiskRequest) SetDeviceName

func (r *AttachDiskRequest) SetDeviceName(deviceName string)
param deviceName: 磁盘逻辑挂载点。

**系统盘**:必须指定并且只能是vda。 **数据盘**:取值范围:`[vdb~vdbm]`。 (Optional)

func (*AttachDiskRequest) SetDiskId

func (r *AttachDiskRequest) SetDiskId(diskId string)

param diskId: 云硬盘ID。(Required)

func (*AttachDiskRequest) SetInstanceId

func (r *AttachDiskRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*AttachDiskRequest) SetRegionId

func (r *AttachDiskRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type AttachDiskResponse

type AttachDiskResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    AttachDiskResult   `json:"result"`
}

type AttachDiskResult

type AttachDiskResult struct {
}

type AttachKeypairRequest added in v1.51.0

type AttachKeypairRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 密钥名称。  */
	KeyName string `json:"keyName"`

	/* 要绑定的云主机Id列表。  */
	InstanceIds []string `json:"instanceIds"`

	/* 绑定密钥后,根据此参数决定是否允许使用密码登录。可选范围:
	`yes`:允许SSH密码登录。
	`no`:禁止SSH密码登录。
	*/
	PassWordAuth string `json:"passWordAuth"`
}

func NewAttachKeypairRequest added in v1.51.0

func NewAttachKeypairRequest(
	regionId string,
	keyName string,
	instanceIds []string,
	passWordAuth string,
) *AttachKeypairRequest
  • param regionId: 地域ID。 (Required)
  • param keyName: 密钥名称。 (Required)
  • param instanceIds: 要绑定的云主机Id列表。 (Required)
  • param passWordAuth: 绑定密钥后,根据此参数决定是否允许使用密码登录。可选范围:

`yes`:允许SSH密码登录。 `no`:禁止SSH密码登录。

(Required)
*
* @Deprecated, not compatible when mandatory parameters changed

func NewAttachKeypairRequestWithAllParams added in v1.51.0

func NewAttachKeypairRequestWithAllParams(
	regionId string,
	keyName string,
	instanceIds []string,
	passWordAuth string,
) *AttachKeypairRequest
  • param regionId: 地域ID。 (Required)
  • param keyName: 密钥名称。 (Required)
  • param instanceIds: 要绑定的云主机Id列表。 (Required)
  • param passWordAuth: 绑定密钥后,根据此参数决定是否允许使用密码登录。可选范围:

`yes`:允许SSH密码登录。 `no`:禁止SSH密码登录。

(Required)

func NewAttachKeypairRequestWithoutParam added in v1.51.0

func NewAttachKeypairRequestWithoutParam() *AttachKeypairRequest

This constructor has better compatible ability when API parameters changed

func (AttachKeypairRequest) GetRegionId added in v1.51.0

func (r AttachKeypairRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*AttachKeypairRequest) SetInstanceIds added in v1.51.0

func (r *AttachKeypairRequest) SetInstanceIds(instanceIds []string)

param instanceIds: 要绑定的云主机Id列表。(Required)

func (*AttachKeypairRequest) SetKeyName added in v1.51.0

func (r *AttachKeypairRequest) SetKeyName(keyName string)

param keyName: 密钥名称。(Required)

func (*AttachKeypairRequest) SetPassWordAuth added in v1.51.0

func (r *AttachKeypairRequest) SetPassWordAuth(passWordAuth string)
param passWordAuth: 绑定密钥后,根据此参数决定是否允许使用密码登录。可选范围:

`yes`:允许SSH密码登录。 `no`:禁止SSH密码登录。 (Required)

func (*AttachKeypairRequest) SetRegionId added in v1.51.0

func (r *AttachKeypairRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type AttachKeypairResponse added in v1.51.0

type AttachKeypairResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    AttachKeypairResult `json:"result"`
}

type AttachKeypairResult added in v1.51.0

type AttachKeypairResult struct {
	SuccessInstanceId []string `json:"successInstanceId"`
	FailInstanceId    []string `json:"failInstanceId"`
}

type AttachNetworkInterfaceRequest added in v1.0.5

type AttachNetworkInterfaceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 弹性网卡ID。  */
	NetworkInterfaceId string `json:"networkInterfaceId"`

	/* 随云主机实例自动删除,默认为False。
	受管网卡或授信网卡默认为False并且不支持修改。
	 (Optional) */
	AutoDelete *bool `json:"autoDelete"`
}

func NewAttachNetworkInterfaceRequest added in v1.0.5

func NewAttachNetworkInterfaceRequest(
	regionId string,
	instanceId string,
	networkInterfaceId string,
) *AttachNetworkInterfaceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param networkInterfaceId: 弹性网卡ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewAttachNetworkInterfaceRequestWithAllParams added in v1.0.5

func NewAttachNetworkInterfaceRequestWithAllParams(
	regionId string,
	instanceId string,
	networkInterfaceId string,
	autoDelete *bool,
) *AttachNetworkInterfaceRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param networkInterfaceId: 弹性网卡ID。 (Required)
  • param autoDelete: 随云主机实例自动删除,默认为False。

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

(Optional)

func NewAttachNetworkInterfaceRequestWithoutParam added in v1.0.5

func NewAttachNetworkInterfaceRequestWithoutParam() *AttachNetworkInterfaceRequest

This constructor has better compatible ability when API parameters changed

func (AttachNetworkInterfaceRequest) GetRegionId added in v1.0.5

func (r AttachNetworkInterfaceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*AttachNetworkInterfaceRequest) SetAutoDelete added in v1.0.5

func (r *AttachNetworkInterfaceRequest) SetAutoDelete(autoDelete bool)
param autoDelete: 随云主机实例自动删除,默认为False。

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

func (*AttachNetworkInterfaceRequest) SetInstanceId added in v1.0.5

func (r *AttachNetworkInterfaceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*AttachNetworkInterfaceRequest) SetNetworkInterfaceId added in v1.0.5

func (r *AttachNetworkInterfaceRequest) SetNetworkInterfaceId(networkInterfaceId string)

param networkInterfaceId: 弹性网卡ID。(Required)

func (*AttachNetworkInterfaceRequest) SetRegionId added in v1.0.5

func (r *AttachNetworkInterfaceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type AttachNetworkInterfaceResponse added in v1.0.5

type AttachNetworkInterfaceResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    AttachNetworkInterfaceResult `json:"result"`
}

type AttachNetworkInterfaceResult added in v1.0.5

type AttachNetworkInterfaceResult struct {
}

type CopyImagesRequest added in v1.0.5

type CopyImagesRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 要复制的私有镜像ID列表,最多支持10个。  */
	SourceImageIds []string `json:"sourceImageIds"`

	/* 目标地域。  */
	DestinationRegion string `json:"destinationRegion"`
}

func NewCopyImagesRequest added in v1.0.5

func NewCopyImagesRequest(
	regionId string,
	sourceImageIds []string,
	destinationRegion string,
) *CopyImagesRequest

* param regionId: 地域ID。 (Required) * param sourceImageIds: 要复制的私有镜像ID列表,最多支持10个。 (Required) * param destinationRegion: 目标地域。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCopyImagesRequestWithAllParams added in v1.0.5

func NewCopyImagesRequestWithAllParams(
	regionId string,
	sourceImageIds []string,
	destinationRegion string,
) *CopyImagesRequest

* param regionId: 地域ID。 (Required) * param sourceImageIds: 要复制的私有镜像ID列表,最多支持10个。 (Required) * param destinationRegion: 目标地域。 (Required)

func NewCopyImagesRequestWithoutParam added in v1.0.5

func NewCopyImagesRequestWithoutParam() *CopyImagesRequest

This constructor has better compatible ability when API parameters changed

func (CopyImagesRequest) GetRegionId added in v1.0.5

func (r CopyImagesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CopyImagesRequest) SetDestinationRegion added in v1.0.5

func (r *CopyImagesRequest) SetDestinationRegion(destinationRegion string)

param destinationRegion: 目标地域。(Required)

func (*CopyImagesRequest) SetRegionId added in v1.0.5

func (r *CopyImagesRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*CopyImagesRequest) SetSourceImageIds added in v1.0.5

func (r *CopyImagesRequest) SetSourceImageIds(sourceImageIds []string)

param sourceImageIds: 要复制的私有镜像ID列表,最多支持10个。(Required)

type CopyImagesResponse added in v1.0.5

type CopyImagesResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    CopyImagesResult   `json:"result"`
}

type CopyImagesResult added in v1.0.5

type CopyImagesResult struct {
	CopyImages []vm.CopyImage `json:"copyImages"`
}

type CreateImageFromSnapshotsRequest added in v1.60.0

type CreateImageFromSnapshotsRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像名称,长度为2\~32个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.)。
	 */
	Name string `json:"name"`

	/* 镜像描述,256字符以内。
	(Optional) */
	Description *string `json:"description"`

	/* 镜像的操作系统类型, 可选值:CentOS、Ubuntu、Windows Server、OpenEuler、Rocky Linux、Others Linux。
	 */
	Platform string `json:"platform"`

	/* 操作系统版本。如:7.9
	(Optional) */
	OsVersion *string `json:"osVersion"`

	/* 操作系统架构, 可选值:x86_64、arm64。
	 */
	Architecture string `json:"architecture"`

	/* 云盘快照信息。
	(Optional) */
	CloudDisks []vm.CloudDiskSpec `json:"cloudDisks"`

	/* 用于保证请求的幂等性。由客户端生成,并确保不同请求中该参数唯一,长度不能超过64个字符。
	(Optional) */
	ClientToken *string `json:"clientToken"`
}

func NewCreateImageFromSnapshotsRequest added in v1.60.0

func NewCreateImageFromSnapshotsRequest(
	regionId string,
	name string,
	platform string,
	architecture string,
) *CreateImageFromSnapshotsRequest

* param regionId: 地域ID。 (Required) * param name: 镜像名称,长度为2\~32个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.)。 (Required) * param platform: 镜像的操作系统类型, 可选值:CentOS、Ubuntu、Windows Server、OpenEuler、Rocky Linux、Others Linux。 (Required) * param architecture: 操作系统架构, 可选值:x86_64、arm64。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCreateImageFromSnapshotsRequestWithAllParams added in v1.60.0

func NewCreateImageFromSnapshotsRequestWithAllParams(
	regionId string,
	name string,
	description *string,
	platform string,
	osVersion *string,
	architecture string,
	cloudDisks []vm.CloudDiskSpec,
	clientToken *string,
) *CreateImageFromSnapshotsRequest

* param regionId: 地域ID。 (Required) * param name: 镜像名称,长度为2\~32个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.)。 (Required) * param description: 镜像描述,256字符以内。 (Optional) * param platform: 镜像的操作系统类型, 可选值:CentOS、Ubuntu、Windows Server、OpenEuler、Rocky Linux、Others Linux。 (Required) * param osVersion: 操作系统版本。如:7.9 (Optional) * param architecture: 操作系统架构, 可选值:x86_64、arm64。 (Required) * param cloudDisks: 云盘快照信息。 (Optional) * param clientToken: 用于保证请求的幂等性。由客户端生成,并确保不同请求中该参数唯一,长度不能超过64个字符。 (Optional)

func NewCreateImageFromSnapshotsRequestWithoutParam added in v1.60.0

func NewCreateImageFromSnapshotsRequestWithoutParam() *CreateImageFromSnapshotsRequest

This constructor has better compatible ability when API parameters changed

func (CreateImageFromSnapshotsRequest) GetRegionId added in v1.60.0

func (r CreateImageFromSnapshotsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateImageFromSnapshotsRequest) SetArchitecture added in v1.60.0

func (r *CreateImageFromSnapshotsRequest) SetArchitecture(architecture string)
param architecture: 操作系统架构, 可选值:x86_64、arm64。

(Required)

func (*CreateImageFromSnapshotsRequest) SetClientToken added in v1.60.0

func (r *CreateImageFromSnapshotsRequest) SetClientToken(clientToken string)
param clientToken: 用于保证请求的幂等性。由客户端生成,并确保不同请求中该参数唯一,长度不能超过64个字符。

(Optional)

func (*CreateImageFromSnapshotsRequest) SetCloudDisks added in v1.60.0

func (r *CreateImageFromSnapshotsRequest) SetCloudDisks(cloudDisks []vm.CloudDiskSpec)
param cloudDisks: 云盘快照信息。

(Optional)

func (*CreateImageFromSnapshotsRequest) SetDescription added in v1.60.0

func (r *CreateImageFromSnapshotsRequest) SetDescription(description string)
param description: 镜像描述,256字符以内。

(Optional)

func (*CreateImageFromSnapshotsRequest) SetName added in v1.60.0

func (r *CreateImageFromSnapshotsRequest) SetName(name string)
param name: 镜像名称,长度为2\~32个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.)。

(Required)

func (*CreateImageFromSnapshotsRequest) SetOsVersion added in v1.60.0

func (r *CreateImageFromSnapshotsRequest) SetOsVersion(osVersion string)
param osVersion: 操作系统版本。如:7.9

(Optional)

func (*CreateImageFromSnapshotsRequest) SetPlatform added in v1.60.0

func (r *CreateImageFromSnapshotsRequest) SetPlatform(platform string)
param platform: 镜像的操作系统类型, 可选值:CentOS、Ubuntu、Windows Server、OpenEuler、Rocky Linux、Others Linux。

(Required)

func (*CreateImageFromSnapshotsRequest) SetRegionId added in v1.60.0

func (r *CreateImageFromSnapshotsRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type CreateImageFromSnapshotsResponse added in v1.60.0

type CreateImageFromSnapshotsResponse struct {
	RequestID string                         `json:"requestId"`
	Error     core.ErrorResponse             `json:"error"`
	Result    CreateImageFromSnapshotsResult `json:"result"`
}

type CreateImageFromSnapshotsResult added in v1.60.0

type CreateImageFromSnapshotsResult struct {
	ImageId string `json:"imageId"`
}

type CreateImageRequest

type CreateImageRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 镜像名称,长度为2\~32个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.)。
	 */
	Name string `json:"name"`

	/* 镜像描述。256字符以内。
	(Optional) */
	Description *string `json:"description"`

	/* 数据盘列表。
	在不指定该参数的情况下,制作镜像的过程中会将该实例中的所有云盘数据盘制作快照,并与系统盘一起,制作成打包镜像。
	如果不希望将实例中的某个云盘数据盘制作快照,可使用 `noDevice` 的方式排除,例如:`deviceName=vdb`、`noDevice=true` 就不会将 `vdb` 制作快照。
	如果希望在打包镜像中插入一块新盘,该盘不在实例中,可通过指定新的 `deviceName` 的方式实现,例如:`deviceName=vdx` 将会在打包镜像中插入一块盘符为 `vdx` 的新盘,支持新盘使用或不使用快照都可以。
	如果使用 `deviceName` 指定了与实例中相同的盘符,那么实例中对应的云盘数据盘也不会制作快照,并使用新指定的参数进行替换。
	 (Optional) */
	DataDisks []vm.InstanceDiskAttachmentSpec `json:"dataDisks"`
}

func NewCreateImageRequest

func NewCreateImageRequest(
	regionId string,
	instanceId string,
	name string,
) *CreateImageRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param name: 镜像名称,长度为2\~32个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.)。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCreateImageRequestWithAllParams added in v1.0.4

func NewCreateImageRequestWithAllParams(
	regionId string,
	instanceId string,
	name string,
	description *string,
	dataDisks []vm.InstanceDiskAttachmentSpec,
) *CreateImageRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param name: 镜像名称,长度为2\~32个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.)。 (Required)
  • param description: 镜像描述。256字符以内。 (Optional)
  • param dataDisks: 数据盘列表。

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

(Optional)

func NewCreateImageRequestWithoutParam added in v1.0.4

func NewCreateImageRequestWithoutParam() *CreateImageRequest

This constructor has better compatible ability when API parameters changed

func (CreateImageRequest) GetRegionId

func (r CreateImageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateImageRequest) SetDataDisks

func (r *CreateImageRequest) SetDataDisks(dataDisks []vm.InstanceDiskAttachmentSpec)
param dataDisks: 数据盘列表。

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

func (*CreateImageRequest) SetDescription

func (r *CreateImageRequest) SetDescription(description string)
param description: 镜像描述。256字符以内。

(Optional)

func (*CreateImageRequest) SetInstanceId

func (r *CreateImageRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*CreateImageRequest) SetName

func (r *CreateImageRequest) SetName(name string)
param name: 镜像名称,长度为2\~32个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.)。

(Required)

func (*CreateImageRequest) SetRegionId

func (r *CreateImageRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type CreateImageResponse

type CreateImageResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    CreateImageResult  `json:"result"`
}

type CreateImageResult

type CreateImageResult struct {
	ImageId string `json:"imageId"`
}

type CreateInstanceTemplateRequest added in v1.10.0

type CreateInstanceTemplateRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 实例模板配置信息。  */
	InstanceTemplateData *vm.InstanceTemplateSpec `json:"instanceTemplateData"`

	/* 实例模板的名称,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。  */
	Name string `json:"name"`

	/* 实例模板的描述,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional) */
	Description *string `json:"description"`
}

func NewCreateInstanceTemplateRequest added in v1.10.0

func NewCreateInstanceTemplateRequest(
	regionId string,
	instanceTemplateData *vm.InstanceTemplateSpec,
	name string,
) *CreateInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateData: 实例模板配置信息。 (Required) * param name: 实例模板的名称,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCreateInstanceTemplateRequestWithAllParams added in v1.10.0

func NewCreateInstanceTemplateRequestWithAllParams(
	regionId string,
	instanceTemplateData *vm.InstanceTemplateSpec,
	name string,
	description *string,
) *CreateInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateData: 实例模板配置信息。 (Required) * param name: 实例模板的名称,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Required) * param description: 实例模板的描述,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional)

func NewCreateInstanceTemplateRequestWithoutParam added in v1.10.0

func NewCreateInstanceTemplateRequestWithoutParam() *CreateInstanceTemplateRequest

This constructor has better compatible ability when API parameters changed

func (CreateInstanceTemplateRequest) GetRegionId added in v1.10.0

func (r CreateInstanceTemplateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateInstanceTemplateRequest) SetDescription added in v1.10.0

func (r *CreateInstanceTemplateRequest) SetDescription(description string)

param description: 实例模板的描述,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。(Optional)

func (*CreateInstanceTemplateRequest) SetInstanceTemplateData added in v1.10.0

func (r *CreateInstanceTemplateRequest) SetInstanceTemplateData(instanceTemplateData *vm.InstanceTemplateSpec)

param instanceTemplateData: 实例模板配置信息。(Required)

func (*CreateInstanceTemplateRequest) SetName added in v1.10.0

func (r *CreateInstanceTemplateRequest) SetName(name string)

param name: 实例模板的名称,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。(Required)

func (*CreateInstanceTemplateRequest) SetRegionId added in v1.10.0

func (r *CreateInstanceTemplateRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type CreateInstanceTemplateResponse added in v1.10.0

type CreateInstanceTemplateResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    CreateInstanceTemplateResult `json:"result"`
}

type CreateInstanceTemplateResult added in v1.10.0

type CreateInstanceTemplateResult struct {
	InstanceTemplateId string `json:"instanceTemplateId"`
}

type CreateInstancesRequest

type CreateInstancesRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 实例配置。
	 */
	InstanceSpec *vm.InstanceSpec `json:"instanceSpec"`

	/* 创建实例的数量,不能超过用户配额。
	取值范围:[1,100];默认值:1。
	如果在弹性网卡中指定了内网IP地址,那么单次创建 `maxCount` 只能是 1。
	 (Optional) */
	MaxCount *int `json:"maxCount"`

	/* 用于保证请求的幂等性。由客户端生成,并确保不同请求中该参数唯一,长度不能超过64个字符。
	(Optional) */
	ClientToken *string `json:"clientToken"`

	/* 是否托管实例的生命周期,默认为false;若为包年包月实例,可加入但不支持托管;该字段仅AG开启AS时生效。托管实例将在缩容或健康检查失败时被删除,非托管实例仅移出伸缩组
	(Optional) */
	IsManaged *bool `json:"isManaged"`
}

func NewCreateInstancesRequest

func NewCreateInstancesRequest(
	regionId string,
	instanceSpec *vm.InstanceSpec,
) *CreateInstancesRequest

* param regionId: 地域ID。 (Required) * param instanceSpec: 实例配置。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCreateInstancesRequestWithAllParams added in v1.0.4

func NewCreateInstancesRequestWithAllParams(
	regionId string,
	instanceSpec *vm.InstanceSpec,
	maxCount *int,
	clientToken *string,
	isManaged *bool,
) *CreateInstancesRequest
  • param regionId: 地域ID。 (Required)
  • param instanceSpec: 实例配置。 (Required)
  • param maxCount: 创建实例的数量,不能超过用户配额。

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

(Optional)
* param clientToken: 用于保证请求的幂等性。由客户端生成,并确保不同请求中该参数唯一,长度不能超过64个字符。
(Optional)
* param isManaged: 是否托管实例的生命周期,默认为false;若为包年包月实例,可加入但不支持托管;该字段仅AG开启AS时生效。托管实例将在缩容或健康检查失败时被删除,非托管实例仅移出伸缩组
(Optional)

func NewCreateInstancesRequestWithoutParam added in v1.0.4

func NewCreateInstancesRequestWithoutParam() *CreateInstancesRequest

This constructor has better compatible ability when API parameters changed

func (CreateInstancesRequest) GetRegionId

func (r CreateInstancesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateInstancesRequest) SetClientToken added in v1.0.5

func (r *CreateInstancesRequest) SetClientToken(clientToken string)
param clientToken: 用于保证请求的幂等性。由客户端生成,并确保不同请求中该参数唯一,长度不能超过64个字符。

(Optional)

func (*CreateInstancesRequest) SetInstanceSpec

func (r *CreateInstancesRequest) SetInstanceSpec(instanceSpec *vm.InstanceSpec)
param instanceSpec: 实例配置。

(Required)

func (*CreateInstancesRequest) SetIsManaged added in v1.62.0

func (r *CreateInstancesRequest) SetIsManaged(isManaged bool)
param isManaged: 是否托管实例的生命周期,默认为false;若为包年包月实例,可加入但不支持托管;该字段仅AG开启AS时生效。托管实例将在缩容或健康检查失败时被删除,非托管实例仅移出伸缩组

(Optional)

func (*CreateInstancesRequest) SetMaxCount

func (r *CreateInstancesRequest) SetMaxCount(maxCount int)
param maxCount: 创建实例的数量,不能超过用户配额。

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

func (*CreateInstancesRequest) SetRegionId

func (r *CreateInstancesRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type CreateInstancesResponse

type CreateInstancesResponse struct {
	RequestID string                `json:"requestId"`
	Error     core.ErrorResponse    `json:"error"`
	Result    CreateInstancesResult `json:"result"`
}

type CreateInstancesResult

type CreateInstancesResult struct {
	InstanceIds []string `json:"instanceIds"`
}

type CreateKeypairRequest added in v1.1.0

type CreateKeypairRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 密钥对名称,需要全局唯一。
	只允许数字、大小写字母、下划线“_”及中划线“-”,不超过32个字符。
	*/
	KeyName string `json:"keyName"`
}

func NewCreateKeypairRequest added in v1.1.0

func NewCreateKeypairRequest(
	regionId string,
	keyName string,
) *CreateKeypairRequest
  • param regionId: 地域ID。 (Required)
  • param keyName: 密钥对名称,需要全局唯一。

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

(Required)
*
* @Deprecated, not compatible when mandatory parameters changed

func NewCreateKeypairRequestWithAllParams added in v1.1.0

func NewCreateKeypairRequestWithAllParams(
	regionId string,
	keyName string,
) *CreateKeypairRequest
  • param regionId: 地域ID。 (Required)
  • param keyName: 密钥对名称,需要全局唯一。

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

(Required)

func NewCreateKeypairRequestWithoutParam added in v1.1.0

func NewCreateKeypairRequestWithoutParam() *CreateKeypairRequest

This constructor has better compatible ability when API parameters changed

func (CreateKeypairRequest) GetRegionId added in v1.1.0

func (r CreateKeypairRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateKeypairRequest) SetKeyName added in v1.1.0

func (r *CreateKeypairRequest) SetKeyName(keyName string)
param keyName: 密钥对名称,需要全局唯一。

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

func (*CreateKeypairRequest) SetRegionId added in v1.1.0

func (r *CreateKeypairRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type CreateKeypairResponse added in v1.1.0

type CreateKeypairResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    CreateKeypairResult `json:"result"`
}

type CreateKeypairResult added in v1.1.0

type CreateKeypairResult struct {
	KeyName        string `json:"keyName"`
	PrivateKey     string `json:"privateKey"`
	KeyFingerprint string `json:"keyFingerprint"`
}

type DeleteImageRequest

type DeleteImageRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`

	/* 删除镜像时是否删除关联的快照。默认为 `false`;如果指定为 `true`, 将会删除镜像关联的快照。
	(Optional) */
	DeleteSnapshot *bool `json:"deleteSnapshot"`
}

func NewDeleteImageRequest

func NewDeleteImageRequest(
	regionId string,
	imageId string,
) *DeleteImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteImageRequestWithAllParams added in v1.0.4

func NewDeleteImageRequestWithAllParams(
	regionId string,
	imageId string,
	deleteSnapshot *bool,
) *DeleteImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * param deleteSnapshot: 删除镜像时是否删除关联的快照。默认为 `false`;如果指定为 `true`, 将会删除镜像关联的快照。 (Optional)

func NewDeleteImageRequestWithoutParam added in v1.0.4

func NewDeleteImageRequestWithoutParam() *DeleteImageRequest

This constructor has better compatible ability when API parameters changed

func (DeleteImageRequest) GetRegionId

func (r DeleteImageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteImageRequest) SetDeleteSnapshot added in v1.51.0

func (r *DeleteImageRequest) SetDeleteSnapshot(deleteSnapshot bool)
param deleteSnapshot: 删除镜像时是否删除关联的快照。默认为 `false`;如果指定为 `true`, 将会删除镜像关联的快照。

(Optional)

func (*DeleteImageRequest) SetImageId

func (r *DeleteImageRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*DeleteImageRequest) SetRegionId

func (r *DeleteImageRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DeleteImageResponse

type DeleteImageResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DeleteImageResult  `json:"result"`
}

type DeleteImageResult

type DeleteImageResult struct {
}

type DeleteInstanceRequest

type DeleteInstanceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 是否删除主机的主网卡绑定的所有弹性公网IP,默认为否。可选值:`true`,`false`。
	当回收站功能关闭的时候,此参数生效。
	当回收站功能开启的时候,且参数 `destroy` 为 `true` 的时候,此参数生效。
	当回收站功能开启的时候,且参数 `destroy` 为 `false` 的时候,此参数不生效。
	 (Optional) */
	DeletePrimaryNetworkInterfaceAllElasticIp *bool `json:"deletePrimaryNetworkInterfaceAllElasticIp"`
}

func NewDeleteInstanceRequest

func NewDeleteInstanceRequest(
	regionId string,
	instanceId string,
) *DeleteInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteInstanceRequestWithAllParams added in v1.0.4

func NewDeleteInstanceRequestWithAllParams(
	regionId string,
	instanceId string,
	deletePrimaryNetworkInterfaceAllElasticIp *bool,
) *DeleteInstanceRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param deletePrimaryNetworkInterfaceAllElasticIp: 是否删除主机的主网卡绑定的所有弹性公网IP,默认为否。可选值:`true`,`false`。

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

(Optional)

func NewDeleteInstanceRequestWithoutParam added in v1.0.4

func NewDeleteInstanceRequestWithoutParam() *DeleteInstanceRequest

This constructor has better compatible ability when API parameters changed

func (DeleteInstanceRequest) GetRegionId

func (r DeleteInstanceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteInstanceRequest) SetDeletePrimaryNetworkInterfaceAllElasticIp added in v1.60.0

func (r *DeleteInstanceRequest) SetDeletePrimaryNetworkInterfaceAllElasticIp(deletePrimaryNetworkInterfaceAllElasticIp bool)
param deletePrimaryNetworkInterfaceAllElasticIp: 是否删除主机的主网卡绑定的所有弹性公网IP,默认为否。可选值:`true`,`false`。

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

func (*DeleteInstanceRequest) SetInstanceId

func (r *DeleteInstanceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*DeleteInstanceRequest) SetRegionId

func (r *DeleteInstanceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DeleteInstanceResponse

type DeleteInstanceResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    DeleteInstanceResult `json:"result"`
}

type DeleteInstanceResult

type DeleteInstanceResult struct {
}

type DeleteInstanceTemplateRequest added in v1.10.0

type DeleteInstanceTemplateRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 实例模板ID。  */
	InstanceTemplateId string `json:"instanceTemplateId"`
}

func NewDeleteInstanceTemplateRequest added in v1.10.0

func NewDeleteInstanceTemplateRequest(
	regionId string,
	instanceTemplateId string,
) *DeleteInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateId: 实例模板ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteInstanceTemplateRequestWithAllParams added in v1.10.0

func NewDeleteInstanceTemplateRequestWithAllParams(
	regionId string,
	instanceTemplateId string,
) *DeleteInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateId: 实例模板ID。 (Required)

func NewDeleteInstanceTemplateRequestWithoutParam added in v1.10.0

func NewDeleteInstanceTemplateRequestWithoutParam() *DeleteInstanceTemplateRequest

This constructor has better compatible ability when API parameters changed

func (DeleteInstanceTemplateRequest) GetRegionId added in v1.10.0

func (r DeleteInstanceTemplateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteInstanceTemplateRequest) SetInstanceTemplateId added in v1.10.0

func (r *DeleteInstanceTemplateRequest) SetInstanceTemplateId(instanceTemplateId string)

param instanceTemplateId: 实例模板ID。(Required)

func (*DeleteInstanceTemplateRequest) SetRegionId added in v1.10.0

func (r *DeleteInstanceTemplateRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DeleteInstanceTemplateResponse added in v1.10.0

type DeleteInstanceTemplateResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    DeleteInstanceTemplateResult `json:"result"`
}

type DeleteInstanceTemplateResult added in v1.10.0

type DeleteInstanceTemplateResult struct {
}

type DeleteKeypairRequest added in v1.1.0

type DeleteKeypairRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 密钥名称。  */
	KeyName string `json:"keyName"`
}

func NewDeleteKeypairRequest added in v1.1.0

func NewDeleteKeypairRequest(
	regionId string,
	keyName string,
) *DeleteKeypairRequest

* param regionId: 地域ID。 (Required) * param keyName: 密钥名称。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteKeypairRequestWithAllParams added in v1.1.0

func NewDeleteKeypairRequestWithAllParams(
	regionId string,
	keyName string,
) *DeleteKeypairRequest

* param regionId: 地域ID。 (Required) * param keyName: 密钥名称。 (Required)

func NewDeleteKeypairRequestWithoutParam added in v1.1.0

func NewDeleteKeypairRequestWithoutParam() *DeleteKeypairRequest

This constructor has better compatible ability when API parameters changed

func (DeleteKeypairRequest) GetRegionId added in v1.1.0

func (r DeleteKeypairRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteKeypairRequest) SetKeyName added in v1.1.0

func (r *DeleteKeypairRequest) SetKeyName(keyName string)

param keyName: 密钥名称。(Required)

func (*DeleteKeypairRequest) SetRegionId added in v1.1.0

func (r *DeleteKeypairRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DeleteKeypairResponse added in v1.1.0

type DeleteKeypairResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    DeleteKeypairResult `json:"result"`
}

type DeleteKeypairResult added in v1.1.0

type DeleteKeypairResult struct {
}

type DescribeBriefInstancesRequest added in v1.25.0

type DescribeBriefInstancesRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 页码;默认为1。 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional) */
	PageSize *int `json:"pageSize"`

	/* Tag筛选条件 (Optional) */
	Tags []vm.TagFilter `json:"tags"`

	/* <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` 为或者的关系。
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeBriefInstancesRequest added in v1.25.0

func NewDescribeBriefInstancesRequest(
	regionId string,
) *DescribeBriefInstancesRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeBriefInstancesRequestWithAllParams added in v1.25.0

func NewDescribeBriefInstancesRequestWithAllParams(
	regionId string,
	pageNumber *int,
	pageSize *int,
	tags []vm.TagFilter,
	filters []common.Filter,
) *DescribeBriefInstancesRequest
  • param regionId: 地域ID。 (Required)
  • param pageNumber: 页码;默认为1。 (Optional)
  • param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional)
  • param tags: Tag筛选条件 (Optional)
  • param filters: <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` 为或者的关系。

(Optional)

func NewDescribeBriefInstancesRequestWithoutParam added in v1.25.0

func NewDescribeBriefInstancesRequestWithoutParam() *DescribeBriefInstancesRequest

This constructor has better compatible ability when API parameters changed

func (DescribeBriefInstancesRequest) GetRegionId added in v1.25.0

func (r DescribeBriefInstancesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeBriefInstancesRequest) SetFilters added in v1.25.0

func (r *DescribeBriefInstancesRequest) SetFilters(filters []common.Filter)
param filters: <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` 为或者的关系。 (Optional)

func (*DescribeBriefInstancesRequest) SetPageNumber added in v1.25.0

func (r *DescribeBriefInstancesRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码;默认为1。(Optional)

func (*DescribeBriefInstancesRequest) SetPageSize added in v1.25.0

func (r *DescribeBriefInstancesRequest) SetPageSize(pageSize int)

param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。(Optional)

func (*DescribeBriefInstancesRequest) SetRegionId added in v1.25.0

func (r *DescribeBriefInstancesRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*DescribeBriefInstancesRequest) SetTags added in v1.25.0

func (r *DescribeBriefInstancesRequest) SetTags(tags []vm.TagFilter)

param tags: Tag筛选条件(Optional)

type DescribeBriefInstancesResponse added in v1.25.0

type DescribeBriefInstancesResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    DescribeBriefInstancesResult `json:"result"`
}

type DescribeBriefInstancesResult added in v1.25.0

type DescribeBriefInstancesResult struct {
	Instances  []vm.BriefInstance `json:"instances"`
	TotalCount int                `json:"totalCount"`
}

type DescribeImageConstraintsBatchRequest added in v1.0.4

type DescribeImageConstraintsBatchRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 要查询的镜像ID列表,只支持官方镜像和第三方镜像。 (Optional) */
	Ids []string `json:"ids"`
}

func NewDescribeImageConstraintsBatchRequest added in v1.0.4

func NewDescribeImageConstraintsBatchRequest(
	regionId string,
) *DescribeImageConstraintsBatchRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeImageConstraintsBatchRequestWithAllParams added in v1.0.4

func NewDescribeImageConstraintsBatchRequestWithAllParams(
	regionId string,
	ids []string,
) *DescribeImageConstraintsBatchRequest

* param regionId: 地域ID。 (Required) * param ids: 要查询的镜像ID列表,只支持官方镜像和第三方镜像。 (Optional)

func NewDescribeImageConstraintsBatchRequestWithoutParam added in v1.0.4

func NewDescribeImageConstraintsBatchRequestWithoutParam() *DescribeImageConstraintsBatchRequest

This constructor has better compatible ability when API parameters changed

func (DescribeImageConstraintsBatchRequest) GetRegionId added in v1.0.4

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeImageConstraintsBatchRequest) SetIds added in v1.0.4

param ids: 要查询的镜像ID列表,只支持官方镜像和第三方镜像。(Optional)

func (*DescribeImageConstraintsBatchRequest) SetRegionId added in v1.0.4

func (r *DescribeImageConstraintsBatchRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeImageConstraintsBatchResponse added in v1.0.4

type DescribeImageConstraintsBatchResponse struct {
	RequestID string                              `json:"requestId"`
	Error     core.ErrorResponse                  `json:"error"`
	Result    DescribeImageConstraintsBatchResult `json:"result"`
}

type DescribeImageConstraintsBatchResult added in v1.0.4

type DescribeImageConstraintsBatchResult struct {
	ImageConstraints []vm.ImageConstraint `json:"imageConstraints"`
}

type DescribeImageConstraintsRequest

type DescribeImageConstraintsRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`
}

func NewDescribeImageConstraintsRequest

func NewDescribeImageConstraintsRequest(
	regionId string,
	imageId string,
) *DescribeImageConstraintsRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeImageConstraintsRequestWithAllParams added in v1.0.4

func NewDescribeImageConstraintsRequestWithAllParams(
	regionId string,
	imageId string,
) *DescribeImageConstraintsRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required)

func NewDescribeImageConstraintsRequestWithoutParam added in v1.0.4

func NewDescribeImageConstraintsRequestWithoutParam() *DescribeImageConstraintsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeImageConstraintsRequest) GetRegionId

func (r DescribeImageConstraintsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeImageConstraintsRequest) SetImageId

func (r *DescribeImageConstraintsRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*DescribeImageConstraintsRequest) SetRegionId

func (r *DescribeImageConstraintsRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeImageConstraintsResponse

type DescribeImageConstraintsResponse struct {
	RequestID string                         `json:"requestId"`
	Error     core.ErrorResponse             `json:"error"`
	Result    DescribeImageConstraintsResult `json:"result"`
}

type DescribeImageConstraintsResult

type DescribeImageConstraintsResult struct {
	ImageConstraints vm.ImageConstraint `json:"imageConstraints"`
}

type DescribeImageMembersRequest

type DescribeImageMembersRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`
}

func NewDescribeImageMembersRequest

func NewDescribeImageMembersRequest(
	regionId string,
	imageId string,
) *DescribeImageMembersRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeImageMembersRequestWithAllParams added in v1.0.4

func NewDescribeImageMembersRequestWithAllParams(
	regionId string,
	imageId string,
) *DescribeImageMembersRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required)

func NewDescribeImageMembersRequestWithoutParam added in v1.0.4

func NewDescribeImageMembersRequestWithoutParam() *DescribeImageMembersRequest

This constructor has better compatible ability when API parameters changed

func (DescribeImageMembersRequest) GetRegionId

func (r DescribeImageMembersRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeImageMembersRequest) SetImageId

func (r *DescribeImageMembersRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*DescribeImageMembersRequest) SetRegionId

func (r *DescribeImageMembersRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeImageMembersResponse

type DescribeImageMembersResponse struct {
	RequestID string                     `json:"requestId"`
	Error     core.ErrorResponse         `json:"error"`
	Result    DescribeImageMembersResult `json:"result"`
}

type DescribeImageMembersResult

type DescribeImageMembersResult struct {
	Pins []string `json:"pins"`
}

type DescribeImageRequest

type DescribeImageRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`
}

func NewDescribeImageRequest

func NewDescribeImageRequest(
	regionId string,
	imageId string,
) *DescribeImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeImageRequestWithAllParams added in v1.0.4

func NewDescribeImageRequestWithAllParams(
	regionId string,
	imageId string,
) *DescribeImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required)

func NewDescribeImageRequestWithoutParam added in v1.0.4

func NewDescribeImageRequestWithoutParam() *DescribeImageRequest

This constructor has better compatible ability when API parameters changed

func (DescribeImageRequest) GetRegionId

func (r DescribeImageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeImageRequest) SetImageId

func (r *DescribeImageRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*DescribeImageRequest) SetRegionId

func (r *DescribeImageRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeImageResponse

type DescribeImageResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    DescribeImageResult `json:"result"`
}

type DescribeImageResult

type DescribeImageResult struct {
	Image vm.Image `json:"image"`
}

type DescribeImagesRequest

type DescribeImagesRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像来源,如果没有指定 `ids` 参数,此参数必传。取值范围:
	`public`:官方镜像。
	`thirdparty`:镜像市场镜像。
	`private`:用户自己的私有镜像。
	`shared`:其他用户分享的镜像。
	`community`:社区镜像。
	 (Optional) */
	ImageSource *string `json:"imageSource"`

	/* 查询已经下线的镜像时使用。
	只有查询 `官方镜像` 或者 `镜像市场镜像` 时,此参数才有意义,其它情况下此参数无效。
	指定 `ids` 查询时,此参数无效。
	 (Optional) */
	Offline *bool `json:"offline"`

	/* 根据镜像的操作系统发行版查询。
	取值范围:`Ubuntu、CentOS、Windows Server`。
	 (Optional) */
	Platform *string `json:"platform"`

	/* 指定镜像ID查询,如果指定了此参数,其它参数可以不传。
	(Optional) */
	Ids []string `json:"ids"`

	/* 根据镜像名称模糊查询。 (Optional) */
	ImageName *string `json:"imageName"`

	/* 根据镜像支持的系统盘类型查询。支持范围:`localDisk` 本地系统盘镜像;`cloudDisk` 云盘系统盘镜像。 (Optional) */
	RootDeviceType *string `json:"rootDeviceType"`

	/* 根据镜像的使用权限查询,可选参数,仅当 `imageSource` 为 `private` 时有效。取值范围:
	`all`:没有限制,所有人均可以使用。
	`specifiedUsers`:只有共享用户可以使用。
	`ownerOnly`:镜像拥有者自己可以使用。
	 (Optional) */
	LaunchPermission *string `json:"launchPermission"`

	/* 根据镜像状态查询。参考 [镜像状态](https://docs.jdcloud.com/virtual-machines/api/image_status) (Optional) */
	Status *string `json:"status"`

	/* 已废弃。 (Optional) */
	ServiceCode *string `json:"serviceCode"`

	/* CPU架构。支持范围:`x86_64`、`arm64`。 (Optional) */
	Architecture *string `json:"architecture"`

	/* 页码;默认为1。 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional) */
	PageSize *int `json:"pageSize"`
}

func NewDescribeImagesRequest

func NewDescribeImagesRequest(
	regionId string,
) *DescribeImagesRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeImagesRequestWithAllParams added in v1.0.4

func NewDescribeImagesRequestWithAllParams(
	regionId string,
	imageSource *string,
	offline *bool,
	platform *string,
	ids []string,
	imageName *string,
	rootDeviceType *string,
	launchPermission *string,
	status *string,
	serviceCode *string,
	architecture *string,
	pageNumber *int,
	pageSize *int,
) *DescribeImagesRequest
  • param regionId: 地域ID。 (Required)
  • param imageSource: 镜像来源,如果没有指定 `ids` 参数,此参数必传。取值范围:

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

(Optional)
* param offline: 查询已经下线的镜像时使用。

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

(Optional)
* param platform: 根据镜像的操作系统发行版查询。

取值范围:`Ubuntu、CentOS、Windows Server`。

(Optional)
* param ids: 指定镜像ID查询,如果指定了此参数,其它参数可以不传。
(Optional)
* param imageName: 根据镜像名称模糊查询。 (Optional)
* param rootDeviceType: 根据镜像支持的系统盘类型查询。支持范围:`localDisk` 本地系统盘镜像;`cloudDisk` 云盘系统盘镜像。 (Optional)
* param launchPermission: 根据镜像的使用权限查询,可选参数,仅当 `imageSource` 为 `private` 时有效。取值范围:

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

(Optional)
* param status: 根据镜像状态查询。参考 [镜像状态](https://docs.jdcloud.com/virtual-machines/api/image_status) (Optional)
* param serviceCode: 已废弃。 (Optional)
* param architecture: CPU架构。支持范围:`x86_64`、`arm64`。 (Optional)
* param pageNumber: 页码;默认为1。 (Optional)
* param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional)

func NewDescribeImagesRequestWithoutParam added in v1.0.4

func NewDescribeImagesRequestWithoutParam() *DescribeImagesRequest

This constructor has better compatible ability when API parameters changed

func (DescribeImagesRequest) GetRegionId

func (r DescribeImagesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeImagesRequest) SetArchitecture added in v1.56.0

func (r *DescribeImagesRequest) SetArchitecture(architecture string)

param architecture: CPU架构。支持范围:`x86_64`、`arm64`。(Optional)

func (*DescribeImagesRequest) SetIds

func (r *DescribeImagesRequest) SetIds(ids []string)
param ids: 指定镜像ID查询,如果指定了此参数,其它参数可以不传。

(Optional)

func (*DescribeImagesRequest) SetImageName added in v1.51.0

func (r *DescribeImagesRequest) SetImageName(imageName string)

param imageName: 根据镜像名称模糊查询。(Optional)

func (*DescribeImagesRequest) SetImageSource

func (r *DescribeImagesRequest) SetImageSource(imageSource string)
param imageSource: 镜像来源,如果没有指定 `ids` 参数,此参数必传。取值范围:

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

func (*DescribeImagesRequest) SetLaunchPermission added in v1.13.0

func (r *DescribeImagesRequest) SetLaunchPermission(launchPermission string)
param launchPermission: 根据镜像的使用权限查询,可选参数,仅当 `imageSource` 为 `private` 时有效。取值范围:

`all`:没有限制,所有人均可以使用。 `specifiedUsers`:只有共享用户可以使用。 `ownerOnly`:镜像拥有者自己可以使用。 (Optional)

func (*DescribeImagesRequest) SetOffline added in v1.25.0

func (r *DescribeImagesRequest) SetOffline(offline bool)
param offline: 查询已经下线的镜像时使用。

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

func (*DescribeImagesRequest) SetPageNumber added in v1.0.5

func (r *DescribeImagesRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码;默认为1。(Optional)

func (*DescribeImagesRequest) SetPageSize added in v1.0.5

func (r *DescribeImagesRequest) SetPageSize(pageSize int)

param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。(Optional)

func (*DescribeImagesRequest) SetPlatform

func (r *DescribeImagesRequest) SetPlatform(platform string)
param platform: 根据镜像的操作系统发行版查询。

取值范围:`Ubuntu、CentOS、Windows Server`。 (Optional)

func (*DescribeImagesRequest) SetRegionId

func (r *DescribeImagesRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*DescribeImagesRequest) SetRootDeviceType added in v1.0.5

func (r *DescribeImagesRequest) SetRootDeviceType(rootDeviceType string)

param rootDeviceType: 根据镜像支持的系统盘类型查询。支持范围:`localDisk` 本地系统盘镜像;`cloudDisk` 云盘系统盘镜像。(Optional)

func (*DescribeImagesRequest) SetServiceCode added in v1.25.0

func (r *DescribeImagesRequest) SetServiceCode(serviceCode string)

param serviceCode: 已废弃。(Optional)

func (*DescribeImagesRequest) SetStatus added in v1.0.5

func (r *DescribeImagesRequest) SetStatus(status string)

param status: 根据镜像状态查询。参考 [镜像状态](https://docs.jdcloud.com/virtual-machines/api/image_status)(Optional)

type DescribeImagesResponse

type DescribeImagesResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    DescribeImagesResult `json:"result"`
}

type DescribeImagesResult

type DescribeImagesResult struct {
	Images     []vm.Image `json:"images"`
	TotalCount int        `json:"totalCount"`
}

type DescribeInstancePrivateIpAddressRequest added in v1.0.11

type DescribeInstancePrivateIpAddressRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 页码;默认为1。 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional) */
	PageSize *int `json:"pageSize"`

	/* <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,精确匹配,支持多个
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeInstancePrivateIpAddressRequest added in v1.0.11

func NewDescribeInstancePrivateIpAddressRequest(
	regionId string,
) *DescribeInstancePrivateIpAddressRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstancePrivateIpAddressRequestWithAllParams added in v1.0.11

func NewDescribeInstancePrivateIpAddressRequestWithAllParams(
	regionId string,
	pageNumber *int,
	pageSize *int,
	filters []common.Filter,
) *DescribeInstancePrivateIpAddressRequest
  • param regionId: 地域ID。 (Required)
  • param pageNumber: 页码;默认为1。 (Optional)
  • param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional)
  • param filters: <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,精确匹配,支持多个

(Optional)

func NewDescribeInstancePrivateIpAddressRequestWithoutParam added in v1.0.11

func NewDescribeInstancePrivateIpAddressRequestWithoutParam() *DescribeInstancePrivateIpAddressRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstancePrivateIpAddressRequest) GetRegionId added in v1.0.11

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstancePrivateIpAddressRequest) SetFilters added in v1.0.11

func (r *DescribeInstancePrivateIpAddressRequest) SetFilters(filters []common.Filter)
param filters: <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,精确匹配,支持多个 (Optional)

func (*DescribeInstancePrivateIpAddressRequest) SetPageNumber added in v1.0.11

func (r *DescribeInstancePrivateIpAddressRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码;默认为1。(Optional)

func (*DescribeInstancePrivateIpAddressRequest) SetPageSize added in v1.0.11

func (r *DescribeInstancePrivateIpAddressRequest) SetPageSize(pageSize int)

param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。(Optional)

func (*DescribeInstancePrivateIpAddressRequest) SetRegionId added in v1.0.11

func (r *DescribeInstancePrivateIpAddressRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeInstancePrivateIpAddressResponse added in v1.0.11

type DescribeInstancePrivateIpAddressResponse struct {
	RequestID string                                 `json:"requestId"`
	Error     core.ErrorResponse                     `json:"error"`
	Result    DescribeInstancePrivateIpAddressResult `json:"result"`
}

type DescribeInstancePrivateIpAddressResult added in v1.0.11

type DescribeInstancePrivateIpAddressResult struct {
	InstancePrivateIpAddress []vm.InstancePrivateIpAddress `json:"instancePrivateIpAddress"`
	TotalCount               int                           `json:"totalCount"`
}

type DescribeInstanceRequest

type DescribeInstanceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`
}

func NewDescribeInstanceRequest

func NewDescribeInstanceRequest(
	regionId string,
	instanceId string,
) *DescribeInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstanceRequestWithAllParams added in v1.0.4

func NewDescribeInstanceRequestWithAllParams(
	regionId string,
	instanceId string,
) *DescribeInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required)

func NewDescribeInstanceRequestWithoutParam added in v1.0.4

func NewDescribeInstanceRequestWithoutParam() *DescribeInstanceRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstanceRequest) GetRegionId

func (r DescribeInstanceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstanceRequest) SetInstanceId

func (r *DescribeInstanceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*DescribeInstanceRequest) SetRegionId

func (r *DescribeInstanceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeInstanceResponse

type DescribeInstanceResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    DescribeInstanceResult `json:"result"`
}

type DescribeInstanceResult

type DescribeInstanceResult struct {
	Instance vm.Instance `json:"instance"`
}

type DescribeInstanceStatusRequest added in v1.0.4

type DescribeInstanceStatusRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 页码;默认为1。 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional) */
	PageSize *int `json:"pageSize"`

	/* <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,精确匹配,支持多个
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeInstanceStatusRequest added in v1.0.4

func NewDescribeInstanceStatusRequest(
	regionId string,
) *DescribeInstanceStatusRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstanceStatusRequestWithAllParams added in v1.0.4

func NewDescribeInstanceStatusRequestWithAllParams(
	regionId string,
	pageNumber *int,
	pageSize *int,
	filters []common.Filter,
) *DescribeInstanceStatusRequest
  • param regionId: 地域ID。 (Required)
  • param pageNumber: 页码;默认为1。 (Optional)
  • param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional)
  • param filters: <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,精确匹配,支持多个

(Optional)

func NewDescribeInstanceStatusRequestWithoutParam added in v1.0.4

func NewDescribeInstanceStatusRequestWithoutParam() *DescribeInstanceStatusRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstanceStatusRequest) GetRegionId added in v1.0.4

func (r DescribeInstanceStatusRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstanceStatusRequest) SetFilters added in v1.0.4

func (r *DescribeInstanceStatusRequest) SetFilters(filters []common.Filter)
param filters: <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,精确匹配,支持多个 (Optional)

func (*DescribeInstanceStatusRequest) SetPageNumber added in v1.0.4

func (r *DescribeInstanceStatusRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码;默认为1。(Optional)

func (*DescribeInstanceStatusRequest) SetPageSize added in v1.0.4

func (r *DescribeInstanceStatusRequest) SetPageSize(pageSize int)

param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。(Optional)

func (*DescribeInstanceStatusRequest) SetRegionId added in v1.0.4

func (r *DescribeInstanceStatusRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeInstanceStatusResponse added in v1.0.4

type DescribeInstanceStatusResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    DescribeInstanceStatusResult `json:"result"`
}

type DescribeInstanceStatusResult added in v1.0.4

type DescribeInstanceStatusResult struct {
	InstanceStatuses []vm.InstanceStatus `json:"instanceStatuses"`
	TotalCount       int                 `json:"totalCount"`
}

type DescribeInstanceTemplateRequest added in v1.10.0

type DescribeInstanceTemplateRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 实例模板ID。  */
	InstanceTemplateId string `json:"instanceTemplateId"`
}

func NewDescribeInstanceTemplateRequest added in v1.10.0

func NewDescribeInstanceTemplateRequest(
	regionId string,
	instanceTemplateId string,
) *DescribeInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateId: 实例模板ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstanceTemplateRequestWithAllParams added in v1.10.0

func NewDescribeInstanceTemplateRequestWithAllParams(
	regionId string,
	instanceTemplateId string,
) *DescribeInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateId: 实例模板ID。 (Required)

func NewDescribeInstanceTemplateRequestWithoutParam added in v1.10.0

func NewDescribeInstanceTemplateRequestWithoutParam() *DescribeInstanceTemplateRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstanceTemplateRequest) GetRegionId added in v1.10.0

func (r DescribeInstanceTemplateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstanceTemplateRequest) SetInstanceTemplateId added in v1.10.0

func (r *DescribeInstanceTemplateRequest) SetInstanceTemplateId(instanceTemplateId string)

param instanceTemplateId: 实例模板ID。(Required)

func (*DescribeInstanceTemplateRequest) SetRegionId added in v1.10.0

func (r *DescribeInstanceTemplateRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeInstanceTemplateResponse added in v1.10.0

type DescribeInstanceTemplateResponse struct {
	RequestID string                         `json:"requestId"`
	Error     core.ErrorResponse             `json:"error"`
	Result    DescribeInstanceTemplateResult `json:"result"`
}

type DescribeInstanceTemplateResult added in v1.10.0

type DescribeInstanceTemplateResult struct {
	InstanceTemplate vm.InstanceTemplate `json:"instanceTemplate"`
}

type DescribeInstanceTemplatesCustomdataRequest added in v1.51.0

type DescribeInstanceTemplatesCustomdataRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* <b>filters 中支持使用以下关键字进行过滤</b>
	`instanceTemplateId`: 实例模板ID,精确匹配,最多支持10个
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeInstanceTemplatesCustomdataRequest added in v1.51.0

func NewDescribeInstanceTemplatesCustomdataRequest(
	regionId string,
) *DescribeInstanceTemplatesCustomdataRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstanceTemplatesCustomdataRequestWithAllParams added in v1.51.0

func NewDescribeInstanceTemplatesCustomdataRequestWithAllParams(
	regionId string,
	filters []common.Filter,
) *DescribeInstanceTemplatesCustomdataRequest
  • param regionId: 地域ID。 (Required)
  • param filters: <b>filters 中支持使用以下关键字进行过滤</b>

`instanceTemplateId`: 实例模板ID,精确匹配,最多支持10个

(Optional)

func NewDescribeInstanceTemplatesCustomdataRequestWithoutParam added in v1.51.0

func NewDescribeInstanceTemplatesCustomdataRequestWithoutParam() *DescribeInstanceTemplatesCustomdataRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstanceTemplatesCustomdataRequest) GetRegionId added in v1.51.0

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstanceTemplatesCustomdataRequest) SetFilters added in v1.51.0

func (r *DescribeInstanceTemplatesCustomdataRequest) SetFilters(filters []common.Filter)
param filters: <b>filters 中支持使用以下关键字进行过滤</b>

`instanceTemplateId`: 实例模板ID,精确匹配,最多支持10个 (Optional)

func (*DescribeInstanceTemplatesCustomdataRequest) SetRegionId added in v1.51.0

func (r *DescribeInstanceTemplatesCustomdataRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeInstanceTemplatesCustomdataResponse added in v1.51.0

type DescribeInstanceTemplatesCustomdataResponse struct {
	RequestID string                                    `json:"requestId"`
	Error     core.ErrorResponse                        `json:"error"`
	Result    DescribeInstanceTemplatesCustomdataResult `json:"result"`
}

type DescribeInstanceTemplatesCustomdataResult added in v1.51.0

type DescribeInstanceTemplatesCustomdataResult struct {
	InstanceTemplatesCustomData []vm.InstanceTemplateCustomData `json:"instanceTemplatesCustomData"`
	TotalCount                  int                             `json:"totalCount"`
}

type DescribeInstanceTemplatesRequest added in v1.10.0

type DescribeInstanceTemplatesRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 页码;默认为1。 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional) */
	PageSize *int `json:"pageSize"`

	/* <b>filters 中支持使用以下关键字进行过滤</b>
	`name`: 实例模板名称,模糊匹配,支持多个
	`instanceTemplateId`: 实例模板ID,精确匹配,支持多个
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeInstanceTemplatesRequest added in v1.10.0

func NewDescribeInstanceTemplatesRequest(
	regionId string,
) *DescribeInstanceTemplatesRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstanceTemplatesRequestWithAllParams added in v1.10.0

func NewDescribeInstanceTemplatesRequestWithAllParams(
	regionId string,
	pageNumber *int,
	pageSize *int,
	filters []common.Filter,
) *DescribeInstanceTemplatesRequest
  • param regionId: 地域ID。 (Required)
  • param pageNumber: 页码;默认为1。 (Optional)
  • param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional)
  • param filters: <b>filters 中支持使用以下关键字进行过滤</b>

`name`: 实例模板名称,模糊匹配,支持多个 `instanceTemplateId`: 实例模板ID,精确匹配,支持多个

(Optional)

func NewDescribeInstanceTemplatesRequestWithoutParam added in v1.10.0

func NewDescribeInstanceTemplatesRequestWithoutParam() *DescribeInstanceTemplatesRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstanceTemplatesRequest) GetRegionId added in v1.10.0

func (r DescribeInstanceTemplatesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstanceTemplatesRequest) SetFilters added in v1.10.0

func (r *DescribeInstanceTemplatesRequest) SetFilters(filters []common.Filter)
param filters: <b>filters 中支持使用以下关键字进行过滤</b>

`name`: 实例模板名称,模糊匹配,支持多个 `instanceTemplateId`: 实例模板ID,精确匹配,支持多个 (Optional)

func (*DescribeInstanceTemplatesRequest) SetPageNumber added in v1.10.0

func (r *DescribeInstanceTemplatesRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码;默认为1。(Optional)

func (*DescribeInstanceTemplatesRequest) SetPageSize added in v1.10.0

func (r *DescribeInstanceTemplatesRequest) SetPageSize(pageSize int)

param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。(Optional)

func (*DescribeInstanceTemplatesRequest) SetRegionId added in v1.10.0

func (r *DescribeInstanceTemplatesRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeInstanceTemplatesResponse added in v1.10.0

type DescribeInstanceTemplatesResponse struct {
	RequestID string                          `json:"requestId"`
	Error     core.ErrorResponse              `json:"error"`
	Result    DescribeInstanceTemplatesResult `json:"result"`
}

type DescribeInstanceTemplatesResult added in v1.10.0

type DescribeInstanceTemplatesResult struct {
	InstanceTemplates []vm.InstanceTemplate `json:"instanceTemplates"`
	TotalCount        int                   `json:"totalCount"`
}

type DescribeInstanceTypesRequest

type DescribeInstanceTypesRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 产品线类型,默认为 `vm`。支持范围:`vm` 云主机,`nc` 原生容器。 (Optional) */
	ServiceName *string `json:"serviceName"`

	/* 目前支持postpaid_by_spot:抢占式实例(后付费)。 (Optional) */
	ChargeMode *string `json:"chargeMode"`

	/* <b>filters 中支持使用以下关键字进行过滤</b>
	`instanceTypes`: 实例规格,精确匹配,支持多个
	`az`: 可用区,精确匹配,支持多个
	`architecture`: CPU架构,精确匹配,支持单个,可选范围:x86_64或arm64
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeInstanceTypesRequest

func NewDescribeInstanceTypesRequest(
	regionId string,
) *DescribeInstanceTypesRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstanceTypesRequestWithAllParams added in v1.0.4

func NewDescribeInstanceTypesRequestWithAllParams(
	regionId string,
	serviceName *string,
	chargeMode *string,
	filters []common.Filter,
) *DescribeInstanceTypesRequest
  • param regionId: 地域ID。 (Required)
  • param serviceName: 产品线类型,默认为 `vm`。支持范围:`vm` 云主机,`nc` 原生容器。 (Optional)
  • param chargeMode: 目前支持postpaid_by_spot:抢占式实例(后付费)。 (Optional)
  • param filters: <b>filters 中支持使用以下关键字进行过滤</b>

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

(Optional)

func NewDescribeInstanceTypesRequestWithoutParam added in v1.0.4

func NewDescribeInstanceTypesRequestWithoutParam() *DescribeInstanceTypesRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstanceTypesRequest) GetRegionId

func (r DescribeInstanceTypesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstanceTypesRequest) SetChargeMode added in v1.60.0

func (r *DescribeInstanceTypesRequest) SetChargeMode(chargeMode string)

param chargeMode: 目前支持postpaid_by_spot:抢占式实例(后付费)。(Optional)

func (*DescribeInstanceTypesRequest) SetFilters

func (r *DescribeInstanceTypesRequest) SetFilters(filters []common.Filter)
param filters: <b>filters 中支持使用以下关键字进行过滤</b>

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

func (*DescribeInstanceTypesRequest) SetRegionId

func (r *DescribeInstanceTypesRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*DescribeInstanceTypesRequest) SetServiceName added in v1.10.0

func (r *DescribeInstanceTypesRequest) SetServiceName(serviceName string)

param serviceName: 产品线类型,默认为 `vm`。支持范围:`vm` 云主机,`nc` 原生容器。(Optional)

type DescribeInstanceTypesResponse

type DescribeInstanceTypesResponse struct {
	RequestID string                      `json:"requestId"`
	Error     core.ErrorResponse          `json:"error"`
	Result    DescribeInstanceTypesResult `json:"result"`
}

type DescribeInstanceTypesResult

type DescribeInstanceTypesResult struct {
	InstanceTypes         []vm.InstanceType `json:"instanceTypes"`
	SpecificInstanceTypes []vm.InstanceType `json:"specificInstanceTypes"`
	TotalCount            int               `json:"totalCount"`
}

type DescribeInstanceVncUrlRequest

type DescribeInstanceVncUrlRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`
}

func NewDescribeInstanceVncUrlRequest

func NewDescribeInstanceVncUrlRequest(
	regionId string,
	instanceId string,
) *DescribeInstanceVncUrlRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstanceVncUrlRequestWithAllParams added in v1.0.4

func NewDescribeInstanceVncUrlRequestWithAllParams(
	regionId string,
	instanceId string,
) *DescribeInstanceVncUrlRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required)

func NewDescribeInstanceVncUrlRequestWithoutParam added in v1.0.4

func NewDescribeInstanceVncUrlRequestWithoutParam() *DescribeInstanceVncUrlRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstanceVncUrlRequest) GetRegionId

func (r DescribeInstanceVncUrlRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstanceVncUrlRequest) SetInstanceId

func (r *DescribeInstanceVncUrlRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*DescribeInstanceVncUrlRequest) SetRegionId

func (r *DescribeInstanceVncUrlRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeInstanceVncUrlResponse

type DescribeInstanceVncUrlResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    DescribeInstanceVncUrlResult `json:"result"`
}

type DescribeInstanceVncUrlResult

type DescribeInstanceVncUrlResult struct {
	VncUrl string `json:"vncUrl"`
}

type DescribeInstancesCustomDataRequest added in v1.51.0

type DescribeInstancesCustomDataRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 页码;默认为1。 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小;默认为10;取值范围[1, 10]。 (Optional) */
	PageSize *int `json:"pageSize"`

	/* <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,精确匹配,支持多个
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeInstancesCustomDataRequest added in v1.51.0

func NewDescribeInstancesCustomDataRequest(
	regionId string,
) *DescribeInstancesCustomDataRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstancesCustomDataRequestWithAllParams added in v1.51.0

func NewDescribeInstancesCustomDataRequestWithAllParams(
	regionId string,
	pageNumber *int,
	pageSize *int,
	filters []common.Filter,
) *DescribeInstancesCustomDataRequest
  • param regionId: 地域ID。 (Required)
  • param pageNumber: 页码;默认为1。 (Optional)
  • param pageSize: 分页大小;默认为10;取值范围[1, 10]。 (Optional)
  • param filters: <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,精确匹配,支持多个

(Optional)

func NewDescribeInstancesCustomDataRequestWithoutParam added in v1.51.0

func NewDescribeInstancesCustomDataRequestWithoutParam() *DescribeInstancesCustomDataRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstancesCustomDataRequest) GetRegionId added in v1.51.0

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstancesCustomDataRequest) SetFilters added in v1.51.0

func (r *DescribeInstancesCustomDataRequest) SetFilters(filters []common.Filter)
param filters: <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,精确匹配,支持多个 (Optional)

func (*DescribeInstancesCustomDataRequest) SetPageNumber added in v1.51.0

func (r *DescribeInstancesCustomDataRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码;默认为1。(Optional)

func (*DescribeInstancesCustomDataRequest) SetPageSize added in v1.51.0

func (r *DescribeInstancesCustomDataRequest) SetPageSize(pageSize int)

param pageSize: 分页大小;默认为10;取值范围[1, 10]。(Optional)

func (*DescribeInstancesCustomDataRequest) SetRegionId added in v1.51.0

func (r *DescribeInstancesCustomDataRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeInstancesCustomDataResponse added in v1.51.0

type DescribeInstancesCustomDataResponse struct {
	RequestID string                            `json:"requestId"`
	Error     core.ErrorResponse                `json:"error"`
	Result    DescribeInstancesCustomDataResult `json:"result"`
}

type DescribeInstancesCustomDataResult added in v1.51.0

type DescribeInstancesCustomDataResult struct {
	CustomData []vm.CustomData `json:"customData"`
	TotalCount int             `json:"totalCount"`
}

type DescribeInstancesRequest

type DescribeInstancesRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 页码;默认为1。 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional) */
	PageSize *int `json:"pageSize"`

	/* Tag筛选条件。 (Optional) */
	Tags []vm.TagFilter `json:"tags"`

	/* <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` 为或者的关系。
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeInstancesRequest

func NewDescribeInstancesRequest(
	regionId string,
) *DescribeInstancesRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeInstancesRequestWithAllParams added in v1.0.4

func NewDescribeInstancesRequestWithAllParams(
	regionId string,
	pageNumber *int,
	pageSize *int,
	tags []vm.TagFilter,
	filters []common.Filter,
) *DescribeInstancesRequest
  • param regionId: 地域ID。 (Required)
  • param pageNumber: 页码;默认为1。 (Optional)
  • param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional)
  • param tags: Tag筛选条件。 (Optional)
  • param filters: <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` 为或者的关系。

(Optional)

func NewDescribeInstancesRequestWithoutParam added in v1.0.4

func NewDescribeInstancesRequestWithoutParam() *DescribeInstancesRequest

This constructor has better compatible ability when API parameters changed

func (DescribeInstancesRequest) GetRegionId

func (r DescribeInstancesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeInstancesRequest) SetFilters

func (r *DescribeInstancesRequest) SetFilters(filters []common.Filter)
param filters: <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` 为或者的关系。 (Optional)

func (*DescribeInstancesRequest) SetPageNumber

func (r *DescribeInstancesRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码;默认为1。(Optional)

func (*DescribeInstancesRequest) SetPageSize

func (r *DescribeInstancesRequest) SetPageSize(pageSize int)

param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。(Optional)

func (*DescribeInstancesRequest) SetRegionId

func (r *DescribeInstancesRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*DescribeInstancesRequest) SetTags added in v1.0.2

func (r *DescribeInstancesRequest) SetTags(tags []vm.TagFilter)

param tags: Tag筛选条件。(Optional)

type DescribeInstancesResponse

type DescribeInstancesResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    DescribeInstancesResult `json:"result"`
}

type DescribeInstancesResult

type DescribeInstancesResult struct {
	Instances  []vm.Instance `json:"instances"`
	TotalCount int           `json:"totalCount"`
}

type DescribeKeypairsRequest added in v1.1.0

type DescribeKeypairsRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 页码;默认为1。 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional) */
	PageSize *int `json:"pageSize"`

	/* <b>filters 中支持使用以下关键字进行过滤</b>
	`keyNames`: 密钥对名称,精确匹配,支持多个
	 (Optional) */
	Filters []common.Filter `json:"filters"`
}

func NewDescribeKeypairsRequest added in v1.1.0

func NewDescribeKeypairsRequest(
	regionId string,
) *DescribeKeypairsRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeKeypairsRequestWithAllParams added in v1.1.0

func NewDescribeKeypairsRequestWithAllParams(
	regionId string,
	pageNumber *int,
	pageSize *int,
	filters []common.Filter,
) *DescribeKeypairsRequest
  • param regionId: 地域ID。 (Required)
  • param pageNumber: 页码;默认为1。 (Optional)
  • param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。 (Optional)
  • param filters: <b>filters 中支持使用以下关键字进行过滤</b>

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

(Optional)

func NewDescribeKeypairsRequestWithoutParam added in v1.1.0

func NewDescribeKeypairsRequestWithoutParam() *DescribeKeypairsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeKeypairsRequest) GetRegionId added in v1.1.0

func (r DescribeKeypairsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeKeypairsRequest) SetFilters added in v1.1.0

func (r *DescribeKeypairsRequest) SetFilters(filters []common.Filter)
param filters: <b>filters 中支持使用以下关键字进行过滤</b>

`keyNames`: 密钥对名称,精确匹配,支持多个 (Optional)

func (*DescribeKeypairsRequest) SetPageNumber added in v1.1.0

func (r *DescribeKeypairsRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码;默认为1。(Optional)

func (*DescribeKeypairsRequest) SetPageSize added in v1.1.0

func (r *DescribeKeypairsRequest) SetPageSize(pageSize int)

param pageSize: 分页大小;<br>默认为20;取值范围[10, 100]。(Optional)

func (*DescribeKeypairsRequest) SetRegionId added in v1.1.0

func (r *DescribeKeypairsRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeKeypairsResponse added in v1.1.0

type DescribeKeypairsResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    DescribeKeypairsResult `json:"result"`
}

type DescribeKeypairsResult added in v1.1.0

type DescribeKeypairsResult struct {
	Keypairs   []vm.Keypair `json:"keypairs"`
	TotalCount int          `json:"totalCount"`
}

type DescribeQuotasRequest

type DescribeQuotasRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* <b>filters 中支持使用以下关键字进行过滤</b>
	`resourceTypes`: 资源类型,支持多个,可选范围:`instance、instance_cpu、instance_memory、instance_local_disk、keypair、image、instanceTemplate、imageShare`
	 (Optional) */
	Filters []common.Filter `json:"filters"`

	/* 私有镜像Id。
	查询镜像共享 `imageShare` 的配额时,此参数必传。
	 (Optional) */
	ImageId *string `json:"imageId"`
}

func NewDescribeQuotasRequest

func NewDescribeQuotasRequest(
	regionId string,
) *DescribeQuotasRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeQuotasRequestWithAllParams added in v1.0.4

func NewDescribeQuotasRequestWithAllParams(
	regionId string,
	filters []common.Filter,
	imageId *string,
) *DescribeQuotasRequest
  • param regionId: 地域ID。 (Required)
  • param filters: <b>filters 中支持使用以下关键字进行过滤</b>

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

(Optional)
* param imageId: 私有镜像Id。

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

(Optional)

func NewDescribeQuotasRequestWithoutParam added in v1.0.4

func NewDescribeQuotasRequestWithoutParam() *DescribeQuotasRequest

This constructor has better compatible ability when API parameters changed

func (DescribeQuotasRequest) GetRegionId

func (r DescribeQuotasRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeQuotasRequest) SetFilters

func (r *DescribeQuotasRequest) SetFilters(filters []common.Filter)
param filters: <b>filters 中支持使用以下关键字进行过滤</b>

`resourceTypes`: 资源类型,支持多个,可选范围:`instance、instance_cpu、instance_memory、instance_local_disk、keypair、image、instanceTemplate、imageShare` (Optional)

func (*DescribeQuotasRequest) SetImageId added in v1.1.0

func (r *DescribeQuotasRequest) SetImageId(imageId string)
param imageId: 私有镜像Id。

查询镜像共享 `imageShare` 的配额时,此参数必传。 (Optional)

func (*DescribeQuotasRequest) SetRegionId

func (r *DescribeQuotasRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DescribeQuotasResponse

type DescribeQuotasResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    DescribeQuotasResult `json:"result"`
}

type DescribeQuotasResult

type DescribeQuotasResult struct {
	Quotas []vm.Quota `json:"quotas"`
}

type DetachDiskRequest

type DetachDiskRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 云硬盘ID。  */
	DiskId string `json:"diskId"`

	/* 是否强制缷载,默认False。
	如果此参数传值为True,数据盘的IO会被强制断掉。
	 (Optional) */
	Force *bool `json:"force"`
}

func NewDetachDiskRequest

func NewDetachDiskRequest(
	regionId string,
	instanceId string,
	diskId string,
) *DetachDiskRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param diskId: 云硬盘ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDetachDiskRequestWithAllParams added in v1.0.4

func NewDetachDiskRequestWithAllParams(
	regionId string,
	instanceId string,
	diskId string,
	force *bool,
) *DetachDiskRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param diskId: 云硬盘ID。 (Required)
  • param force: 是否强制缷载,默认False。

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

(Optional)

func NewDetachDiskRequestWithoutParam added in v1.0.4

func NewDetachDiskRequestWithoutParam() *DetachDiskRequest

This constructor has better compatible ability when API parameters changed

func (DetachDiskRequest) GetRegionId

func (r DetachDiskRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DetachDiskRequest) SetDiskId

func (r *DetachDiskRequest) SetDiskId(diskId string)

param diskId: 云硬盘ID。(Required)

func (*DetachDiskRequest) SetForce

func (r *DetachDiskRequest) SetForce(force bool)
param force: 是否强制缷载,默认False。

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

func (*DetachDiskRequest) SetInstanceId

func (r *DetachDiskRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*DetachDiskRequest) SetRegionId

func (r *DetachDiskRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DetachDiskResponse

type DetachDiskResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DetachDiskResult   `json:"result"`
}

type DetachDiskResult

type DetachDiskResult struct {
}

type DetachKeypairRequest added in v1.51.0

type DetachKeypairRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 密钥名称。  */
	KeyName string `json:"keyName"`

	/* 要解绑的云主机实例ID列表。  */
	InstanceIds []string `json:"instanceIds"`
}

func NewDetachKeypairRequest added in v1.51.0

func NewDetachKeypairRequest(
	regionId string,
	keyName string,
	instanceIds []string,
) *DetachKeypairRequest

* param regionId: 地域ID。 (Required) * param keyName: 密钥名称。 (Required) * param instanceIds: 要解绑的云主机实例ID列表。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDetachKeypairRequestWithAllParams added in v1.51.0

func NewDetachKeypairRequestWithAllParams(
	regionId string,
	keyName string,
	instanceIds []string,
) *DetachKeypairRequest

* param regionId: 地域ID。 (Required) * param keyName: 密钥名称。 (Required) * param instanceIds: 要解绑的云主机实例ID列表。 (Required)

func NewDetachKeypairRequestWithoutParam added in v1.51.0

func NewDetachKeypairRequestWithoutParam() *DetachKeypairRequest

This constructor has better compatible ability when API parameters changed

func (DetachKeypairRequest) GetRegionId added in v1.51.0

func (r DetachKeypairRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DetachKeypairRequest) SetInstanceIds added in v1.51.0

func (r *DetachKeypairRequest) SetInstanceIds(instanceIds []string)

param instanceIds: 要解绑的云主机实例ID列表。(Required)

func (*DetachKeypairRequest) SetKeyName added in v1.51.0

func (r *DetachKeypairRequest) SetKeyName(keyName string)

param keyName: 密钥名称。(Required)

func (*DetachKeypairRequest) SetRegionId added in v1.51.0

func (r *DetachKeypairRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DetachKeypairResponse added in v1.51.0

type DetachKeypairResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    DetachKeypairResult `json:"result"`
}

type DetachKeypairResult added in v1.51.0

type DetachKeypairResult struct {
	SuccessInstanceId []string `json:"successInstanceId"`
	FailInstanceId    []string `json:"failInstanceId"`
}

type DetachNetworkInterfaceRequest added in v1.0.5

type DetachNetworkInterfaceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 弹性网卡ID  */
	NetworkInterfaceId string `json:"networkInterfaceId"`
}

func NewDetachNetworkInterfaceRequest added in v1.0.5

func NewDetachNetworkInterfaceRequest(
	regionId string,
	instanceId string,
	networkInterfaceId string,
) *DetachNetworkInterfaceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param networkInterfaceId: 弹性网卡ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDetachNetworkInterfaceRequestWithAllParams added in v1.0.5

func NewDetachNetworkInterfaceRequestWithAllParams(
	regionId string,
	instanceId string,
	networkInterfaceId string,
) *DetachNetworkInterfaceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param networkInterfaceId: 弹性网卡ID (Required)

func NewDetachNetworkInterfaceRequestWithoutParam added in v1.0.5

func NewDetachNetworkInterfaceRequestWithoutParam() *DetachNetworkInterfaceRequest

This constructor has better compatible ability when API parameters changed

func (DetachNetworkInterfaceRequest) GetRegionId added in v1.0.5

func (r DetachNetworkInterfaceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DetachNetworkInterfaceRequest) SetInstanceId added in v1.0.5

func (r *DetachNetworkInterfaceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*DetachNetworkInterfaceRequest) SetNetworkInterfaceId added in v1.0.5

func (r *DetachNetworkInterfaceRequest) SetNetworkInterfaceId(networkInterfaceId string)

param networkInterfaceId: 弹性网卡ID(Required)

func (*DetachNetworkInterfaceRequest) SetRegionId added in v1.0.5

func (r *DetachNetworkInterfaceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DetachNetworkInterfaceResponse added in v1.0.5

type DetachNetworkInterfaceResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    DetachNetworkInterfaceResult `json:"result"`
}

type DetachNetworkInterfaceResult added in v1.0.5

type DetachNetworkInterfaceResult struct {
}

type DisassociateElasticIpRequest

type DisassociateElasticIpRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 弹性公网IP的ID。  */
	ElasticIpId string `json:"elasticIpId"`
}

func NewDisassociateElasticIpRequest

func NewDisassociateElasticIpRequest(
	regionId string,
	instanceId string,
	elasticIpId string,
) *DisassociateElasticIpRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param elasticIpId: 弹性公网IP的ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDisassociateElasticIpRequestWithAllParams added in v1.0.4

func NewDisassociateElasticIpRequestWithAllParams(
	regionId string,
	instanceId string,
	elasticIpId string,
) *DisassociateElasticIpRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param elasticIpId: 弹性公网IP的ID。 (Required)

func NewDisassociateElasticIpRequestWithoutParam added in v1.0.4

func NewDisassociateElasticIpRequestWithoutParam() *DisassociateElasticIpRequest

This constructor has better compatible ability when API parameters changed

func (DisassociateElasticIpRequest) GetRegionId

func (r DisassociateElasticIpRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DisassociateElasticIpRequest) SetElasticIpId

func (r *DisassociateElasticIpRequest) SetElasticIpId(elasticIpId string)

param elasticIpId: 弹性公网IP的ID。(Required)

func (*DisassociateElasticIpRequest) SetInstanceId

func (r *DisassociateElasticIpRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*DisassociateElasticIpRequest) SetRegionId

func (r *DisassociateElasticIpRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type DisassociateElasticIpResponse

type DisassociateElasticIpResponse struct {
	RequestID string                      `json:"requestId"`
	Error     core.ErrorResponse          `json:"error"`
	Result    DisassociateElasticIpResult `json:"result"`
}

type DisassociateElasticIpResult

type DisassociateElasticIpResult struct {
}

type ExportImageRequest added in v1.25.0

type ExportImageRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`

	/* 用户创建的服务角色名称。  */
	RoleName string `json:"roleName"`

	/* 存储导出镜像文件的 `oss bucket` 的域名,请填写以 https:// 开头的完整url。  */
	OssUrl string `json:"ossUrl"`

	/* 导出镜像文件名前缀,仅支持英文字母和数字,不能超过32个字符。 (Optional) */
	OssPrefix *string `json:"ossPrefix"`

	/* 用户导出镜像的幂等性保证。每次导出请传入不同的值,如果传值与某次的clientToken相同,则返还同一个请求结果,不能超过64个字符。 (Optional) */
	ClientToken *string `json:"clientToken"`

	/* 是否导出整机镜像(包含数据盘),默认为false,仅导出系统盘。 (Optional) */
	IsAllDisk *bool `json:"isAllDisk"`
}

func NewExportImageRequest added in v1.25.0

func NewExportImageRequest(
	regionId string,
	imageId string,
	roleName string,
	ossUrl string,
) *ExportImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * param roleName: 用户创建的服务角色名称。 (Required) * param ossUrl: 存储导出镜像文件的 `oss bucket` 的域名,请填写以 https:// 开头的完整url。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewExportImageRequestWithAllParams added in v1.25.0

func NewExportImageRequestWithAllParams(
	regionId string,
	imageId string,
	roleName string,
	ossUrl string,
	ossPrefix *string,
	clientToken *string,
	isAllDisk *bool,
) *ExportImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * param roleName: 用户创建的服务角色名称。 (Required) * param ossUrl: 存储导出镜像文件的 `oss bucket` 的域名,请填写以 https:// 开头的完整url。 (Required) * param ossPrefix: 导出镜像文件名前缀,仅支持英文字母和数字,不能超过32个字符。 (Optional) * param clientToken: 用户导出镜像的幂等性保证。每次导出请传入不同的值,如果传值与某次的clientToken相同,则返还同一个请求结果,不能超过64个字符。 (Optional) * param isAllDisk: 是否导出整机镜像(包含数据盘),默认为false,仅导出系统盘。 (Optional)

func NewExportImageRequestWithoutParam added in v1.25.0

func NewExportImageRequestWithoutParam() *ExportImageRequest

This constructor has better compatible ability when API parameters changed

func (ExportImageRequest) GetRegionId added in v1.25.0

func (r ExportImageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ExportImageRequest) SetClientToken added in v1.25.0

func (r *ExportImageRequest) SetClientToken(clientToken string)

param clientToken: 用户导出镜像的幂等性保证。每次导出请传入不同的值,如果传值与某次的clientToken相同,则返还同一个请求结果,不能超过64个字符。(Optional)

func (*ExportImageRequest) SetImageId added in v1.25.0

func (r *ExportImageRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*ExportImageRequest) SetIsAllDisk added in v1.60.0

func (r *ExportImageRequest) SetIsAllDisk(isAllDisk bool)

param isAllDisk: 是否导出整机镜像(包含数据盘),默认为false,仅导出系统盘。(Optional)

func (*ExportImageRequest) SetOssPrefix added in v1.25.0

func (r *ExportImageRequest) SetOssPrefix(ossPrefix string)

param ossPrefix: 导出镜像文件名前缀,仅支持英文字母和数字,不能超过32个字符。(Optional)

func (*ExportImageRequest) SetOssUrl added in v1.25.0

func (r *ExportImageRequest) SetOssUrl(ossUrl string)

param ossUrl: 存储导出镜像文件的 `oss bucket` 的域名,请填写以 https:// 开头的完整url。(Required)

func (*ExportImageRequest) SetRegionId added in v1.25.0

func (r *ExportImageRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*ExportImageRequest) SetRoleName added in v1.25.0

func (r *ExportImageRequest) SetRoleName(roleName string)

param roleName: 用户创建的服务角色名称。(Required)

type ExportImageResponse added in v1.25.0

type ExportImageResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    ExportImageResult  `json:"result"`
}

type ExportImageResult added in v1.25.0

type ExportImageResult struct {
	TaskId string `json:"taskId"`
}

type ImageTasksRequest added in v1.10.0

type ImageTasksRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 任务操作类型。支持范围:`ImportImage、ExportImage`。 (Optional) */
	TaskAction *string `json:"taskAction"`

	/* 任务id列表。 (Optional) */
	TaskIds []string `json:"taskIds"`

	/* 任务状态。支持范围:`pending、running、failed、finished`。 (Optional) */
	TaskStatus *string `json:"taskStatus"`

	/* 任务开始时间 (Optional) */
	StartTime *string `json:"startTime"`

	/* 任务结束时间 (Optional) */
	EndTime *string `json:"endTime"`

	/* 页码;默认为1。 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小;取值范围[10, 100]。 (Optional) */
	PageSize *int `json:"pageSize"`
}

func NewImageTasksRequest added in v1.10.0

func NewImageTasksRequest(
	regionId string,
) *ImageTasksRequest

* param regionId: 地域ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewImageTasksRequestWithAllParams added in v1.10.0

func NewImageTasksRequestWithAllParams(
	regionId string,
	taskAction *string,
	taskIds []string,
	taskStatus *string,
	startTime *string,
	endTime *string,
	pageNumber *int,
	pageSize *int,
) *ImageTasksRequest

* param regionId: 地域ID。 (Required) * param taskAction: 任务操作类型。支持范围:`ImportImage、ExportImage`。 (Optional) * param taskIds: 任务id列表。 (Optional) * param taskStatus: 任务状态。支持范围:`pending、running、failed、finished`。 (Optional) * param startTime: 任务开始时间 (Optional) * param endTime: 任务结束时间 (Optional) * param pageNumber: 页码;默认为1。 (Optional) * param pageSize: 分页大小;取值范围[10, 100]。 (Optional)

func NewImageTasksRequestWithoutParam added in v1.10.0

func NewImageTasksRequestWithoutParam() *ImageTasksRequest

This constructor has better compatible ability when API parameters changed

func (ImageTasksRequest) GetRegionId added in v1.10.0

func (r ImageTasksRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ImageTasksRequest) SetEndTime added in v1.10.0

func (r *ImageTasksRequest) SetEndTime(endTime string)

param endTime: 任务结束时间(Optional)

func (*ImageTasksRequest) SetPageNumber added in v1.10.0

func (r *ImageTasksRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码;默认为1。(Optional)

func (*ImageTasksRequest) SetPageSize added in v1.10.0

func (r *ImageTasksRequest) SetPageSize(pageSize int)

param pageSize: 分页大小;取值范围[10, 100]。(Optional)

func (*ImageTasksRequest) SetRegionId added in v1.10.0

func (r *ImageTasksRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*ImageTasksRequest) SetStartTime added in v1.10.0

func (r *ImageTasksRequest) SetStartTime(startTime string)

param startTime: 任务开始时间(Optional)

func (*ImageTasksRequest) SetTaskAction added in v1.10.0

func (r *ImageTasksRequest) SetTaskAction(taskAction string)

param taskAction: 任务操作类型。支持范围:`ImportImage、ExportImage`。(Optional)

func (*ImageTasksRequest) SetTaskIds added in v1.10.0

func (r *ImageTasksRequest) SetTaskIds(taskIds []string)

param taskIds: 任务id列表。(Optional)

func (*ImageTasksRequest) SetTaskStatus added in v1.10.0

func (r *ImageTasksRequest) SetTaskStatus(taskStatus string)

param taskStatus: 任务状态。支持范围:`pending、running、failed、finished`。(Optional)

type ImageTasksResponse added in v1.10.0

type ImageTasksResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    ImageTasksResult   `json:"result"`
}

type ImageTasksResult added in v1.10.0

type ImageTasksResult struct {
	TaskSet    []vm.TaskInfo `json:"taskSet"`
	TotalCount int           `json:"totalCount"`
}

type ImportImageRequest added in v1.10.0

type ImportImageRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像架构。取值范围:`x86_64、arm64`。  */
	Architecture string `json:"architecture"`

	/* 镜像的操作系统类型。取值范围:`windows、linux`。  */
	OsType string `json:"osType"`

	/* 镜像的操作系统平台名称。
	取值范围:`Ubuntu、CentOS、Windows Server、Other Linux、Other Windows`。
	*/
	Platform string `json:"platform"`

	/* 磁盘格式,取值范围:`qcow2、vhd、vmdk、raw`。  */
	DiskFormat string `json:"diskFormat"`

	/* 以此镜像需要制作的系统盘的默认大小,单位GB。最小值40,最大值500,要求值是10的整数倍。  */
	SystemDiskSizeGB int `json:"systemDiskSizeGB"`

	/* 要导入镜像的对象存储外链地址。  */
	ImageUrl string `json:"imageUrl"`

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

	/* 导入镜像的自定义名称。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。  */
	ImageName string `json:"imageName"`

	/* 导入镜像的描述信息。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional) */
	Description *string `json:"description"`

	/* 是否强制导入。强制导入会忽略镜像的合规性检测。默认为false。 (Optional) */
	ForceImport *bool `json:"forceImport"`

	/* 用户导出镜像的幂等性保证。每次导出请传入不同的值,如果传值与某次的clientToken相同,则返还同一个请求结果,不能超过64个字符。 (Optional) */
	ClientToken *string `json:"clientToken"`
}

func NewImportImageRequest added in v1.10.0

func NewImportImageRequest(
	regionId string,
	architecture string,
	osType string,
	platform string,
	diskFormat string,
	systemDiskSizeGB int,
	imageUrl string,
	imageName string,
) *ImportImageRequest
  • param regionId: 地域ID。 (Required)
  • param architecture: 镜像架构。取值范围:`x86_64、arm64`。 (Required)
  • param osType: 镜像的操作系统类型。取值范围:`windows、linux`。 (Required)
  • param platform: 镜像的操作系统平台名称。

取值范围:`Ubuntu、CentOS、Windows Server、Other Linux、Other Windows`。

(Required)
* param diskFormat: 磁盘格式,取值范围:`qcow2、vhd、vmdk、raw`。 (Required)
* param systemDiskSizeGB: 以此镜像需要制作的系统盘的默认大小,单位GB。最小值40,最大值500,要求值是10的整数倍。 (Required)
* param imageUrl: 要导入镜像的对象存储外链地址。 (Required)
* param imageName: 导入镜像的自定义名称。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Required)
*
* @Deprecated, not compatible when mandatory parameters changed

func NewImportImageRequestWithAllParams added in v1.10.0

func NewImportImageRequestWithAllParams(
	regionId string,
	architecture string,
	osType string,
	platform string,
	diskFormat string,
	systemDiskSizeGB int,
	imageUrl string,
	osVersion *string,
	imageName string,
	description *string,
	forceImport *bool,
	clientToken *string,
) *ImportImageRequest
  • param regionId: 地域ID。 (Required)
  • param architecture: 镜像架构。取值范围:`x86_64、arm64`。 (Required)
  • param osType: 镜像的操作系统类型。取值范围:`windows、linux`。 (Required)
  • param platform: 镜像的操作系统平台名称。

取值范围:`Ubuntu、CentOS、Windows Server、Other Linux、Other Windows`。

(Required)
* param diskFormat: 磁盘格式,取值范围:`qcow2、vhd、vmdk、raw`。 (Required)
* param systemDiskSizeGB: 以此镜像需要制作的系统盘的默认大小,单位GB。最小值40,最大值500,要求值是10的整数倍。 (Required)
* param imageUrl: 要导入镜像的对象存储外链地址。 (Required)
* param osVersion: 镜像的操作系统版本。 (Optional)
* param imageName: 导入镜像的自定义名称。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Required)
* param description: 导入镜像的描述信息。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional)
* param forceImport: 是否强制导入。强制导入会忽略镜像的合规性检测。默认为false。 (Optional)
* param clientToken: 用户导出镜像的幂等性保证。每次导出请传入不同的值,如果传值与某次的clientToken相同,则返还同一个请求结果,不能超过64个字符。 (Optional)

func NewImportImageRequestWithoutParam added in v1.10.0

func NewImportImageRequestWithoutParam() *ImportImageRequest

This constructor has better compatible ability when API parameters changed

func (ImportImageRequest) GetRegionId added in v1.10.0

func (r ImportImageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ImportImageRequest) SetArchitecture added in v1.10.0

func (r *ImportImageRequest) SetArchitecture(architecture string)

param architecture: 镜像架构。取值范围:`x86_64、arm64`。(Required)

func (*ImportImageRequest) SetClientToken added in v1.10.0

func (r *ImportImageRequest) SetClientToken(clientToken string)

param clientToken: 用户导出镜像的幂等性保证。每次导出请传入不同的值,如果传值与某次的clientToken相同,则返还同一个请求结果,不能超过64个字符。(Optional)

func (*ImportImageRequest) SetDescription added in v1.10.0

func (r *ImportImageRequest) SetDescription(description string)

param description: 导入镜像的描述信息。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。(Optional)

func (*ImportImageRequest) SetDiskFormat added in v1.10.0

func (r *ImportImageRequest) SetDiskFormat(diskFormat string)

param diskFormat: 磁盘格式,取值范围:`qcow2、vhd、vmdk、raw`。(Required)

func (*ImportImageRequest) SetForceImport added in v1.10.0

func (r *ImportImageRequest) SetForceImport(forceImport bool)

param forceImport: 是否强制导入。强制导入会忽略镜像的合规性检测。默认为false。(Optional)

func (*ImportImageRequest) SetImageName added in v1.10.0

func (r *ImportImageRequest) SetImageName(imageName string)

param imageName: 导入镜像的自定义名称。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。(Required)

func (*ImportImageRequest) SetImageUrl added in v1.10.0

func (r *ImportImageRequest) SetImageUrl(imageUrl string)

param imageUrl: 要导入镜像的对象存储外链地址。(Required)

func (*ImportImageRequest) SetOsType added in v1.10.0

func (r *ImportImageRequest) SetOsType(osType string)

param osType: 镜像的操作系统类型。取值范围:`windows、linux`。(Required)

func (*ImportImageRequest) SetOsVersion added in v1.10.0

func (r *ImportImageRequest) SetOsVersion(osVersion string)

param osVersion: 镜像的操作系统版本。(Optional)

func (*ImportImageRequest) SetPlatform added in v1.10.0

func (r *ImportImageRequest) SetPlatform(platform string)
param platform: 镜像的操作系统平台名称。

取值范围:`Ubuntu、CentOS、Windows Server、Other Linux、Other Windows`。 (Required)

func (*ImportImageRequest) SetRegionId added in v1.10.0

func (r *ImportImageRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*ImportImageRequest) SetSystemDiskSizeGB added in v1.10.0

func (r *ImportImageRequest) SetSystemDiskSizeGB(systemDiskSizeGB int)

param systemDiskSizeGB: 以此镜像需要制作的系统盘的默认大小,单位GB。最小值40,最大值500,要求值是10的整数倍。(Required)

type ImportImageResponse added in v1.10.0

type ImportImageResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    ImportImageResult  `json:"result"`
}

type ImportImageResult added in v1.10.0

type ImportImageResult struct {
	ImageId string `json:"imageId"`
	TaskId  string `json:"taskId"`
}

type ImportKeypairRequest added in v1.1.0

type ImportKeypairRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 密钥对名称,需要全局唯一。
	只允许数字、大小写字母、下划线“_”及中划线“-”,不超过32个字符。
	*/
	KeyName string `json:"keyName"`

	/* 密钥对的公钥部分。  */
	PublicKey string `json:"publicKey"`
}

func NewImportKeypairRequest added in v1.1.0

func NewImportKeypairRequest(
	regionId string,
	keyName string,
	publicKey string,
) *ImportKeypairRequest
  • param regionId: 地域ID。 (Required)
  • param keyName: 密钥对名称,需要全局唯一。

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

(Required)
* param publicKey: 密钥对的公钥部分。 (Required)
*
* @Deprecated, not compatible when mandatory parameters changed

func NewImportKeypairRequestWithAllParams added in v1.1.0

func NewImportKeypairRequestWithAllParams(
	regionId string,
	keyName string,
	publicKey string,
) *ImportKeypairRequest
  • param regionId: 地域ID。 (Required)
  • param keyName: 密钥对名称,需要全局唯一。

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

(Required)
* param publicKey: 密钥对的公钥部分。 (Required)

func NewImportKeypairRequestWithoutParam added in v1.1.0

func NewImportKeypairRequestWithoutParam() *ImportKeypairRequest

This constructor has better compatible ability when API parameters changed

func (ImportKeypairRequest) GetRegionId added in v1.1.0

func (r ImportKeypairRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ImportKeypairRequest) SetKeyName added in v1.1.0

func (r *ImportKeypairRequest) SetKeyName(keyName string)
param keyName: 密钥对名称,需要全局唯一。

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

func (*ImportKeypairRequest) SetPublicKey added in v1.1.0

func (r *ImportKeypairRequest) SetPublicKey(publicKey string)

param publicKey: 密钥对的公钥部分。(Required)

func (*ImportKeypairRequest) SetRegionId added in v1.1.0

func (r *ImportKeypairRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type ImportKeypairResponse added in v1.1.0

type ImportKeypairResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    ImportKeypairResult `json:"result"`
}

type ImportKeypairResult added in v1.1.0

type ImportKeypairResult struct {
	KeyName        string `json:"keyName"`
	KeyFingerprint string `json:"keyFingerprint"`
}

type ModifyImageAttributeRequest added in v1.0.4

type ModifyImageAttributeRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`

	/* 镜像名称。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional) */
	Name *string `json:"name"`

	/* 镜像描述。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional) */
	Description *string `json:"description"`
}

func NewModifyImageAttributeRequest added in v1.0.4

func NewModifyImageAttributeRequest(
	regionId string,
	imageId string,
) *ModifyImageAttributeRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModifyImageAttributeRequestWithAllParams added in v1.0.4

func NewModifyImageAttributeRequestWithAllParams(
	regionId string,
	imageId string,
	name *string,
	description *string,
) *ModifyImageAttributeRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * param name: 镜像名称。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional) * param description: 镜像描述。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional)

func NewModifyImageAttributeRequestWithoutParam added in v1.0.4

func NewModifyImageAttributeRequestWithoutParam() *ModifyImageAttributeRequest

This constructor has better compatible ability when API parameters changed

func (ModifyImageAttributeRequest) GetRegionId added in v1.0.4

func (r ModifyImageAttributeRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModifyImageAttributeRequest) SetDescription added in v1.0.4

func (r *ModifyImageAttributeRequest) SetDescription(description string)

param description: 镜像描述。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。(Optional)

func (*ModifyImageAttributeRequest) SetImageId added in v1.0.4

func (r *ModifyImageAttributeRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*ModifyImageAttributeRequest) SetName added in v1.0.4

func (r *ModifyImageAttributeRequest) SetName(name string)

param name: 镜像名称。参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。(Optional)

func (*ModifyImageAttributeRequest) SetRegionId added in v1.0.4

func (r *ModifyImageAttributeRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type ModifyImageAttributeResponse added in v1.0.4

type ModifyImageAttributeResponse struct {
	RequestID string                     `json:"requestId"`
	Error     core.ErrorResponse         `json:"error"`
	Result    ModifyImageAttributeResult `json:"result"`
}

type ModifyImageAttributeResult added in v1.0.4

type ModifyImageAttributeResult struct {
}

type ModifyInstanceAttributeRequest

type ModifyInstanceAttributeRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 实例名称。长度为2\~128个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.),不能以(.)作为首尾。
	(Optional) */
	Name *string `json:"name"`

	/* 实例描述。256字符以内。
	(Optional) */
	Description *string `json:"description"`

	/* 实例hostname。
	**Windows系统**:长度为2\~15个字符,允许大小写字母、数字或连字符(-),不能以连字符(-)开头或结尾,不能连续使用连字符(-),也不能全部使用数字。不支持点号(.)。
	**Linux系统**:长度为2-64个字符,允许支持多个点号,点之间为一段,每段允许使用大小写字母、数字或连字符(-),但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾。
	 (Optional) */
	Hostname *string `json:"hostname"`

	/* 用户自定义元数据。
	以 `key-value` 键值对形式指定,可在实例系统内通过元数据服务查询获取。最多支持40对键值对,且 `key` 不超过256字符,`value` 不超过16KB,不区分大小写。
	注意:`key` 不要以连字符(-)结尾,否则此 `key` 不生效。
	 (Optional) */
	Metadata []vm.Metadata `json:"metadata"`

	/* 自定义脚本。
	目前仅支持启动脚本,即 `launch-script`,须Base64编码且编码前数据长度不能超过16KB。
	**linux系统**:支持bash和python,编码前须分别以 `#!/bin/bash` 和 `#!/usr/bin/env python` 作为内容首行。
	**Windows系统**:支持 `bat` 和 `powershell` ,编码前须分别以 `<cmd></cmd>和<powershell></powershell>` 作为内容首、尾行。
	 (Optional) */
	Userdata []vm.Userdata `json:"userdata"`
}

func NewModifyInstanceAttributeRequest

func NewModifyInstanceAttributeRequest(
	regionId string,
	instanceId string,
) *ModifyInstanceAttributeRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModifyInstanceAttributeRequestWithAllParams added in v1.0.4

func NewModifyInstanceAttributeRequestWithAllParams(
	regionId string,
	instanceId string,
	name *string,
	description *string,
	hostname *string,
	metadata []vm.Metadata,
	userdata []vm.Userdata,
) *ModifyInstanceAttributeRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param name: 实例名称。长度为2\~128个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.),不能以(.)作为首尾。 (Optional)
  • param description: 实例描述。256字符以内。 (Optional)
  • param hostname: 实例hostname。

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

(Optional)
* param metadata: 用户自定义元数据。

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

(Optional)
* param userdata: 自定义脚本。

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

(Optional)

func NewModifyInstanceAttributeRequestWithoutParam added in v1.0.4

func NewModifyInstanceAttributeRequestWithoutParam() *ModifyInstanceAttributeRequest

This constructor has better compatible ability when API parameters changed

func (ModifyInstanceAttributeRequest) GetRegionId

func (r ModifyInstanceAttributeRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModifyInstanceAttributeRequest) SetDescription

func (r *ModifyInstanceAttributeRequest) SetDescription(description string)
param description: 实例描述。256字符以内。

(Optional)

func (*ModifyInstanceAttributeRequest) SetHostname added in v1.51.0

func (r *ModifyInstanceAttributeRequest) SetHostname(hostname string)
param hostname: 实例hostname。

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

func (*ModifyInstanceAttributeRequest) SetInstanceId

func (r *ModifyInstanceAttributeRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*ModifyInstanceAttributeRequest) SetMetadata added in v1.51.0

func (r *ModifyInstanceAttributeRequest) SetMetadata(metadata []vm.Metadata)
param metadata: 用户自定义元数据。

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

func (*ModifyInstanceAttributeRequest) SetName

func (r *ModifyInstanceAttributeRequest) SetName(name string)
param name: 实例名称。长度为2\~128个字符,只允许中文、数字、大小写字母、英文下划线(\_)、连字符(-)及点(.),不能以(.)作为首尾。

(Optional)

func (*ModifyInstanceAttributeRequest) SetRegionId

func (r *ModifyInstanceAttributeRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*ModifyInstanceAttributeRequest) SetUserdata added in v1.51.0

func (r *ModifyInstanceAttributeRequest) SetUserdata(userdata []vm.Userdata)
param userdata: 自定义脚本。

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

type ModifyInstanceAttributeResponse

type ModifyInstanceAttributeResponse struct {
	RequestID string                        `json:"requestId"`
	Error     core.ErrorResponse            `json:"error"`
	Result    ModifyInstanceAttributeResult `json:"result"`
}

type ModifyInstanceAttributeResult

type ModifyInstanceAttributeResult struct {
}

type ModifyInstanceDiskAttributeRequest added in v1.0.5

type ModifyInstanceDiskAttributeRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 云硬盘列表。 (Optional) */
	DataDisks []vm.InstanceDiskAttribute `json:"dataDisks"`
}

func NewModifyInstanceDiskAttributeRequest added in v1.0.5

func NewModifyInstanceDiskAttributeRequest(
	regionId string,
	instanceId string,
) *ModifyInstanceDiskAttributeRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModifyInstanceDiskAttributeRequestWithAllParams added in v1.0.5

func NewModifyInstanceDiskAttributeRequestWithAllParams(
	regionId string,
	instanceId string,
	dataDisks []vm.InstanceDiskAttribute,
) *ModifyInstanceDiskAttributeRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param dataDisks: 云硬盘列表。 (Optional)

func NewModifyInstanceDiskAttributeRequestWithoutParam added in v1.0.5

func NewModifyInstanceDiskAttributeRequestWithoutParam() *ModifyInstanceDiskAttributeRequest

This constructor has better compatible ability when API parameters changed

func (ModifyInstanceDiskAttributeRequest) GetRegionId added in v1.0.5

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModifyInstanceDiskAttributeRequest) SetDataDisks added in v1.0.5

func (r *ModifyInstanceDiskAttributeRequest) SetDataDisks(dataDisks []vm.InstanceDiskAttribute)

param dataDisks: 云硬盘列表。(Optional)

func (*ModifyInstanceDiskAttributeRequest) SetInstanceId added in v1.0.5

func (r *ModifyInstanceDiskAttributeRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*ModifyInstanceDiskAttributeRequest) SetRegionId added in v1.0.5

func (r *ModifyInstanceDiskAttributeRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type ModifyInstanceDiskAttributeResponse added in v1.0.5

type ModifyInstanceDiskAttributeResponse struct {
	RequestID string                            `json:"requestId"`
	Error     core.ErrorResponse                `json:"error"`
	Result    ModifyInstanceDiskAttributeResult `json:"result"`
}

type ModifyInstanceDiskAttributeResult added in v1.0.5

type ModifyInstanceDiskAttributeResult struct {
}

type ModifyInstanceNetworkAttributeRequest added in v1.0.5

type ModifyInstanceNetworkAttributeRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 弹性网卡列表。  */
	Networks []vm.InstanceNetworkAttribute `json:"networks"`
}

func NewModifyInstanceNetworkAttributeRequest added in v1.0.5

func NewModifyInstanceNetworkAttributeRequest(
	regionId string,
	instanceId string,
	networks []vm.InstanceNetworkAttribute,
) *ModifyInstanceNetworkAttributeRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param networks: 弹性网卡列表。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModifyInstanceNetworkAttributeRequestWithAllParams added in v1.0.5

func NewModifyInstanceNetworkAttributeRequestWithAllParams(
	regionId string,
	instanceId string,
	networks []vm.InstanceNetworkAttribute,
) *ModifyInstanceNetworkAttributeRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param networks: 弹性网卡列表。 (Required)

func NewModifyInstanceNetworkAttributeRequestWithoutParam added in v1.0.5

func NewModifyInstanceNetworkAttributeRequestWithoutParam() *ModifyInstanceNetworkAttributeRequest

This constructor has better compatible ability when API parameters changed

func (ModifyInstanceNetworkAttributeRequest) GetRegionId added in v1.0.5

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModifyInstanceNetworkAttributeRequest) SetInstanceId added in v1.0.5

func (r *ModifyInstanceNetworkAttributeRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*ModifyInstanceNetworkAttributeRequest) SetNetworks added in v1.0.5

param networks: 弹性网卡列表。(Required)

func (*ModifyInstanceNetworkAttributeRequest) SetRegionId added in v1.0.5

func (r *ModifyInstanceNetworkAttributeRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type ModifyInstanceNetworkAttributeResponse added in v1.0.5

type ModifyInstanceNetworkAttributeResponse struct {
	RequestID string                               `json:"requestId"`
	Error     core.ErrorResponse                   `json:"error"`
	Result    ModifyInstanceNetworkAttributeResult `json:"result"`
}

type ModifyInstanceNetworkAttributeResult added in v1.0.5

type ModifyInstanceNetworkAttributeResult struct {
}

type ModifyInstancePasswordRequest

type ModifyInstancePasswordRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

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

func NewModifyInstancePasswordRequest

func NewModifyInstancePasswordRequest(
	regionId string,
	instanceId string,
	password string,
) *ModifyInstancePasswordRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param password: 实例密码。

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

(Required)
*
* @Deprecated, not compatible when mandatory parameters changed

func NewModifyInstancePasswordRequestWithAllParams added in v1.0.4

func NewModifyInstancePasswordRequestWithAllParams(
	regionId string,
	instanceId string,
	password string,
) *ModifyInstancePasswordRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param password: 实例密码。

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

(Required)

func NewModifyInstancePasswordRequestWithoutParam added in v1.0.4

func NewModifyInstancePasswordRequestWithoutParam() *ModifyInstancePasswordRequest

This constructor has better compatible ability when API parameters changed

func (ModifyInstancePasswordRequest) GetRegionId

func (r ModifyInstancePasswordRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModifyInstancePasswordRequest) SetInstanceId

func (r *ModifyInstancePasswordRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*ModifyInstancePasswordRequest) SetPassword

func (r *ModifyInstancePasswordRequest) SetPassword(password string)
param password: 实例密码。

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

func (*ModifyInstancePasswordRequest) SetRegionId

func (r *ModifyInstancePasswordRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type ModifyInstancePasswordResponse

type ModifyInstancePasswordResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    ModifyInstancePasswordResult `json:"result"`
}

type ModifyInstancePasswordResult

type ModifyInstancePasswordResult struct {
}

type ModifyInstancePlacementRequest added in v1.56.0

type ModifyInstancePlacementRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 高可用组Id,必填项。
	可查询 [DescribeAgs](https://docs.jdcloud.com/cn/availability-group/api/describeags) 接口获得高可用组信息。
	 (Optional) */
	AgId *string `json:"agId"`

	/* 是否强制均衡,默认 false
	(Optional) */
	Balance *bool `json:"balance"`

	/* 是否确认清除本地盘数据,默认 false
	(Optional) */
	ClearLocalDisk *bool `json:"clearLocalDisk"`

	/* 是否托管实例的生命周期,默认为false;若为包年包月实例,可加入但不支持托管;该字段仅AG开启AS时生效。托管实例将在缩容或健康检查失败时被删除,非托管实例仅移出伸缩组
	(Optional) */
	IsManaged *bool `json:"isManaged"`
}

func NewModifyInstancePlacementRequest added in v1.56.0

func NewModifyInstancePlacementRequest(
	regionId string,
	instanceId string,
) *ModifyInstancePlacementRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModifyInstancePlacementRequestWithAllParams added in v1.56.0

func NewModifyInstancePlacementRequestWithAllParams(
	regionId string,
	instanceId string,
	agId *string,
	balance *bool,
	clearLocalDisk *bool,
	isManaged *bool,
) *ModifyInstancePlacementRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param agId: 高可用组Id,必填项。

可查询 [DescribeAgs](https://docs.jdcloud.com/cn/availability-group/api/describeags) 接口获得高可用组信息。

(Optional)
* param balance: 是否强制均衡,默认 false
(Optional)
* param clearLocalDisk: 是否确认清除本地盘数据,默认 false
(Optional)
* param isManaged: 是否托管实例的生命周期,默认为false;若为包年包月实例,可加入但不支持托管;该字段仅AG开启AS时生效。托管实例将在缩容或健康检查失败时被删除,非托管实例仅移出伸缩组
(Optional)

func NewModifyInstancePlacementRequestWithoutParam added in v1.56.0

func NewModifyInstancePlacementRequestWithoutParam() *ModifyInstancePlacementRequest

This constructor has better compatible ability when API parameters changed

func (ModifyInstancePlacementRequest) GetRegionId added in v1.56.0

func (r ModifyInstancePlacementRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModifyInstancePlacementRequest) SetAgId added in v1.56.0

func (r *ModifyInstancePlacementRequest) SetAgId(agId string)
param agId: 高可用组Id,必填项。

可查询 [DescribeAgs](https://docs.jdcloud.com/cn/availability-group/api/describeags) 接口获得高可用组信息。 (Optional)

func (*ModifyInstancePlacementRequest) SetBalance added in v1.56.0

func (r *ModifyInstancePlacementRequest) SetBalance(balance bool)
param balance: 是否强制均衡,默认 false

(Optional)

func (*ModifyInstancePlacementRequest) SetClearLocalDisk added in v1.56.0

func (r *ModifyInstancePlacementRequest) SetClearLocalDisk(clearLocalDisk bool)
param clearLocalDisk: 是否确认清除本地盘数据,默认 false

(Optional)

func (*ModifyInstancePlacementRequest) SetInstanceId added in v1.56.0

func (r *ModifyInstancePlacementRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*ModifyInstancePlacementRequest) SetIsManaged added in v1.62.0

func (r *ModifyInstancePlacementRequest) SetIsManaged(isManaged bool)
param isManaged: 是否托管实例的生命周期,默认为false;若为包年包月实例,可加入但不支持托管;该字段仅AG开启AS时生效。托管实例将在缩容或健康检查失败时被删除,非托管实例仅移出伸缩组

(Optional)

func (*ModifyInstancePlacementRequest) SetRegionId added in v1.56.0

func (r *ModifyInstancePlacementRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type ModifyInstancePlacementResponse added in v1.56.0

type ModifyInstancePlacementResponse struct {
	RequestID string                        `json:"requestId"`
	Error     core.ErrorResponse            `json:"error"`
	Result    ModifyInstancePlacementResult `json:"result"`
}

type ModifyInstancePlacementResult added in v1.56.0

type ModifyInstancePlacementResult struct {
}

type ModifyInstanceVpcAttributeRequest added in v1.56.0

type ModifyInstanceVpcAttributeRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 子网Id。  */
	SubnetId string `json:"subnetId"`

	/* `true`: 分配IPV6地址。
	`false`: 不分配IPV6地址。
	 (Optional) */
	AssignIpv6 *bool `json:"assignIpv6"`

	/* Ipv4地址。
	不变更 `vpc` 及子网时必须指定Ipv4地址
	 (Optional) */
	PrivateIpAddress *string `json:"privateIpAddress"`

	/* 安全组列表。
	更换 `vpc` 时必须指定新的安全组。
	不更换 `vpc` 时不可以指定安全组。
	 (Optional) */
	SecurityGroups []string `json:"securityGroups"`
}

func NewModifyInstanceVpcAttributeRequest added in v1.56.0

func NewModifyInstanceVpcAttributeRequest(
	regionId string,
	instanceId string,
	subnetId string,
) *ModifyInstanceVpcAttributeRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param subnetId: 子网Id。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModifyInstanceVpcAttributeRequestWithAllParams added in v1.56.0

func NewModifyInstanceVpcAttributeRequestWithAllParams(
	regionId string,
	instanceId string,
	subnetId string,
	assignIpv6 *bool,
	privateIpAddress *string,
	securityGroups []string,
) *ModifyInstanceVpcAttributeRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param subnetId: 子网Id。 (Required)
  • param assignIpv6: `true`: 分配IPV6地址。

`false`: 不分配IPV6地址。

(Optional)
* param privateIpAddress: Ipv4地址。

不变更 `vpc` 及子网时必须指定Ipv4地址

(Optional)
* param securityGroups: 安全组列表。

更换 `vpc` 时必须指定新的安全组。 不更换 `vpc` 时不可以指定安全组。

(Optional)

func NewModifyInstanceVpcAttributeRequestWithoutParam added in v1.56.0

func NewModifyInstanceVpcAttributeRequestWithoutParam() *ModifyInstanceVpcAttributeRequest

This constructor has better compatible ability when API parameters changed

func (ModifyInstanceVpcAttributeRequest) GetRegionId added in v1.56.0

func (r ModifyInstanceVpcAttributeRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModifyInstanceVpcAttributeRequest) SetAssignIpv6 added in v1.56.0

func (r *ModifyInstanceVpcAttributeRequest) SetAssignIpv6(assignIpv6 bool)
param assignIpv6: `true`: 分配IPV6地址。

`false`: 不分配IPV6地址。 (Optional)

func (*ModifyInstanceVpcAttributeRequest) SetInstanceId added in v1.56.0

func (r *ModifyInstanceVpcAttributeRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*ModifyInstanceVpcAttributeRequest) SetPrivateIpAddress added in v1.56.0

func (r *ModifyInstanceVpcAttributeRequest) SetPrivateIpAddress(privateIpAddress string)
param privateIpAddress: Ipv4地址。

不变更 `vpc` 及子网时必须指定Ipv4地址 (Optional)

func (*ModifyInstanceVpcAttributeRequest) SetRegionId added in v1.56.0

func (r *ModifyInstanceVpcAttributeRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*ModifyInstanceVpcAttributeRequest) SetSecurityGroups added in v1.56.0

func (r *ModifyInstanceVpcAttributeRequest) SetSecurityGroups(securityGroups []string)
param securityGroups: 安全组列表。

更换 `vpc` 时必须指定新的安全组。 不更换 `vpc` 时不可以指定安全组。 (Optional)

func (*ModifyInstanceVpcAttributeRequest) SetSubnetId added in v1.56.0

func (r *ModifyInstanceVpcAttributeRequest) SetSubnetId(subnetId string)

param subnetId: 子网Id。(Required)

type ModifyInstanceVpcAttributeResponse added in v1.56.0

type ModifyInstanceVpcAttributeResponse struct {
	RequestID string                           `json:"requestId"`
	Error     core.ErrorResponse               `json:"error"`
	Result    ModifyInstanceVpcAttributeResult `json:"result"`
}

type ModifyInstanceVpcAttributeResult added in v1.56.0

type ModifyInstanceVpcAttributeResult struct {
}

type RebootInstanceRequest

type RebootInstanceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`
}

func NewRebootInstanceRequest

func NewRebootInstanceRequest(
	regionId string,
	instanceId string,
) *RebootInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewRebootInstanceRequestWithAllParams added in v1.0.4

func NewRebootInstanceRequestWithAllParams(
	regionId string,
	instanceId string,
) *RebootInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required)

func NewRebootInstanceRequestWithoutParam added in v1.0.4

func NewRebootInstanceRequestWithoutParam() *RebootInstanceRequest

This constructor has better compatible ability when API parameters changed

func (RebootInstanceRequest) GetRegionId

func (r RebootInstanceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RebootInstanceRequest) SetInstanceId

func (r *RebootInstanceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*RebootInstanceRequest) SetRegionId

func (r *RebootInstanceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type RebootInstanceResponse

type RebootInstanceResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    RebootInstanceResult `json:"result"`
}

type RebootInstanceResult

type RebootInstanceResult struct {
}

type RebuildInstanceRequest added in v1.0.2

type RebuildInstanceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

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

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

	/* 密钥对名称。仅Linux系统下该参数生效,当前仅支持输入单个密钥。
	(Optional) */
	KeyNames []string `json:"keyNames"`

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

	/* 用户自定义元数据。
	以 `key-value` 键值对形式指定,可在实例系统内通过元数据服务查询获取。最多支持40对键值对,且 `key` 不超过256字符,`value` 不超过16KB,不区分大小写。
	注意:`key` 不要以连字符(-)结尾,否则此 `key` 不生效。
	 (Optional) */
	Metadata []vm.Metadata `json:"metadata"`

	/* 自定义脚本。
	目前仅支持启动脚本,即 `launch-script`,须Base64编码且编码前数据长度不能超过16KB。
	**linux系统**:支持bash和python,编码前须分别以 `#!/bin/bash` 和 `#!/usr/bin/env python` 作为内容首行。
	**Windows系统**:支持 `bat` 和 `powershell`,编码前须分别以 `<cmd></cmd>和<powershell></powershell>` 作为内容首、尾行。
	 (Optional) */
	Userdata []vm.Userdata `json:"userdata"`

	/* 密码授权,若存在密匙,则根据此参数决定是否使用密码,若没有密匙,此参数无效,会强制使用密码。
	若不使用密码,且密匙对解绑后,用户需重置密码,方可使用密码登录。
	此参数在windows系统中必须为yes。
	 (Optional) */
	PassWordAuth *string `json:"passWordAuth"`

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

func NewRebuildInstanceRequest added in v1.0.2

func NewRebuildInstanceRequest(
	regionId string,
	instanceId string,
) *RebuildInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewRebuildInstanceRequestWithAllParams added in v1.0.4

func NewRebuildInstanceRequestWithAllParams(
	regionId string,
	instanceId string,
	password *string,
	imageId *string,
	keyNames []string,
	hostname *string,
	metadata []vm.Metadata,
	userdata []vm.Userdata,
	passWordAuth *string,
	imageInherit *string,
) *RebuildInstanceRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param password: 实例密码。

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

(Optional)
* param imageId: 镜像ID。

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

(Optional)
* param keyNames: 密钥对名称。仅Linux系统下该参数生效,当前仅支持输入单个密钥。
(Optional)
* param hostname: 实例hostname。

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

(Optional)
* param metadata: 用户自定义元数据。

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

(Optional)
* param userdata: 自定义脚本。

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

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

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

(Optional)
* param imageInherit: 继承镜像中的登录验证方式,"yes"为使用,"no"为不使用,""默认为"no" (Optional)

func NewRebuildInstanceRequestWithoutParam added in v1.0.4

func NewRebuildInstanceRequestWithoutParam() *RebuildInstanceRequest

This constructor has better compatible ability when API parameters changed

func (RebuildInstanceRequest) GetRegionId added in v1.0.2

func (r RebuildInstanceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RebuildInstanceRequest) SetHostname added in v1.51.0

func (r *RebuildInstanceRequest) SetHostname(hostname string)
param hostname: 实例hostname。

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

func (*RebuildInstanceRequest) SetImageId added in v1.0.2

func (r *RebuildInstanceRequest) SetImageId(imageId string)
param imageId: 镜像ID。

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

func (*RebuildInstanceRequest) SetImageInherit added in v1.57.0

func (r *RebuildInstanceRequest) SetImageInherit(imageInherit string)

param imageInherit: 继承镜像中的登录验证方式,"yes"为使用,"no"为不使用,""默认为"no"(Optional)

func (*RebuildInstanceRequest) SetInstanceId added in v1.0.2

func (r *RebuildInstanceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*RebuildInstanceRequest) SetKeyNames added in v1.0.2

func (r *RebuildInstanceRequest) SetKeyNames(keyNames []string)
param keyNames: 密钥对名称。仅Linux系统下该参数生效,当前仅支持输入单个密钥。

(Optional)

func (*RebuildInstanceRequest) SetMetadata added in v1.51.0

func (r *RebuildInstanceRequest) SetMetadata(metadata []vm.Metadata)
param metadata: 用户自定义元数据。

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

func (*RebuildInstanceRequest) SetPassWordAuth added in v1.57.0

func (r *RebuildInstanceRequest) SetPassWordAuth(passWordAuth string)
param passWordAuth: 密码授权,若存在密匙,则根据此参数决定是否使用密码,若没有密匙,此参数无效,会强制使用密码。

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

func (*RebuildInstanceRequest) SetPassword added in v1.0.2

func (r *RebuildInstanceRequest) SetPassword(password string)
param password: 实例密码。

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

func (*RebuildInstanceRequest) SetRegionId added in v1.0.2

func (r *RebuildInstanceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

func (*RebuildInstanceRequest) SetUserdata added in v1.51.0

func (r *RebuildInstanceRequest) SetUserdata(userdata []vm.Userdata)
param userdata: 自定义脚本。

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

type RebuildInstanceResponse added in v1.0.2

type RebuildInstanceResponse struct {
	RequestID string                `json:"requestId"`
	Error     core.ErrorResponse    `json:"error"`
	Result    RebuildInstanceResult `json:"result"`
}

type RebuildInstanceResult added in v1.0.2

type RebuildInstanceResult struct {
}

type RedeployInstanceRequest added in v1.60.0

type RedeployInstanceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`
}

func NewRedeployInstanceRequest added in v1.60.0

func NewRedeployInstanceRequest(
	regionId string,
	instanceId string,
) *RedeployInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewRedeployInstanceRequestWithAllParams added in v1.60.0

func NewRedeployInstanceRequestWithAllParams(
	regionId string,
	instanceId string,
) *RedeployInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required)

func NewRedeployInstanceRequestWithoutParam added in v1.60.0

func NewRedeployInstanceRequestWithoutParam() *RedeployInstanceRequest

This constructor has better compatible ability when API parameters changed

func (RedeployInstanceRequest) GetRegionId added in v1.60.0

func (r RedeployInstanceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RedeployInstanceRequest) SetInstanceId added in v1.60.0

func (r *RedeployInstanceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*RedeployInstanceRequest) SetRegionId added in v1.60.0

func (r *RedeployInstanceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type RedeployInstanceResponse added in v1.60.0

type RedeployInstanceResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    RedeployInstanceResult `json:"result"`
}

type RedeployInstanceResult added in v1.60.0

type RedeployInstanceResult struct {
}

type ReleaseImageRequest added in v1.13.0

type ReleaseImageRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`
}

func NewReleaseImageRequest added in v1.13.0

func NewReleaseImageRequest(
	regionId string,
	imageId string,
) *ReleaseImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewReleaseImageRequestWithAllParams added in v1.13.0

func NewReleaseImageRequestWithAllParams(
	regionId string,
	imageId string,
) *ReleaseImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required)

func NewReleaseImageRequestWithoutParam added in v1.13.0

func NewReleaseImageRequestWithoutParam() *ReleaseImageRequest

This constructor has better compatible ability when API parameters changed

func (ReleaseImageRequest) GetRegionId added in v1.13.0

func (r ReleaseImageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ReleaseImageRequest) SetImageId added in v1.13.0

func (r *ReleaseImageRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*ReleaseImageRequest) SetRegionId added in v1.13.0

func (r *ReleaseImageRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type ReleaseImageResponse added in v1.13.0

type ReleaseImageResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    ReleaseImageResult `json:"result"`
}

type ReleaseImageResult added in v1.13.0

type ReleaseImageResult struct {
}

type ResizeInstanceRequest added in v1.0.2

type ResizeInstanceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 实例规格,可查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得指定地域或可用区的规格信息。  */
	InstanceType string `json:"instanceType"`

	/* 是否强制调配,默认为 `false`。如果指定为 `true`, 将会清除本地数据盘。 (Optional) */
	Force *bool `json:"force"`
}

func NewResizeInstanceRequest added in v1.0.2

func NewResizeInstanceRequest(
	regionId string,
	instanceId string,
	instanceType string,
) *ResizeInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param instanceType: 实例规格,可查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得指定地域或可用区的规格信息。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewResizeInstanceRequestWithAllParams added in v1.0.4

func NewResizeInstanceRequestWithAllParams(
	regionId string,
	instanceId string,
	instanceType string,
	force *bool,
) *ResizeInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * param instanceType: 实例规格,可查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得指定地域或可用区的规格信息。 (Required) * param force: 是否强制调配,默认为 `false`。如果指定为 `true`, 将会清除本地数据盘。 (Optional)

func NewResizeInstanceRequestWithoutParam added in v1.0.4

func NewResizeInstanceRequestWithoutParam() *ResizeInstanceRequest

This constructor has better compatible ability when API parameters changed

func (ResizeInstanceRequest) GetRegionId added in v1.0.2

func (r ResizeInstanceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ResizeInstanceRequest) SetForce added in v1.25.0

func (r *ResizeInstanceRequest) SetForce(force bool)

param force: 是否强制调配,默认为 `false`。如果指定为 `true`, 将会清除本地数据盘。(Optional)

func (*ResizeInstanceRequest) SetInstanceId added in v1.0.2

func (r *ResizeInstanceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*ResizeInstanceRequest) SetInstanceType added in v1.0.2

func (r *ResizeInstanceRequest) SetInstanceType(instanceType string)

param instanceType: 实例规格,可查询 [DescribeInstanceTypes](https://docs.jdcloud.com/virtual-machines/api/describeinstancetypes) 接口获得指定地域或可用区的规格信息。(Required)

func (*ResizeInstanceRequest) SetRegionId added in v1.0.2

func (r *ResizeInstanceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type ResizeInstanceResponse added in v1.0.2

type ResizeInstanceResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    ResizeInstanceResult `json:"result"`
}

type ResizeInstanceResult added in v1.0.2

type ResizeInstanceResult struct {
}

type ShareImageRequest

type ShareImageRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`

	/* 共享的目标京东云帐户列表。  */
	Pins []string `json:"pins"`
}

func NewShareImageRequest

func NewShareImageRequest(
	regionId string,
	imageId string,
	pins []string,
) *ShareImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * param pins: 共享的目标京东云帐户列表。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewShareImageRequestWithAllParams added in v1.0.4

func NewShareImageRequestWithAllParams(
	regionId string,
	imageId string,
	pins []string,
) *ShareImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * param pins: 共享的目标京东云帐户列表。 (Required)

func NewShareImageRequestWithoutParam added in v1.0.4

func NewShareImageRequestWithoutParam() *ShareImageRequest

This constructor has better compatible ability when API parameters changed

func (ShareImageRequest) GetRegionId

func (r ShareImageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ShareImageRequest) SetImageId

func (r *ShareImageRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*ShareImageRequest) SetPins

func (r *ShareImageRequest) SetPins(pins []string)

param pins: 共享的目标京东云帐户列表。(Required)

func (*ShareImageRequest) SetRegionId

func (r *ShareImageRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type ShareImageResponse

type ShareImageResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    ShareImageResult   `json:"result"`
}

type ShareImageResult

type ShareImageResult struct {
}

type StartInstanceRequest

type StartInstanceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`
}

func NewStartInstanceRequest

func NewStartInstanceRequest(
	regionId string,
	instanceId string,
) *StartInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewStartInstanceRequestWithAllParams added in v1.0.4

func NewStartInstanceRequestWithAllParams(
	regionId string,
	instanceId string,
) *StartInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required)

func NewStartInstanceRequestWithoutParam added in v1.0.4

func NewStartInstanceRequestWithoutParam() *StartInstanceRequest

This constructor has better compatible ability when API parameters changed

func (StartInstanceRequest) GetRegionId

func (r StartInstanceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*StartInstanceRequest) SetInstanceId

func (r *StartInstanceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*StartInstanceRequest) SetRegionId

func (r *StartInstanceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type StartInstanceResponse

type StartInstanceResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    StartInstanceResult `json:"result"`
}

type StartInstanceResult

type StartInstanceResult struct {
}

type StopInstanceRequest

type StopInstanceRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 云主机ID。  */
	InstanceId string `json:"instanceId"`

	/* 停机不计费模式。
	该参数仅对按配置计费且系统盘为云硬盘的实例生效,并且不是专有宿主机中的实例。
	配置停机不计费且停机后,实例部分将停止计费,且释放实例自身包含的资源(CPU/内存/GPU/本地数据盘)。
	可选值:
	`keepCharging`:停机后保持计费,不释放资源。
	`stopCharging`:停机后停止计费,释放实例资源。默认值为空。
	 (Optional) */
	ChargeOnStopped *string `json:"chargeOnStopped"`
}

func NewStopInstanceRequest

func NewStopInstanceRequest(
	regionId string,
	instanceId string,
) *StopInstanceRequest

* param regionId: 地域ID。 (Required) * param instanceId: 云主机ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewStopInstanceRequestWithAllParams added in v1.0.4

func NewStopInstanceRequestWithAllParams(
	regionId string,
	instanceId string,
	chargeOnStopped *string,
) *StopInstanceRequest
  • param regionId: 地域ID。 (Required)
  • param instanceId: 云主机ID。 (Required)
  • param chargeOnStopped: 停机不计费模式。

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

(Optional)

func NewStopInstanceRequestWithoutParam added in v1.0.4

func NewStopInstanceRequestWithoutParam() *StopInstanceRequest

This constructor has better compatible ability when API parameters changed

func (StopInstanceRequest) GetRegionId

func (r StopInstanceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*StopInstanceRequest) SetChargeOnStopped added in v1.25.0

func (r *StopInstanceRequest) SetChargeOnStopped(chargeOnStopped string)
param chargeOnStopped: 停机不计费模式。

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

func (*StopInstanceRequest) SetInstanceId

func (r *StopInstanceRequest) SetInstanceId(instanceId string)

param instanceId: 云主机ID。(Required)

func (*StopInstanceRequest) SetRegionId

func (r *StopInstanceRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type StopInstanceResponse

type StopInstanceResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    StopInstanceResult `json:"result"`
}

type StopInstanceResult

type StopInstanceResult struct {
}

type UnReleaseImageRequest added in v1.13.0

type UnReleaseImageRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`
}

func NewUnReleaseImageRequest added in v1.13.0

func NewUnReleaseImageRequest(
	regionId string,
	imageId string,
) *UnReleaseImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUnReleaseImageRequestWithAllParams added in v1.13.0

func NewUnReleaseImageRequestWithAllParams(
	regionId string,
	imageId string,
) *UnReleaseImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required)

func NewUnReleaseImageRequestWithoutParam added in v1.13.0

func NewUnReleaseImageRequestWithoutParam() *UnReleaseImageRequest

This constructor has better compatible ability when API parameters changed

func (UnReleaseImageRequest) GetRegionId added in v1.13.0

func (r UnReleaseImageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UnReleaseImageRequest) SetImageId added in v1.13.0

func (r *UnReleaseImageRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*UnReleaseImageRequest) SetRegionId added in v1.13.0

func (r *UnReleaseImageRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type UnReleaseImageResponse added in v1.13.0

type UnReleaseImageResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    UnReleaseImageResult `json:"result"`
}

type UnReleaseImageResult added in v1.13.0

type UnReleaseImageResult struct {
}

type UnShareImageRequest

type UnShareImageRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 镜像ID。  */
	ImageId string `json:"imageId"`

	/* 需要取消的京东云帐户列表。  */
	Pins []string `json:"pins"`
}

func NewUnShareImageRequest

func NewUnShareImageRequest(
	regionId string,
	imageId string,
	pins []string,
) *UnShareImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * param pins: 需要取消的京东云帐户列表。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUnShareImageRequestWithAllParams added in v1.0.4

func NewUnShareImageRequestWithAllParams(
	regionId string,
	imageId string,
	pins []string,
) *UnShareImageRequest

* param regionId: 地域ID。 (Required) * param imageId: 镜像ID。 (Required) * param pins: 需要取消的京东云帐户列表。 (Required)

func NewUnShareImageRequestWithoutParam added in v1.0.4

func NewUnShareImageRequestWithoutParam() *UnShareImageRequest

This constructor has better compatible ability when API parameters changed

func (UnShareImageRequest) GetRegionId

func (r UnShareImageRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UnShareImageRequest) SetImageId

func (r *UnShareImageRequest) SetImageId(imageId string)

param imageId: 镜像ID。(Required)

func (*UnShareImageRequest) SetPins

func (r *UnShareImageRequest) SetPins(pins []string)

param pins: 需要取消的京东云帐户列表。(Required)

func (*UnShareImageRequest) SetRegionId

func (r *UnShareImageRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type UnShareImageResponse

type UnShareImageResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    UnShareImageResult `json:"result"`
}

type UnShareImageResult

type UnShareImageResult struct {
}

type UpdateInstanceTemplateRequest added in v1.10.0

type UpdateInstanceTemplateRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 实例模板ID。  */
	InstanceTemplateId string `json:"instanceTemplateId"`

	/* 实例模板的名称,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional) */
	Name *string `json:"name"`

	/* 实例模板的描述,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional) */
	Description *string `json:"description"`

	/* 实例模板配置信息。 (Optional) */
	InstanceTemplateData *vm.UpdateInstanceTemplateSpec `json:"instanceTemplateData"`
}

func NewUpdateInstanceTemplateRequest added in v1.10.0

func NewUpdateInstanceTemplateRequest(
	regionId string,
	instanceTemplateId string,
) *UpdateInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateId: 实例模板ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateInstanceTemplateRequestWithAllParams added in v1.10.0

func NewUpdateInstanceTemplateRequestWithAllParams(
	regionId string,
	instanceTemplateId string,
	name *string,
	description *string,
	instanceTemplateData *vm.UpdateInstanceTemplateSpec,
) *UpdateInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateId: 实例模板ID。 (Required) * param name: 实例模板的名称,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional) * param description: 实例模板的描述,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。 (Optional) * param instanceTemplateData: 实例模板配置信息。 (Optional)

func NewUpdateInstanceTemplateRequestWithoutParam added in v1.10.0

func NewUpdateInstanceTemplateRequestWithoutParam() *UpdateInstanceTemplateRequest

This constructor has better compatible ability when API parameters changed

func (UpdateInstanceTemplateRequest) GetRegionId added in v1.10.0

func (r UpdateInstanceTemplateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UpdateInstanceTemplateRequest) SetDescription added in v1.10.0

func (r *UpdateInstanceTemplateRequest) SetDescription(description string)

param description: 实例模板的描述,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。(Optional)

func (*UpdateInstanceTemplateRequest) SetInstanceTemplateData added in v1.56.0

func (r *UpdateInstanceTemplateRequest) SetInstanceTemplateData(instanceTemplateData *vm.UpdateInstanceTemplateSpec)

param instanceTemplateData: 实例模板配置信息。(Optional)

func (*UpdateInstanceTemplateRequest) SetInstanceTemplateId added in v1.10.0

func (r *UpdateInstanceTemplateRequest) SetInstanceTemplateId(instanceTemplateId string)

param instanceTemplateId: 实例模板ID。(Required)

func (*UpdateInstanceTemplateRequest) SetName added in v1.10.0

func (r *UpdateInstanceTemplateRequest) SetName(name string)

param name: 实例模板的名称,参考 [公共参数规范](https://docs.jdcloud.com/virtual-machines/api/general_parameters)。(Optional)

func (*UpdateInstanceTemplateRequest) SetRegionId added in v1.10.0

func (r *UpdateInstanceTemplateRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type UpdateInstanceTemplateResponse added in v1.10.0

type UpdateInstanceTemplateResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    UpdateInstanceTemplateResult `json:"result"`
}

type UpdateInstanceTemplateResult added in v1.10.0

type UpdateInstanceTemplateResult struct {
}

type VerifyInstanceTemplateRequest added in v1.10.0

type VerifyInstanceTemplateRequest struct {
	core.JDCloudRequest

	/* 地域ID。  */
	RegionId string `json:"regionId"`

	/* 实例模板ID。  */
	InstanceTemplateId string `json:"instanceTemplateId"`
}

func NewVerifyInstanceTemplateRequest added in v1.10.0

func NewVerifyInstanceTemplateRequest(
	regionId string,
	instanceTemplateId string,
) *VerifyInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateId: 实例模板ID。 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewVerifyInstanceTemplateRequestWithAllParams added in v1.10.0

func NewVerifyInstanceTemplateRequestWithAllParams(
	regionId string,
	instanceTemplateId string,
) *VerifyInstanceTemplateRequest

* param regionId: 地域ID。 (Required) * param instanceTemplateId: 实例模板ID。 (Required)

func NewVerifyInstanceTemplateRequestWithoutParam added in v1.10.0

func NewVerifyInstanceTemplateRequestWithoutParam() *VerifyInstanceTemplateRequest

This constructor has better compatible ability when API parameters changed

func (VerifyInstanceTemplateRequest) GetRegionId added in v1.10.0

func (r VerifyInstanceTemplateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*VerifyInstanceTemplateRequest) SetInstanceTemplateId added in v1.10.0

func (r *VerifyInstanceTemplateRequest) SetInstanceTemplateId(instanceTemplateId string)

param instanceTemplateId: 实例模板ID。(Required)

func (*VerifyInstanceTemplateRequest) SetRegionId added in v1.10.0

func (r *VerifyInstanceTemplateRequest) SetRegionId(regionId string)

param regionId: 地域ID。(Required)

type VerifyInstanceTemplateResponse added in v1.10.0

type VerifyInstanceTemplateResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    VerifyInstanceTemplateResult `json:"result"`
}

type VerifyInstanceTemplateResult added in v1.10.0

type VerifyInstanceTemplateResult struct {
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL