云服务器相关接口

创建云服务器

描述

  • 创建一台或多台按量付费或者预付费（包年包月）云服务器。

  • 单次最多能创建100台实例。

  • 实例创建成功后将自动开机启动，实例状态变为“运行中(active)”。

  • 预付费实例的购买会预先扣除本次实例购买所需金额，按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额，在调用本接口前请确保账户余额充足。

  • 在启动实例时，实例属于“开机中”（powering-on）状态，在实例准备好时，会进入“运行中（active）”状态。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：CreateServer
AvailabilityZone String 是 可用区标识，例如：cn-north-3 表示华北三区域
ProductTypeCode String 否 默认标准型ECS_std
BillType String 是 计费方式，hourlySettlement或monthly
Duration String 否 若计费方式为monthly，该参数必传
DurationUnit String 否 若计费方式为monthly，该参数必传
Count String 是 云服务器购买数量
Name String 是 云服务器名称，长度为2-128个字符，不能以特殊字符及数字开头，只可包含特殊字符中的"."，"_"或"-"
FlavorRef String 是 创建云服务器的系统规格，请参考产品规格
Vcpus String 是 若FlavorRef=S1.null，Vcpus必传
Ram String 是 若FlavorRef=S1.null，Ram必传
ImageRef String 是 镜像的UUID
RootVolume Object 是 系统盘配置。
RootVolume.Size String 是 系统盘容量， 不能小于镜像大小，最大不超过500GiB
RootVolume.VolumeType String 是 系统盘类型， 默认为空
DataVolumes.N List 否 数据盘。若购买多块数据盘，N由1开始依次递增；最多可挂载23块数据盘
DataVolumes.N.VolumeType List 否 数据盘类型。若挂载数据盘，该参数必传。
DataVolumes.N.Size List 否 数据盘容量。若挂载数据盘，该参数必传。
VpcId String 是 创建云服务器的内部网络Vpc id
Nics.N List 是 网络，若配置多个网络，N由1开始依次递增
Nics.N.SubnetId List 是 子网ID
Nics.N.FixedIp List 否 固定IP地址
SecurityGroups.N List 是 实例所属安全组。若所属多安全组，N由1开始依次递增
SecurityGroups.N.Id List 是 安全组id
AdminPass String 是 实例的密码。密码功能规则为：8-32个字符，必须包含大小写字母和数字，支持英文特殊字符!"$%()*+,-./:;<=>?@[]^_`{|}~
BackupId String 否 备份ID

返回参数

名称 类型 描述
Code String 返回码：202成功，其他失败
Message String 描述信息

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action CreatServer

示例

请求示例

创建一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=CreateServer&ImageRef=259606a6-da3e-4727-a3c5-8056cd36f6ae&AvailabilityZone=cn-north-3a&ProductTypeCode=ECS_std&BillType=hourlySettlement&Count=1&Name=ECS-XXXX&FlavorRef=S1.small.1&RootVolume.Size=40&VpcId=99&SecurityGroups.1.Id=4435935b-d481-446b-bfca-5677a2d5f53e&Nics.1.SubnetId=55f86bd8-4edc-4496-9b7a-28f460feb82a&Nics.1.FixedIp=&Vcpus=1&AdminPass=Lc13yfwpW&Ram=1&RootVolume.VolumeType<公共请求参数>

响应示例

<CreateServerResponse>
    <Code>202</Code>
    <Data>
        <OrderId>330997721993256960</OrderId>
        <Result>true</Result>
    </Data>
    <Message>Accepted</Message>
</CreateServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

启动云服务器

启动一台云服务器

描述

  • 实例状态必须为已停止（stopped），才可以进行此操作

  • 接口调用成功后变为“开机中(powering-on)”。在实例准备好时，会进入“运行中（active）”状态。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：StartServer
Serverid String 是 待操作云服务器ID
OSStart String 是 标识符， 填空或者null

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action os-start

示例

请求示例

启动一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=StartServer&Serverid=de3831c5-54eb-4656-8a00-6f7210a39ed4&OSStart=&<公共请求参数>

响应示例

<StartServerResponse>
    <Code>202</Code>
    <Data>null</Data>
    <Message>success</Message>
</StartServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量启动云服务器

启动多台关闭中的云服务器

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：StartMultipleServers
Serversid.N String 是 一个或多个待操作的云服务器UUID。若操作多台实例，N由0开始依次递增

权限

权限属性名称 权限属性值
service ecs
resourceType multiple-servers
action os-start

示例

请求示例

启动三台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=StartMultipleServers&Serversid.0=de3831c5-54eb-4656-8a00-6f7210a39ed4&Serversid.1=ef2ffe7d-92c2-4e66-bb50-dc3c978971db&Serversid.2=96b8794e-94b7-4c91-9d3c-bebb7000d6a2&<公共请求参数>

响应示例

<StartMultipleServersResponse>
    <Code>202</Code>
    <Data>null</Data>
    <Message>The following server start success:[{de3831c5-54eb-4656-8a00-6f7210a39ed4},{96b8794e-94b7-4c91-9d3c-bebb7000d6a2},{ef2ffe7d-92c2-4e66-bb50-dc3c978971db}]</Message>
</StartMultipleServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

关闭云服务器

关闭一台云服务器

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：StopServer
Serverid String 是 待操作云服务器ID
OSStop String 是 标识符，填空或者null

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action os-stop

示例

请求示例

关闭一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=StopServer&Serverid=de3831c5-54eb-4656-8a00-6f7210a39ed4&OSStop=&<公共请求参数>

响应示例

<StopServerResponse>
    <Code>202</Code>
    <Data>null</Data>
    <Message>success</Message>
</StopServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量关闭云服务器

关闭多台运行中的云服务器

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值:StopMultipleServers
Serversid.N String 是 一个或多个待操作的云服务器ID。若操作多台实例，N由0开始依次递增

权限

权限属性名称 权限属性值
service ecs
resourceType multiple-servers
action os-stop

示例

请求示例

关闭两台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=StopMultipleServers&Serversid.0=ef2ffe7d-92c2-4e66-bb50-dc3c978971db&Serversid.1=96b8794e-94b7-4c91-9d3c-bebb7000d6a2&<公共请求参数>

响应示例

<StopMultipleServersResponse>
    <Code>202</Code>
    <Data>null</Data>
    <Message>The following server stop success:[{ef2ffe7d-92c2-4e66-bb50-dc3c978971db},{96b8794e-94b7-4c91-9d3c-bebb7000d6a2}]</Message>
</StopMultipleServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

重启云服务器

重启一台云服务器。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：RebootServer
Serverid String 是 待操作云服务器ID
Type String 否 重启类型，SOFT：普通重启（默认），HARD：强制重启

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action reboot

示例

请求示例

重启一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=RebootServer&Serverid=c8b4f558-b6da-4b6d-86cc-f0070909ce20&Type=SOFT&<公共请求参数>

响应示例

<RebootServerResponse>
    <Code>202</Code>
    <Data>null</Data>
    <Message>success</Message>
</RebootServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量重启云服务器

重启多台运行中的云服务器。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：RebootMultipleServers
Serversid.N String 是 一个或多个待操作的云服务器ID。若操作多台实例，N由0开始依次递增
Type String 否 重启类型，SOFT：普通重启（默认），HARD：强制重启

权限

权限属性名称 权限属性值
service ecs
resourceType multiple-servers
action reboot

示例

请求示例

重启两台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=RebootMultipleServers&Serversid.0=c8b4f558-b6da-4b6d-86cc-f0070909ce20&Serversid.1=9034feb8-9d18-4a03-a2b2-41ed4d33d737&Type=SOFT&<公共请求参数>

响应示例

<RebootMultipleServersResponse>
    <Code>202</Code>
    <Data>null</Data>
    <Message>The following server reboot success:[{c8b4f558-b6da-4b6d-86cc-f0070909ce20},{9034feb8-9d18-4a03-a2b2-41ed4d33d737}]</Message>
</RebootMultipleServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除云服务器

删除一台或多台云服务器实例，仅hourlySettlement计费方式支持删除云服务器。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：DeleteServer
Servers.N.Id String 是 一个或多个待操作的云服务器ID。若操作多台实例，N由0开始依次递增
DeleteVolume boolean 否 定值：false; 可不填
DeleteEip boolean 否 定值：false; 可不填

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action DeleteServer

示例

请求示例

删除一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=DeleteServer&Servers.0.Id=de3831c5-54eb-4656-8a00-6f7210a39ed4&<公共请求参数>

响应示例

<DeleteServerResponse>
    <Code>200</Code>
    <Data>
        <OrderId>331010329174417408</OrderId>
        <Result>true</Result>
    </Data>
    <Message>success</Message>
</DeleteServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查看云服务器列表

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ListServers
SearchValue String 否 搜索参数，按名称/ID/内网IP三个条件进行筛选。为空时不进行过滤
SearchField String 否 按哪个字段进行过滤。为空时不进行过滤
SortField String 否 按哪个字段进行排序，为空时使用默认排序
SortOrder String 否 descend/ascend,升序排序/降序排序
PageNo String 是 查询页数
PageSize String 是 每页显示条数

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action ListServers

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ListServers&PageSize=1&PageNo=1&<公共请求参数>

