CreateServiceInstance - Compute Nest - Alibaba Cloud Documentation Center

You can create and deploy a service instance by specifying parameters such as the region ID, service ID, and service version.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

computenestsupplier:CreateServiceInstance

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. Valid values: cn-hangzhou: China (Hangzhou) ap-southeast-1: Singapore	cn-hangzhou
Name	string	No	The name of the service instance. The name must meet the following requirements: It can be up to 64 characters in length. It must start with a letter or a digit and can contain letters, digits, hyphens (-), and underscores (_).	TestName
ServiceId	string	Yes	The ID of the service.	service-0e6fca6a51a54420****
ServiceVersion	string	No	The version of the service.	1
Parameters	object	No	The parameters used to deploy the service instance. Note If the service instance includes information about the deployment region, specify that information in the deployment parameters.	{"NodeCount": 3, "SystemDiskSize": 40, "InstancePassword": "******"}
ClientToken	string	No	A client token to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The token can be up to 64 characters in length and can contain only ASCII characters.	123e4567-e89b-12d3-a456-426655440000
TemplateName	string	No	The name of the template. Specify this parameter if the service supports multiple templates.	模板1
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzuqyxxxxxx
UserId	string	No	The ID of the user.	1563457855xxxxxx
Tag	array<object>	No	The custom tags.
	object	No	The custom tags.
Key	string	No	The key of the tag.	key1
Value	string	No	The value of the tag.	value1
SpecificationName	string	No	The name of the specification package.	套餐一
DryRun	boolean	No	Specifies whether to perform a dry run. A dry run checks for permissions and instance status. Valid values: true: The system checks the request but does not create the service instance. false: The system sends the request. If the request passes the check, the service instance is created.	false
EndTime	string	No	The time when the service instance is released. Note Only service providers can set this parameter for their own service instances in managed scenarios.	2023-12-12T03:13:05Z

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the service instance. Valid values: Created: The service instance is created. Deploying: The service instance is being deployed. DeployedFailed: The service instance failed to be deployed. Deployed: The service instance is deployed. Upgrading: The service instance is being upgraded. Deleting: The service instance is being deleted. Deleted: The service instance is deleted. DeletedFailed: The service instance failed to be deleted.	Created
RequestId	string	The ID of the request.	4DB0F536-B3BE-4F0D-BD29-E83FB56D****
ServiceInstanceId	string	The ID of the service instance.	si-d6ab3a63ccbb4b17****

Examples

Success response

JSON format

{
  "Status": "Created",
  "RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D****",
  "ServiceInstanceId": "si-d6ab3a63ccbb4b17****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.