com.baidubce.services.bcc
Class BccClient

java.lang.Object
  extended by com.baidubce.AbstractBceClient
      extended by com.baidubce.services.bcc.BccClient

public class BccClient
extends AbstractBceClient

Provides the client for accessing the Baidu Cloud Compute Service(bcc).


Field Summary
 
Fields inherited from class com.baidubce.AbstractBceClient
config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX
 
Constructor Summary
BccClient()
          Constructs a new client to invoke service methods on bcc.
BccClient(BceClientConfiguration clientConfiguration)
          Constructs a new bcc client using the client configuration to access bcc.
 
Method Summary
 AttachVolumeResponse attachVolume(AttachVolumeRequest request)
          Attaching the specified volume to a specified instance.
 AttachVolumeResponse attachVolume(String volumeId, String instanceId)
          Attaching the specified volume to a specified instance.
 void authorizeSecurityGroupRule(SecurityGroupRuleOperateRequest request)
          authorizing a security group rule to a specified security group
 void bindInstanceToSecurityGroup(BindSecurityGroupRequest request)
          Binding the instance to specified securitygroup.
 void bindInstanceToSecurityGroup(String instanceId, String securityGroupId)
          Binding the instance to specified securitygroup.
 CreateImageResponse createImage(CreateImageRequest request)
          Creating a customized image which can be used for creating instance in the future.
 CreateImageResponse createImageFromInstance(String imageName, String instanceId)
          Creating a customized image from the instance..
 CreateImageResponse createImageFromSnapshot(String imageName, String snapshotId)
          Creating a customized image from specified snapshot.
 CreateInstanceResponse createInstance(CreateInstanceRequest request)
          Create a bcc Instance with the specified options, see all the supported instance in InstanceType You must fill the field of clientToken,which is especially for keeping idempotent.
 CreateSecurityGroupResponse createSecurityGroup(CreateSecurityGroupRequest request)
          Creating a newly SecurityGroup with specified rules.
 CreateSnapshotResponse createSnapshot(CreateSnapshotRequest request)
          Creating snapshot from specified volume.
 CreateSnapshotResponse createSnapshot(String volumeId, String snapshotName)
          Creating snapshot from specified volume.
 CreateSnapshotResponse createSnapshot(String volumeId, String snapshotName, String desc)
          Creating snapshot from specified volume.
 CreateVolumeResponse createVolume(CreateVolumeRequest request)
          Create a volume with the specified options.
 void deleteImage(DeleteImageRequest request)
          Deleting the specified image.
 void deleteImage(String imageId)
          Deleting the specified image.
 void deleteSecurityGroup(DeleteSecurityGroupRequest request)
          Deleting the specified SecurityGroup.
 void deleteSecurityGroup(String securityGroupId)
          Deleting the specified SecurityGroup.
 void deleteSnapshot(DeleteSnapshotRequest request)
          Deleting the specified snapshot.
 void deleteSnapshot(String snapshotId)
          Deleting the specified snapshot.
 void detachVolume(DetachVolumeRequest request)
          Detaching the specified volume from a specified instance.
 void detachVolume(String volumeId, String instanceId)
          Detaching the specified volume from a specified instance.
 GetImageResponse getImage(GetImageRequest request)
          Get the detail information of specified image.
 GetImageResponse getImage(String imageId)
          Get the detail information of specified image.
 GetInstanceResponse getInstance(GetInstanceRequest request)
          Get the detail information of specified instance.
 GetInstanceResponse getInstance(String instanceId)
          Get the detail information of specified instance.
 GetInstanceVncResponse getInstanceVnc(GetInstanceVncRequest request)
          Getting the vnc url to access the instance.
 GetInstanceVncResponse getInstanceVnc(String instanceId)
          Getting the vnc url to access the instance.
 GetSnapshotResponse getSnapshot(GetSnapshotRequest request)
          Getting the detail information of specified snapshot.
 GetSnapshotResponse getSnapshot(String snapshotId)
          Get the detail information of specified snapshot.
 GetVolumeResponse getVolume(GetVolumeRequest request)
          Get the detail information of specified volume.
 GetVolumeResponse getVolume(String volumeId)
          Get the detail information of specified volume.
 ListImagesResponse listImages()
          Listing images owned by the authenticated user.
 ListImagesResponse listImages(ListImagesRequest request)
          Listing images owned by the authenticated user.
 ListInstancesResponse listInstances()
          Return a list of instances owned by the authenticated user.
 ListInstancesResponse listInstances(ListInstancesRequest request)
          Return a list of instances owned by the authenticated user.
 ListInstanceSpecsResponse listInstanceSpecs()
          Deprecated. 
 ListInstanceSpecsResponse listInstanceSpecs(ListInstanceSpecsRequest request)
          Deprecated. 
 ListSecurityGroupsResponse listSecurityGroups(ListSecurityGroupsRequest request)
          Listing SecurityGroup owned by the authenticated user.
 ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)
          Listing snapshots owned by the authenticated user.
 ListVolumesResponse listVolumes()
          Listing volumes owned by the authenticated user.
 ListVolumesResponse listVolumes(ListVolumesRequest request)
          Listing volumes owned by the authenticated user.
 ListZonesResponse listZones()
          listing zones within current region
 ListZonesResponse listZones(AbstractBceRequest request)
          listing zones within current region
 void modifyInstanceAttributes(ModifyInstanceAttributesRequest request)
          Modifying the special attribute to new value of the instance.
 void modifyInstancePassword(ModifyInstancePasswordRequest request)
          Modifying the password of the instance.
 void modifyInstancePassword(String instanceId, String adminPass)
          Modifying the password of the instance.
 void purchaseReservedInstance(PurchaseReservedInstanceRequeset request)
          Renewing the instance with fixed duration.
 void purchaseReservedInstance(String instanceId, int reservationLength, String reservationTimeUnit)
          PurchaseReserved the instance with fixed duration.
 void purchaseReservedVolume(PurchaseReservedVolumeRequest request)
          PurchaseReserved the instance with fixed duration.
 void purchaseReservedVolume(String volumeId, int reservationLength, String reservationTimeUnit)
          PurchaseReserved the instance with fixed duration.
 void rebootInstance(RebootInstanceRequest request)
          Rebooting the instance owned by the user.
 void rebootInstance(String instanceId)
          Rebooting the instance owned by the user.
 void rebootInstance(String instanceId, boolean forceStop)
          Rebooting the instance owned by the user.
 void rebuildInstance(RebuildInstanceRequest request)
          Rebuilding the instance owned by the user.
 void rebuildInstance(String instanceId, String imageId, String adminPass)
          Rebuilding the instance owned by the user.
 void releaseInstance(ReleaseInstanceRequest request)
          Releasing the instance owned by the user.
 void releaseInstance(String instanceId)
          Releasing the instance owned by the user.
 void releaseVolume(ReleaseVolumeRequest request)
          Releasing the specified volume owned by the user.
 void releaseVolume(String volumeId)
          Releasing the specified volume owned by the user.
 void resizeInstance(ResizeInstanceRequest request)
          Resizing the instance owned by the user.
 void resizeVolume(ResizeVolumeRequest request)
          Resizing the specified volume with newly size.
 void resizeVolume(String volumeId, int newCdsSizeInGB)
          Resizing the specified volume with newly size.
 void revokeSecurityGroupRule(SecurityGroupRuleOperateRequest request)
          revoking a security group rule from the specified security group
 void rollbackVolume(RollbackVolumeRequest request)
          Rollback the volume with the specified volume snapshot.
 void rollbackVolume(String volumeId, String snapshotId)
          Rollback the volume with the specified volume snapshot.
 void startInstance(StartInstanceRequest request)
          Starting the instance owned by the user.
 void startInstance(String instanceId)
          Starting the instance owned by the user.
 void stopInstance(StopInstanceRequest request)
          Stopping the instance owned by the user.
 void stopInstance(String instanceId)
          Stopping the instance owned by the user.
 void stopInstance(String instanceId, boolean forceStop)
          Stopping the instance owned by the user.
 void unbindInstanceFromSecurityGroup(String instanceId, String securityGroupId)
          Unbinding the instance from securitygroup.
 void unbindInstanceFromSecurityGroup(UnbindSecurityGroupRequest request)
          Unbinding the instance from securitygroup.
 
