文档中心

云服务器

API参考

API 列表

本文为您详细列举了云服务器ECS的API。

说明

API的Action（操作名称）定义了IAM权限策略中允许执行的的操作范围。表格中的是否支持按项目授权一列，用于判断API操作能否在限定项目范围的IAM权限策略中生效。例如，用户被授予ECSFullAccess（云服务器的完全管理权限）且限制了项目范围时，其权限会受到以下影响：

支持按项目授权的Action：这类操作会被严格限定在指定项目内，用户只能对该项目下的ECS资源执行相关操作。

不支持按项目授权的Action：即便整体权限被限定在指定项目内，但操作本身不受项目约束，将提示“缺少权限”。您需要为IAM策略授予全局权限方可正常访问，了解更多。

地域

API	说明	是否支持按项目授权
DescribeRegions	获取地域信息	不支持
DescribeZones	获取一个地域下的可用区信息	不支持

实例

API	说明	是否支持按项目授权
RunInstances	创建一台或多台实例	支持
AllocateInstances	创建一台或多台实例（支持可用区灵活性）	支持
StartInstance	启动一台实例	支持
StopInstance	停止一台实例	支持
RebootInstance	重启一台实例	支持
DeleteInstance	删除一台实例	支持
StartInstances	启动一台或多台实例	支持
StopInstances	停止一台或多台实例	支持
RebootInstances	重启一台或多台实例	支持
DeleteInstances	删除一台或多台实例	支持
DescribeInstances	获取实例信息	支持
DescribeInstanceTypes	获取云服务器提供的所有实例规格的信息	不支持
DescribeInstanceTypeFamilies	获取云服务器提供的实例规格族信息	不支持
DescribeAvailableResource	查询可用区中计算资源的库存信息	不支持
DescribeUserData	查询实例自定义数据	支持
ModifyInstanceMetadataOptions	修改实例元数据的访问模式	支持
DescribeInstanceVncUrl	查询实例 VNC 管理终端地址	支持
DescribeInstanceECSTerminalUrl	查询实例 Terminal 管理终端地址	支持
RenewInstance	续费一台包年包月实例	支持
ModifyInstanceAttribute	修改指定实例的信息	支持
ModifyInstanceSpec	修改指定实例的规格	支持
ModifyInstancesSpec	批量修改指定实例的规格	支持
ModifyInstanceChargeType	修改指定实例的计费模式	支持
AssociateInstancesIamRole	为一台或多台实例绑定IAM角色	支持
DisassociateInstancesIamRole	为一台或多台实例解绑IAM角色	支持
DescribeInstancesIamRoles	获取一台或多台实例上已绑定的IAM角色	支持
DescribeSpotAdvice	查询抢占式实例近30天的实例平均释放率、平均折扣率等信息	不支持
DescribeSpotPriceHistory	查询抢占式实例近30天内的历史价格	不支持
ModifyInstanceVpcAttribute	修改一台实例的VPC、子网或安全组	支持
PurchaseReservedInstances	购买一张预留实例券	支持
DescribeReservedInstances	查询已购买的预留实例券信息	支持
ModifyReservedInstances	更改预留实例券	支持
CreateScheduledInstances	创建弹性预约实例	不支持
DescribeScheduledInstances	查询弹性预约单列表	不支持
DeleteScheduledInstance	取消预约弹性预约实例	不支持
DescribeScheduledInstanceStock	查询弹性预约实例预约情况	不支持
GetScheduledInstanceLatestReleaseAt	查询弹性预约实例-时段型的最晚释放时间	不支持

镜像

API	说明	是否支持按项目授权
DescribeImages	获取镜像信息	支持
ReplaceSystemVolume	为一台实例重装系统或者更换新的系统盘	支持
ImportImage	导入自定义镜像	支持
ExportImage	导出自定义镜像	支持
ModifyImageAttribute	修改自定义镜像的名称、描述信息、状态等	支持
DeleteImages	删除自定义镜像	支持
DescribeImageSharePermission	查询自定义镜像已经共享的所有用户	支持
ModifyImageSharePermission	管理镜像共享权限	支持
DescribeTasks	查询一个或多个异步请求的进度	不支持
CreateImage	通过实例创建自定义镜像	支持
CopyImage	复制自定义镜像或共享镜像	支持
DetectImage	发起镜像检测流程	支持
DescribeAutoInstallPackages	查询镜像及实例规格族支持的自动安装组件包	支持

