1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
This API has been discontinued for maintenance from April 14, 2022.
This API (SwitchParameterRunInstances) is used to create one or more instances with a specified configuration, supporting parameter conversion.
- After an instance is successfully created, it will automatically start up, and the Instance Status will change to Running.
- The purchase of prepaid instances will deduct the amount required for the instance purchase in advance. The purchase of pay-per-hour postpaid instances will freeze the amount required for the instance purchase within 1 hour in advance. Make sure your account balance is sufficient before calling this API.
- This API is an asynchronous API. After the creation request is successfully sent, a list of instance IDs will be returned. At this point, the creation of the instance is not immediately completed. During this period, the instance status will be Preparing. You can query the status of the corresponding instance by calling the API DescribeInstancesStatus to determine whether the production ultimately succeeded. If the instance status changes from Preparing to Running, it indicates that the instance is successfully created.
Default interface request rate limit: 10 times per second.
Interface update time: 2022-11-30 07:47:38.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: SwitchParameterRunInstances |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| HostName | No | No | String | 1 Example: alice |
| ClientToken | No | No | String | 1 Example: 98114f60-c600-4fe4-84a4-f9b303d11fe6 |
| Placement | Yes | No | Placement | 1 Example:View |
| InstanceChargePrepaid | No | No | InstanceChargePrepaid | 1 Example:View |
| InstanceChargeType | No | No | String | 1 Example: PREPAID |
| InstanceType | No | No | String | 1 Example: S1.SMALL1 |
| ImageId | Yes | No | String | 1 Example: img-6mre94jv |
| SystemDisk | No | No | SystemDisk | 1 Example:View |
| DataDisks | No | No | Array of DataDisk | 1 Example:View |
| VirtualPrivateCloud | No | No | VirtualPrivateCloud | 1 Example:View |
| InternetAccessible | No | No | InternetAccessible | 1 Example:View |
| InstanceCount | No | No | Int64 | 1 Example: 1 |
| InstanceName | No | No | String | 1 Example: alice-1 |
| LoginSettings | No | No | LoginSettings | 1 Example:View |
| SecurityGroupIds | No | No | Array of String | 1 Example: ["sec-61dyt49h"] |
| EnhancedService | No | No | EnhancedService | 1 Example:View |
| DryRun | No | No | Bool | 1 Example: true |
| UserData | No | No | String | 1 Example: SKADAFKASPOASDASFOSAC== |
| AvailableZone | No | No | String | 1 Example: region1 |
| PurchaseSource | No | No | String | 1 Example: MC |
| DisasterRecoverGroupIds | No | No | Array of String | 1 Example: ["ps-l86ok62z"] |
| DesAction | No | No | String | 1 Example: GetRecycleInfo |
| ActionTimer | No | No | ActionTimer | 1 Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| InstanceOrder | InstanceOrder | Detailed information of instance order. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or not supported, etc. |
| AccountQualificationRestrictions | The requesting account did not pass the qualification audit. |
| InvalidParameterValue.Range | Invalid parameter value. The range of the parameter value is not legal. |
| InvalidInstanceName.TooLong | The string length of the specified InstanceName exceeds the limit. It should be less than or equal to 60 bytes. |
| InvalidParameterCombination | It indicates that the parameter combination is incorrect. |
| InvalidInstanceType.Malformed | The parameter format of the specified InstanceType is invalid. |
| InvalidHostId.NotFound | The specified HostId does not exist, or does not belong to the requesting account. |
| InvalidPeriod | Invalid duration. Currently, only the following durations are supported: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36], unit: months. |
| InstancesQuotaLimitExceeded | It indicates that the number of instances being created exceeds the remaining quota allowed for purchase by the account. |
| InvalidZone.MismatchRegion | The specified zone does not exist. |
| InvalidClientToken.TooLong | The string length of the specified ClientToken exceeds the limit. It should be less than or equal to 64 bytes. |
| MissingParameter | Parameters are missing. The request did not include mandatory parameters. |
| InvalidPassword | Invalid password. The specified password does not meet password complexity restrictions. For example, the password length does not meet restrictions. |
| VpcIpIsUsed | The VPC IP has already been used. |
| VpcAddrNotInSubNet | The VPC IP is not within the subnet. |
| InvalidPermission | The account does not support this operation. |