Methods inherited from class com.baidubce.AbstractBceClient
getClient, getEndpoint, getServiceId, invokeHttpClient, isRegionSupported, setClient, shutdown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BccClient

public BccClient()
Constructs a new client to invoke service methods on bcc.


BccClient

public BccClient(BceClientConfiguration clientConfiguration)
Constructs a new bcc client using the client configuration to access bcc.

Parameters:
clientConfiguration - The bcc client configuration options controlling how this client connects to bcc (e.g. proxy settings, retry counts, etc).
Method Detail

createInstance

public CreateInstanceResponse createInstance(CreateInstanceRequest request)
                                      throws BceClientException
Create a bcc Instance with the specified options, see all the supported instance in InstanceType You must fill the field of clientToken,which is especially for keeping idempotent. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
request - The request containing all options for creating a bcc Instance.
Returns:
List of instanceId newly created
Throws:
BceClientException

listInstances

public ListInstancesResponse listInstances()
Return a list of instances owned by the authenticated user.

Returns:
The response containing a list of instances owned by the authenticated user.

listInstances

public ListInstancesResponse listInstances(ListInstancesRequest request)
Return a list of instances owned by the authenticated user.

Parameters:
request - The request containing all options for listing own's bcc Instance.
Returns:
The response containing a list of instances owned by the authenticated user.

