API overview
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (ComputeNest/2021-06-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Service
|
API |
Title |
Description |
| GetService | GetService | Retrieves the details of a specified service. |
| GetServiceTemplateParameterConstraints | GetServiceTemplateParameterConstraints | Queries the parameter constraints for a Resource Orchestration Service (ROS) template in a specified region using the template name and service ID. |
| GetServiceEstimateCost | GetServiceEstimateCost | Queries the estimated cost of creating a service instance. |
| GenerateServicePolicy | GenerateServicePolicy | Check for missing access policies before you create a service instance. |
| GetServiceProvisions | GetServiceProvisions | Retrieves the provisions of a service, such as its activation status and service roles. |
| ListServices | ListServices | Queries information about your services. |
Service Category
|
API |
Title |
Description |
| ListServiceCategories | ListServiceCategories | Lists the available service categories. |
Service Instance
|
API |
Title |
Description |
| UpgradeServiceInstance | UpgradeServiceInstance | Upgrades a service instance to a new version. |
| CreateServiceInstance | CreateServiceInstance | Creates and deploys a service instance in Compute Nest by specifying parameters such as a region ID, a service instance name, and a service ID. |
| GetServiceInstance | GetServiceInstance | Queries the details of a service instance by its region ID, service instance ID, or Alibaba Cloud Marketplace instance ID. The returned information includes the service status, template name, and a list of resources. |
| ContinueDeployServiceInstance | ContinueDeployServiceInstance | If a service instance fails to deploy, you can call the ContinueDeployServiceInstance operation to resume the deployment. |
| DeleteServiceInstances | DeleteServiceInstances | Deletes the specified service instances in a region. |
| ListServiceInstanceLogs | ListServiceInstanceLogs | Retrieves the deployment and upgrade logs of a service instance. |
| ListServiceInstanceResources | ListServiceInstanceResources | Queries the resources of a service instance based on parameters such as the service instance ID, Alibaba Cloud Resource Name (ARN), and region ID. |
| ListServiceInstances | ListServiceInstances | Queries service instances for your account in a specified region. |
| StartServiceInstance | StartServiceInstance | Call the StartServiceInstance operation to start a service instance that is in the Stopped or StartFailed state. |
| StopServiceInstance | StopServiceInstance | Call the StopServiceInstance operation to shut down a service instance that is in the Deployed or StopFailed state. |
| RestartServiceInstance | RestartServiceInstance | Restarts a service instance in the Deployed state. |
| UpdateServiceInstanceSpec | UpdateServiceInstanceSpec | You can call the UpdateServiceInstanceSpec operation to upgrade or downgrade a service instance if its parameters or package settings do not meet your requirements. |
| ListServiceInstanceUpgradeHistory | ListServiceInstanceUpgradeHistory | You can call ListServiceInstanceUpgradeHistory to query the upgrade history of a service instance. |
| RollbackServiceInstance | RollbackServiceInstance | Rolls back an upgraded service instance. |
| UpdateServiceInstanceAttributes | UpdateServiceInstanceAttributes | Updates the attributes of a service instance. |
| ValidateServiceInstanceName | ValidateServiceInstanceName | Validates the name of a service instance. |
Tags and resource groups
|
API |
Title |
Description |
| ListTagKeys | ListTagKeys | This operation lists existing tag keys. |
| UnTagResources | UnTagResources | Detaches tags from specified resources. |
| TagResources | TagResources | You can call TagResources to create and attach tags to multiple resources. |
| ListTagValues | ListTagValues | Lists the tag values for a specified tag key. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group for a cloud resource. |
User Information
|
API |
Title |
Description |
| UpdateUserInformation | UpdateUserInformation | The UpdateUserInformation operation updates user information. |
| GetUserInformation | GetUserInformation | Queries user information. |
Service Use Request
|
API |
Title |
Description |
| ListServiceUsages | ListServiceUsages | Queries your service usages. |
| CancelServiceUsage | CancelServiceUsage | Cancels a service usage request. |
| CreateServiceUsage | CreateServiceUsage | Creates a service usage request. |
| UpdateServiceUsage | UpdateServiceUsage | Updates the information about a service usage request. |
Other
|
API |
Title |
Description |
| DeployServiceInstance | DeployServiceInstance | Deploys a service instance. |
| DescribeRegions | DescribeRegions | Queries the available regions. |
| ListPolicies | ListPolicies | Retrieves a list of access policies. |
| GetNetworkAvailableZones | GetNetworkAvailableZones | Returns a list of available zones for a specified region. |
| RenewServiceInstanceResources | RenewServiceInstanceResources | Renews the subscription resources for a private deployment service instance. This operation supports two renewal methods: renewing all subscription resources for a service instance or renewing only specific resources. You can use only one method per request. |
| ListTagResources | ListTagResources | Queries a list of tagged resources. |
| GetServiceInstanceSubscriptionEstimateCost | GetServiceInstanceSubscriptionEstimateCost | Queries the estimated renewal cost of subscription resources in a privately deployed service instance. You can query the cost for all resources associated with a service instance ID, or for a specific set of resources. |
| ListServiceInstanceBill | ListServiceInstanceBill | Call the ListServiceInstanceBill operation to query bills for service instances. |
| CheckServiceDeployable | CheckServiceDeployable | Performs a precheck to verify that a service instance can be deployed. |
| CreateRestoreTask | CreateRestoreTask | Creates a restore job. |
| GetBackup | GetBackup | Retrieves the details of a backup. |
| ListRestoreTasks | ListRestoreTasks | Queries a list of restore jobs. |
| ListBackups | ListBackups | Queries a list of backups for Compute Nest service instances. |
| CreateBackup | CreateBackup | Creates a backup for a Compute Nest service instance. |
| DeleteBackup | DeleteBackup | Deletes a Compute Nest instance backup. |
Others
|
API |
Title |
Description |
| RenewServiceInstance | RenewServiceInstance | Renews a service instance. |