API_Overview

<table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p style="text-align: center;"><strong>API</strong></p> </td> <td> <p style="text-align: center;"><strong>Description</strong></p> </td> </tr> <tr> <td> <p>CreateImage</p> </td> <td> <p>Create image</p> <p>Create image need to get the token by logging in for authentication&nbsp; Pleaee take note that when calling interface:&nbsp;&nbsp;&nbsp; 1) there must be EBS or ECS, or throwing exception of ParameterRequiredException</p> </td> </tr> <tr> <td> <p>DeleteImage</p> </td> <td> <p>Destroy image by image id.</p> <p>Please take note to get the token by logging in for authentication before calling interface:&nbsp;&nbsp;&nbsp; 1) image that Status are Available, Unavailable, CreateFailed, DeleteFailed can be destroyed</p> </td> </tr> <tr> <td> <p>ListImages</p> </td> <td> <p>Query all the images.&nbsp;</p> <p>Please take note to get the token by logging in for authentication before calling interface: 1, the interface is executed by page query with the default page 1, 100 rows of data will be displayed in each page.</p> </td> </tr> <tr> <td> <p>ListOsMappingCsOs</p> </td> <td> <p>Query all the corresponding relations operating system mapped to CS operating system.</p> <p>Need to get the token by logging in for authentication&nbsp; List regional information by ListRegions&nbsp; Get available zone information by ListZones</p> </td> </tr> <tr> <td> <p>ListOsTypes</p> </td> <td> <p>Query operating system type.</p> <p>Please take note to get the token by logging in for authentication before calling interface: 1, interface is used by page query, the default page is 1, 10 rows of data will be displayed each page sorted in ascending order. 2, if the page is over 3000, then set the page size to 3000</p> </td> </tr> <tr> <td> <p>ManualUploadImage</p> </td> <td> <p>Manual upload image.</p> <p>Need to get the token by logging in for authentication. Query all the image by ListImages interface.</p> </td> </tr> <tr> <td> <p>ModifyImageAttribute</p> </td> <td> <p>Modify image properties according to image id.&nbsp; Need to get the token by logging in for authentication. Query all the image by ListImages interface</p> </td> </tr> <tr> <td> <p>BatchDestroyInstance</p> </td> <td> <p>To destroy ECS by batch</p> </td> </tr> <tr> <td> <p>BatchStartInstance</p> </td> <td> <p>To start ECS by batch</p> </td> </tr> <tr> <td> <p>BatchStopInstance</p> </td> <td> <p>To stop ECS by batch</p> </td> </tr> <tr> <td> <p>CheckInstanceName</p> </td> <td> <p>Check the uniqueness of users&rsquo; customized ECS name</p> </td> </tr> <tr> <td> <p>DestroyInstance</p> </td> <td> <p>Destroy ECS</p> </td> </tr> <tr> <td> <p>DowngradeInstance</p> </td> <td> <p>Downgrade ECS</p> </td> </tr> <tr> <td> <p>GetAllEcsSummary</p> </td> <td> <p>Get all ECS summary</p> </td> </tr> <tr> <td> <p>Get ECS summary</p> </td> <td> <p>Get ECS summary</p> </td> </tr> <tr> <td> <p>GetInstance</p> </td> <td> <p>Get ECS information</p> </td> </tr> <tr> <td> <p>GetInstancePassword</p> </td> <td> <p>Get ECS password</p> </td> </tr> <tr> <td> <p>ListAbleKeyRelateInstancs</p> </td> <td> <p>List available key related ECS</p> </td> </tr> <tr> <td> <p>ListExpiredInstance</p> </td> <td> <p>List Expired Instance</p> </td> </tr> <tr> <td> <p>ListExpiringInstance</p> </td> <td> <p>List Expiring Instance</p> </td> </tr> <tr> <td> <p>ListInstanceDependencies</p> </td> <td> <p>List Instance Dependencies</p> </td> </tr> <tr> <td> <p>ListInstanceTypes</p> </td> <td> <p>List ECS types</p> </td> </tr> <tr> <td> <p>ListInstances</p> </td> <td> <p>List ECS instances</p> </td> </tr> <tr> <td> <p>ListKeyRelatedInstance</p> </td> <td> <p>List ECS can destroy bound secret key</p> </td> </tr> <tr> <td> <p>ModifyChargeType</p> </td> <td> <p>Modify to change type to monthly payment</p> </td> </tr> <tr> <td> <p>ModifyInstanceAttribute</p> </td> <td> <p>Modify ECS attribute</p> </td> </tr> <tr> <td> <p>OpenConsole</p> </td> <td> <p>Open console</p> </td> </tr> <tr> <td> <p>RenewInstance</p> </td> <td> <p>ECS charges renewal</p> </td> </tr> <tr> <td> <p>ResetPasswordForInstance</p> </td> <td> <p>Reset ECS password</p> </td> </tr> <tr> <td> <p>RestartInstance</p> </td> <td> <p>Restart ECS</p> </td> </tr> <tr> <td> <p>RestoreInstance</p> </td> <td> <p>Restore ECS</p> </td> </tr> <tr> <td> <p>RunInstances</p> </td> <td> <p>Run ECS</p> </td> </tr> <tr> <td> <p>StartInstance</p> </td> <td> <p>Start ECS</p> </td> </tr> <tr> <td> <p>StopInstance</p> </td> <td> <p>Stop ECS</p> </td> </tr> <tr> <td> <p>UpdateInstanceAutoRenewFlag</p> </td> <td> <p>Modify ECS charges to automatic or manual renewal. Only valid when the ECS is in monthly payment</p> </td> </tr> <tr> <td> <p>UpdateInstanceName</p> </td> <td> <p>Update user&rsquo;s customized ECS name</p> <p>Only ESC with Status of shut down can be changed.</p> </td> </tr> <tr> <td> <p>UpgradeInstance</p> </td> <td> <p>Upgraded ECS</p> </td> </tr> <tr> <td> <p>CreateKey</p> </td> <td> <p>Create secret key pair,</p> <p>Create secret key needs to get the token by logging in for authentication. Calling createKey by using corresponding DTO to create secret key. After the creation of secret key normal operations can be performed on the instance.</p> </td> </tr> <tr> <td> <p>CreateKeyRelatedInstance</p> </td> <td> <p>Create ECS related secret key pairs.</p> <p>Create ECS related secret key pairs needs to get the token by logging in for authentication. Can list associated instance by ListAbleKeyRelateInstancs interface. Need to send short message whenassociating an instance.&nbsp; When creating, it is important to note that if ECS has expired and reaches the forced shutdown time, the ECS will not be allowed to have a key pair relationship once it shut down for a month.</p> </td> </tr> <tr> <td> <p>DeleteKey</p> </td> <td> <p>Delete secret key pair.</p> <p>Delete secret key pair needs to get the token by logging in for authentication.&nbsp; Get the secret key pair by getting the id of secret key, and then calling deleteKey to delete secret key pair.&nbsp; The interface is asynchronous job creation. Check whether the deletion is successful.</p> </td> </tr> <tr> <td> <p>DeleteKeyRelatedInstance</p> </td> <td> <p>Delete ECS related secret key pair.</p> <p>Call ListKeyRelatedInstance interface to list the associated instance that can be cancelled . Deletion of ECS related secret key pair needs to get the token by logging in for authentication.</p> </td> </tr> <tr> <td> <p>ListKey</p> </td> <td> <p>Listing of tenant secret key information by page.</p> <p>Listing of tenant secret key information by page need to get the token by logging in for authentication. Please take note that when calling findAllByTenant to list information. Calling interface by using corresponding DTO: 1, the interface executed by page query with the default page 1, 1000 rows of data will be displayed in each page.</p> </td> </tr> <tr> <td> <p>AddInstanceToSecurityGroup</p> </td> <td> <p>Add ECS to security group.</p> <p>Add security group rule need to get the token by logging in for authentication. ECS information can be checked by calling ListInstances. Security group information can be checked by calling ListSecurityGroups interface.&nbsp; Please take note that when calling interfaces: 1) the security group and ECS must be in the same Internet region, or InvalidParameterException exception will be thrown. 2) security groups bound to ECS cannot exceed three, or LimitExceededException exception will be thrown.</p> </td> </tr> <tr> <td> <p>AddSecurityGroupRule</p> </td> <td> <p>Add security group rule to security group.</p> <p>Add security group rule to security group that need to get the token by logging in for authentication.&nbsp; Security group rule information can be checked by calling ListSecurityGroupRules interface.&nbsp; Security group information can be checked by calling ListSecurityGroups interface.</p> </td> </tr> <tr> <td> <p>CheckDependencyForDeleteSG</p> </td> <td> <p>Dependent resources need to be checked before deleting a security group.</p> <p>Adding security group rule needs to obtain the token by login authentication.</p> <p>DependencyExistException will be thrown if there are dependent resources.</p> </td> </tr> <tr> <td> <p>CreateSecurityGroup</p> </td> <td> <p>Creating security group needs to get the token by logging in for authentication. The interface to create the subnet is CreateSubnet.&nbsp; The interface to query subnet is ListSubnets. Please take note that when calling interface. 1) there must be at least one subnet to create security group</p> </td> </tr> <tr> <td> <p>DeleteSecurityGroup</p> </td> <td> <p>Delete security group by security group id.</p> <p>Need to get the token by logging in for authentication.&nbsp; Delete security group needs to verify whether there is resource dependence, if it is, the security group should be deleted by relieving dependent resources.</p> </td> </tr> <tr> <td> <p>ListSecurityGroupRules</p> </td> <td> <p>List security group rules</p> </td> </tr> <tr> <td> <p>ListSecurityGroups</p> </td> <td> <p>List security groups.</p> <p>Please take note that when calling interface: 1, the interface uses query by page with default page is 1, 3000 rows of data is maximum that can be displayed in each page.</p> </td> </tr> <tr> <td> <p>ModifySecurityGroupAttribute</p> </td> <td> <p>Modify security group properties by security group id.</p> <p>Security group information can be listed by calling ListSecurityGroups interface</p> </td> </tr> <tr> <td> <p>RemoveInstanceFromSecurityGroup</p> </td> <td> <p>Remove ECS from security group.</p> <p>Adding security group rules need to get the token by logging in for authentication. ECS information can be listed by calling ListInstances interface. Security group information can be listed by calling ListSecurityGroups interface</p> </td> </tr> <tr> <td> <p>RemoveSecurityGroupRule</p> </td> <td> <p>Remove security group rule by security group rules id.</p> <p>Security group rules information can be listed by ListSecurityGroupRules</p> </td> </tr> <tr> <td> <p>CreateEbsRelatedPolicy</p> </td> <td> <p>Create related policy between disk and snapshot .</p> <p>Create related policy between disk and snapshot policy need to get the token by logging in for authentication. List snapshot policy by ListAllSnapshotPolicies interface to operate related EBS.&nbsp; If the snapshot policy is null, then the exception will be thrown that snapshot policy is nonexistent. And the related disk to create the snapshot policy of disk cannot exceed 8, or it will throw exception.</p> </td> </tr> <tr> <td> <p>CreateSnapshot</p> </td> <td> <p>Create snapshot.</p> <p>Create snapshot needs to get the token by logging in for authentication.&nbsp; List snapshot by ListDisks interface and then proceed to create snapshot.&nbsp; If ECS is expired or has reached forced shut off time, once it stopped, snapshot is not allowed to create.</p> </td> </tr> <tr> <td> <p>CreateSnapshotPolicy</p> </td> <td> <p>Create snapshot policy.</p> <p>Create snapshot policy needs to get the token by logging in for authentication. Please take note that the maximum number of reserved copies cannot exceed 8 when creating snapshot policy.&nbsp; Create snapshot by createSnapshotPolicy method with corresponding DTO.</p> </td> </tr> <tr> <td> <p>DeleteEbsRelatedPolicy</p> </td> <td> <p>Delete related policy between disk and policy. &nbsp;&nbsp;&nbsp;Delete related policy between disk and policy needs to get the token by logging in for authentication.&nbsp; Delete relation by calling getDisk interface for disk details listing. Delete relation by getting snapshot policy corresponded to disk with the method of deleteEbsRelatedPolicy method The interface is asynchronous job deletion. Check whether the relation between disk and policy is successful.</p> </td> </tr> <tr> <td> <p>DeleteSnapshot</p> </td> <td> <p>Delete snapshot.</p> <p>Delete snapshot needs to get the token by logging in for authentication. &nbsp;List snapshot by ListAllSnapshots to delete. Delete snapshot by get the id of snapshot to call deleteSnapshotJob method. The interface is asynchronous job deletion. Check whether the snapshot is deleted successfully</p> </td> </tr> <tr> <td> <p>DeleteSnapshotPolicy</p> </td> <td> <p>Delete snapshot policy.</p> <p>Delete snapshot policy needs to get the token by logging in for authentication. List snapshot policy by ListAllSnapshotPolicies interface to delete.&nbsp; Pay attention to dependent resource before deleting. Need to disassociate by listing disk information through getDisk interface to delete.&nbsp; Get the id of corresponding snapshot policy, and then&nbsp; delete snapshot policy by calling deleteSnapshotPolicy</p> </td> </tr> <tr> <td> <p>GetSnapshotPolicy</p> </td> <td> <p>Get snapshot policy.</p> <p>Need to get the token by logging in for authentication.&nbsp; List snapshot policy to execute by ListAllSnapshotPolicies interface.&nbsp; List snapshot policy by the id of snapshot policy</p> </td> </tr> <tr> <td> <p>ListAllSnapshotPolicies</p> </td> <td> <p>List all snapshot policies.</p> <p>Need to get the token by logging in for authentication.&nbsp; Please take note that when calling interface: 1, the interface is executed by page query with the default page is 1, 10 rows of data will be displayed in each page.&nbsp; List all the snapshot policy by findAllByTenant method, sorting order, display amount of each page, pages displayed.</p> </td> </tr> <tr> <td> <p>ListAllSnapshots</p> </td> <td> <p>List all snapshot. &nbsp;</p> <p>List all snapshot information needs to get the token by logging in for authentication. Please take note that when calling interface: 1, the interface is executed by page query with the default page is 1, 10 rows of data will be displayed in each page.&nbsp; List all the snapshot policy by findAllByTenant method, sorting order, display amount of each page, pages displayed.</p> </td> </tr> <tr> <td> <p>ListSnapshotPolicies</p> </td> <td> <p>List snapshot policy.</p> <p>List snapshot policy needs to get the token by logging in for authentication.&nbsp; List EBS by calling GetDisk interface. Used to list associated snapshot policy. &nbsp;List snapshot policy under this disk by findRelatedPolicyByEbsId method provided by disk id.</p> </td> </tr> <tr> <td> <p>ListSnapshots</p> </td> <td> <p>List snapshot</p> <p>List snapshot policy needs to get the token by logging in for authentication.&nbsp; List EBS by calling GetDisk interface. Used to list associated snapshot policy.&nbsp; List snapshot policy under this disk by querySnapshotsPolicy method provided by disk id.</p> </td> </tr> <tr> <td> <p>ModifySnapshotAttribute</p> </td> <td> <p>Modify snapshot attribute.</p> <p>Modify snapshot properties need to get the token by logging in for authentication.&nbsp; Modify the name Description after listing snapshot by ListAllSnapshots interface.&nbsp; List corresponding snapshot by id provided, and then update snapshot properties that need to be modified.</p> </td> </tr> <tr> <td> <p>ModifySnapshotPolicyAttribute</p> </td> <td> <p>Modify snapshot policy attribute.</p> <p>Modify snapshot policy attribute needs to get the token by logging in for authentication.&nbsp; Modify snapshot policy after listing it by ListAllSnapshots interface.&nbsp; List corresponding snapshot by id provided, and then update snapshot policy properties that need to be modified.</p> </td> </tr> <tr> <td> <p>ModifySnapshotPolicyDisplayName</p> </td> <td> <p>Modify snapshot policy Description.</p> <p>Modify snapshot policy Description need to get the token by logging in for authentication.&nbsp; Modify the name Description after listing snapshot by ListAllSnapshotsPolicies interface.&nbsp; List corresponding snapshot by id provided, and then update snapshot policy Description name properties that need to be modified.</p> </td> </tr> <tr> <td> <p>RevertSnapshot</p> </td> <td> <p>Revert snapshot. &nbsp;</p> <p>Revert snapshot needs to get the token by logging in for authentication.&nbsp; List snapshot to revert snapshot by ListAllSnapshots.&nbsp; List snapshot by id and list disk by snapshot.&nbsp; Then do the judgment.&nbsp; If ECS is expired and reaches to the forced shut down time, once the monthly-paid EBS shut down, revert disk is not allowed.&nbsp; One that meet the requirement to revert need to do the revert snapshot by revertSnapshot method.&nbsp; The interface is asynchronous job revert Check whether revert snapshot is succeed</p> </td> </tr> <tr> <td> <p>ListPods</p> </td> <td> <p>List high available zone</p> </td> </tr> </tbody> </table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products