getInstance

public GetInstanceResponse getInstance(String instanceId)
Get the detail information of specified instance.

Parameters:
instanceId - The id of the instance.
Returns:
A instance detail model for the instanceId.

getInstance

public GetInstanceResponse getInstance(GetInstanceRequest request)
Get the detail information of specified instance.

Parameters:
request - The request containing all options for getting the instance info.
Returns:
A instance detail model for the instanceId.

startInstance

public void startInstance(String instanceId)
Starting the instance owned by the user. You can start the instance only when the instance is Stopped, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
instanceId - The id of the instance.

startInstance

public void startInstance(StartInstanceRequest request)
Starting the instance owned by the user. You can start the instance only when the instance is Stopped, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
request - The request containing all options for starting the instance.

stopInstance

public void stopInstance(String instanceId)
Stopping the instance owned by the user. You can stop the instance only when the instance is Running, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
instanceId - The id of the instance.

stopInstance

public void stopInstance(String instanceId,
                         boolean forceStop)
Stopping the instance owned by the user. You can stop the instance only when the instance is Running, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
instanceId - The id of the instance.
forceStop - The optional parameter to stop the instance forcibly.If true, it will stop the instance just like power off immediately and it may result in losing important data which have not been written to disk.

stopInstance

public void stopInstance(StopInstanceRequest request)
Stopping the instance owned by the user. You can stop the instance only when the instance is Running, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
request - The request containing all options for stopping the instance.

rebootInstance

public void rebootInstance(String instanceId)
Rebooting the instance owned by the user. You can reboot the instance only when the instance is Running, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
instanceId - The id of the instance.

rebootInstance

public void rebootInstance(String instanceId,
                           boolean forceStop)
Rebooting the instance owned by the user. You can reboot the instance only when the instance is Running, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
instanceId - The id of the instance.
forceStop - The option param to stop the instance forcibly.If true, it will stop the instance just like power off immediately and it may result int losing important data which have not written to disk.

rebootInstance

public void rebootInstance(RebootInstanceRequest request)
Rebooting the instance owned by the user. You can reboot the instance only when the instance is Running, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
request - The request containing all options for rebooting the instance.

modifyInstancePassword

