全部产品
Search

搜索本产品

    轻量应用服务器：API概览

    文档中心

    轻量应用服务器：API概览

    更新时间：Dec 19, 2024
    本产品（轻量应用服务器/2020-06-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。
    在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

    实例

    API标题API概述
    CreateInstances创建实例创建一台或多台包年包月的轻量应用服务器实例。
    StartInstance启动实例启动一台轻量应用服务器。
    StartInstances批量启动实例启动一台或多台轻量应用服务器。
    ListInstanceStatus批量获取实例状态查询一个或多个实例的状态。
    StopInstance停止实例停止一台轻量应用服务器。
    StopInstances批量停止实例停止一台或多台轻量应用服务器。
    UpdateInstanceAttribute修改实例部分信息修改实例的部分信息，包括实例名称，密码。
    ListInstances获取实例列表查询指定地域下一个或多个实例的详细信息。
    LoginInstance 远程登录实例使用Workbench远程登录轻量应用服务器。
    DescribeInstanceVncUrl获取实例VNC连接地址获取指定轻量应用服务器的VNC连接地址。
    ModifyInstanceVncPassword修改实例VNC密码修改实例的VNC密码。
    ListInstancePlansModification获取当前实例可升级的套餐列表查询指定的轻量应用服务器可升级的套餐列表。
    ListInstancesTrafficPackages获取指定服务器的流量包使用情况查询一个或多个实例的流量包详情信息。
    DescribeInstancePasswordsSetting查询实例是否设置过密码查询轻量应用服务器是否设置过密码。
    InstallCloudMonitorAgent安装云监控插件为指定的轻量应用服务器安装云监控插件。
    DescribeCloudMonitorAgentStatuses查询云监控插件状态查询轻量应用服务器云监控插件的状态。
    DescribeMonitorData获取实例监控数据获取实例监控信息（vCPU、内存、磁盘IO、流量）。
    DescribeSecurityAgentStatus查询安全中心Agent插件状态查询指定轻量应用服务器的安全中心Agent插件状态。
    RebootInstance重启实例重启一台轻量应用服务器。
    RebootInstances批量重启实例重启一台或多台轻量应用服务器。
    UpgradeInstance升级实例为指定的轻量应用服务器升级套餐配置。
    RenewInstance续费实例续费一台轻量应用服务器。
    ResetSystem重置系统为指定的轻量应用服务器重置系统。

    密钥对

    API标题API概述
    CreateInstanceKeyPair创建实例密钥对创建轻量应用服务器密钥对。
    CreateKeyPair创建密钥对创建轻量应用服务器密钥对。
    UploadInstanceKeyPair导入密钥对为一台轻量应用服务器导入密钥对。
    ImportKeyPair导入密钥对导入已有密钥对。
    DescribeInstanceKeyPair查询实例密钥对信息查询轻量应用服务器的密钥对信息。
    ListKeyPairs查询密钥对密钥对列表。
    AttachKeyPair绑定密钥对轻量应用服务器绑定密钥对。
    DetachKeyPair解绑密钥对解绑轻量应用服务器的密钥对。
    DeleteInstanceKeyPair删除实例密钥对删除轻量应用服务器密钥对。
    DeleteKeyPairs删除密钥对删除轻量应用服务器密钥对。

    防火墙模板

    API标题API概述
    CreateFirewallTemplate创建防火墙模板创建一个防火墙模板。
    DescribeFirewallTemplates查询防火墙模板查询防火墙模板的信息。
    CreateFirewallTemplateRules创建防火墙模板规则对于已创建的防火墙模板，您可以根据业务需求为防火墙模板增加防火墙规则。
    ApplyFirewallTemplate应用防火墙模板使用防火墙模板可以同时为多台轻量应用服务器实例设置防火墙规则，提高设置防火墙规则的效率。
    ModifyFirewallTemplate修改防火墙模板对于已创建的防火墙模板，您可以根据业务需求修改防火墙规则，并最终将这些规则通过防火墙模板设置到轻量应用服务器实例中。
    DescribeFirewallTemplateApplyResults查询防火墙模板应用结果查询防火墙模板应用实例结果。
    DescribeFirewallTemplateRulesApplyResult查询防火墙模板规则应用结果查询防火墙模板规则应用结果信息。
    DeleteFirewallTemplateRules删除防火墙模板规则对于已创建的防火墙模板，您可以根据业务需求删除防火墙规则。
    DeleteFirewallTemplates删除防火墙模板删除已创建的防火墙模板。

    防火墙

    API标题API概述
    DeleteFirewallRules批量删除实例防火墙规则删除指定轻量应用服务器的多条防火墙规则。
    CreateFirewallRule创建实例的防火墙规则为指定的轻量应用服务器创建一条防火墙规则。
    CreateFirewallRules批量创建实例的防火墙规则为指定的轻量应用服务器批量创建防火墙规则。
    ListFirewallRules获取实例的防火墙规则查询指定轻量应用服务器的防火墙规则。
    ModifyFirewallRule修改实例防火墙规则修改指定轻量应用服务器的防火墙规则。
    EnableFirewallRule开启实例防火墙规则开启指定轻量应用服务器的一条防火墙策略。
    DisableFirewallRule禁用实例防火墙规则禁用指定轻量应用服务器的一条防火墙策略。
    DeleteFirewallRule删除实例防火墙规则删除指定轻量应用服务器的一条防火墙规则。

    快照

    API标题API概述
    CreateSnapshot创建快照为指定的磁盘创建快照。
    ListSnapshots获取快照查询一个或多个已创建的快照信息。
    UpdateSnapshotAttribute修改快照备注信息修改轻量应用服务器指定快照的备注信息。
    DeleteSnapshot删除快照删除轻量应用服务器指定的快照。
    DeleteSnapshots批量删除快照删除一个或多个已创建的快照。

    磁盘

    API标题API概述
    UpdateDiskAttribute修改数据盘备注信息修改轻量应用服务器指定数据盘的备注信息。
    ListDisks查询一个或多个磁盘信息查询指定地域下一个或多个已创建的磁盘信息。
    ResetDisk回滚磁盘根据快照回滚磁盘。

    自定义镜像

    API标题API概述
    CreateCustomImage创建自定义镜像通过快照创建用户自定义镜像。
    ListCustomImages查询一个或多个自定义镜像信息查询指定地域下一个或多个已创建的自定义镜像信息。
    ModifyImageShareStatus共享、解除共享自定义镜像为指定的自定义镜像共享或取消共享到ECS。
    AddCustomImageShareAccount跨账号共享自定义镜像您可以将自定义镜像共享给同地域下的其他阿里云账号，快速为多个轻量应用服务器部署相同的环境配置，提高部署效率。
    ListCustomImageShareAccounts查看跨账号共享镜像信息查询跨账号共享镜像的信息。
    ListCustomImageShareAccounts查看跨账号共享镜像信息查询跨账号共享镜像的信息。
    RemoveCustomImageShareAccount取消跨账号共享镜像为了安全考虑，跨账号共享自定义镜像后，您可以调用RemoveCustomImageShareAccount接口取消跨账号共享自定义镜像。
    DeleteCustomImage删除自定义镜像删除指定的自定义镜像。
    DeleteCustomImages批量删除镜像如果您不再需要某些自定义镜像，可以将其批量删除。自定义镜像被删除后，使用该镜像创建的轻量应用服务器将无法使用该镜像重置系统。

    命令助手

    API标题API概述
    DescribeCloudAssistantAttributes查询一台或者多台实例的命令助手信息查询一台或者多台实例的命令助手信息。
    UpdateCommandAttribute修改命令修改一条命令相关参数。
    InvokeCommand执行命令为一台或多台轻量应用服务器执行一条命令助手命令。
    DescribeCommands查询命令查询您手动创建的命令或者阿里云提供的公共命令。
    DescribeCommandInvocations查询命令执行列表和状态查询命令助手执行命令的列表和状态。
    DeleteCommand删除命令删除一条命令助手命令。
    CreateCommand创建命令新建一条命令助手命令。
    StartTerminalSession开启免密登录会话为轻量应用服务器提供会话登录能力。
    InstallCloudAssistant安装云助手为轻量应用服务器安装云助手。
    DescribeCloudAssistantStatus查询云助手安装状态查询轻量云服务器是否安装云助手。
    DescribeInvocationResult查询单个命令的执行结果查询单个命令的执行结果。
    RunCommand执行命令在轻量应用服务器上执行命令。
    DescribeInvocations查看命令详细信息查看命令详细信息。

    标签

    API标题API概述
    TagResources绑定标签对轻量应用服务器、快照、自定义镜像、命令、防火墙规则和磁盘绑定标签，便于查看和管理轻量资源。
    ListTagResources查询标签列表调用ListTagResources查询一个或多个轻量资源（实例、快照、磁盘、镜像、命令、防火墙规则）已经绑定的标签信息。
    UntagResources解绑并删除标签为指定的轻量资源（实例、快照、磁盘、镜像、命令、防火墙规则）统一解绑并删除标签。

    其他资源

    API标题API概述
    ListRegions查询可用地域列表查询轻量服务器所有可用地域列表。
    ListImages获取镜像列表查询指定地域下一个或多个镜像信息。
    ListPlans获取套餐信息查询指定地域下轻量应用服务器所有的套餐信息。