响应示例

<ListServersResponse>
    <Code>200</Code>
    <Data>
        <TotalCount>96</TotalCount>
        <Servers>
            <Created>2020-07-01 18:51:44</Created>
            <Id>f792c106-b549-4e59-bbc4-d6aec668967b</Id>
            <Tags>ECS</Tags>
            <Status>active</Status>
            <RegionID>cn-north-3</RegionID>
            <Security_groups>
                <Name>default</Name>
            </Security_groups>
            <Egs_metadata>null</Egs_metadata>
            <Nics>
                <Portid>088afebe-c3e4-4b78-869b-ba68ac40f467</Portid>
                <Fixed_ip>10.158.144.91</Fixed_ip>
                <Subnet_cidr>10.158.144.0/24</Subnet_cidr>
                <Mac_address>fa:16:3e:76:c9:e5</Mac_address>
                <NetworkId>3ce9bd13-fdd8-490d-895c-f910e126262d</NetworkId>
                <Subnet_id>55f86bd8-4edc-4496-9b7a-28f460feb82a</Subnet_id>
                <Subnet_name>vxlan_0000000049</Subnet_name>
            </Nics>
            <Power_state>1</Power_state>
            <Vpcname>vxlan_0000000049</Vpcname>
            <Key_name>null</Key_name>
            <Task_state>null</Task_state>
            <FeeData>
                <CreateTime>2020-07-01 18:51:44</CreateTime>
                <IsAutoRenew>false</IsAutoRenew>
                <DeleteTime>null</DeleteTime>
                <ServiceStatus>alreadyOpened</ServiceStatus>
                <ProductLineCode>ECS</ProductLineCode>
                <BillType>hourlySettlement</BillType>
                <DaysOfDelete>null</DaysOfDelete>
                <NextFeeTime>2099-12-31 23:59:59</NextFeeTime>
                <ProductTypeCode>ECS_std</ProductTypeCode>
                <StartFeeTime>2020-07-01 18:51:44</StartFeeTime>
            </FeeData>
            <Name>ECS-TEST-Final</Name>
            <Updated>2020-07-02 09:54:06</Updated>
            <DiskConfig>MANUAL</DiskConfig>
            <Availability_zone>cn-north-3a</Availability_zone>
            <Vm_state>active</Vm_state>
            <Image>
                <Hw_architecture>null</Hw_architecture>
                <SystemType>linux</SystemType>
                <Tags>null</Tags>
                <Name>CentOS 7.6</Name>
                <System>CentOS 7.6 64位</System>
                <Id>259606a6-da3e-4727-a3c5-8056cd36f6ae</Id>
            </Image>
            <Vpcid>99</Vpcid>
            <Addresses>
                <Vxlan_0000000049>
                    <Addr>10.158.144.91</Addr>
                    <OS-EXT-IPS-MAC:mac_addr>fa:16:3e:76:c9:e5</OS-EXT-IPS-MAC:mac_addr>
                    <OS-EXT-IPS:type>fixed</OS-EXT-IPS:type>
                    <Version>4</Version>
                </Vxlan_0000000049>
            </Addresses>
            <Flavor>
                <Original_name>ecs_1C1G0G_general</Original_name>
                <Disk>0</Disk>
                <Extra_specs>
                    <Quota:vif_inbound_average>1048576</Quota:vif_inbound_average>
                    <Hw:cpu_cores>1</Hw:cpu_cores>
                    <Hw:cpu_threads>1</Hw:cpu_threads>
                    <SERVICE>ECS</SERVICE>
                    <Quota:vif_outbound_average>1048576</Quota:vif_outbound_average>
                    <SPEC>GENERAL</SPEC>
                    <Hw:cpu_sockets>1</Hw:cpu_sockets>
                </Extra_specs>
                <Swap>0</Swap>
                <Vcpus>1</Vcpus>
                <Ephemeral>0</Ephemeral>
                <Ram>1</Ram>
            </Flavor>
            <Root_volume>
                <Volumeid>2a3bba3d-f531-4040-832d-a222c89ee3d3</Volumeid>
                <Size>null</Size>
                <Multiattach>null</Multiattach>
                <Volume_type>null</Volume_type>
            </Root_volume>
            <Eip>null</Eip>
        </Servers>
    </Data>
    <Message>OK</Message>
</ListServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

云服务器概览和监控

查看当前用户下的云服务器资源概览

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ResourceOverview

权限

权限属性名称 权限属性值
service ecs
resourceType monitor
action ListInstanceNumber

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ResourceOverview&<公共请求参数>

响应示例

<ResourceOverviewResponse>
    <Code>200</Code>
    <Data>
        <Images>
            <TotalCount>0</TotalCount>
        </Images>
        <Servers>
            <DueCount>1</DueCount>
            <TotalCount>96</TotalCount>
            <RunningCount>83</RunningCount>
            <RecentCreatedCount>7</RecentCreatedCount>
            <ExpiredCount>0</ExpiredCount>
        </Servers>
        <RegionId>cn-north-3</RegionId>
    </Data>
    <Message>OK</Message>
</ResourceOverviewResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

变更云服务器规格

变更实例的规格（vCPU和内存）。实例必须处于关闭状态。

对于包年包月的只能升级规格不能降低规格；按需付费的可以升级也可以降低规格。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ResizeServer
Serverid String 是 待操作云服务器ID
FlavorRef String 是 云服务器的系统规格，请参考产品规格
Vcpus String 否 若flavorRef=S1.null，则该参数必传
Ram String 否 若flavorRef=S1.null，则该参数必传

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action resize

示例

请求示例

变更一台实例规格

https://ecs.cn-north-3.inspurcloudapi.com?Action=ResizeServer
&Serverid=00e9e21b-a62e-42d8-818f-4628229c9358
&FlavorRef=S1.medium.8
&<公共请求参数>

响应示例

<ResizeServerResponse>
    <Code>200</Code>
    <Data>
        <OrderId>331012399452594176</OrderId>
        <Result>true</Result>
    </Data>
    <Message>success</Message>
</ResizeServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查看云服务器详情

查看一台云服务器详情。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ShowServersDetails
Serverid String 是 待操作云服务器ID

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action GetServer

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ShowServersDetails&Serverid=f792c106-b549-4e59-bbc4-d6aec668967b&<公共请求参数>

响应示例

<ShowServersDetailsResponse>
    <Code>200</Code>
    <Data>
        <Server>
            <Created>2020-07-01 18:51:44</Created>
            <Id>f792c106-b549-4e59-bbc4-d6aec668967b</Id>
            <Tags>ECS</Tags>
            <Status>shutoff</Status>
            <RegionID>cn-north-3</RegionID>
            <Security_groups>
                <Id>4435935b-d481-446b-bfca-5677a2d5f53e</Id>
                <Name>default</Name>
            </Security_groups>
            <Egs_metadata>null</Egs_metadata>
            <Nics>
                <Portid>088afebe-c3e4-4b78-869b-ba68ac40f467</Portid>
                <Fixed_ip>10.158.144.91</Fixed_ip>
                <Subnet_cidr>10.158.144.0/24</Subnet_cidr>
                <Mac_address>fa:16:3e:76:c9:e5</Mac_address>
                <NetworkId>3ce9bd13-fdd8-490d-895c-f910e126262d</NetworkId>
                <Subnet_id>55f86bd8-4edc-4496-9b7a-28f460feb82a</Subnet_id>
                <Subnet_name>vxlan_0000000049</Subnet_name>
            </Nics>
            <Power_state>4</Power_state>
            <Vpcname>vxlan_0000000049</Vpcname>
            <Key_name>null</Key_name>
            <Task_state>null</Task_state>
            <FeeData>
                <CreateTime>2020-07-01 18:51:44</CreateTime>
                <IsAutoRenew>false</IsAutoRenew>
                <DeleteTime>null</DeleteTime>
                <ServiceStatus>alreadyOpened</ServiceStatus>
                <ProductLineCode>ECS</ProductLineCode>
                <BillType>hourlySettlement</BillType>
                <DaysOfDelete>null</DaysOfDelete>
                <NextFeeTime>2099-12-31 23:59:59</NextFeeTime>
                <ProductTypeCode>ECS_std</ProductTypeCode>
                <StartFeeTime>2020-07-01 18:51:44</StartFeeTime>
            </FeeData>
            <Name>ECS-TEST-Final</Name>
            <Updated>2020-07-02 10:08:05</Updated>
            <DiskConfig>MANUAL</DiskConfig>
            <Availability_zone>cn-north-3a</Availability_zone>
            <Vm_state>stopped</Vm_state>
            <Image>
                <Hw_architecture>null</Hw_architecture>
                <SystemType>linux</SystemType>
                <Tags>null</Tags>
                <Name>CentOS 7.6</Name>
                <System>CentOS 7.6 64位</System>
                <Id>259606a6-da3e-4727-a3c5-8056cd36f6ae</Id>
            </Image>
            <Vpcid>99</Vpcid>
            <Addresses>
                <Vxlan_0000000049>
                    <Addr>10.158.144.91</Addr>
                    <OS-EXT-IPS-MAC:mac_addr>fa:16:3e:76:c9:e5</OS-EXT-IPS-MAC:mac_addr>
                    <OS-EXT-IPS:type>fixed</OS-EXT-IPS:type>
                    <Version>4</Version>
                </Vxlan_0000000049>
            </Addresses>
            <Flavor>
                <Original_name>ecs_1C1G0G_general</Original_name>
                <Disk>0</Disk>
                <Extra_specs>
                    <Quota:vif_inbound_average>1048576</Quota:vif_inbound_average>
                    <Hw:cpu_cores>1</Hw:cpu_cores>
                    <Hw:cpu_threads>1</Hw:cpu_threads>
                    <SERVICE>ECS</SERVICE>
                    <Quota:vif_outbound_average>1048576</Quota:vif_outbound_average>
                    <SPEC>GENERAL</SPEC>
                    <Hw:cpu_sockets>1</Hw:cpu_sockets>
                </Extra_specs>
                <Swap>0</Swap>
                <Vcpus>1</Vcpus>
                <Ephemeral>0</Ephemeral>
                <Ram>1</Ram>
            </Flavor>
            <Root_volume>
                <Volumeid>2a3bba3d-f531-4040-832d-a222c89ee3d3</Volumeid>
                <Size>null</Size>
                <Multiattach>false</Multiattach>
                <Volume_type>standard-iops</Volume_type>
            </Root_volume>
            <Eip>null</Eip>
        </Server>
    </Data>
    <Message>OK</Message>
</ShowServersDetailsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

修改云服务器密码

修改云服务器密码

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ChangeAdministrativePassword
Serverid String 是 待操作云服务器ID
AdminPass String 是 新密码

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action changePassword

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ChangeAdministrativePassword&Serverid=9034feb8-9d18-4a03-a2b2-41ed4d33d737&AdminPass=123456a?A&<公共请求参数>

响应示例

<ChangeAdministrativePasswordResponse>
    <Code>200</Code>
    <Data>null</Data>
    <Message>null</Message>
</ChangeAdministrativePasswordResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

修改云服务器名称

修改云服务器名称

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：UpdateServerName
ServerId String 是 待操作云服务器ID
Name String 是 新名称，长度为2-128个字符，不能以特殊字符及数字开头，只可包含特殊字符中的"."，"_"或"-"

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action UpdateServer

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=UpdateServerName&ServerId=ea83c312-d435-48a7-9c0d-2962667575fa&Name=newName&<公共请求参数>

响应示例

<UpdateServerNameResponse>
    <Code>200</Code>
    <Data>
        <Server>
            <Name>newName</Name>
            <Status>true</Status>
            <Id>ea83c312-d435-48a7-9c0d-2962667575fa</Id>
        </Server>
    </Data>
    <Message>OK</Message>
</UpdateServerNameResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

重置操作系统

重置操作系统

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：RebuildServer
Serverid String 是 待操作云服务器ID
ImageRef String 是 用于重建镜像的UUID。
AdminPass String 是 重建之后的密码，必须满足密码复杂度要求
Name String 否 重建云服务器名称
AccessIPv4 String 否 用于访问此重建服务器的IPv4地址
AccessIPv6 String 否 用于访问此重建服务器的IPv6地址
OS-DCF:diskConfig String 否 重建云服务器磁盘分区类型
Description String 否 云服务器描述信息
Metadata_meta_var String 否 元数据
Personality_path String 否 云服务器重建初始化注入数据
Personality_contents String 否 云服务器重建初始化注入数据

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action rebuild

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=RebuildServer
&Serverid=f792c106-b549-4e59-bbc4-d6aec668967b
&ImageRef=da5faf99-4b18-4f8f-801e-f3b46373bbf2
&AdminPass=123456Aa
&<公共请求参数>

响应示例

<RebuildServerResponse>
    <Code>202</Code>
    <Data>
        <Server>
            <Created>2020-07-01T10:51:27Z</Created>
            <Links>
                <Rel>self</Rel>
                <Href>http://10.200.0.20:8774/v2.1/servers/f792c106-b549-4e59-bbc4-d6aec668967b</Href>
            </Links>
            <Links>
                <Rel>bookmark</Rel>
                <Href>http://10.200.0.20:8774/servers/f792c106-b549-4e59-bbc4-d6aec668967b</Href>
            </Links>
            <Id>f792c106-b549-4e59-bbc4-d6aec668967b</Id>
            <Tags>ECS</Tags>
            <Status>REBUILD</Status>
            <AccessIPv4></AccessIPv4>
            <Description>null</Description>
            <HostId>2aac75a008c02bdb89ae62d50a20f573283914ac4dcf234d679f80b2</HostId>
            <Tenant_id>5718e87f79ee4d5dbf7e77ab02cf504e</Tenant_id>
            <Metadata>
                <BillType>hourlySettlement</BillType>
                <Created>2020-07-01 18:51:44</Created>
                <System_disk_id>2a3bba3d-f531-4040-832d-a222c89ee3d3</System_disk_id>
                <Image_id>259606a6-da3e-4727-a3c5-8056cd36f6ae</Image_id>
                <Image_name>CentOS 7.6</Image_name>
                <Image_system_type>linux</Image_system_type>
                <Image_system>CentOS 7.6 64位</Image_system>
                <Admin_pass>123456Aa</Admin_pass>
            </Metadata>
            <AdminPass>Lc13yfwpW</AdminPass>
            <User_id>66b5fc89cb2e4057aaacd8f3a99e1bf5</User_id>
            <Flavor>
                <Original_name>ecs_1C1G0G_general</Original_name>
                <Disk>0</Disk>
                <Ephemeral>0</Ephemeral>
                <Swap>0</Swap>
                <Vcpus>1</Vcpus>
                <Extra_specs>
                    <Quota:vif_inbound_average>1048576</Quota:vif_inbound_average>
                    <Hw:cpu_cores>1</Hw:cpu_cores>
                    <Hw:cpu_threads>1</Hw:cpu_threads>
                    <SERVICE>ECS</SERVICE>
                    <Quota:vif_outbound_average>1048576</Quota:vif_outbound_average>
                    <SPEC>GENERAL</SPEC>
                    <Hw:cpu_sockets>1</Hw:cpu_sockets>
                </Extra_specs>
                <Ram>1024</Ram>
            </Flavor>
            <Progress>0</Progress>
            <Name>ECS-TEST-NEW-NAME</Name>
            <Image></Image>
            <OS-DCF:diskConfig>MANUAL</OS-DCF:diskConfig>
            <Updated>2020-07-02T02:46:43Z</Updated>
            <Addresses>
                <Vxlan_0000000049>
                    <Addr>10.158.144.91</Addr>
                    <Version>4</Version>
                </Vxlan_0000000049>
            </Addresses>
            <Locked>false</Locked>
            <AccessIPv6></AccessIPv6>
        </Server>
    </Data>
    <Message>Successful operation!</Message>
</RebuildServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

云服务器控制台

云服务器VNC

描述

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：GetVNCConsole
Serverid String 是 待操作云服务器ID
Type String 是 VNC控制台的类型。有效值为novnc和xvpvnc。

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action os-getVNCConsole

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=GetVNCConsole&Serverid=c8b4f558-b6da-4b6d-86cc-f0070909ce20&Type=novnc&<公共请求参数>

响应示例

<GetVNCConsoleResponse>
    <Code>200</Code>
    <Data>
        <Console>
            <Type>novnc</Type>
            <Token>f79275ba-0383-497d-a107-caeaa2c31ed0</Token>
        </Console>
    </Data>
    <Message>Successful operation!</Message>
</GetVNCConsoleResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

扩容系统盘

扩容系统盘，实例必须处于关闭状态。

描述

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ExpandServerSystemDisk
Serverid String 是 待操作云服务器ID
Size String 是 系统盘扩展之后的大小。单位GiB，必须大于原有系统盘大小，最小步长为10GiB，上限为500GiB

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action expand

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ExpandServerSystemDisk&Serverid=c8b4f558-b6da-4b6d-86cc-f0070909ce20&Size=50&<公共请求参数>

响应示例

<ExpandServerSystemDiskResponse>
    <Code>200</Code>
    <Data>
        <OrderId>331023794713862144</OrderId>
        <Result>true</Result>
    </Data>
    <Message>success</Message>
</ExpandServerSystemDiskResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

包年包月云服务器续费

描述

  • 包年包月云服务器续费

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：RenewServers
ServerId String 是 待操作云服务器ID
Duration int 是 续费单位时长，单月为月,只支持：1、2、3、4、5、6、7、8、9、12、24、36

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action renew

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=RenewServers&ServerId=c8b4f558-b6da-4b6d-86cc-f0070909ce20&Duration=1&<公共请求参数>

响应示例