public void modifyInstancePassword(String instanceId,
                                   String adminPass)
                            throws BceClientException
Modifying the password of the instance. You can change the instance password only when the instance is Running or Stopped , otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
instanceId - The id of the instance.
adminPass - The new password to update. The adminPass will be encrypted in AES-128 algorithm with the substring of the former 16 characters of user SecretKey.
Throws:
BceClientException

modifyInstancePassword

public void modifyInstancePassword(ModifyInstancePasswordRequest request)
                            throws BceClientException
Modifying the password of the instance. You can reboot the instance only when the instance is Running or Stopped , otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
request - The request containing all options for modifying the instance password.
Throws:
BceClientException

modifyInstanceAttributes

public void modifyInstanceAttributes(ModifyInstanceAttributesRequest request)
Modifying the special attribute to new value of the instance. You can reboot the instance only when the instance is Running or Stopped , otherwise,it's will get 409 errorCode.

Parameters:
request - The request containing all options for modifying the instance attribute.

rebuildInstance

public void rebuildInstance(String instanceId,
                            String imageId,
                            String adminPass)
                     throws BceClientException
Rebuilding the instance owned by the user. After rebuilding the instance, all of snapshots created from original instance system disk will be deleted, all of customized images will be saved for using in the future. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
instanceId - The id of the instance.
imageId - The id of the image which is used to rebuild the instance.
adminPass - The admin password to login the instance. The admin password will be encrypted in AES-128 algorithm with the substring of the former 16 characters of user SecretKey. See more detail on BCE API doc
Throws:
BceClientException

rebuildInstance

public void rebuildInstance(RebuildInstanceRequest request)
                     throws BceClientException
Rebuilding the instance owned by the user. After rebuilding the instance, all of snapshots created from original instance system disk will be deleted, all of customized images created from original instance system disk will be saved. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
request - The request containing all options for rebuilding the instance.
Throws:
BceClientException

releaseInstance

public void releaseInstance(String instanceId)
Releasing the instance owned by the user. Only the Postpaid instance or Prepaid which is expired can be released. After releasing the instance, all of the data will be deleted. all of volumes attached will be auto detached, but the volume snapshots will be saved. all of snapshots created from original instance system disk will be deleted, all of customized images created from original instance system disk will be reserved.

Parameters:
instanceId - The id of the instance.

releaseInstance

public void releaseInstance(ReleaseInstanceRequest request)
Releasing the instance owned by the user. Only the Postpaid instance or Prepaid which is expired can be released. After releasing the instance, all of the data will be deleted. all of volumes attached will be detached,but the volume snapshots will be saved. all of snapshots created from original instance system disk will be deleted, all of customized images created from original instance system disk will be reserved.

Parameters:
request - The request containing all options for releasing the instance.

resizeInstance

public void resizeInstance(ResizeInstanceRequest request)
Resizing the instance owned by the user. The Prepaid instance can not be downgrade. Only the Running/Stopped instance can be resized,otherwise,it's will get 409 errorCode. After resizing the instance,it will be reboot once. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
request - The request containing all options for resizing the instance.

bindInstanceToSecurityGroup

public void bindInstanceToSecurityGroup(String instanceId,
                                        String securityGroupId)
Binding the instance to specified securitygroup.

Parameters:
instanceId - The id of the instance.
securityGroupId - The id of the securitygroup.

bindInstanceToSecurityGroup

public void bindInstanceToSecurityGroup(BindSecurityGroupRequest request)
Binding the instance to specified securitygroup.

Parameters:
request - The request containing all options for binding the instance to specified securitygroup.

unbindInstanceFromSecurityGroup

public void unbindInstanceFromSecurityGroup(String instanceId,
                                            String securityGroupId)
Unbinding the instance from securitygroup.

Parameters:
instanceId - The id of the instance.
securityGroupId - The id of the securitygroup.

unbindInstanceFromSecurityGroup

public void unbindInstanceFromSecurityGroup(UnbindSecurityGroupRequest request)
Unbinding the instance from securitygroup.

