API概览

最近更新时间:2019-05-30 17:59:11

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 实例相关接口

接口功能 Action ID 功能描述
查看实例列表 DescribeInstances 用于获取一个或多个实例的详细信息。
创建实例(包年包月) RunInstances 用于创建一台或多台指定配置的实例(包年包月)。
创建实例(按量计费) RunInstancesHour 用于创建一个或多个指定配置的实例(按量计费)。
启动实例 StartInstances 用于启动一个或者多个实例。
关闭实例 StopInstances 用于关闭一个或者多个实例。
重启实例 RestartInstances 用于重启一个或者多个实例。
重装系统 ResetInstances 用于将重装指定实例上的操作系统。
修改实例属性 ModifyInstanceAttributes 用于修改实例的属性(如实例名称等)。
重置密码 ResetInstancePassword 用于将实例操作系统的密码重置为用户指定的值
查询实例价格(包年包月) InquiryInstancePrice 用于获取实例价格(包年包月)。
查询实例价格(按量计费) InquiryInstancePriceHour 用于获取实例价格(按量计费)。
调整配置(包年包月) ResizeInstance 用于支持升级或降级指定实例的配置,包括CPU、内存、数据盘。
调整配置(按量计费) ResizeInstanceHour 用于支持升级或降级指定实例的配置,包括CPU、内存、数据盘。
续费实例(包年包月) RenewInstance 用于包年包月实例续费。
退还实例(按量计费) ReturnInstance 用于主动退还实例。
修改实例所属项目 ModifyInstanceProject 用于修改实例所属项目。
设置实例自动续费 SetAutoRenew 用于设置实例的续费策略。

2. 镜像相关接口

接口功能 Action ID 功能描述
查看可用的镜像列表 DescribeImages 用于获取本账户能够使用的镜像,用户可以使用这些镜像来创建CVM实例。
创建自定义镜像 CreateImage 用于将实例系统盘的当前状态制作成全新的镜像,使用此镜像可以快速创建实例。
删除镜像 DeleteImages 用于删除一个或者多个镜像。
修改镜像属性 ModifyImageAttributes 用于修改镜像的名称和描述等信息。
复制镜像 SyncCvmImage 用于将自定义镜像复制(同步)到其它地区。
共享镜像 ShareImage 用于共享镜像。
取消共享镜像 CancelShareImage 用于取消共享镜像。
查询镜像共享的账号列表 GetImageShareUinInfo 用于查询本账户的镜像共享情况,包括共享的账户列表。

3. 网络相关接口

接口功能 Action ID 功能描述
调整按量计费实例带宽 UpdateInstanceBandwidthHour 用于调整按量计费实例的公网带宽。
绑定子机与弹性网卡 AttachNetworkInterface 用于绑定子机与弹性网卡。
调整包年包月实例带宽 UpdateInstanceBandwidth 用于调整包年包月实例的公网带宽。

4. 安全组相关接口

接口功能 Action ID 功能描述
查询安全组关联的网卡列表 DescribeNetworkInterfacesOfSecurityGroup 用于查询已关联指定的安全组的弹性网卡。
修改弹性网卡关联的安全组 ModifySecurityGroupsOfNetworkInterface 用于修改指定弹性网卡关联的安全组。
删除安全组 DeleteSecurityGroup 用于删除新的安全组。
修改安全组名称 ModifySecurityGroupAttributes 用于修改已经存在的安全组的属性信息,包括名称和描述。
查询安全组规则 DescribeSecurityGroupPolicys 用于查询已经存在的安全组的规则。
修改安全组规则 ModifySecurityGroupPolicys 用于修改已经存在的安全组的规则。
查询安全组关联的云服务器列表 DescribeInstancesOfSecurityGroup 用于查询已关联指定的安全组的云服务器。
修改云服务器关联的安全组 ModifySecurityGroupsOfInstance 用于修改指定云服务器关联的安全组。
查询与安全组关联的安全组列表 DescribeAssociateSecurityGroups 查询有哪些安全组的出站或入站规则中包含了输入的安全组 ID。
添加安全组规则 CreateSecurityGroupPolicy 用于添加安全组规则。
编辑单条安全组规则 ModifySingleSecurityGroupPolicy 用于编辑单条安全组规则。
查询安全组列表 DescribeSecurityGroupEx 用于查询已经存在的安全组的规则。
创建安全组 CreateSecurityGroup 用于创建新的安全组。
删除安全组规则 DeleteSecurityGroupPolicy 用于删除安全组规则。

5. 弹性IP相关接口

接口功能 Action ID 功能描述
查询弹性公网IP列表 DescribeEip 查询弹性公网IP。
查询弹性公网IP配额 DescribeEipQuota 查询指定地域弹性公网IP配额。
修改弹性公网IP名称 ModifyEipAttributes 修改弹性公网IP名称。
创建弹性公网IP CreateEip 创建弹性公网IP(EIP),弹性公网IP是专为动态云计算设计的静态IP地址。借助弹性公网IP,您可以快速将EIP重新映射到您的另一个实例上,从而屏蔽实例故障。
释放弹性公网IP DeleteEip 释放弹性公网IP。
绑定弹性公网IP EipBindInstance 弹性公网IP与服务器绑定。
解绑弹性公网IP EipUnBindInstance 弹性公网IP与服务器解绑。
普通公网IP转弹性公网IP TransformWanIpToEip 普通公网IP转弹性公网IP,将服务器当前绑定的普通公网IP转换成弹性公网IP,转换后随着服务器的释放,该弹性公网IP将会保留。

6. 密钥相关接口

接口功能 Action ID 功能描述
查询密钥 DescribeKeyPairs 用于查询密钥。
创建密钥 CreateKeyPair 用于创建密钥。
修改密钥名称 ModifyKeyPair 用于修改密钥名称。
删除密钥 DeleteKeyPair 用于删除密钥。
导入密钥 ImportKeyPair 用于导入密钥。
绑定密钥 BindInstanceKey 用于将密钥绑定到CVM实例上。
解绑密钥 unBindInstanceKey 用于解除CVM的密钥绑定关系。