<RenewServersResponse>
    <Code>200</Code>
    <Data>
        <OrderId>331025583119867904</OrderId>
        <Result>true</Result>
    </Data>
    <Message>success</Message>
</RenewServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

镜像相关接口

创建私有镜像

描述

  • 创建私有镜像，生成的私有镜像可以用于创建实例。

  • 私有镜像只能保存已经写入磁盘的数据，不包括当时位于缓存的数据。建议停止云服务器写入再创建私有镜像。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：CreateImage
Serverid String 是 待操作云服务器ID
Name String 是 镜像名称。规则为：2-64个字符，不能以特殊字符及数字开头，只可包含特殊字符中的"_"或"-"
Description String 否 描述。规则为：长度为2-256个字符，不能以 http://或https://开头

权限

权限属性名称 权限属性值
service ecs
resourceType servers
action createImage

示例

请求示例

创建一个私有镜像

https://ecs.cn-north-3.inspurcloudapi.com?Action=CreateImage&Serverid=9034feb8-9d18-4a03-a2b2-41ed4d33d737&Name=selImage3&<公共请求参数>

响应示例

<CreateImageResponse>
    <Code>201</Code>
    <Data>
        <Image_id>c1382da8-9476-4830-ab89-02960c22270e</Image_id>
    </Data>
    <Message>Created</Message>
</CreateImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询镜像列表

描述

  • 本接口用于查询镜像列表。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ListImages
PageNo int 否 页数
PageSize int 否 分页大小
SearchValue String 否 查询筛选值
Visibility String 否 private：私有镜像，public：公共镜像

权限

权限属性名称 权限属性值
service ecs
resourceType images
action ListImages

示例

请求示例

查询私有镜像列表

https://ecs.cn-north-3.inspurcloudapi.com?Action=ListImages&Visibility=private&PageNo=1&PageSize=1&<公共请求参数>

响应示例

<ListImagesResponse>
    <Code>200</Code>
    <Data>
        <TotalCount>13</TotalCount>
        <Images>
            <Architecture>null</Architecture>
            <Tags>CentOS 7.6 64bit</Tags>
            <Tags>ECS</Tags>
            <Tags>SYSTEMDISK_40</Tags>
            <Status>active</Status>
            <Locations>
                <Url>rbd://ba01f534-3062-a84d-50c0-c31b3c26e3df/images/36e85627-0446-4e59-a938-6c87e1558f65/snap</Url>
            </Locations>
            <Container_format>bare</Container_format>
            <Schema>/v2/schemas/image</Schema>
            <Kernel_id>null</Kernel_id>
            <Size>42949672960</Size>
            <SystemType>linux</SystemType>
            <Name>jfw-centos76</Name>
            <Disk_format>raw</Disk_format>
            <Checksum>1d9f5b3daa38a38e3cb97beadf80152b</Checksum>
            <SystemDisk>40</SystemDisk>
            <Self>/v2/images/36e85627-0446-4e59-a938-6c87e1558f65</Self>
            <System>CentOS 7.6 64位</System>
            <Visibility>private</Visibility>
            <Links>null</Links>
            <Id>36e85627-0446-4e59-a938-6c87e1558f65</Id>
            <RegionID>cn-north-3</RegionID>
            <Os_version>7.6</Os_version>
            <Description>centos7.6-cloud-int</Description>
            <Virtual_size>null</Virtual_size>
            <Protected>false</Protected>
            <Ramdisk_id>null</Ramdisk_id>
            <Hw_architecture>null</Hw_architecture>
            <Os_distro>centos</Os_distro>
            <Owner>5718e87f79ee4d5dbf7e77ab02cf504e</Owner>
            <Created_at>2020-06-21 08:14:36</Created_at>
            <Updated_at>2020-06-21 08:34:57</Updated_at>
            <Min_disk>0</Min_disk>
            <Direct_url>rbd://ba01f534-3062-a84d-50c0-c31b3c26e3df/images/36e85627-0446-4e59-a938-6c87e1558f65/snap</Direct_url>
            <Instance_uuid>null</Instance_uuid>
            <Min_ram>0</Min_ram>
            <File>/v2/images/36e85627-0446-4e59-a938-6c87e1558f65/file</File>
        </Images>
    </Data>
    <Message>OK</Message>
</ListImagesResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询指定镜像详情

描述

  • 可以通过指定镜像ID来查询指定镜像的详细信息

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ShowImageDetails
Imageid String 是 镜像ID

示例

请求示例

查询id为dc19fd18-c656-4553-87e5-8c29074ada8f的镜像详情

https://ecs.cn-north-3.inspurcloudapi.com?Action=ShowImageDetails&Imageid=36e85627-0446-4e59-a938-6c87e1558f65&<公共请求参数>

响应示例

<ShowImageDetailsResponse>
    <Code>200</Code>
    <Data>
        <Architecture>null</Architecture>
        <Tags>CentOS 7.6 64bit</Tags>
        <Tags>ECS</Tags>
        <Tags>SYSTEMDISK_40</Tags>
        <Status>active</Status>
        <Locations>
            <Url>rbd://ba01f534-3062-a84d-50c0-c31b3c26e3df/images/36e85627-0446-4e59-a938-6c87e1558f65/snap</Url>
        </Locations>
        <Container_format>bare</Container_format>
        <Schema>/v2/schemas/image</Schema>
        <Kernel_id>null</Kernel_id>
        <Size>42949672960</Size>
        <SystemType>linux</SystemType>
        <Name>jfw-centos76</Name>
        <Disk_format>raw</Disk_format>
        <Checksum>1d9f5b3daa38a38e3cb97beadf80152b</Checksum>
        <SystemDisk>40</SystemDisk>
        <Self>/v2/images/36e85627-0446-4e59-a938-6c87e1558f65</Self>
        <System>CentOS 7.6 64位</System>
        <Visibility>private</Visibility>
        <Links>null</Links>
        <Id>36e85627-0446-4e59-a938-6c87e1558f65</Id>
        <RegionID>cn-north-3</RegionID>
        <Os_version>7.6</Os_version>
        <Description>centos7.6-cloud-int</Description>
        <Virtual_size>null</Virtual_size>
        <Protected>false</Protected>
        <Ramdisk_id>null</Ramdisk_id>
        <Hw_architecture>null</Hw_architecture>
        <Os_distro>centos</Os_distro>
        <Owner>5718e87f79ee4d5dbf7e77ab02cf504e</Owner>
        <Created_at>2020-06-21 08:14:36</Created_at>
        <Updated_at>2020-06-21 08:34:57</Updated_at>
        <Min_disk>0</Min_disk>
        <Direct_url>rbd://ba01f534-3062-a84d-50c0-c31b3c26e3df/images/36e85627-0446-4e59-a938-6c87e1558f65/snap</Direct_url>
        <Instance_uuid>null</Instance_uuid>
        <Min_ram>0</Min_ram>
        <File>/v2/images/36e85627-0446-4e59-a938-6c87e1558f65/file</File>
    </Data>
    <Message>OK</Message>
</ShowImageDetailsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

修改私有镜像

描述

  • 本接口用于修改私有镜像的名称与描述

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：UpdateImage
Imageid String 是 镜像ID
Op.N String 是 特定值：add，若进行多个操作，N由1开始依次递增。
Value.N String 是 更新修改的属性项对应的值
Path.N String 是 修改的属性项，只有两个：/description（修复描述） /name（修改名称）

权限

权限属性名称 权限属性值
service ecs
resourceType images
action UpdateImage

示例

请求示例

修改私有镜像名称或描述

https://ecs.cn-north-3.inspurcloudapi.com?Action=UpdateImage&Imageid=36e85627-0446-4e59-a938-6c87e1558f65&Op.1=add&Value.1=newdescription&Path.1=/description<公共请求参数>

响应示例

<UpdateImageResponse>
    <Code>200</Code>
    <Data>
        <Visibility>private</Visibility>
        <Id>36e85627-0446-4e59-a938-6c87e1558f65</Id>
        <Build_at>20190429</Build_at>
        <Status>active</Status>
        <Os_version>7.6</Os_version>
        <Container_format>bare</Container_format>
        <Created_at>2020-06-21T00:14:36Z</Created_at>
        <Description>newdescription</Description>
        <Os_type>linux</Os_type>
        <Schema>/v2/schemas/image</Schema>
        <Min_ram>0</Min_ram>
        <Builder>handmade</Builder>
        <Locations>
            <Url>rbd://ba01f534-3062-a84d-50c0-c31b3c26e3df/images/36e85627-0446-4e59-a938-6c87e1558f65/snap</Url>
        </Locations>
        <Size>42949672960</Size>
        <Protected>false</Protected>
        <Os_distro>centos</Os_distro>
        <Virtual_size>null</Virtual_size>
        <Name>jfw-centos76</Name>
        <Disk_format>raw</Disk_format>
        <Checksum>1d9f5b3daa38a38e3cb97beadf80152b</Checksum>
        <Updated_at>2020-07-02T03:10:07Z</Updated_at>
        <Tags>CentOS 7.6 64bit</Tags>
        <Tags>ECS</Tags>
        <Tags>SYSTEMDISK_40</Tags>
        <Owner>5718e87f79ee4d5dbf7e77ab02cf504e</Owner>
        <Min_disk>0</Min_disk>
        <Self>/v2/images/36e85627-0446-4e59-a938-6c87e1558f65</Self>
        <Hw_qemu_guest_agent>yes</Hw_qemu_guest_agent>
        <Direct_url>rbd://ba01f534-3062-a84d-50c0-c31b3c26e3df/images/36e85627-0446-4e59-a938-6c87e1558f65/snap</Direct_url>
        <File>/v2/images/36e85627-0446-4e59-a938-6c87e1558f65/file</File>
    </Data>
    <Message>update image success</Message>
</UpdateImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除私有镜像

描述

  • 本接口用于删除一个私有镜像

  • 删除私有镜像时需要保证镜像无关联的云服务器才可删除

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：DeleteImage
Imageid String 是 镜像ID

权限

权限属性名称 权限属性值
service ecs
resourceType images
action DeleteImage

示例

请求示例

删除私有镜像

https://ecs.cn-north-3.inspurcloudapi.com?Action=DeleteImage&Imageid=c26d7433-6eb3-4f93-ad90-d561410cd2cc&<公共请求参数>

响应示例

<DeleteImageResponse>
    <Code>204</Code>
    <Data>null</Data>
    <Message>null</Message>
</DeleteImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量删除私有镜像

描述

  • 本接口用于批量删除多个私有镜像

  • 删除私有镜像时需要保证所有镜像镜像无关联的云服务器才可删除

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：DeleteDatchImage
Id.N String 是 一个或多个待操作的镜像ID。若操作多个镜像，N由0开始依次递增

权限

权限属性名称 权限属性值
service ecs
resourceType images
action DeleteDatchImage

示例

请求示例

批量删除私有镜像

https://ecs.cn-north-3.inspurcloudapi.com?Action=DeleteDatchImage&Id.1=c18e47ee-2d8f-425e-844f-bad134a069a2&Id.2=80b539da-e213-4511-90bd-ade8bde9d49a&<公共请求参数>

响应示例

<DeleteDatchImageResponse>
    <Code>200</Code>
    <Data>
        <Status>删除成功台数:2 删除失败台数:0</Status>
    </Data>
    <Message>OK</Message>
</DeleteDatchImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

网络相关接口

查询云服务器所属安全组

描述

  • 本接口用于查询云服务器所属

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ListSecurityGroupsByServer
Serverid String 是 待操作云服务器ID

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ListSecurityGroupsByServer&Serverid=f792c106-b549-4e59-bbc4-d6aec668967b&<公共请求参数>

响应示例

<ListSecurityGroupsByServerResponse>
    <Code>200</Code>
    <Data>
        <Tenant_id>5718e87f79ee4d5dbf7e77ab02cf504e</Tenant_id>
        <Links>null</Links>
        <Description>Default security group</Description>
        <Name>default</Name>
        <Id>4435935b-d481-446b-bfca-5677a2d5f53e</Id>
        <Rules>
            <Ipprotocol>unrecognized</Ipprotocol>
            <Ip_protocol>null</Ip_protocol>
            <Cidr>null</Cidr>
            <Range>
                <Cidr>0.0.0.0/0</Cidr>
            </Range>
            <From_port>0</From_port>
            <Name>null</Name>
            <To_port>0</To_port>
            <Ip_range>
                <Cidr>0.0.0.0/0</Cidr>
            </Ip_range>
            <Parent_group_id>4435935b-d481-446b-bfca-5677a2d5f53e</Parent_group_id>
            <Group>
                <Tenant_id>null</Tenant_id>
                <Name>null</Name>
            </Group>
            <Id>016e3f1b-3bae-4e0b-9655-a6b8e36c8578</Id>
            <Group_id>null</Group_id>
        </Rules>
        <Rules>
            <Ipprotocol>tcp</Ipprotocol>
            <Ip_protocol>tcp</Ip_protocol>
            <Cidr>null</Cidr>
            <Range>
                <Cidr>0.0.0.0/0</Cidr>
            </Range>
            <From_port>1228</From_port>
            <Name>null</Name>
            <To_port>1228</To_port>
            <Ip_range>
                <Cidr>0.0.0.0/0</Cidr>
            </Ip_range>
            <Parent_group_id>4435935b-d481-446b-bfca-5677a2d5f53e</Parent_group_id>
            <Group>
                <Tenant_id>null</Tenant_id>
                <Name>null</Name>
            </Group>
            <Id>1b1264f2-5d34-458e-89fd-c4b04ab04d77</Id>
            <Group_id>null</Group_id>
        </Rules>
        <Rules>
            <Ipprotocol>unrecognized</Ipprotocol>
            <Ip_protocol>null</Ip_protocol>
            <Cidr>null</Cidr>
            <Range>
                <Cidr>null</Cidr>
            </Range>
            <From_port>0</From_port>
            <Name>null</Name>
            <To_port>0</To_port>
            <Ip_range>
                <Cidr>null</Cidr>
            </Ip_range>
            <Parent_group_id>4435935b-d481-446b-bfca-5677a2d5f53e</Parent_group_id>
            <Group>
                <Tenant_id>5718e87f79ee4d5dbf7e77ab02cf504e</Tenant_id>
                <Name>default</Name>
            </Group>
            <Id>59bcaf3d-a561-41bf-be6d-0f2fdf69546c</Id>
            <Group_id>null</Group_id>
        </Rules>
        <Rules>
            <Ipprotocol>unrecognized</Ipprotocol>
            <Ip_protocol>null</Ip_protocol>
            <Cidr>null</Cidr>
            <Range>
                <Cidr>0.0.0.0/0</Cidr>
            </Range>
            <From_port>0</From_port>
            <Name>null</Name>
            <To_port>0</To_port>
            <Ip_range>
                <Cidr>0.0.0.0/0</Cidr>
            </Ip_range>
            <Parent_group_id>4435935b-d481-446b-bfca-5677a2d5f53e</Parent_group_id>
            <Group>
                <Tenant_id>null</Tenant_id>
                <Name>null</Name>
            </Group>
            <Id>5af558a5-7da7-4945-8492-51442ce0f7c6</Id>
            <Group_id>null</Group_id>
        </Rules>
        <Rules>
            <Ipprotocol>tcp</Ipprotocol>
            <Ip_protocol>tcp</Ip_protocol>
            <Cidr>null</Cidr>
            <Range>
                <Cidr>0.0.0.0/0</Cidr>
            </Range>
            <From_port>3389</From_port>
            <Name>null</Name>
            <To_port>3389</To_port>
            <Ip_range>
                <Cidr>0.0.0.0/0</Cidr>
            </Ip_range>
            <Parent_group_id>4435935b-d481-446b-bfca-5677a2d5f53e</Parent_group_id>
            <Group>
                <Tenant_id>null</Tenant_id>
                <Name>null</Name>
            </Group>
            <Id>6ddb252b-9d28-4f3e-829f-91082c7769f4</Id>
            <Group_id>null</Group_id>
        </Rules>
        <Rules>
            <Ipprotocol>icmp</Ipprotocol>
            <Ip_protocol>icmp</Ip_protocol>
            <Cidr>null</Cidr>
            <Range>
                <Cidr>0.0.0.0/0</Cidr>
            </Range>
            <From_port>-1</From_port>
            <Name>null</Name>
            <To_port>-1</To_port>
            <Ip_range>
                <Cidr>0.0.0.0/0</Cidr>
            </Ip_range>
            <Parent_group_id>4435935b-d481-446b-bfca-5677a2d5f53e</Parent_group_id>
            <Group>
                <Tenant_id>null</Tenant_id>
                <Name>null</Name>
            </Group>
            <Id>8f63f71f-eade-4f3b-aa22-bcc0ea912d83</Id>
            <Group_id>null</Group_id>
        </Rules>
        <Rules>
            <Ipprotocol>unrecognized</Ipprotocol>
            <Ip_protocol>null</Ip_protocol>
            <Cidr>null</Cidr>
            <Range>
                <Cidr>null</Cidr>
            </Range>
            <From_port>0</From_port>
            <Name>null</Name>
            <To_port>0</To_port>
            <Ip_range>
                <Cidr>null</Cidr>
            </Ip_range>
            <Parent_group_id>4435935b-d481-446b-bfca-5677a2d5f53e</Parent_group_id>
            <Group>
                <Tenant_id>5718e87f79ee4d5dbf7e77ab02cf504e</Tenant_id>
                <Name>default</Name>
            </Group>
            <Id>c0e9b749-73a7-4288-89e3-9eb75f6afc12</Id>
            <Group_id>null</Group_id>
        </Rules>
    </Data>
    <Message>OK</Message>
</ListSecurityGroupsByServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

添加安全组

描述

  • 本接口用于为云服务器添加安全组

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：AddSecurityGroup
Serverid String 是 待操作云服务器ID
Name String 是 安全组名称

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=AddSecurityGroup&Serverid=9034feb8-9d18-4a03-a2b2-41ed4d33d737&Name=safegroup001&<公共请求参数>