Parameters:
request - The request containing all options for unbinding the instance from securitygroup.

getInstanceVnc

public GetInstanceVncResponse getInstanceVnc(String instanceId)
Getting the vnc url to access the instance. The vnc url can be used once.

Parameters:
instanceId - The id of the instance.

getInstanceVnc

public GetInstanceVncResponse getInstanceVnc(GetInstanceVncRequest request)
Getting the vnc url to access the instance. The vnc url can be used once.

Parameters:
request - The request containing all options for getting the vnc url.

purchaseReservedInstance

public void purchaseReservedInstance(String instanceId,
                                     int reservationLength,
                                     String reservationTimeUnit)
PurchaseReserved the instance with fixed duration. You can not purchaseReserved the instance which is resizing. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
instanceId - The id of the instance.
reservationLength - The fixed duration to purchaseReserved,available is [1,2,3,4,5,6,7,8,9,12,24,36]
reservationTimeUnit - The timeUnit to renew the instance,only support "month" now.

purchaseReservedInstance

public void purchaseReservedInstance(PurchaseReservedInstanceRequeset request)
Renewing the instance with fixed duration. You can not renew the instance which is resizing. This is an asynchronous interface, you can get the latest status by invoke getInstance(GetInstanceRequest)

Parameters:
request - The request containing all options for renewing the instance with fixed duration.

listInstanceSpecs

@Deprecated
public ListInstanceSpecsResponse listInstanceSpecs()
Deprecated. 

The interface will be deprecated in the future, we suggest to use triad (instanceType,cpuCount,memoryCapacityInGB) to specified the instance configuration. Listing all of specification for instance resource to buy. See more detail on BCE API doc

Returns:
List of specification for instance resource to buy.

listInstanceSpecs

@Deprecated
public ListInstanceSpecsResponse listInstanceSpecs(ListInstanceSpecsRequest request)
Deprecated. 

The interface will be deprecated in the future, we suggest to use triad (instanceType,cpuCount,memoryCapacityInGB) to specified the instance configuration. Listing all of specification for instance resource to buy. See more detail on BCE API doc

Parameters:
request - The request containing all options for Listing all of specification for instance resource.
Returns:
List of specification for instance resource to buy.

createVolume

public CreateVolumeResponse createVolume(CreateVolumeRequest request)
Create a volume with the specified options. You can use this method to create a new empty volume by specified options or you can create a new volume from customized volume snapshot but not system disk snapshot. By using the cdsSizeInGB parameter you can create a newly empty volume. By using snapshotId parameter to create a volume form specific snapshot.

Parameters:
request - The request containing all options for creating a volume.
Returns:
The response with list of id of volumes newly created.

listVolumes

public ListVolumesResponse listVolumes()
Listing volumes owned by the authenticated user.

Returns:
The response containing a list of volume owned by the authenticated user.

listVolumes

public ListVolumesResponse listVolumes(ListVolumesRequest request)
Listing volumes owned by the authenticated user.

Parameters:
request - The request containing all options for listing volumes owned by the authenticated user.
Returns:
The response containing a list of volume owned by the authenticated user.

getVolume

public GetVolumeResponse getVolume(String volumeId)
Get the detail information of specified volume.

Parameters:
volumeId - The id of the volume.
Returns:
The response containing the detail information of specified volume.

getVolume

public GetVolumeResponse getVolume(GetVolumeRequest request)
Get the detail information of specified volume.

Parameters:
request - The request containing all options for getting the detail information of specified volume.
Returns:
The response containing the detail information of specified volume.

attachVolume

public AttachVolumeResponse attachVolume(String volumeId,
                                         String instanceId)
Attaching the specified volume to a specified instance. You can attach the specified volume to a specified instance only when the volume is Available and the instance is Running or Stopped , otherwise,it's will get 409 errorCode.

Parameters:
volumeId - The id of the volume which will be attached to specified instance.
instanceId - The id of the instance which will be attached with a volume.
Returns:
The response containing the volume-instance attach relation.

