SwitchParameterRunInstances

最近更新时间: 2024-12-21 13:01:32

1. 接口描述

接口请求域名: cvm.api3.gsesgpucloud.com。

本接口自2022年4月14日起停止维护。 本接口 (SwitchParameterRunInstances) 用于创建一个或多个指定配置的实例参数转换。

  • 实例创建成功后将自动开机启动,实例状态变为“运行中”。
  • 预付费实例的购买会预先扣除本次实例购买所需金额,按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额,在调用本接口前请确保账户余额充足。
  • 本接口为异步接口,当创建请求下发成功后会返回一个实例ID列表,此时实例的创建并立即未完成。在此期间实例的状态将会处于“准备中”,可以通过调用 DescribeInstancesStatus 接口查询对应实例的状态,来判断生产有没有最终成功。如果实例的状态由“准备中”变为“运行中”,则为创建成功。

默认接口请求频率限制:10次/秒。

接口更新时间:2022-11-29 15: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
示例值: chongqing
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 账户不支持该操作。