响应示例

<AddSecurityGroupResponse>
    <Code>200</Code>
    <Data>null</Data>
    <Message>success</Message>
</AddSecurityGroupResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

更新安全组

描述

  • 本接口用于为云服务器更新安全组,支持多个

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：UpdateSecurityGroup
ServerId String 是 待操作云服务器ID
Name.N String 是 安全组id，若操作多个安全组，N从0开始依次递增，每个云服务器最多能绑定5个安全组

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=UpdateSecurityGroup&ServerId=XXXX312-d435-48a7-9c0d-29626675XXXX&Name.0=ad4a493f-7565-4b61-b390-9bd495d7f9aa&Name.1=9b04b7a9-eecf-4cf5-9412-51c2c2b72d5d&<公共请求参数>

响应示例

<UpdateSecurityGroupResponse>
    <Code>202</Code>
    <Data>null</Data>
    <Message>success</Message>
</UpdateSecurityGroupResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

移除安全组

描述

  • 本接口用于为云服务器移除安全组

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：RemoveSecurityGroup
Serverid String 是 待操作云服务器ID
Name String 是 安全组名称

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=RemoveSecurityGroup&Serverid=9034feb8-9d18-4a03-a2b2-41ed4d33d737&Name=safegroup001&<公共请求参数>

响应示例

<RemoveSecurityGroupResponse>
    <Code>200</Code>
    <Data>null</Data>
    <Message>success</Message>
</RemoveSecurityGroupResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

磁盘相关接口

查询云服务器的挂载云硬盘信息

描述

  • 获取一个云服务器的挂载云硬盘信息

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ListVolumeAttachmentsByServer
Serverid String 是 待操作云服务器ID

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ListVolumeAttachmentsByServer&Serverid=9034feb8-9d18-4a03-a2b2-41ed4d33d737&<公共请求参数>

响应示例

<ListVolumeAttachmentsByServerResponse>
    <Code>200</Code>
    <Data>
        <VolumeAttachments>
            <VolumeId>2a3bba3d-f531-4040-832d-a222c89ee3d3</VolumeId>
            <Id>2a3bba3d-f531-4040-832d-a222c89ee3d3</Id>
            <Device>/dev/vda</Device>
            <ServerId>f792c106-b549-4e59-bbc4-d6aec668967b</ServerId>
        </VolumeAttachments>
    </Data>
    <Message>OK</Message>
</ListVolumeAttachmentsByServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询可挂载云硬盘服务器列表

描述

  • 查询还可以挂载云硬盘的服务器列表

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ListServersForVolumeToAttach
Filter String 是 填写canAttachIndisk，指明要调用查询可挂载云硬盘的云服务器列表接口

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ListServersForVolumeToAttach&Filter=canAttachIndisk&<公共请求参数>

响应示例

    <ListServersForVolumeToAttachResponse>
        <code>200</code>
        <message>OK</message>
        <data>
            <instances>
                <instance_uuid>5913a1c2-32f0-4956-96f9-38cf134151e5</instance_uuid>
                <instance_name>ECS-2019510165920</instance_name>
            </instances>
            <instances>
                <instance_uuid>a8bd724a-b1e6-4969-8313-35787ee52d2e</instance_uuid>
                <instance_name>rebuild</instance_name>
            </instances>
            <instances>
                <instance_uuid>cf1309c2-9722-424b-892e-c57143c5b10c</instance_uuid>
                <instance_name>测试_连接</instance_name>
            </instances>
            <instances>
                <instance_uuid>e5fc6e20-6a58-4104-93b3-2a464a7dd90c</instance_uuid>
                <instance_name>ECS-2008验证</instance_name>
            </instances>
        </data>
    </ListServersForVolumeToAttachResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

密钥相关接口

创建或导入密钥对

描述

  • 创建或导入一个密钥

  • 创建SSH密钥成功后，请把响应数据中的私钥内容保存到本地文件，用户使用该私钥登录云服务器。为保证云服务器安全，私钥数据只能读取一次，请妥善保管。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：CreateOrImportKeypair
Keypairname String 是 待创建的密钥名称，名称不能重复。名称规则：名称长度2-128个字符，支持英文大小写、数字及特殊符号中的‘-’和‘_’，不能以数字和特殊字符开头，且密钥名称不能与已删除但仍在被云服务器使用的密钥名称相同
Type String 否 密钥类型，允许ssh和x509，默认为ssh格式
PublicKey String 否 要导入的公钥，如果忽略该字段，将为您创建新的秘钥

权限

权限属性名称 权限属性值
service ecs
resourceType os-keypairs
action CreateImportKeypair

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=CreateOrImportKeypair&Keypairname=test-00123&<公共请求参数>

响应示例

<CreateOrImportKeypairResponse>
    <Code>201</Code>
    <Data>
        <Keypair>
            <Fingerprint>0c:6d:83:d9:ec:a1:2e:99:01:8a:ec:34:3c:f7:62:6b</Fingerprint>
            <Private_key>-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEApmD8lVXtdYTJLXWgh0cr8DYnjHs+5RovVtQyY8HT2WnjamBI
it9x1glWVqtBnM6r1FRMwhIyP8kPXwIbZtJWjE0q0NsSFf/o5F9WWvmu7El+4W/f
sxFd+5aUNs1172tD6C4kihoQa3b7XhDPedVsiy2eETmh+p0A8g4YXnwAa683GVw1
531Xzi8YLKMToYxe0vBaDpJVgSJlxsFX36BU2HNo6Yf5RjXjw26j6vBNDusGtc8Y
CauSKGnrpQsRhyKsDqxO3hXGbKGRBM7HNIefrDjZI+9qUn+uKDcUFSMdoI6YkjL/
AkiP0Wjq03nQG+AenaTGc9FRcM9m4XzkPe8T3QIDAQABAoIBAQCPrN0x0Hw4qaxY
t2UirNFCpGFOrPdJPG1429GP18erzgb2y6KZWg+ht3p5aXZFhStZNlr6lGAUOPov
H1CuYCEhE1pP9X4OxWlGHRYjhc4KegU5hDR3HB4+rm/bS132nHiNvZsMLynSw3Ka
boXcPfN31LLVSSGZm48/d/CPVyG92rJGsof9OjHdB6rygtBVoRjK0V9SWLpwEajF
q1JqFpcKzLX5F0TL35ISTYYpxLS1ItXe1KYYBQU7FGRH4zoYfZNMOGHwWMD3vHzY
lV9xrHNgkuOPLpKc4JumlvLmwGexiaAbkuY6CjL0fN0MR3qzI4jN1qrqEsULAJlB
SX84IQd5AoGBANc15G/ZSfV04ddi8rS/mx1PIC0F1teok6MCMIil6LjNkGG72671
vkwppgty/lALRqAHhOae9ob24rpfg0/OvsHXcvv5zdJF2stJ/gb+/8/KRFGfFXIL
TkhIrqup4S9UlgvKqoGIakuDLo3yaMfSWDbl3hN0QScOzMAqgyro4PtHAoGBAMXp
wsdCglA7PbXqzTn1z9ymxQeN2SJ8nRZYmX5+XpwwplHjeUsflcp9dabLADna9drT
jTehB11kor4/hC7q5o2TkSjNYVen81NhlbzgB15W5ziFaWjHWtSQyTQ84uQleryB
Y1XfoDNbjgx3FryNiQuZx3AJ804xBeXc0wTgIcG7AoGAV1YDknB31yjLzgDVxgxM
AqTtxdeszHAZGfn1gD70JqslgMQf7uzDgV0ViWftVMZ+rsreYEj6euMON9wzCdw5
BalNfHxvznmSxRUOBgDOB6FqAEWzCkkUR7lXSUrzm6WUDsz8TPzzRhnCdtB9PTpb
mkvGx9ZR6mvTI9kcyfkf9FkCgYEAwlmE2bH5UBpsxkk2kZVPMwpd78YfFVuz0y7c
RLiJ5e1sVnwAL4Jr0TYUo98zcJ0R03rtcVRjbBYYLqUnA//OufbQlHXjAnY+X4Iz
zg9djQnf88QnOCqUiqtHulGUKaCYf6a7yqdYpTZiLuF/ZVfD3a18iQxsbjt75DdO
zbnfzGMCgYBzvuVibsyT1J6p+GoBFKt9wKbzfUOiPOwH0beLRHHrcUNL6Cj8MJAT
h3mkZoKKgvelUTNU3KPapxtuQHdK+prSD0j+CErwqPURLIy7ZX05XLjLcT3IzXCM
Fag3947B4Rb2pkAgsa524Xnp0P6AFN9+wf8MQoCynPmlnR67iI+A6Q==
-----END RSA PRIVATE KEY-----
</Private_key>
            <Public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCmYPyVVe11hMktdaCHRyvwNieMez7lGi9W1DJjwdPZaeNqYEiK33HWCVZWq0GczqvUVEzCEjI/yQ9fAhtm0laMTSrQ2xIV/+jkX1Za+a7sSX7hb9+zEV37lpQ2zXXva0PoLiSKGhBrdvteEM951WyLLZ4ROaH6nQDyDhhefABrrzcZXDXnfVfOLxgsoxOhjF7S8FoOklWBImXGwVffoFTYc2jph/lGNePDbqPq8E0O6wa1zxgJq5IoaeulCxGHIqwOrE7eFcZsoZEEzsc0h5+sONkj72pSf64oNxQVIx2gjpiSMv8CSI/RaOrTedAb4B6dpMZz0VFwz2bhfOQ97xPd Generated-by-Nova</Public_key>
            <Name>test-00123</Name>
            <User_id>66b5fc89cb2e4057aaacd8f3a99e1bf5</User_id>
            <Type>ssh</Type>
        </Keypair>
    </Data>
    <Message>Created</Message>
</CreateOrImportKeypairResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除密钥对

描述

  • 根据SSH密钥的名称，删除指定SSH密钥。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：DeleteKeypair
Keypairname String 是 密钥名称

权限

权限属性名称 权限属性值
service ecs
resourceType os-keypairs
action DeleteKeypair

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=DeleteKeypair&Keypairname=SSZG001&<公共请求参数>

响应示例

<DeleteKeypairResponse>
    <Code>202</Code>
    <Data>null</Data>
    <Message>Delete success</Message>
</DeleteKeypairResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询密钥对列表

描述

  • 查询SSH密钥信息列表。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ListKeypairs
PageSize int 否 页面大小，不填默认为10
PageNo int 否 页面数，不填默认为1

权限

权限属性名称 权限属性值
service ecs
resourceType os-keypairs
action ListKeypairs

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ListKeypairs&<公共请求参数>

响应示例

<ListKeypairsResponse>
    <Code>200</Code>
    <Data>
        <PageSize>1</PageSize>
        <PageNo>1</PageNo>
        <TotalCount>6</TotalCount>
        <Keypairs>
            <Keypair>
                <Public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDJNLEGVPxjNXpSOCvcNXfum2zowhY40L1l/bdPvjypy6Q25H8+ghEOReSVuHuQHU9IBMhlsEXFcE5FVLYghEPIs3toB7XegZNI5v0ghAASRqq74eIjaXsozgMK/cPU4J7gMAqnSEHr7gkXBvSKCYAPQxdv+XGCpJM+YtGnnjZFKOQ8UlPlwqCmkm0cygsEb8fcBD9GkgAmSxrAGzoSBCmKDLEJtDrT8j785IFHf8drXFKA3xt5AEv+FEe6UhVG0fs6lOUPbhkZnKwKGMAW4iz1BOkSShmZyG+sdQxt7AKd11wMg9Kuz0sy426FVG/5GmM/OSHpq9OWRU2KKa8zfG0H Generated-by-Nova</Public_key>
                <Fingerprint>cb:01:af:fe:95:bb:32:ce:69:49:50:bd:af:8b:18:db</Fingerprint>
                <Name>dgsg</Name>
                <Type>ssh</Type>
            </Keypair>
        </Keypairs>
    </Data>
    <Message>OK</Message>
</ListKeypairsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询秘钥详情

描述

  • 根据SSH密钥名称查询指定SSH密钥。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ShowKeypairDetails
Keypairname String 是 密钥名称

权限

权限属性名称 权限属性值
service ecs
resourceType os-keypairs
action GetKeypair

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ShowKeypairDetails&Keypairname=dgsg&<公共请求参数>

响应示例

<ShowKeypairDetailsResponse>
    <Code>200</Code>
    <Data>
        <Keypair>
            <Created_at>2020-05-22T01:42:37.000000</Created_at>
            <Id>10866</Id>
            <Deleted>false</Deleted>
            <Deleted_at>null</Deleted_at>
            <User_id>66b5fc89cb2e4057aaacd8f3a99e1bf5</User_id>
            <Fingerprint>cb:01:af:fe:95:bb:32:ce:69:49:50:bd:af:8b:18:db</Fingerprint>
            <Public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDJNLEGVPxjNXpSOCvcNXfum2zowhY40L1l/bdPvjypy6Q25H8+ghEOReSVuHuQHU9IBMhlsEXFcE5FVLYghEPIs3toB7XegZNI5v0ghAASRqq74eIjaXsozgMK/cPU4J7gMAqnSEHr7gkXBvSKCYAPQxdv+XGCpJM+YtGnnjZFKOQ8UlPlwqCmkm0cygsEb8fcBD9GkgAmSxrAGzoSBCmKDLEJtDrT8j785IFHf8drXFKA3xt5AEv+FEe6UhVG0fs6lOUPbhkZnKwKGMAW4iz1BOkSShmZyG+sdQxt7AKd11wMg9Kuz0sy426FVG/5GmM/OSHpq9OWRU2KKa8zfG0H Generated-by-Nova</Public_key>
            <Name>dgsg</Name>
            <Updated_at>null</Updated_at>
            <Type>ssh</Type>
        </Keypair>
    </Data>
    <Message>OK</Message>
</ShowKeypairDetailsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

云助手相关相关接口

云服务器发送并执行脚本命令

描述

  • 为一台或多台windows云服务器执行bat脚本命令，并返回对应进程PID。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：InvokeCommand
ServerIds.N String 是 需要执行命令的云服务器ID列表
Commands.N String 是 需要执行的bat命令行列表

示例

请求示例

云助手执行相关命令

https://ecs.cn-north-3.inspurcloudapi.com?Action=InvokeCommand&ServerIds.1=4224c127-0a01-4e2e-874d-447cda8c55fe&Commands.1=cd C:\\&Commands.2=dir&<公共请求参数>

响应示例

<InvokeCommandResponse>
    <Message></Message>
    <Cmd>dir</Cmd>
    <Data>
        <Pid>2544</Pid>
        <ServerId>4224c127-0a01-4e2e-874d-447cda8c55fe</ServerId>
    </Data>
    <Code>200</Code>
</InvokeCommandResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

云服务器终止相应执行进程

描述

  • 中断一台或多台windows云服务器对应PID进程的执行。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：StopInvocation
ServerId.N String 是 需要执行命令的云服务器ID列表
Pid.N int 是 需要中断执行的对应进程PID
Cmd.N String 否 需要中断执行的命令行内容

示例

请求示例

云助手停止执行相关进行

https://ecs.cn-north-3.inspurcloudapi.com?Action=StopInvocation&ServerId.1=4224c127-0a01-4e2e-874d-447cda8c55fe&Pid.1=15280&<公共请求参数>

响应示例

<StopInvocationResponse>
    <Message></Message>
    <Cmd>null</Cmd>
    <Data>
        <ExitCode>0</ExitCode>
        <ServerId>4224c127-0a01-4e2e-874d-447cda8c55fe</ServerId>
    </Data>
    <Code>200</Code>
</StopInvocationResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

云服务器查询命令执行结果

描述

  • 查询一台或多台windows云服务器bat命令执行结果。

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：DescribeInvocationResults
ServerId.N String 是 需要查询的云服务器ID列表
Pid.N int 是 需要查询执行的对应进程PID
Cmd.N String 否 需要查询执行的命令行内容

示例

请求示例

云助手查询相关命令执行结果

https://ecs.cn-north-3.inspurcloudapi.com?Action=DescribeInvocationResults&ServerId.1=509405df-a92f-4b7b-a1ad-2016c176724a&Pid.1=15280&<公共请求参数>

响应示例

<DescribeInvocationResultsResponse>
    <Message></Message>
    <Cmd>null</Cmd>
    <Data>
        <Exited>true</Exited>
        <ErrData></ErrData>
        <ServerId>4224c127-0a01-4e2e-874d-447cda8c55fe</ServerId>
        <ExitCode>0</ExitCode>
        <OutData>
C:\Windows\system32>cd C:\\ 
</OutData>
    </Data>
    <Code>200</Code>
</DescribeInvocationResultsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

云备份相关接口

创建云服务器备份

创建云服务器备份

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：EcsBackups
Incremental String 否 是否增量 默认false
Name String 是 备份名称
InstanceId String 是 云服务器的ID

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=EcsBackups&Name=test-backup-0015&InstanceId=f792c106-b549-4e59-bbc4-d6aec668967b&Incremental=false&<公共请求参数>

响应示例

