CreateServiceInstance - Compute Nest - Alibaba Cloud Documentation Center

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.

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

computenest:CreateServiceInstance

create

*ServiceInstance

acs:computenest:{#regionId}:{#accountId}:serviceinstance/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. 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: The name 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 service ID.	service-0e6fca6a51a54420****
ServiceVersion	string	No	The service version.	1
Parameters	object	No	The parameters for deploying the user instance. Note If the service instance contains deployment region information, you must specify the region in the deployment parameters.	{ "RegionId": "cn-hangzhou" "NodeCount": 3, "SystemDiskSize": 40, "InstancePassword": "******" }
ClientToken	string	No	A client-generated, unique token that ensures the idempotence of the request. The token can contain only ASCII characters and cannot exceed 64 characters in length.	123e4567-e89b-12d3-a456-426655440000
EnableInstanceOps	boolean	No	Indicates whether the service instance has the O&M feature. Valid values: true: The service instance has the O&M feature. false: The service instance does not have the O&M feature.	true
TemplateName	string	No	The template name. You must specify this parameter if the service supports multiple templates.	模板1
OperationMetadata	object	No	The O&M configuration.
StartTime	string	No	The start time of the O&M window. This parameter is valid only in managed O&M mode.	2021-12-29T06:48:56Z
EndTime	string	No	The end time of the O&M window. This parameter is valid only in managed O&M mode.	2022-01-28T06:48:56Z
Resources	string	No	The list of imported resources.	{ "RegionId": "cn-hangzhou", "Type": "ResourceIds", "ResourceIds": { "ALIYUN::ECS::INSTANCE": ["i-xxx", "i-yyy"], "ALIYUN::RDS::INSTANCE": ["rm-xxx", "rm-yyy"], "ALIYUN::VPC::VPC": ["vpc-xxx", "vpc-yyy"], "ALIYUN::SLB::INSTANCE": ["lb-xxx", "lb-yyy"] } }
ServiceInstanceId	string	No	The ID of the imported service instance.	si-d6ab3a63ccbb4b17****
ExtraInfo	string	No	Additional information about the managed O&M service.	```json { "vncInfo": [ { "instanceId": "i-001", "username": "admin", "password": "****", "vncPassword": "****" } ] } ```
ResourceGroupId	string	No	The resource group ID.	rg-bp67acfmxazb4p****
ContactGroup	string	No	The CloudMonitor alert contact group that receives alerts.	云账号报警联系人
TrialType	string	No	The type of the service instance. Valid values: Trial: The service instance supports trial. NotTrial: The service instance does not support trial.	Trial
Tag	array<object>	No	The custom tags.
	object	No	The custom tags.
Key	string	No	The tag key.	key1
Value	string	No	The tag value.	value1
SpecificationName	string	No	The name of the specification package.	套餐一
DryRun	boolean	No	Indicates whether to perform a dry run for the request. The dry run checks for permissions and instance status. Valid values: true: Sends the request without creating the service instance. false: Sends the request and creates the service instance after the check is passed.	false
SpecificationCode	string	No	The commodity specification code.	yuncode5425200001
EnableUserPrometheus	boolean	No	Indicates whether to enable Prometheus monitoring. Valid values: true: Enable. false: Disable.	true
Commodity	object	No	The information about the Alibaba Cloud Marketplace purchase order. You do not need to specify this parameter if the service is not listed in Alibaba Cloud Marketplace or if you use the pay-as-you-go billing method.
PayPeriodUnit	string	No	The unit of the subscription duration. Valid values: Year: Year. Month: Month. Day: Day.	Year
PayPeriod	integer	No	The subscription duration.	1
AutoRenew	boolean	No	Indicates whether to enable auto-renewal. Valid values: true: Enable. false: Disable.	false
AutoPay	boolean	No	Indicates whether to enable automatic payment for the order. Valid values: true: Enable automatic payment. false: Disable automatic payment.	false
CouponId	string	No	The coupon ID.	302070970220
QuotationId	string	No	The ID of the private offer in Alibaba Cloud Marketplace.	xxxx-xxxx-xxxx-xxxx
ResourceAutoPay	boolean	No	Indicates whether to automatically deduct the payment from your account balance. Valid values: true: Enable automatic payment. false: Disable automatic payment.	true
ServiceInstanceId	string	No	The ID of the service instance to convert to a paid instance.	si-d32fbcef30664721b785

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 request ID.	4DB0F536-B3BE-4F0D-BD29-E83FB56D****
ServiceInstanceId	string	The service instance ID.	si-d6ab3a63ccbb4b17****
MarketInstanceId	string	The ID of the Alibaba Cloud Marketplace instance.	786***45
OrderId	string	The order ID.	2306175xxxxxxxx

Examples

Success response

JSON format

{
  "Status": "Created",
  "RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D****",
  "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "MarketInstanceId": "786***45",
  "OrderId": "2306175xxxxxxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.