1. 接口描述
接口请求域名： cvm.api3.fincloud.tencent.cn。
本接口自2022年4月14日起停止维护。
本接口 (SwitchParameterRunInstances) 用于创建一个或多个指定配置的实例参数转换。
- 实例创建成功后将自动开机启动，实例状态变为“运行中”。
- 预付费实例的购买会预先扣除本次实例购买所需金额，按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额，在调用本接口前请确保账户余额充足。
- 本接口为异步接口，当创建请求下发成功后会返回一个实例
ID列表，此时实例的创建并立即未完成。在此期间实例的状态将会处于“准备中”，可以通过调用 DescribeInstancesStatus 接口查询对应实例的状态，来判断生产有没有最终成功。如果实例的状态由“准备中”变为“运行中”，则为创建成功。
默认接口请求频率限制：10次/秒。
接口更新时间：2022-11-30 07:47:38。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：SwitchParameterRunInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| HostName | 否 | 否 | String | 1 示例值： alice |
| ClientToken | 否 | 否 | String | 1 示例值： 98114f60-c600-4fe4-84a4-f9b303d11fe6 |
| Placement | 是 | 否 | Placement | 1 示例值：查看 |
| InstanceChargePrepaid | 否 | 否 | InstanceChargePrepaid | 1 示例值：查看 |
| InstanceChargeType | 否 | 否 | String | 1 示例值： PREPAID |
| InstanceType | 否 | 否 | String | 1 示例值： S1.SMALL1 |
| ImageId | 是 | 否 | String | 1 示例值： img-6mre94jv |
| SystemDisk | 否 | 否 | SystemDisk | 1 示例值：查看 |
| DataDisks | 否 | 否 | Array of DataDisk | 1 示例值：查看 |
| VirtualPrivateCloud | 否 | 否 | VirtualPrivateCloud | 1 示例值：查看 |
| InternetAccessible | 否 | 否 | InternetAccessible | 1 示例值：查看 |
| InstanceCount | 否 | 否 | Int64 | 1 示例值： 1 |
| InstanceName | 否 | 否 | String | 1 示例值： alice-1 |
| LoginSettings | 否 | 否 | LoginSettings | 1 示例值：查看 |
| SecurityGroupIds | 否 | 否 | Array of String | 1 示例值： ["sec-61dyt49h"] |
| EnhancedService | 否 | 否 | EnhancedService | 1 示例值：查看 |
| DryRun | 否 | 否 | Bool | 1 示例值： true |
| UserData | 否 | 否 | String | 1 示例值： SKADAFKASPOASDASFOSAC== |
| AvailableZone | 否 | 否 | String | 1 示例值： region1 |
| PurchaseSource | 否 | 否 | String | 1 示例值： MC |
| DisasterRecoverGroupIds | 否 | 否 | Array of String | 1 示例值： ["ps-l86ok62z"] |
| DesAction | 否 | 否 | String | 1 示例值： GetRecycleInfo |
| ActionTimer | 否 | 否 | ActionTimer | 1 示例值：查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceOrder | InstanceOrder | 实例订单详情信息。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
| AccountQualificationRestrictions | 该请求账户未通过资格审计。 |
| InvalidParameterValue.Range | 无效参数值。参数值取值范围不合法。 |
| InvalidInstanceName.TooLong | 指定的InstanceName字符串长度超出限制，必须小于等于60字节。 |
| InvalidParameterCombination | 表示参数组合不正确。 |
| InvalidInstanceType.Malformed | 指定InstanceType参数格式不合法。 |
| InvalidHostId.NotFound | 指定的HostId不存在，或不属于该请求账号所有。 |
| InvalidPeriod | 无效时长。目前只支持时长：[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]，单位：月。 |
| InstancesQuotaLimitExceeded | 表示当前创建的实例个数超过了该账户允许购买的剩余配额数。 |
| InvalidZone.MismatchRegion | 指定的zone不存在。 |
| InvalidClientToken.TooLong | 指定的ClientToken字符串长度超出限制，必须小于等于64字节。 |
| MissingParameter | 参数缺失。请求没有带必选参数。 |
| InvalidPassword | 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。 |
| VpcIpIsUsed | 私有网络ip已经被使用。 |
| VpcAddrNotInSubNet | 私有网络ip不在子网内。 |
| InvalidPermission | 账户不支持该操作。 |
5. 示例
示例1 创建一个或多个指定配置的实例参数转换
本示例用于转换创建一个或多个指定配置的实例的参数。
输入示例
https://cvm.api3.fincloud.tencent.cn/?Action=SwitchParameterRunInstances
&Placement.Zone=ap-region1-2
&ImageId=img-6mre94jv
&InstanceChargeType=PREPAID
&InstanceChargePrepaid.Period=1
&<公共请求参数>
输出示例
{
"Response": {
"InstanceOrder": {
"appId": 1254254149,
"uin": "100001298535",
"ownerUin": "100001298535",
"autoVoucher": 1,
"goods": [
{
"goodsNum": 1,
"zoneId": 100002,
"projectId": 0,
"regionId": 1,
"payMode": 1,
"goodsCategoryId": 100019,
"autoVoucher": 1,
"goodsDetail": {
"alias": "未命名",
"transactionId": "9c37c4ce-ff60-4ffd-95d7-763e02782bed",
"action": "RunInstances",
"storageBlock": 0,
"timeUnit": "m",
"timeSpan": 1,
"isWinOs": 0,
"type": "VSELF",
"imageId": "img-6mre94jv",
"imageProductCode": "image-zero",
"bandwidth": 0,
"cpu": 1,
"mem": 1,
"wanIp": 0,
"rootType": 1,
"diskType": 1,
"cvmPayMode": 1,
"networkPayMode": 1,
"agentList": {
"security": 1,
"monitor": 1
},
"hasOnion": true,
"curDeadline": "0000-00-00",
"purchaseSource": "cloudApi",
"payment": {
"goodsNum": 1,
"timeUnit": "m",
"cvmPayMode": 1,
"timeSpan": 1,
"networkPayMode": 1
},
"autoRenewFlag": 0,
"location": {
"regionId": 1,
"zoneId": 100002,
"projectId": 0
},
"compute": {
"cpu": 1,
"mem": 1
},
"diskInfo": {
"storageBlock": 0,
"root": {
"target": "xvda",
"type": 1,
"size": 50
},
"data": [
{
"type": 1,
"size": 0
}
],
"dataDiskPortable": 1
},
"network": {
"bandwidth": 0,
"wanIp": 0,
"isBandwidthPackage": 0,
"vpcId": 303071,
"subnetId": 180306
},
"image": {
"os": "coreos717.3.0x86_64",
"customId": 1,
"isCustom": 0,
"agentList": {
"security": 1,
"monitor": 1
}
},
"account": {
"alias": "未命名"
},
"productInfo": [
{
"name": "地域",
"value": "region1"
},
{
"name": "可用区",
"value": "region1二区"
},
{
"name": "机型",
"value": "系列1、标准型1核CPU、1G内存"
},
{
"name": "镜像",
"value": "CoreOS 717.3.0 64位"
},
{
"name": "存储",
"value": "系统盘（50G本地硬盘）"
},
{
"name": "网络",
"value": "私有网络"
},
{
"name": "带宽",
"value": "按带宽计费（带宽0Mbps）"
},
{
"name": "名称",
"value": "未命名"
}
],
"os": "coreos717.3.0x86_64",
"vpcId": 303071,
"subnetId": 180306,
"rootDisk": 50,
"disk": 0,
"appId": 1254254149,
"signature": "5a99cc94c1e238cc20e64d5162046a0b"
}
}
]
},
"RequestId": "d40ee0cc-ee0a-4a6a-b5af-ec2bf762b64f"
}
}