attachVolume

public AttachVolumeResponse attachVolume(AttachVolumeRequest request)
Attaching the specified volume to a specified instance. You can attach the specified volume to a specified instance only when the volume is Available and the instance is Running or Stopped , otherwise,it's will get 409 errorCode.

Parameters:
request - The request containing all options for attaching the specified volume to a specified instance.
Returns:
The response containing the volume-instance attach relation.

detachVolume

public void detachVolume(String volumeId,
                         String instanceId)
Detaching the specified volume from a specified instance. You can detach the specified volume from a specified instance only when the instance is Running or Stopped , otherwise,it's will get 409 errorCode.

Parameters:
volumeId - The id of the volume which has been attached to specified instance.
instanceId - The id of the instance which will be detached a volume.

detachVolume

public void detachVolume(DetachVolumeRequest request)
Detaching the specified volume from a specified instance. You can detach the specified volume from a specified instance only when the instance is Running or Stopped , otherwise,it's will get 409 errorCode.

Parameters:
request - The request containing all options for detaching the specified volume from a specified instance.

releaseVolume

public void releaseVolume(String volumeId)
Releasing the specified volume owned by the user. You can release the specified volume only when the instance is among state of Available/Expired/Error, otherwise,it's will get 409 errorCode.

Parameters:
volumeId - The id of the volume which will be released.

releaseVolume

public void releaseVolume(ReleaseVolumeRequest request)
Releasing the specified volume owned by the user. You can release the specified volume only when the volume is Available/Expired/Error, otherwise,it's will get 409 errorCode.

Parameters:
request - The request containing all options for releasing the specified volume.

resizeVolume

public void resizeVolume(String volumeId,
                         int newCdsSizeInGB)
Resizing the specified volume with newly size. You can resize the specified volume only when the volume is Available, otherwise,it's will get 409 errorCode. The prepaid volume can not be downgrade.

This is an asynchronous interface, you can get the latest status by invoke getVolume(String)

Parameters:
volumeId - The id of volume which you want to resize.
newCdsSizeInGB - The new volume size you want to resize in GB.

resizeVolume

public void resizeVolume(ResizeVolumeRequest request)
Resizing the specified volume with newly size. You can resize the specified volume only when the volume is Available, otherwise,it's will get 409 errorCode. The prepaid volume can not be downgrade.

This is an asynchronous interface, you can get the latest status by invoke getVolume(String)

Parameters:
request - The request containing all options for resize the specified volume.

rollbackVolume

public void rollbackVolume(String volumeId,
                           String snapshotId)
Rollback the volume with the specified volume snapshot.

You can rollback the specified volume only when the volume is Available, otherwise,it's will get 409 errorCode.

The snapshot used to rollback must be created by the volume, otherwise,it's will get 404 errorCode.

If rolling back the system volume,the instance must be Running or Stopped, otherwise,it's will get 409 errorCode.After rolling back the volume,all the system disk data will erase.

Parameters:
volumeId - The id of volume which will be rollback.
snapshotId - The id of snapshot which will be used to rollback the volume.

rollbackVolume

public void rollbackVolume(RollbackVolumeRequest request)
Rollback the volume with the specified volume snapshot.

You can rollback the specified volume only when the volume is Available, otherwise,it's will get 409 errorCode.

The snapshot used to rollback must be created by the volume, otherwise,it's will get 404 errorCode.

If rolling back the system volume,the instance must be Running or Stopped, otherwise,it's will get 409 errorCode.After rolling back the volume,all the system disk data will erase.

Parameters:
request - The request containing all options for rolling back the specified volume.

purchaseReservedVolume

public void purchaseReservedVolume(String volumeId,
                                   int reservationLength,
                                   String reservationTimeUnit)
PurchaseReserved the instance with fixed duration. You can not purchaseReserved the instance which is resizing. This is an asynchronous interface, you can get the latest status by invoke getVolume(String)