高性能计算集群

API	说明	是否支持按项目授权
CreateHpcCluster	创建一个高性能计算集群	不支持
DeleteHpcCluster	删除一个高性能计算集群	不支持
DescribeHpcClusters	查询符合条件的高性能计算集群详情列表	不支持
DescribeHpcInstancePosition	查询高性能计算型实例在RDMA网络中的位置	不支持

密钥对

API	说明	是否支持按项目授权
ImportKeyPair	导入密钥对的公钥	支持
CreateKeyPair	创建一个密钥对	支持
DescribeKeyPairs	查询密钥对列表信息	支持
ModifyKeyPairAttribute	修改密钥对描述信息	支持
AttachKeyPair	绑定一个或多个密钥对到一台或多台Linux实例	支持
DetachKeyPair	为一台或多台Linux实例解绑密钥对	支持
DeleteKeyPairs	删除密钥对	支持

标签

API	说明	是否支持按项目授权
TagResources（新版）	为一个或多个资源（实例、镜像、密钥对、运维编排、启动模板等）绑定标签	支持
UntagResources（新版）	为一个或多个资源（实例、镜像、密钥对、运维编排、启动模板等）解绑标签	支持
ListTagsForResources（新版）	查询已绑定标签的资源	支持
CreateTags（旧版）	为一个或多个资源（实例、镜像、密钥对等）绑定标签	不支持
DeleteTags（旧版）	为一个或多个资源（实例、镜像、密钥对等）解绑标签	不支持
DescribeTags（旧版）	查询已绑定标签的资源	不支持
CreateTags	为一个或多个云盘绑定标签	-
DeleteTags	为一个或多个云盘解绑标签	-
DescribeTags	查询一个或多个云盘已绑定的标签信息	-

云盘

API	说明
CreateVolume	创建一个云盘
DeleteVolume	删除一个云盘
AttachVolume	挂载云盘到实例
DetachVolume	将云盘从实例上卸载
ExtendVolume	扩容一个云盘
RollbackVolume	回滚一个云盘
DescribeVolumes	查询云盘列表
DescribeVolumeType	查询各地域可用区支持创建的云盘类型
ModifyVolumeSpec	变更云盘规格
ModifyVolumeAttribute	修改云盘属性
ModifyVolumeChargeType	修改云盘计费方式
ModifyVolumeExtraPerformance	为云盘配置额外性能或修改额外性能属性
CalculatePriceV2	查询云盘价格
ReInitializeVolume	重新初始化云盘
PurchaseReservedStorageCapacity	创建预留存储容量包
DescribeReservedStorageCapacity	查询预留存储容量包
ModifyReservedStorageCapacityEffectiveAt	修改存储容量包生效时间
CreatePlacementGroup	创建存储放置组
DescribePlacementGroups	查询存储放置组的信息
DescribePlacementGroupDetails	查询存储放置组绑定的云盘信息
ModifyPlacementGroup	修改存储放置组
DeletePlacementGroup	删除存储放置组

快照

API	说明
CreateSnapshot	创建一个快照
DeleteSnapshot	删除一个快照
DescribeSnapshots	查询快照列表
ModifySnapshotAttribute	修改快照属性
DescribeSnapshotChains	查询快照链
DescribeSnapshotsUsage	查询快照用量
CreateAutoSnapshotPolicy	创建自动快照策略
DeleteAutoSnapshotPolicy	删除自动快照策略
ModifyAutoSnapshotPolicy	修改自动快照策略
DescribeAutoSnapshotPolicy	查询自动快照策略
ApplyAutoSnapshotPolicy	为云盘应用自动快照策略
CancelAutoSnapshotPolicy	取消自动快照策略
CreateSnapshotGroup	创建快照一致性组
DescribeSnapshotGroups	查询快照一致性组
ModifySnapshotGroup	修改快照一致性组
DeleteSnapshotGroup	删除快照一致性组
RollbackSnapshotGroup	回滚快照一致性组