<EcsBackupsResponse>
    <Code>202</Code>
    <Data>
        <UpdatedTime>null</UpdatedTime>
        <Id>12b4f382-f0f0-492b-9d3f-34cf4a268a1b</Id>
        <BackupVolumes>null</BackupVolumes>
        <Creator>2952b70c-4e42-4baf-a646-9d96147391e4</Creator>
        <InstanceImageId>da5faf99-4b18-4f8f-801e-f3b46373bbf2</InstanceImageId>
        <Incremental>false</Incremental>
        <Container>null</Container>
        <InstanceSystem>CentOS 7.4 64位</InstanceSystem>
        <Size>40</Size>
        <Region>cn-north-3</Region>
        <Name>backup-test-0015</Name>
        <InstanceImageType>null</InstanceImageType>
        <InstanceType>ECS_std</InstanceType>
        <InstanceSystemType>linux</InstanceSystemType>
        <InstanceId>f792c106-b549-4e59-bbc4-d6aec668967b</InstanceId>
        <InstanceImageName>centos74x86_64_20190408</InstanceImageName>
        <AccountId>2952b70c-4e42-4baf-a646-9d96147391e4</AccountId>
        <CreatedTime>2020-07-02 15:35:56</CreatedTime>
        <AvalibilityZone>cn-north-3a</AvalibilityZone>
        <ProjectName>null</ProjectName>
        <Status>creating</Status>
    </Data>
    <Message>Accepted</Message>
</EcsBackupsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

云服务器备份恢复

云服务器备份恢复

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：EcsBackupsRestore
InstanceId String 是 恢复云服务器的ID
BackupId String 是 备份ID
Id.N String 是 一个或多个云硬盘备份id，N由1开始依次递增
VolumeId.N String 是 一个或多个云硬盘id，N由1开始依次递增

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=EcsBackupsRestore&InstanceId=XXXbd4a41a-24fe-4536-b6c2-eb5f9a4d6212&BackupId=f8c49167-eb4d-4794-967d-e633d8bfXXX&Id.1=f8c49167-eb4d-4794-967d-e633d8bfXXX&VolumeId.1=XXXX9167-XXXX-4794-967d-e633d8bfXXX&<公共请求参数>

响应示例

    <EcsBackupsRestoreResponse>
        <code>202</code>
        <message>Accepted</message>
        <data>
            <instanceId>XXXbd4a41a-24fe-4536-b6c2-eb5f9a4d6212</instanceId>
        </data>
    </EcsBackupsRestoreResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询正在备份恢复中云服务器数量

查询正在恢复中云服务器数量

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：NumberServerBackupRestoring

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=NumberServerBackupRestoring&<公共请求参数>

响应示例

<NumberServerBackupRestoringResponse>
    <Code>200</Code>
    <Data>0</Data>
    <Message>OK</Message>
</NumberServerBackupRestoringResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除云服务器备份

删除云服务器备份

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：DeleteServerBackups
BackupId String 是 云服务器备ID

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=DeleteServerBackups&BackupId=f8c49167-eb4d-4794-967d-e633d8bf14ff&<公共请求参数>

响应示例

    <DeleteServerBackupsResponse>
        <code>200</code>
        <message>The command is sent successfully, and the operation is in progress.             </message>                  
        <data/>
    </DeleteServerBackupsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量删除云服务器备份

批量删除云服务备份

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：DeleteMultipleServerBackups
SnapIds String 是 云服务器备id,多个的话以【,】隔开

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=DeleteMultipleServerBackups&SnapIds=92abdb6b-b4b2-4412-965d-6fe02783ac30,f8c49167-eb4d-4794-967d-e633d8bf14ff&<公共请求参数>

响应示例

    <DeleteMultipleServerBackupsResponse>
        <code>200</code>
        <message>The command is sent successfully, and the operation is in progress.             </message>                  
        <data/>
    </DeleteMultipleServerBackupsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询云服务器备份详情

查询云服务器备份详情

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ShowBackupsDetails
BackupId String 是 云服务器备id

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ShowBackupsDetails&BackupId=f8c49167-eb4d-4794-967d-e633d8bf14ff&<公共请求参数>

响应示例

<ShowBackupsDetailsResponse>
    <Code>200</Code>
    <Data>
        <UpdatedTime>2020-04-28 20:29:52</UpdatedTime>
        <Id>04fef082-53df-47e0-a2e4-cce949954502</Id>
        <BackupVolumes>
            <DeviceName>null</DeviceName>
            <VolumeType>SATA</VolumeType>
            <Id>baeec9e4-67bc-436b-926c-34baa3d91886</Id>
            <BackupId>04fef082-53df-47e0-a2e4-cce949954502</BackupId>
            <Name>ECS-Test_system_20200428121255999</Name>
            <Creator>2952b70c-4e42-4baf-a646-9d96147391e4</Creator>
            <Bootable>true</Bootable>
            <Incremental>false</Incremental>
            <VolumeName>null</VolumeName>
            <AccountId>2952b70c-4e42-4baf-a646-9d96147391e4</AccountId>
            <Status>available</Status>
            <CreatedTime>2020-04-28 20:12:55</CreatedTime>
            <UpdatedTime>2020-04-28 20:29:52</UpdatedTime>
            <VolumeId>9f95c75b-f755-4a76-9e9f-228cf8a14c95</VolumeId>
            <Size>40</Size>
        </BackupVolumes>
        <BackupVolumes>
            <DeviceName>null</DeviceName>
            <VolumeType>SATA</VolumeType>
            <Id>f521149f-c6f9-4f92-897b-5495ce731aa2</Id>
            <BackupId>04fef082-53df-47e0-a2e4-cce949954502</BackupId>
            <Name>ecs_0_20200428121259520</Name>
            <Creator>2952b70c-4e42-4baf-a646-9d96147391e4</Creator>
            <Bootable>false</Bootable>
            <Incremental>false</Incremental>
            <VolumeName>null</VolumeName>
            <AccountId>2952b70c-4e42-4baf-a646-9d96147391e4</AccountId>
            <Status>available</Status>
            <CreatedTime>2020-04-28 20:12:55</CreatedTime>
            <UpdatedTime>2020-04-28 20:29:52</UpdatedTime>
            <VolumeId>b68d552a-88f5-4c72-871f-55ac793a93bb</VolumeId>
            <Size>20</Size>
        </BackupVolumes>
        <Creator>2952b70c-4e42-4baf-a646-9d96147391e4</Creator>
        <InstanceImageId>259606a6-da3e-4727-a3c5-8056cd36f6ae</InstanceImageId>
        <Incremental>false</Incremental>
        <Container>null</Container>
        <InstanceSystem>CentOS 7.6 64位</InstanceSystem>
        <Size>60</Size>
        <Region>cn-north-3</Region>
        <Name>backup_test3</Name>
        <InstanceImageType>public</InstanceImageType>
        <InstanceType>ECS_std</InstanceType>
        <InstanceSystemType>linux</InstanceSystemType>
        <InstanceId>c17d19b1-3d32-42f8-9ef8-d815b5450461</InstanceId>
        <InstanceImageName>CentOS 7.6</InstanceImageName>
        <AccountId>2952b70c-4e42-4baf-a646-9d96147391e4</AccountId>
        <CreatedTime>2020-04-28 20:12:55</CreatedTime>
        <AvalibilityZone>cn-north-3a</AvalibilityZone>
        <ProjectName>null</ProjectName>
        <Status>available</Status>
    </Data>
    <Message>success</Message>
</ShowBackupsDetailsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询云服务器备份列表

查询云服务器备份列表

请求参数

名称 类型 是否必须 描述
Action String 是 公共参数，取值：ListServerBackups
PageNo int 是 云服务器备份列表显示页码
PageSize int 是 列表每页数量
SearchField String 是 列表查询key值。name(模糊查询)、id（多个精确查询）、instanceIds（多个精确查询）（多个传法"id1,id2,id3"）
SearchValue String 是 列表查询key值对应的目标值

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ListServerBackups&PageNo=1&PageSize=1&SearchField=name&SearchValue=test&<公共请求参数>

响应示例

<ListServerBackupsResponse>
    <Code>200</Code>
    <Data>
        <PageSize>1</PageSize>
        <PageNo>1</PageNo>
        <TotalCount>1</TotalCount>
        <Backups>
            <UpdatedTime>2020-04-28 20:29:52</UpdatedTime>
            <Id>04fef082-53df-47e0-a2e4-cce949954502</Id>
            <BackupVolumes>null</BackupVolumes>
            <Creator>2952b70c-4e42-4baf-a646-9d96147391e4</Creator>
            <InstanceImageId>259606a6-da3e-4727-a3c5-8056cd36f6ae</InstanceImageId>
            <Incremental>false</Incremental>
            <Container>null</Container>
            <InstanceSystem>CentOS 7.6 64位</InstanceSystem>
            <Size>60</Size>
            <Region>cn-north-3</Region>
            <Name>backup_test3</Name>
            <InstanceImageType>null</InstanceImageType>
            <InstanceType>ECS_std</InstanceType>
            <InstanceSystemType>linux</InstanceSystemType>
            <InstanceId>c17d19b1-3d32-42f8-9ef8-d815b5450461</InstanceId>
            <InstanceImageName>CentOS 7.6</InstanceImageName>
            <AccountId>2952b70c-4e42-4baf-a646-9d96147391e4</AccountId>
            <CreatedTime>2020-04-28 20:12:55</CreatedTime>
            <AvalibilityZone>cn-north-3a</AvalibilityZone>
            <ProjectName>null</ProjectName>
            <Status>available</Status>
        </Backups>
    </Data>
    <Message>success</Message>
</ListServerBackupsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码