Parameters:
volumeId - The id of volume which will be renew.
reservationLength - The fixed duration to renew,available is [1,2,3,4,5,6,7,8,9,12,24,36]
reservationTimeUnit - The timeUnit to renew the instance,only support "month" now.

purchaseReservedVolume

public void purchaseReservedVolume(PurchaseReservedVolumeRequest request)
PurchaseReserved the instance with fixed duration. You can not purchaseReserved the instance which is resizing. This is an asynchronous interface, you can get the latest status by invoke getVolume(String)

Parameters:
request - The request containing all options for renew the specified volume.

createImageFromInstance

public CreateImageResponse createImageFromInstance(String imageName,
                                                   String instanceId)
Creating a customized image from the instance..

While creating an image from an instance,the instance must be Running or Stopped, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getImage(GetImageRequest)

Parameters:
imageName - The name of image that will be created.
instanceId - The id of instance which will be used to create image.
Returns:
The response with id of image newly created.

createImageFromSnapshot

public CreateImageResponse createImageFromSnapshot(String imageName,
                                                   String snapshotId)
Creating a customized image from specified snapshot. You can create the image only from system snapshot. While creating an image from a system snapshot,the snapshot must be Available, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getImage(GetImageRequest)

Parameters:
imageName - The name of image that will be created.
snapshotId - The id of snapshot which will be used to create image.
Returns:
The response with id of image newly created.

createImage

public CreateImageResponse createImage(CreateImageRequest request)
Creating a customized image which can be used for creating instance in the future.

You can create an image from an instance or you can create from an snapshot. The parameters of instanceId and snapshotId can no be null simultaneously. when both instanceId and snapshotId are assigned,only instanceId will be used.

While creating an image from an instance,the instance must be Running or Stopped, otherwise,it's will get 409 errorCode.

You can create the image only from system snapshot. While creating an image from a system snapshot,the snapshot must be Available, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getImage(GetImageRequest)

Parameters:
request - The request containing all options for creating a new image.
Returns:
The response with id of image newly created.

listImages

public ListImagesResponse listImages()
Listing images owned by the authenticated user.

Returns:
The response with list of images.

listImages

public ListImagesResponse listImages(ListImagesRequest request)
Listing images owned by the authenticated user.

Parameters:
request - The request containing all options for listing images owned by user.
Returns:
The response with list of images.

getImage

public GetImageResponse getImage(String imageId)
Get the detail information of specified image.

Parameters:
imageId - The id of image.
Returns:
The response with the image detail information.

getImage

public GetImageResponse getImage(GetImageRequest request)
Get the detail information of specified image.

Parameters:
request - The request containing all options for getting the detail information of specified image.
Returns:
The response with the image detail information.

deleteImage

public void deleteImage(String imageId)
Deleting the specified image. Only the customized image can be deleted, otherwise,it's will get 403 errorCode.

Parameters:
imageId - The id of image.

deleteImage

public void deleteImage(DeleteImageRequest request)
Deleting the specified image. Only the customized image can be deleted, otherwise,it's will get 403 errorCode.

Parameters:
request - The request containing all options for deleting the specified image.

createSnapshot

public CreateSnapshotResponse createSnapshot(String volumeId,
                                             String snapshotName)
Creating snapshot from specified volume. You can create snapshot from system volume and CDS volume. While creating snapshot from system volume,the instance must be Running or Stopped, otherwise,it's will get 409 errorCode. While creating snapshot from CDS volume,,the volume must be InUse or Available, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getSnapshot(GetSnapshotRequest)

Parameters:
volumeId - The id of volume which will be used to create snapshot.
snapshotName - The name of snapshot will be created.
Returns:
The response with the id of snapshot created.

createSnapshot

public CreateSnapshotResponse createSnapshot(String volumeId,
                                             String snapshotName,
                                             String desc)
Creating snapshot from specified volume. You can create snapshot from system volume and CDS volume. While creating snapshot from system volume,the instance must be Running or Stopped, otherwise,it's will get 409 errorCode. While creating snapshot from CDS volume,,the volume must be InUs or Available, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getSnapshot(GetSnapshotRequest)