部署集

API	说明	是否支持按项目授权
CreateDeploymentSet	创建一个部署集	不支持
DescribeDeploymentSets	查询部署集的属性	不支持
DescribeDeploymentSetSupportedInstanceTypeFamily	查询支持部署集的实例规格族	不支持
ModifyDeploymentSetAttribute	修改一个部署集的名称和描述信息	不支持
ModifyInstanceDeployment	调整实例所属部署集	支持
DeleteDeploymentSet	删除一个部署集	不支持

实例启动模版

API	说明
CreateLaunchTemplate	创建一个实例启动模板
CreateLaunchTemplateVersion	创建一个实例启动模板的版本
DescribeLaunchTemplates	查询实例启动模板
DescribeLaunchTemplateVersions	查询实例启动模板版本
ModifyTemplateDefaultVersion	修改实例启动模板的默认版本
DeleteLaunchTemplate	删除一个实例启动模板
DeleteLaunchTemplateVersion	删除一个实例启动模板的版本

监控

API	说明	是否支持按项目授权
DescribeSystemEvents	查询实例的系统事件信息	支持
UpdateSystemEvents	修改系统事件状态	不支持
CreateSubscription	订阅ECS事件通知	不支持
ModifySubscriptionEventTypes	修改订阅事件类型	不支持
DescribeSubscriptions	查询事件通知订阅列表	不支持
DescribeEventTypes	查询事件类型列表	不支持
ModifySystemEventDefaultAction	修改事件默认的运维操作	不支持
DescribeSystemEventDefaultAction	查询事件默认设置的运维操作	不支持

运维

API	说明	是否支持按项目授权
GetConsoleOutput	获取实例最近启动、重启或者关机时的系统命令行输出	支持
GetConsoleScreenshot	获取正在运行实例的JPG格式屏幕截图，以帮助进行故障排查	支持

云助手

API	说明
CreateCommand	新建一条云助手自定义命令
ModifyCommand	修改云助手自定义命令内容
DeleteCommand	删除指定自定义命令
DescribeCommands	查询云助手命令列表
RunCommand	使用手工输入命令的方式创建用云助手任务
InvokeCommand	使用已有的自定义命令或公共命令创建云助手任务
StopInvocation	停止一条正在运行中（Running）的云助手命令
DescribeInvocations	查询云助手的执行列表和状态
DescribeInvocationInstances	查询云助手执行对象列表
DescribeInvocationResults	查看一条或多条云助手的执行结果
InstallCloudAssistant	为云服务器实例安装云助手客户端
UpgradeCloudAssistants	升级已安装的云助手客户端至最新版本
UninstallCloudAssistants	卸载已安装的云助手客户端
DescribeCloudAssistantStatus	查询实例云助手客户端的安装状态

补丁管理

API	说明
CreatePatchPlan	创建一个补丁计划
ListPatchPlans	获取补丁计划列表信息
GetPatchPlan	获取补丁计划详情
ListPatchPlanTasks	查询补丁计划运行任务列表信息
ListInstancePatches	查询实例补丁安装情况
CancelPatchPlan	取消补丁计划
CreatePatchBaseline	创建一个补丁基线
RegisterDefaultPatchBaseline	设置默认补丁基线
DeletePatchBaseline	删除补丁基线
ListPatchBaselines	查询补丁基线列表
GetPatchBaseline	获取补丁基线详情
UpdatePatchBaseline	更新补丁基线
ListInstancePatchReports	查询实例合规性报告列表
ListPatchProperties	查询补丁元数据

最近更新时间：2026.03.03 16:15:06

这个页面对您有帮助吗？

有用

无用