本文介绍了云服务器ECS的OpenAPI变更信息。
2024年10月
API | 变更记录 | 关联功能 |
---|
RunInstances | - 新增请求参数:
NetworkInterfaces.N.Ipv6AddressCount (邀测、可选),表示为主网卡分配的IPv6地址数量。 - 新增错误码:InvalidIpv6AddressCount.Malformed、InvalidSubnet.DisableIPv6。
| 实例 |
DescribeInstances | 新增返回参数:NetworkInterfaces 结构新增Ipv6Addresses ,表示网卡分配的IPv6地址。 |
2024年09月
API | 变更记录 | 关联功能 |
---|
StopInstance StopInstances | 修改StoppedMode 参数描述。 | 实例 |
ModifyInstanceAttribute | 修改Password 参数描述。 |
DescribeInstances | |
RunInstances | |
StartInstance | 新增错码:OperationDenied.InstanceIsSnapshotRollback、InvalidActionOrVersion。 |
DescribeInstanceTypes DescribeScheduledInstances GetScheduledInstanceLatestReleaseAt | 新增错误码:InvalidActionOrVersion。 |
ModifyInstanceChargeType | 新增错误码:QuotaExceeded.MaximumGeneralCpus、QuotaExceeded.MaximumGpuBasicNums、QuotaExceeded.MaximumHighPerformanceGpus、QuotaExceeded.MaximumLocalVolumeCpus、QuotaExceeded.MaximumReservedInstanceGeneralCpus、QuotaExceeded.MaximumReservedInstanceGpuBasicNums、QuotaExceeded.MaximumReservedInstanceHighPerformanceGpus、QuotaExceeded.MaximumReservedInstanceLocalVolumeCpus、DryRunOperation。 |
ModifyInstanceSpec | 新增错误码:QuotaExceeded.MaximumGeneralCpus、QuotaExceeded.MaximumGpuBasicNums、QuotaExceeded.MaximumHighPerformanceGpus、QuotaExceeded.MaximumLocalVolumeCpus、QuotaExceeded.MaximumReservedInstanceGeneralCpus、QuotaExceeded.MaximumReservedInstanceGpuBasicNums、QuotaExceeded.MaximumReservedInstanceHighPerformanceGpus、QuotaExceeded.MaximumReservedInstanceLocalVolumeCpus。 |
CreateScheduledInstances | |
ModifyReservedInstances PurchaseReservedInstances | 新增请求参数(可选):Description ,表示预留实例券的描述信息。 新增错误码:QuotaExceeded.MaximumGeneralCpus、QuotaExceeded.MaximumGpuBasicNums、QuotaExceeded.MaximumHighPerformanceGpus、QuotaExceeded.MaximumLocalVolumeCpus、QuotaExceeded.MaximumReservedInstanceGeneralCpus、QuotaExceeded.MaximumReservedInstanceGpuBasicNums、QuotaExceeded.MaximumReservedInstanceHighPerformanceGpus、QuotaExceeded.MaximumReservedInstanceLocalVolumeCpus、InvalidInstanceDescription.Malformed。
|
DescribeReservedInstances | 新增返回参数:Description ,表示预留实例券的描述信息。 |
CopyImage | 新增错误码: 412,OperationDenied.SnapshotServiceUnavailable | 镜像 |
CreateImage | 新增错误码: 400,LimitExceeded.MaximumSnapshotCount |
ImportImage | 新增错误码: 412,OperationDenied.SnapshotServiceUnavailable |
DescribeImages | 新增返回参数: DescribeImageNextTokenResponse.Images结构,新增: |
2024年08月
2024年07月
API | 发布时间 | 变更记录 | 关联功能 |
---|
RunInstances | 2024-07-30 | 新增错误码:LimitExceeded.MaximumSecurityProtectionTypes、OperationDenied.PurchaseLimited、InvalidTenancy.InstanceTypeIdMismatch。 | 实例 |
ModifyInstanceSpec | 新增错误码:LimitExceeded.MaximumVolumes、OperationDenied.InstanceHasUnfinishedOrder、OperationDenied.InstanceIsSnapshotRollback。 |
DeleteInstance | 新增错误码:OperationDenied.InstanceIsSnapshotRollback。 |
ModifyInstanceVpcAttribute | 新增错误码:Insufficient.Balance、OperationDenied.SpecifiedSecurityGroupNotAuthorized。 |
ModifyReservedInstances | 新增错误码:InvalidReservedInstance.ProjectMismatch。 |
CreateScheduledInstances | 新增错误码:InvalidImageForCreateScheduledInstance.UnSupported、LimitExceeded.MaximumSecurityProtectionTypes、OperationDenied.ImageNotSnapshot、Insufficient.ScheduledInstanceDeliveryCapacity、Insufficient.VolumePoolCapacity。 修改错误码Insufficient.ScheduledInstanceCapacity描述。
|
DescribeInstanceTypes | - 新增请求参数:
ImageId 参数,表示查询该镜像可创建的实例规格。
- 新增错误码:
|
DescribeImages | 新增返回参数:
Images 结构新增LicenseType 参数,表示惊喜许可证类型。 | 镜像 |
CreateImage | - 新增请求参数:
新增CreateWholeImage 参数,表示否是创建整机镜像。 - 新增错误码:
400,InvalidVolumeTypeForCreateImage.Unsupported
|
ImportImage | - 新增请求参数:
新增LicenseType 参数,表示镜像许可证类型。 - 新增错误码:
400,InvalidImageFormat.Malformed
|
CreateSubscription | 请求参数新增取值: 请求参数EventTypes.N 中增加取值:SystemFailure.Stop.Succeeded,表示系统故障,导致实例停止:执行成功。 | 事件监控 |
ModifySubscriptionEventTypes | 请求参数新增取值: 请求参数EventTypes.N 中增加取值:SystemFailure.Stop.Succeeded,表示系统故障,导致实例停止:执行成功。 |
2024年05月
2024年03月
API | 发布时间 | 变更记录 | 关联功能 |
---|
RunInstances | 2024-03-22 | 新增请求参数(可选): EipAddress.ReleaseWithInstance ,表示创建实例时是否选择公网IP随实例释放。
Volumes.N.SnapshotId ,表示使用快照创建云盘,仅支持创建数据盘。
EipAddress.SecurityProtectionInstanceId 、EipAddress.SecurityProtectionTypes.N ,表示公网IP的安全防护属性。
新增错误码: InvalidSnapshotStatus InvalidVolumeTypeForSnapshot.UnSupported InvalidSnapshot.NotFound InvalidSnapshotZoneId.Mismatch InvalidReleaseWithInstance.ChargeTypeMismatch LimitExceeded.MaximumEipBandwidth InvalidSecurityProtectionTypes.Malformed InvalidSecurityProtectionTypes.BandwidthPackageIdMismatch OperationDenied.SpecifiedSecurityGroupNotAuthorized
| 实例 |
DescribeInstances | - 新增请求参数(可选):
EipAddresses.N ,表示支持按公网IP地址查询实例。 - 新增返回数据:
IpAddress ,表示实例绑定的公网IP地址。 - 新增错误码:LimitExceeded.PrimaryIpAddresses、LimitExceeded.MaximumEipAddresses。
|
CreateScheduledInstances | 新增请求参数(可选): EipAddress.ReleaseWithInstance ,表示创建实例时是否选择公网IP随实例释放。
Volumes.N.SnapshotId ,表示使用快照创建云盘,仅支持创建数据盘。
EipAddress.SecurityProtectionInstanceId 、EipAddress.SecurityProtectionTypes.N ,表示公网IP的安全防护属性。
新增错误码: InvalidSnapshotStatus InvalidVolumeTypeForSnapshot.UnSupported InvalidSnapshot.NotFound InvalidSnapshotZoneId.Mismatch InvalidReleaseWithInstance.ChargeTypeMismatch LimitExceeded.MaximumEipBandwidth InvalidSecurityProtectionTypes.Malformed InvalidSecurityProtectionTypes.BandwidthPackageIdMismatch OperationDenied.SpecifiedSecurityGroupNotAuthorized
| 弹性预约实例 |
DescribeScheduledInstances | |
GetScheduledInstanceLatestReleaseAt | 新增接口,用于查询弹性预约实例-时段型(预约交付)的最晚释放时间。 |
DetectImage | 新增接口,用于发起镜像检测流程。 | 镜像 |
CreateImage | - 新增请求参数:
NeedDetection ,表示是否进行镜像检测。SnapshotGroupId ,表示使用快照一致性组创建自定义镜像。SnapshotId ,表示使用系统盘快照创建自定义镜像。
- 更新请求参数:
InstanceId ,调整为非必填参数。Tags.N.Key ,增加使用限制,不支持任何大小写形式sys: 开头。
- 新增错误码:
- 400,InvalidPlatformForDetect.UnSupported,指定的镜像平台不支持检测。
- 400,InvalidSnapshotIdOrSnapshotGroupIdForCreateImage.UnSupported,指定的快照或一致性组不支持创建自定义镜像。
- 400,LimitExceeded.MaximumSnapshotGroupTotalSize,指定的快照一致性组容量超过限制。
- 404,InvalidSnapshotGroupId.NotFound,指定的快照一致性组Id不存在。
- 404,InvalidSnapshotId.NotFound,指定的快照Id不存在。
- 412,OperationDenied.SnapshotServiceUnavailable,指定的操作被拒绝,因为快照服务未开通。
|
ImportImage | - 新增请求参数:
NeedDetection 参数,表示是否进行镜像检测。
- 更新请求参数:
Tags.N.Key 参数增加使用限制,不支持任何大小写形式sys: 开头。
- 新增错误码:
- 400,InvalidPlatformForDetect.UnSupported,指定的镜像平台不支持检测。
|
DescribeImages | - 新增返回参数:
Images 结构新增:
DetectionResults 结构,表示镜像的检测结果。Snapshots 结构,表示镜像关联的快照信息。
|
DeleteImages | - 新增请求参数:
DeleteBindedSnapshots ,表示删除镜像是否同时删除快照或快照一致性组。
|
|
2024年01月
2023年11月30日
模块 | 接口名称 | 变更记录 | 发布地域 |
---|
实例 | DescribeInstances | - 新增返回数据:
- 新增
ElasticScheduledInstanceType ,表示是否为弹性预约实例。
| 全部 |
DescribeAvailableResource | 变更请求参数: 新增错误码: - InvalidVolumeType.Malformed
|
RunInstances | |
预留实例券 | PurchaseReservedInstances | 新增接口,用于购买一张预留实例券。 |
DescribeReservedInstances | 新增接口,用于查询已购买的预留实例券信息。 |
ModifyReservedInstances | 新增接口,用于更改预留实例券。 |
镜像 | DescribeImages | - 新增请求参数:
- 新增
IsLTS (可选),表示公共镜像是否长期维护。
- 新增返回数据:
|
监控 | DescribeEventTypes | - 变更请求参数:
Types.N 参数新增枚举值InstanceOOM 表示实例内存OOM。
|
DescribeSystemEvents | - 变更请求参数:
Types.N 参数新增枚举值InstanceOOM 表示实例内存OOM。
|
CreateSubscription | 变更请求参数: Types.N 参数新增枚举值:
InstanceOOM:Succeeded 表示实例内存OOM。SystemFailure.Redeploy:Inquiring 表示系统故障,导致实例重新部署:待响应
|
ModifySubscriptionEventTypes | 变更请求参数: Types.N 参数新增枚举值:
InstanceOOM:Succeeded 表示实例内存OOM。SystemFailure.Redeploy:Inquiring 表示系统故障,导致实例重新部署:待响应
|
批量作业 | CreateCommand | - 更新请求参数:
Type 参数新增枚举值,Bat 表示创建一个Bat脚本;PowerShell 表示创建一个PowerShell脚本。
| 全部 |
ModifyCommand | - 更新请求参数:
Type 参数新增枚举值,Bat 表示创建一个Bat脚本;PowerShell 表示创建一个PowerShell脚本。
|
DescribeCommands | - 新增请求参数:
OrderAscending 参数,表示指定返回命令按升序或降序排列。
|
RunCommand | - 新增请求参数:
EnableParameter 参数,表示创建的命令是否使用自定义参数。ParameterDefinitions.N.Name 参数,表示自定义参数名称。ParameterDefinitions.N.Type 参数,表示自定义参数类型。ParameterDefinitions.N.Required 参数,表示自定义参数是否必填。ParameterDefinitions.N.DefaultValue 参数,表示自定义参数默认值。ParameterDefinitions.N.MinLength 参数,表示自定义参数值(字符串)的最小长度。ParameterDefinitions.N.MaxLength 参数,表示自定义参数值(字符串)的最大长度。ParameterDefinitions.N.MinValue 参数,表示自定义参数值(数值)的最小值。ParameterDefinitions.N.MaxValue 参数,表示自定义参数值(数值)的最大值。ParameterDefinitions.N.DecimalPrecision 参数,表示自定义参数值(数值)允许的小数点后位数。Parameters 参数,表示命令中包含的自定义参数具体值。
- 更新请求参数:
Type 参数新增枚举值,Bat 表示创建一个Bat脚本;PowerShell 表示创建一个PowerShell脚本。
|
2023年09月12日
模块 | 接口名称 | 变更记录 | 发布地域 |
---|
实例 | RunInstances | 新增请求参数: - 新增专有宿主机相关参数(可选、邀测):
Placement.Tenancy 、Placement.DedicatedHostId 、Placement.Affinity 、Placement.DedicatedHostClusterId
新增错误码: InvalidInstanceType.ImageMismatch Insufficient.VolumePoolCapacity InvalidPlacementAffinity.Malformed InvalidPlacementTenancy.Malformed InvalidDedicatedHost.NotFound InvalidDedicatedHostCluster.NotFound InvalidDedicatedHost.InstanceTypeIdMismatch InvalidTenancy.DedicatedHostIdMismatch InvalidDedicatedHostClusterId.DedicatedHostIdMismatch InvalidDedicatedHost.InstanceTypeIdMismatch
| 全部 |
ModifyInstanceChargeType | 新增请求参数: 新增错误码: - InvalidSpotStrategyForModifyInstanceChargeType.Unsupported
|
ModifyInstanceSpec | - 新增错误码:
- InvalidSpotStrategyForModifyInstanceSpec.Unsupported
|
DescribeInstances | 新增请求参数: DedicatedHostId 、DedicatedHostClusterId (可选,邀测),表示专有宿主机ID、专有宿主机集群ID。
新增返回数据: - Instance结构中新增Placement结构,表示专有宿主机实例信息,具体参数如下:
Affinity 表示实例是否关联专有宿主机。DedicatedHostId 表示实例所在的专有宿主机ID。Tenancy 表示是否在专有宿主机上创建实例。DedicatedHostClusterId 表示实例所在的专有宿主机集群ID。
|
DescribeAvailableResource | - 变更请求参数:
DestinationResource 新增取值DedicatedHost ,表示专有宿主机规格。
|
监控 | DescribeEventTypes | - 变更请求参数:
Types.N 参数新增取值:
InfrastructureUpgrade_Redeploy 表示基础设施升级,实例重新部署DiskErrorDetected 表示硬盘异常DiskError_ReplaceDisk 表示硬盘异常,更换硬盘
|
DescribeSystemEvents | - 变更请求参数:
Types.N 参数新增取值:
InfrastructureUpgrade_Redeploy 表示基础设施升级,实例重新部署DiskErrorDetected 表示硬盘异常DiskError_ReplaceDisk 表示硬盘异常,更换硬盘
- 新增请求参数:
- 新增错误码:
- 400,InvalidCategory.Malformed,指定的Category不合法。
|
CreateSubscription | - 变更请求参数:
Types.N 参数新增取值:
DiskErrorDetected:Inquiring ,表示硬盘异常:待响应。
|
ModifySubscriptionEventTypes | - 变更请求参数:
Types.N 参数新增取值:
DiskErrorDetected:Inquiring ,表示硬盘异常:待响应。
|
批量作业 | CreateCommand | 新增接口,用于新建一条自定义命令。 |
ModifyCommand | 新增接口,用于修改指定自定义命令内容。 |
DeleteCommand | 新增接口,用于删除一条自定义命令。 |
DescribeCommands | 新增接口,用于查询批量作业命令列表。 |
RunCommand | 新增接口,用于创建批量作业并在一台或多台ECS实例中立即执行。 |
InvokeCommand | 新增接口,用于创建一个批量作业。 |
StopInvocation | 新增接口,用于停止一条正在运行中(Running)的作业。 |
DescribeInvocations | 新增接口,用于查询批量作业的执行列表和状态。 |
DescribeInvocationInstances | 新增接口,用于查询批量作业执行对象列表。 |
DescribeInvocationResults | 新增接口,用于查看一条或多条批量作业的执行结果。 |
InstallCloudAssistant | 新增接口,用于为云服务器实例安装批量作业客户端。 |
DescribeCloudAssistantStatus | 新增接口,用于查询实例批量作业客户端的安装状态。 |
2023年08月11日
2023年07月18日
模块 | 接口名称 | 变更记录 | 发布地域 |
---|
镜像 | CreateImage | - 删除错误码:
- MissingParameter.InstanceId
- 新增错误码:
- InvalidParameterCombination
| 全部 |
ReplaceSystemVolume | - 新增错误码:
- InvalidImage.HostnameMismatch
|
监控 | DescribeEventTypes | - 变更请求参数:
Types.N 参数新增取值:
DeploymentSet_Modify 表示修改实例部署集ServerMigrationTask 表示服务器迁移任务ServerMigration_FirstSync 表示服务器迁移,全量数据同步ServerMigration_AdditionalSync 表示服务器迁移,增量数据同步GpuRiskDetected 表示GPU运行存在风险
|
DescribeSystemEvents | - 变更请求参数:
Types.N 参数新增取值:
ApplicationFailure 表示应用异常DeploymentSet_Modify 表示修改实例部署集ServerMigrationTask 表示服务器迁移任务ServerMigration_FirstSync 表示服务器迁移,全量数据同步ServerMigration_AdditionalSync 表示服务器迁移,增量数据同步GpuRiskDetected 表示GPU运行存在风险
Status.N 参数新增取值:
Pending 表示已暂停Recovered 表示已恢复
|
CreateSubscription | - 变更请求参数:
EventTypes.N 参数新增取值:
SystemMaintenance.Redeploy:Inquiring 表示系统维护,实例重新部署:待响应SystemMaintenance.Redeploy:Succeeded 表示系统维护,实例重新部署:执行成功ServerMigrationTask:Executing 表示服务器迁移任务:执行中ServerMigrationTask:Pending 表示服务器迁移任务:已暂停ServerMigrationTask:Recovered 表示服务器迁移任务:已恢复ServerMigrationTask:Succeeded 表示服务器迁移任务:执行成功ServerMigrationTask:Failed 表示服务器迁移任务:执行失败ServerMigration.FirstSync:Succeeded 表示服务器迁移,全量数据同步:执行成功ServerMigration.FirstSync:Failed 表示服务器迁移,全量数据同步:执行失败ServerMigration.AdditionalSync:Succeeded 表示服务器迁移,增量数据同步:执行成功ServerMigration.AdditionalSync:Failed 表示服务器迁移,增量数据同步:执行失败GpuRiskDetected:Succeeded 表示GPU运行存在风险:执行成功
|
ModifySubscriptionEventTypes | - 变更请求参数:
EventTypes.N 参数新增取值:
SystemMaintenance.Redeploy:Inquiring 表示系统维护,实例重新部署:待响应SystemMaintenance.Redeploy:Succeeded 表示系统维护,实例重新部署:执行成功ServerMigrationTask:Executing 表示服务器迁移任务:执行中ServerMigrationTask:Pending 表示服务器迁移任务:已暂停ServerMigrationTask:Recovered 表示服务器迁移任务:已恢复ServerMigrationTask:Succeeded 表示服务器迁移任务:执行成功ServerMigrationTask:Failed 表示服务器迁移任务:执行失败ServerMigration.FirstSync:Succeeded 表示服务器迁移,全量数据同步:执行成功ServerMigration.FirstSync:Failed 表示服务器迁移,全量数据同步:执行失败ServerMigration.AdditionalSync:Succeeded 表示服务器迁移,增量数据同步:执行成功ServerMigration.AdditionalSync:Failed 表示服务器迁移,增量数据同步:执行失败GpuRiskDetected:Succeeded 表示GPU运行存在风险:执行成功
|
实例 | ModifyInstanceAttribute | 新增请求参数: 新增错误码: - InvalidHostname.Malformed
|
RunInstances | - 新增请求参数:
InstallRunCommandAgent (可选),表示创建实例时是否安装批量作业Agent。
| |
DescribeAvailableResource | 变更请求参数: 新增错误码: - InvalidVolumeType.Malformed
|
地域及可用区 | DescribeRegions | 新增接口,用于查询地域信息。 |
密钥对 | DeleteKeyPairs | 修改接口说明: - 密钥对删除逻辑优化:仅支持删除未绑定实例的密钥对。
新增错误码:
|
2023年06月14日
2023年05月19日
2023年04月11日
2023年03月14日
2023年02月14日
2023年01月17日