Parameters:
volumeId - The id of volume which will be used to create snapshot.
snapshotName - The name of snapshot will be created.
desc - The optional parameter to describe the newly created snapshot.
Returns:
The response with the id of snapshot created.

createSnapshot

public CreateSnapshotResponse createSnapshot(CreateSnapshotRequest request)
Creating snapshot from specified volume. You can create snapshot from system volume and CDS volume. While creating snapshot from system volume,the instance must be Running or Stopped, otherwise,it's will get 409 errorCode. While creating snapshot from CDS volume,,the volume must be InUs or Available, otherwise,it's will get 409 errorCode. This is an asynchronous interface, you can get the latest status by invoke getSnapshot(GetSnapshotRequest)

Parameters:
request - The request containing all options for creating a new snapshot.
Returns:
The response with the id of snapshot created.

listSnapshots

public ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)
Listing snapshots owned by the authenticated user.

Parameters:
request - The request containing all options for listing snapshot.
Returns:
The response contains a list of snapshots owned by the user.

getSnapshot

public GetSnapshotResponse getSnapshot(String snapshotId)
Get the detail information of specified snapshot.

Parameters:
snapshotId - The id of snapshot.
Returns:
The response with the snapshot detail information.

getSnapshot

public GetSnapshotResponse getSnapshot(GetSnapshotRequest request)
Getting the detail information of specified snapshot.

Parameters:
request - The request containing all options for getting the detail information of specified snapshot.
Returns:
The response with the snapshot detail information.

deleteSnapshot

public void deleteSnapshot(String snapshotId)
Deleting the specified snapshot. Only when the snapshot is CreatedFailed or Available,the specified snapshot can be deleted. otherwise,it's will get 403 errorCode.

Parameters:
snapshotId - The id of snapshot.

deleteSnapshot

public void deleteSnapshot(DeleteSnapshotRequest request)
Deleting the specified snapshot. Only when the snapshot is CreatedFailed or Available,the specified snapshot can be deleted. otherwise,it's will get 403 errorCode.

Parameters:
request - The request containing all options for deleting the specified snapshot.

listSecurityGroups

public ListSecurityGroupsResponse listSecurityGroups(ListSecurityGroupsRequest request)
Listing SecurityGroup owned by the authenticated user.

Parameters:
request - The request containing all options for listing SecurityGroup owned by user.
Returns:
The response with list of SecurityGroup which contains SecurityGroup rules owned by user.

createSecurityGroup

public CreateSecurityGroupResponse createSecurityGroup(CreateSecurityGroupRequest request)
Creating a newly SecurityGroup with specified rules.

Parameters:
request - The request containing all options for creating a new SecurityGroup.
Returns:
The response with the id of SecurityGroup that was created newly.

authorizeSecurityGroupRule

public void authorizeSecurityGroupRule(SecurityGroupRuleOperateRequest request)
authorizing a security group rule to a specified security group

Parameters:
request - The request containing all options for authorizing security group rule

revokeSecurityGroupRule

public void revokeSecurityGroupRule(SecurityGroupRuleOperateRequest request)
revoking a security group rule from the specified security group

Parameters:
request - The request containing all options for revoking security group rule

deleteSecurityGroup

public void deleteSecurityGroup(String securityGroupId)
Deleting the specified SecurityGroup.

Parameters:
securityGroupId - The id of SecurityGroup that will be deleted.

deleteSecurityGroup

public void deleteSecurityGroup(DeleteSecurityGroupRequest request)
Deleting the specified SecurityGroup.

Parameters:
request - The request containing all options for deleting the specified SecurityGroup owned by user.

listZones

public ListZonesResponse listZones()
listing zones within current region

Returns:
The response with list of zones

listZones

public ListZonesResponse listZones(AbstractBceRequest request)
listing zones within current region

Parameters:
request - use withRequestCredentials
Returns:
The response with list of zones


Copyright © 2018. All rights reserved.