云服务器相关接口

创建云服务器

描述

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

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

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

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

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

请求参数

名称 类型 是否必须 描述
Action String 公共参数,取值:CreateServer
BillType String 计费方式,hourlySettlement或monthly
Duration String 若计费方式为monthly,该参数必传
DurationUnit String 若计费方式为monthly,该参数必传
Count String 云服务器购买数量
ServerName String 云服务器名称,长度为2-128个字符,不能以特殊字符及数字开头,只可包含特殊字符中的".","_"或"-"
FlavorRef String 创建云服务器的系统规格,请参考产品规格
Vcpus String 若FlavorRef=S1.null,Vcpus必传
Ram String 若FlavorRef=S1.null,Ram必传
ImageRef String 镜像的UUID
RootVolumeSize String 系统盘容量, 不能小于镜像大小,最大不超过500GiB
DataVolumeSize.N String 数据盘容量。若购买多块数据盘,N由1开始依次递增;最多可挂载23块数据盘
EipBandWidth String 弹性ip带宽
VpcId String Vpc id
SubnetId String Subnet id
SecurityGroups.N String 实例所属安全组。若所属多安全组,N由1开始依次递增
AdminPass String 实例的密码。密码功能规则为:8-32个字符,必须包含大小写字母和数字,支持英文特殊字符!"$%()*+,-./:;<=>?@[]^_`{|}~
IsAutoRenew String 资源是否自动续费,true:自动续费;false:不自动续费(默认)

返回参数

名称 类型 描述
RequestId String 请求流水号
Code String 返回码:0成功,其他失败
Message String 描述信息

示例

请求示例

创建一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=CreateServer&BillType=hourlySettlement&Count=1&ServerName=SSZGH&FlavorRef=S1.small.1&ImageRef=c26d7433-6eb3-4f93-ad90-d561410cd2cc&RootVolumeSize=60&VpcId=1154233141711482880&SubnetId=992f9450-af0f-4b2b-9c7d-4ffc648d6c2b&SecurityGroups.1=98a26a0d-5734-4e1b-a973-e8da89221f08&AdminPass=123456a?A&<公共请求参数>

响应示例

<CreateServerResponse>
    <Result>
        <Result>true</Result>
        <OrderId>206718397769515008</OrderId>
    </Result>
    <Code>0</Code>
    <RequestId>881623b4-cfe3-4f54-8e71-8d78157cb222</RequestId>
    <Message>创建订单成功!</Message>
</CreateServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

启动云服务器

启动一台云服务器

描述

  • 实例状态必须为已停止(stopped),才可以进行此操作

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

请求参数

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

示例

请求示例

启动一台云服务器

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

响应示例

<StartServerResponse>
    <Code>202</Code>
    <Data>null</Data>
    <RequestId>20d82331-9aae-40b8-984f-a92a0e739392</RequestId>
    <Message>null</Message>
</StartServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量启动云服务器

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

请求参数

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

示例

请求示例

启动三台云服务器

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>
    <RequestId>f0dfbeb3-7b9d-4acd-bcee-e075f3708a71</RequestId>
    <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

示例

请求示例

关闭一台云服务器

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

响应示例

<StopServerResponse>
    <Code>202</Code>
    <Data>null</Data>
    <RequestId>fe0aac60-a1df-4b73-817e-10689f57c8cc</RequestId>
    <Message>null</Message>
</StopServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量关闭云服务器

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

请求参数

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

示例

请求示例

关闭两台云服务器

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>
    <RequestId>53db9fc2-beec-4ba9-b97c-dfe5f1269da3</RequestId>
    <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:强制重启

示例

请求示例

重启一台云服务器

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

响应示例

<RebootServerResponse>
    <Code>202</Code>
    <Data>null</Data>
    <RequestId>09bdac6a-2af8-416e-8bd9-bce71161b01f</RequestId>
    <Message>null</Message>
</RebootServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量重启云服务器

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

请求参数

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

示例

请求示例

重启两台云服务器

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>
    <RequestId>41b3bd5e-b2bf-4ed9-bd59-5ffe187a56d4</RequestId>
    <Message>The following server reboot success:[{c8b4f558-b6da-4b6d-86cc-f0070909ce20},{9034feb8-9d18-4a03-a2b2-41ed4d33d737}]</Message>
</RebootMultipleServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除云服务器

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

请求参数

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

请求示例

请求示例

删除一台云服务器

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

响应示例

<DeleteServerResponse>
    <Result>
        <Result>true</Result>
        <OrderId>206814022614974464</OrderId>
    </Result>
    <Code>0</Code>
    <RequestId>9ca101a4-ed6c-42d0-b88e-da10efd79d6a</RequestId>
    <Message>创建订单成功!</Message>
</DeleteServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查看云服务器列表

请求参数

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

示例

请求示例

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

响应示例

<ListServersResponse>
    <Code>200</Code>
    <Data>
        <ServersContainer>
            <Servers>
                <Image>
                    <System>CentOS 7.4 64位</System>
                    <Name>ecs-centos7.4-x64-20181226</Name>
                    <SystemType>linux</SystemType>
                    <Id>27dc8e63-6d28-4f80-a6f4-e5a855a02e46</Id>
                    <TagsContainer>
                        <Tags>CentOS 7.4 64bit</Tags>
                    </TagsContainer>
                </Image>
                <Availability_zone>cn-north-3a</Availability_zone>
                <Addresses>
                    <Default-vpcContainer>
                        <Default-vpc>
                            <OS-EXT-IPS-MAC:mac_addr>fa:16:3e:59:2a:9b</OS-EXT-IPS-MAC:mac_addr>
                            <OS-EXT-IPS:type>fixed</OS-EXT-IPS:type>
                            <Addr>172.31.0.20</Addr>
                            <Version>4</Version>
                        </Default-vpc>
                    </Default-vpcContainer>
                </Addresses>
                <Created>2019-07-25 14:19:33</Created>
                <Data_volumesContainer></Data_volumesContainer>
                <Root_volume>
                    <Volume_type>SATA</Volume_type>
                    <Size>40</Size>
                </Root_volume>
                <Task_state>null</Task_state>
                <Eip>null</Eip>
                <Power_state>1</Power_state>
                <TagsContainer>
                    <Tags>ECS</Tags>
                </TagsContainer>
                <Flavor>
                    <Disk>40</Disk>
                    <Swap>0</Swap>
                    <Original_name>ecs_1C1G40G_general</Original_name>
                    <Extra_specs>
                        <Hw:cpu_cores>1</Hw:cpu_cores>
                        <Hw:cpu_sockets>1</Hw:cpu_sockets>
                        <SERVICE>ECS</SERVICE>
                        <Quota:vif_outbound_average>1048576</Quota:vif_outbound_average>
                        <Hw:cpu_threads>1</Hw:cpu_threads>
                        <SPEC>GENERAL</SPEC>
                        <Quota:vif_inbound_average>1048576</Quota:vif_inbound_average>
                    </Extra_specs>
                    <Ephemeral>0</Ephemeral>
                    <Vcpus>1</Vcpus>
                    <Ram>1.0</Ram>
                </Flavor>
                <Key_name>null</Key_name>
                <Vm_state>active</Vm_state>
                <Vpcname>Default-vpc</Vpcname>
                <Security_groupsContainer>
                    <Security_groups>
                        <Name>default</Name>
                    </Security_groups>
                </Security_groupsContainer>
                <FeeData>
                    <IsAutoRenew>false</IsAutoRenew>
                    <CreateTime>2019-07-25 14:19:33</CreateTime>
                    <DeleteTime>null</DeleteTime>
                    <ServiceStatus>alreadyOpened</ServiceStatus>
                    <BillType>hourlySettlement</BillType>
                    <StartFeeTime>2019-07-25 14:19:33</StartFeeTime>
                    <DaysOfDelete>null</DaysOfDelete>
                    <NextFeeTime>2099-12-31 23:59:59</NextFeeTime>
                </FeeData>
                <RegionID>cn-north-3</RegionID>
                <DiskConfig>MANUAL</DiskConfig>
                <Vpcid>1108258725594615808</Vpcid>
                <Name>ECS-2019725141121-0003</Name>
                <NicsContainer>
                    <Nics>
                        <Mac_address>fa:16:3e:59:2a:9b</Mac_address>
                        <Subnet_cidr>172.31.0.0/20</Subnet_cidr>
                        <Subnet_id>00ad1540-22e0-4885-805e-a7b96e2d284d</Subnet_id>
                        <NetworkId>27fe2536-cf81-4ea9-902e-5f5f9dd1992a</NetworkId>
                        <Fixed_ip>172.31.0.20</Fixed_ip>
                        <Subnet_name>Default-subnet</Subnet_name>
                        <Portid>2ba66c1f-2073-4cd9-b7e7-d61e854130b7</Portid>
                    </Nics>
                </NicsContainer>
                <Id>c8b4f558-b6da-4b6d-86cc-f0070909ce20</Id>
                <Updated>2019-07-25 16:43:51</Updated>
                <Status>active</Status>
            </Servers>
        </ServersContainer>
        <TotalCount>9</TotalCount>
    </Data>
    <RequestId>500321e4-0ff8-43b0-ba52-1efa9b4a4a4f</RequestId>
    <Message>OK</Message>
</ListServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

变更云服务器规格

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

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

请求参数

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

示例

请求示例

变更一台实例规格

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

响应示例

<ResizeServerResponse>
    <RequestId>e686474d-7426-4feb-8e6b-2a4972aac3b0</RequestId>
    <Result>
        <OrderDetailFlowIdListContainer>
            <OrderDetailFlowIdList>132864367706578944</OrderDetailFlowIdList>
        </OrderDetailFlowIdListContainer>
        <OrderId>132864367572361216</OrderId>
        <SettleAccountListContainer>
            <SettleAccountList>
                <Amount>0</Amount>
                <Type>cash</Type>
            </SettleAccountList>
            <SettleAccountList>
                <Amount>0</Amount>
                <Type>grant</Type>
            </SettleAccountList>
            <SettleAccountList>
                <Amount>0</Amount>
                <Type>credit</Type>
            </SettleAccountList>
        </SettleAccountListContainer>
    </Result>
    <Code>0</Code>
    <Message>open api create order success!</Message>
</ResizeServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查看云服务器详情

查看一台云服务器详情。

请求参数

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

示例

请求示例

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

响应示例

<ShowServersDetailsResponse>
    <Code>200</Code>
    <Data>
        <Server>
            <Image>
                <System>CentOS 7.4 64位</System>
                <Name>ecs-centos7.4-x64-20181226</Name>
                <SystemType>linux</SystemType>
                <Id>27dc8e63-6d28-4f80-a6f4-e5a855a02e46</Id>
                <TagsContainer>
                    <Tags>CentOS 7.4 64bit</Tags>
                </TagsContainer>
            </Image>
            <Availability_zone>cn-north-3a</Availability_zone>
            <Addresses>
                <Default-vpcContainer>
                    <Default-vpc>
                        <OS-EXT-IPS-MAC:mac_addr>fa:16:3e:65:36:65</OS-EXT-IPS-MAC:mac_addr>
                        <OS-EXT-IPS:type>fixed</OS-EXT-IPS:type>
                        <Addr>172.31.0.16</Addr>
                        <Version>4</Version>
                    </Default-vpc>
                </Default-vpcContainer>
            </Addresses>
            <Created>2019-07-25 14:19:33</Created>
            <Data_volumesContainer></Data_volumesContainer>
            <Root_volume>
                <Volume_type>SATA</Volume_type>
                <Size>40</Size>
            </Root_volume>
            <Task_state>null</Task_state>
            <Eip>null</Eip>
            <Power_state>1</Power_state>
            <TagsContainer>
                <Tags>ECS</Tags>
            </TagsContainer>
            <Flavor>
                <Disk>40</Disk>
                <Swap>0</Swap>
                <Original_name>ecs_1C1G40G_general</Original_name>
                <Extra_specs>
                    <Hw:cpu_cores>1</Hw:cpu_cores>
                    <Hw:cpu_sockets>1</Hw:cpu_sockets>
                    <SERVICE>ECS</SERVICE>
                    <Quota:vif_outbound_average>1048576</Quota:vif_outbound_average>
                    <Hw:cpu_threads>1</Hw:cpu_threads>
                    <SPEC>GENERAL</SPEC>
                    <Quota:vif_inbound_average>1048576</Quota:vif_inbound_average>
                </Extra_specs>
                <Ephemeral>0</Ephemeral>
                <Vcpus>1</Vcpus>
                <Ram>1.0</Ram>
            </Flavor>
            <Key_name>null</Key_name>
            <Vm_state>active</Vm_state>
            <Vpcname>Default-vpc</Vpcname>
            <Security_groupsContainer>
                <Security_groups>
                    <Name>default</Name>
                    <Id>98a26a0d-5734-4e1b-a973-e8da89221f08</Id>
                </Security_groups>
            </Security_groupsContainer>
            <FeeData>
                <IsAutoRenew>false</IsAutoRenew>
                <CreateTime>2019-07-25 14:19:33</CreateTime>
                <DeleteTime>null</DeleteTime>
                <ServiceStatus>alreadyOpened</ServiceStatus>
                <BillType>hourlySettlement</BillType>
                <StartFeeTime>2019-07-25 14:19:33</StartFeeTime>
                <DaysOfDelete>null</DaysOfDelete>
                <NextFeeTime>2099-12-31 23:59:59</NextFeeTime>
            </FeeData>
            <RegionID>cn-north-3</RegionID>
            <DiskConfig>MANUAL</DiskConfig>
            <Vpcid>1108258725594615808</Vpcid>
            <Name>ECS-2019725141121-0002</Name>
            <NicsContainer>
                <Nics>
                    <Mac_address>fa:16:3e:65:36:65</Mac_address>
                    <Subnet_cidr>172.31.0.0/20</Subnet_cidr>
                    <Subnet_id>00ad1540-22e0-4885-805e-a7b96e2d284d</Subnet_id>
                    <NetworkId>27fe2536-cf81-4ea9-902e-5f5f9dd1992a</NetworkId>
                    <Fixed_ip>172.31.0.16</Fixed_ip>
                    <Subnet_name>Default-subnet</Subnet_name>
                    <Portid>98e077d9-ea13-4532-81ed-b02e2f10f7ba</Portid>
                </Nics>
            </NicsContainer>
            <Id>9034feb8-9d18-4a03-a2b2-41ed4d33d737</Id>
            <Updated>2019-07-25 16:43:36</Updated>
            <Status>active</Status>
        </Server>
    </Data>
    <RequestId>6a65cf3e-e582-4856-ad1a-77868cbc0850</RequestId>
    <Message>OK</Message>
</ShowServersDetailsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

修改云服务器密码

修改云服务器密码

描述

请求参数

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

示例

请求示例

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>
    <RequestId>11370bca-e2c5-49bf-b9d1-035c43879a2a</RequestId>
    <Message>null</Message>
</ChangeAdministrativePasswordResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

重置操作系统

重置操作系统

描述

请求参数

名称 类型 是否必须 描述
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 云服务器重建初始化注入数据

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=RebuildServer
&Serverid=396bb8d5-c2c6-4642-b578-1645b8ef103d
&ImageRef=5c610cbe-f5cb-46a8-8ae7-4fe78e1a2be1
&AdminPass=123456Aa
&<公共请求参数>

响应示例

<RebuildServerResponse>
    <RequestId>0ae200e5-40a4-4077-b9e9-5b8eef4c7717</RequestId>
    <Code>202</Code>
    <Data>
        <Server>
            <Tenant_id>5718e87f79ee4d5dbf7e77ab02cf504e</Tenant_id>
            <Image>
                <LinksContainer>
                    <Links>
                        <Rel>bookmark</Rel>
                        <Href>http://10.200.0.20:8774/5718e87f79ee4d5dbf7e77ab02cf504e/images/5c610cbe-f5cb-46a8-8ae7-4fe78e1a2be1</Href>
                    </Links>
                </LinksContainer>
                <Id>5c610cbe-f5cb-46a8-8ae7-4fe78e1a2be1</Id>
            </Image>
            <AccessIPv4/>
            <Addresses>
                <Vxlan_0000000049Container>
                    <Vxlan_0000000049>
                        <Addr>10.158.144.9</Addr>
                        <Version>4</Version>
                    </Vxlan_0000000049>
                </Vxlan_0000000049Container>
            </Addresses>
            <Metadata>
                <Admin_pass>123456Aa</Admin_pass>
            </Metadata>
            <AccessIPv6/>
            <Created>2018-12-17T08:56:02Z</Created>
            <HostId>17019590b6f94ad670b8d6d4290af9e83caf0c61363b0833b9523ab9</HostId>
            <Description>description of foobar</Description>
            <AdminPass>123456Aa</AdminPass>
            <TagsContainer>
                <Tags>ECS</Tags>
            </TagsContainer>
            <Flavor>
                <Disk>40</Disk>
                <Swap>0</Swap>
                <Original_name>ecs_1C1G40G_general</Original_name>
                <Extra_specs>
                    <SERVICE>ECS</SERVICE>
                    <Quota:vif_outbound_average>1048576</Quota:vif_outbound_average>
                    <SPEC>GENERAL</SPEC>
                    <Quota:vif_inbound_average>1048576</Quota:vif_inbound_average>
                </Extra_specs>
                <Ephemeral>0</Ephemeral>
                <Vcpus>1</Vcpus>
                <Ram>1024</Ram>
            </Flavor>
            <OS-DCF:diskConfig>MANUAL</OS-DCF:diskConfig>
            <User_id>66b5fc89cb2e4057aaacd8f3a99e1bf5</User_id>
            <Name>foobar</Name>
            <Progress>0</Progress>
            <LinksContainer>
                <Links>
                    <Rel>self</Rel>
                    <Href>http://10.200.0.20:8774/v2.1/5718e87f79ee4d5dbf7e77ab02cf504e/servers/dc19fd18-c656-4553-87e5-8c29074ada8f</Href>
                </Links>
                <Links>
                    <Rel>bookmark</Rel>
                    <Href>http://10.200.0.20:8774/5718e87f79ee4d5dbf7e77ab02cf504e/servers/dc19fd18-c656-4553-87e5-8c29074ada8f</Href>
                </Links>
            </LinksContainer>
            <Id>dc19fd18-c656-4553-87e5-8c29074ada8f</Id>
            <Locked>false</Locked>
            <Updated>2019-01-02T08:42:18Z</Updated>
            <Status>REBUILD</Status>
        </Server>
    </Data>
    <Message>Successful operation!</Message>
</RebuildServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

云服务器控制台

云服务器VNC

描述

请求参数

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

示例

请求示例

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>
    <RequestId>af1abde1-5c32-418d-a46c-797689f3f1fa</RequestId>
    <Message>Successful operation!</Message>
</GetVNCConsoleResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

扩容系统盘

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

描述

请求参数

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

示例

请求示例

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

响应示例

<ExpandServerSystemDiskResponse>
    <Result>
        <Result>true</Result>
        <OrderId>206818656704331776</OrderId>
    </Result>
    <Code>0</Code>
    <RequestId>32873c41-9c91-43fc-97d2-98fadf1c84aa</RequestId>
    <Message>创建订单成功!</Message>
</ExpandServerSystemDiskResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

镜像相关接口

创建私有镜像

描述

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

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

请求参数

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

示例

请求示例

创建一个私有镜像

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>
    <RequestId>6863fd0e-11cd-4039-bbb1-7bf0db343c34</RequestId>
    <Message>Created</Message>
</CreateImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询镜像列表

描述

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

请求参数

名称 类型 是否必须 描述
Action String 公共参数,取值:ListImages
Visibility String private:私有镜像,public:公共镜像

示例

请求示例

查询私有镜像列表

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

响应示例

<ListImagesResponse>
    <Code>200</Code>
    <Data>
        <ImagesContainer>
            <Images>
                <Schema>/v2/schemas/image</Schema>
                <Direct_url>null</Direct_url>
                <Min_disk>40</Min_disk>
                <Description>null</Description>
                <Created_at>2019-07-25 17:05:55</Created_at>
                <Container_format>bare</Container_format>
                <File>/v2/images/c1382da8-9476-4830-ab89-02960c22270e/file</File>
                <Updated_at>2019-07-25 17:06:52</Updated_at>
                <Protected>false</Protected>
                <RegionID>cn-north-3</RegionID>
                <Checksum>null</Checksum>
                <SystemType>null</SystemType>
                <Links>null</Links>
                <Id>c1382da8-9476-4830-ab89-02960c22270e</Id>
                <Min_ram>0</Min_ram>
                <Architecture>null</Architecture>
                <Owner>a3499d8221e04a60beef0c008efca505</Owner>
                <Visibility>private</Visibility>
                <SystemDisk>null</SystemDisk>
                <Os_version>7.4</Os_version>
                <TagsContainer></TagsContainer>
                <System>null</System>
                <Kernel_id>null</Kernel_id>
                <Size>null</Size>
                <Name>selImage3</Name>
                <Self>/v2/images/c1382da8-9476-4830-ab89-02960c22270e</Self>
                <Disk_format>raw</Disk_format>
                <Locations>null</Locations>
                <Ramdisk_id>null</Ramdisk_id>
                <Os_distro>centos</Os_distro>
                <Instance_uuid>9034feb8-9d18-4a03-a2b2-41ed4d33d737</Instance_uuid>
                <Virtual_size>null</Virtual_size>
                <Status>saving</Status>
            </Images>
            <Images>
                <Schema>/v2/schemas/image</Schema>
                <Direct_url>rbd://dda6d394-a64a-4fda-aacc-01de3e9e7724/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b/snap</Direct_url>
                <Min_disk>40</Min_disk>
                <Description>null</Description>
                <Created_at>2019-07-24 14:46:33</Created_at>
                <Container_format>bare</Container_format>
                <File>/v2/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b/file</File>
                <Updated_at>2019-07-24 16:37:04</Updated_at>
                <Protected>false</Protected>
                <RegionID>cn-north-3</RegionID>
                <Checksum>eb3a1e04a7f2de95b81f4e8d83376810</Checksum>
                <SystemType>null</SystemType>
                <Links>null</Links>
                <Id>912ae3fb-6cf2-4026-b18a-bff068b68e9b</Id>
                <Min_ram>0</Min_ram>
                <Architecture>null</Architecture>
                <Owner>a3499d8221e04a60beef0c008efca505</Owner>
                <Visibility>private</Visibility>
                <SystemDisk>null</SystemDisk>
                <Os_version>2k8R2STD</Os_version>
                <TagsContainer></TagsContainer>
                <System>null</System>
                <Kernel_id>null</Kernel_id>
                <Size>42949672960</Size>
                <Name>selImage3</Name>
                <Self>/v2/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b</Self>
                <Disk_format>raw</Disk_format>
                <Locations>null</Locations>
                <Ramdisk_id>null</Ramdisk_id>
                <Os_distro>2k8R2</Os_distro>
                <Instance_uuid>cbd94682-acae-4c56-99a0-84ce3a5cd4e4</Instance_uuid>
                <Virtual_size>null</Virtual_size>
                <Status>active</Status>
            </Images>
            <Images>
                <Schema>/v2/schemas/image</Schema>
                <Direct_url>rbd://dda6d394-a64a-4fda-aacc-01de3e9e7724/images/93768c58-7706-4d2a-a541-3e0d69a830e6/snap</Direct_url>
                <Min_disk>40</Min_disk>
                <Description>null</Description>
                <Created_at>2019-06-24 13:32:47</Created_at>
                <Container_format>bare</Container_format>
                <File>/v2/images/93768c58-7706-4d2a-a541-3e0d69a830e6/file</File>
                <Updated_at>2019-06-24 14:49:34</Updated_at>
                <Protected>false</Protected>
                <RegionID>cn-north-3</RegionID>
                <Checksum>95e74fde0ed4ba14dacd4f349b4c4f02</Checksum>
                <SystemType>null</SystemType>
                <Links>null</Links>
                <Id>93768c58-7706-4d2a-a541-3e0d69a830e6</Id>
                <Min_ram>0</Min_ram>
                <Architecture>null</Architecture>
                <Owner>a3499d8221e04a60beef0c008efca505</Owner>
                <Visibility>private</Visibility>
                <SystemDisk>null</SystemDisk>
                <Os_version>7.4</Os_version>
                <TagsContainer></TagsContainer>
                <System>null</System>
                <Kernel_id>null</Kernel_id>
                <Size>42949672960</Size>
                <Name>testtest</Name>
                <Self>/v2/images/93768c58-7706-4d2a-a541-3e0d69a830e6</Self>
                <Disk_format>raw</Disk_format>
                <Locations>null</Locations>
                <Ramdisk_id>null</Ramdisk_id>
                <Os_distro>centos</Os_distro>
                <Instance_uuid>8e7df128-7502-4122-8663-83c62a1da561</Instance_uuid>
                <Virtual_size>null</Virtual_size>
                <Status>active</Status>
            </Images>
            <Images>
                <Schema>/v2/schemas/image</Schema>
                <Direct_url>rbd://dda6d394-a64a-4fda-aacc-01de3e9e7724/images/c26d7433-6eb3-4f93-ad90-d561410cd2cc/snap</Direct_url>
                <Min_disk>40</Min_disk>
                <Description>null</Description>
                <Created_at>2019-06-12 15:36:47</Created_at>
                <Container_format>bare</Container_format>
                <File>/v2/images/c26d7433-6eb3-4f93-ad90-d561410cd2cc/file</File>
                <Updated_at>2019-06-12 17:00:32</Updated_at>
                <Protected>false</Protected>
                <RegionID>cn-north-3</RegionID>
                <Checksum>9b4867cdf6110727692ecdbf215afc63</Checksum>
                <SystemType>null</SystemType>
                <Links>null</Links>
                <Id>c26d7433-6eb3-4f93-ad90-d561410cd2cc</Id>
                <Min_ram>0</Min_ram>
                <Architecture>null</Architecture>
                <Owner>a3499d8221e04a60beef0c008efca505</Owner>
                <Visibility>private</Visibility>
                <SystemDisk>null</SystemDisk>
                <Os_version>7.4</Os_version>
                <TagsContainer></TagsContainer>
                <System>null</System>
                <Kernel_id>null</Kernel_id>
                <Size>42949672960</Size>
                <Name>kdasfjkajf</Name>
                <Self>/v2/images/c26d7433-6eb3-4f93-ad90-d561410cd2cc</Self>
                <Disk_format>raw</Disk_format>
                <Locations>null</Locations>
                <Ramdisk_id>null</Ramdisk_id>
                <Os_distro>centos</Os_distro>
                <Instance_uuid>d6d1fd60-8689-4aa9-8f81-b42474a70eaa</Instance_uuid>
                <Virtual_size>null</Virtual_size>
                <Status>active</Status>
            </Images>
        </ImagesContainer>
        <TotalCount>4</TotalCount>
    </Data>
    <RequestId>784e2485-3396-4bf2-a406-b6c3b9db5f3b</RequestId>
    <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=912ae3fb-6cf2-4026-b18a-bff068b68e9b&<公共请求参数>

响应示例

<ShowImageDetailsResponse>
    <Code>200</Code>
    <Data>
        <Schema>/v2/schemas/image</Schema>
        <Direct_url>rbd://dda6d394-a64a-4fda-aacc-01de3e9e7724/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b/snap</Direct_url>
        <Min_disk>40</Min_disk>
        <Description>null</Description>
        <Created_at>2019-07-24 14:46:33</Created_at>
        <Container_format>bare</Container_format>
        <File>/v2/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b/file</File>
        <Updated_at>2019-07-24 16:37:04</Updated_at>
        <Protected>false</Protected>
        <RegionID>cn-north-3</RegionID>
        <Checksum>eb3a1e04a7f2de95b81f4e8d83376810</Checksum>
        <SystemType>null</SystemType>
        <Links>null</Links>
        <Id>912ae3fb-6cf2-4026-b18a-bff068b68e9b</Id>
        <Min_ram>0</Min_ram>
        <Architecture>null</Architecture>
        <Owner>a3499d8221e04a60beef0c008efca505</Owner>
        <Visibility>private</Visibility>
        <SystemDisk>null</SystemDisk>
        <Os_version>2k8R2STD</Os_version>
        <TagsContainer></TagsContainer>
        <System>null</System>
        <Kernel_id>null</Kernel_id>
        <Size>42949672960</Size>
        <Name>selImage3</Name>
        <Self>/v2/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b</Self>
        <Disk_format>raw</Disk_format>
        <Locations>null</Locations>
        <Ramdisk_id>null</Ramdisk_id>
        <Os_distro>2k8R2</Os_distro>
        <Instance_uuid>cbd94682-acae-4c56-99a0-84ce3a5cd4e4</Instance_uuid>
        <Virtual_size>null</Virtual_size>
        <Status>active</Status>
    </Data>
    <RequestId>fae4d306-6385-4288-a125-c7d8a8e9a070</RequestId>
    <Message>OK</Message>
</ShowImageDetailsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

修改私有镜像

描述

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

请求参数

名称 类型 是否必须 描述
Action String 公共参数,取值:UpdateImage
Imageid String 镜像ID
Name String 设置新的镜像名称,规则为:2-64个字符,不能以特殊字符及数字开头,只可包含特殊字符中的"_"或"-"
Description String 设置新的镜像描述,规则为:长度为2-256个字符,不能以http://或https://开头

示例

请求示例

修改私有镜像名称或描述

https://ecs.cn-north-3.inspurcloudapi.com?Action=UpdateImage&Imageid=912ae3fb-6cf2-4026-b18a-bff068b68e9b&Name=selimage001&<公共请求参数>

响应示例

<UpdateImageResponse>
    <Code>200</Code>
    <Data>
        <Schema>/v2/schemas/image</Schema>
        <Owner_user_name>9d0b67cd-20cb-40b4-8dc4-b0415ca25d72</Owner_user_name>
        <Base_image_ref>da099db5-e180-49c0-a74d-54bbc18fafd4</Base_image_ref>
        <Direct_url>rbd://dda6d394-a64a-4fda-aacc-01de3e9e7724/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b/snap</Direct_url>
        <Owner_id>a3499d8221e04a60beef0c008efca505</Owner_id>
        <Min_disk>40</Min_disk>
        <Created_at>2019-07-24T06:46:33Z</Created_at>
        <Container_format>bare</Container_format>
        <File>/v2/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b/file</File>
        <Updated_at>2019-07-25T09:14:27Z</Updated_at>
        <Protected>false</Protected>
        <Checksum>eb3a1e04a7f2de95b81f4e8d83376810</Checksum>
        <Builder>aibuild</Builder>
        <Image_location>snapshot</Image_location>
        <Id>912ae3fb-6cf2-4026-b18a-bff068b68e9b</Id>
        <Build_at>20181226</Build_at>
        <Min_ram>0</Min_ram>
        <Image_type>snapshot</Image_type>
        <Owner>a3499d8221e04a60beef0c008efca505</Owner>
        <Visibility>private</Visibility>
        <Boot_roles>Member</Boot_roles>
        <Os_version>2k8R2STD</Os_version>
        <Owner_project_name>lishenghao</Owner_project_name>
        <TagsContainer></TagsContainer>
        <Size>42949672960</Size>
        <User_id>400967434e704dce94add520a80a4ad5</User_id>
        <Os_type>windows</Os_type>
        <Name>selimage001</Name>
        <Self>/v2/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b</Self>
        <Disk_format>raw</Disk_format>
        <LocationsContainer>
            <Locations>
                <Metadata></Metadata>
                <Url>rbd://dda6d394-a64a-4fda-aacc-01de3e9e7724/images/912ae3fb-6cf2-4026-b18a-bff068b68e9b/snap</Url>
            </Locations>
        </LocationsContainer>
        <Image_state>available</Image_state>
        <Os_distro>2k8R2</Os_distro>
        <Instance_uuid>cbd94682-acae-4c56-99a0-84ce3a5cd4e4</Instance_uuid>
        <Virtual_size>null</Virtual_size>
        <Status>active</Status>
        <Hw_qemu_guest_agent>yes</Hw_qemu_guest_agent>
    </Data>
    <RequestId>6153f7b2-5c3c-463b-8ab2-ef0a36249d67</RequestId>
    <Message>update image success</Message>
</UpdateImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除私有镜像

描述

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

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

请求参数

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

示例

请求示例

删除私有镜像

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

响应示例

<DeleteImageResponse>
    <Code>204</Code>
    <Data>null</Data>
    <RequestId>c380fe48-8dc4-44db-95b3-91d8e3f4fcfd</RequestId>
    <Message>null</Message>
</DeleteImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

网络相关接口

查询云服务器所属安全组

描述

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

请求参数

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

示例

请求示例

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

响应示例

<ListSecurityGroupsByServerResponse>
    <Code>200</Code>
    <DataContainer>
        <Data>
            <Tenant_id>a3499d8221e04a60beef0c008efca505</Tenant_id>
            <Name>default</Name>
            <Description>Default security group</Description>
            <RulesContainer>
                <Rules>
                    <Ip_range>
                        <Cidr>null</Cidr>
                    </Ip_range>
                    <Ipprotocol>unrecognized</Ipprotocol>
                    <Group_id>null</Group_id>
                    <Parent_group_id>98a26a0d-5734-4e1b-a973-e8da89221f08</Parent_group_id>
                    <Name>null</Name>
                    <Range>
                        <Cidr>null</Cidr>
                    </Range>
                    <To_port>0</To_port>
                    <Cidr>null</Cidr>
                    <Id>2870721c-24dd-4423-88a7-d8bddf7285e2</Id>
                    <From_port>0</From_port>
                    <Ip_protocol>null</Ip_protocol>
                    <Group>
                        <Tenant_id>a3499d8221e04a60beef0c008efca505</Tenant_id>
                        <Name>default</Name>
                    </Group>
                </Rules>
                <Rules>
                    <Ip_range>
                        <Cidr>null</Cidr>
                    </Ip_range>
                    <Ipprotocol>unrecognized</Ipprotocol>
                    <Group_id>null</Group_id>
                    <Parent_group_id>98a26a0d-5734-4e1b-a973-e8da89221f08</Parent_group_id>
                    <Name>null</Name>
                    <Range>
                        <Cidr>null</Cidr>
                    </Range>
                    <To_port>0</To_port>
                    <Cidr>null</Cidr>
                    <Id>871e1037-8d62-4b35-8efc-8e0adbeffd37</Id>
                    <From_port>0</From_port>
                    <Ip_protocol>null</Ip_protocol>
                    <Group>
                        <Tenant_id>a3499d8221e04a60beef0c008efca505</Tenant_id>
                        <Name>default</Name>
                    </Group>
                </Rules>
                <Rules>
                    <Ip_range>
                        <Cidr>0.0.0.0/0</Cidr>
                    </Ip_range>
                    <Ipprotocol>unrecognized</Ipprotocol>
                    <Group_id>null</Group_id>
                    <Parent_group_id>98a26a0d-5734-4e1b-a973-e8da89221f08</Parent_group_id>
                    <Name>null</Name>
                    <Range>
                        <Cidr>0.0.0.0/0</Cidr>
                    </Range>
                    <To_port>0</To_port>
                    <Cidr>null</Cidr>
                    <Id>a095b7e7-e29d-4099-8256-a2809385bdfc</Id>
                    <From_port>0</From_port>
                    <Ip_protocol>null</Ip_protocol>
                    <Group>
                        <Tenant_id>null</Tenant_id>
                        <Name>null</Name>
                    </Group>
                </Rules>
                <Rules>
                    <Ip_range>
                        <Cidr>0.0.0.0/2</Cidr>
                    </Ip_range>
                    <Ipprotocol>icmp</Ipprotocol>
                    <Group_id>null</Group_id>
                    <Parent_group_id>98a26a0d-5734-4e1b-a973-e8da89221f08</Parent_group_id>
                    <Name>null</Name>
                    <Range>
                        <Cidr>0.0.0.0/2</Cidr>
                    </Range>
                    <To_port>-1</To_port>
                    <Cidr>null</Cidr>
                    <Id>bdef802b-27ce-4c7d-a836-22f9426247a4</Id>
                    <From_port>-1</From_port>
                    <Ip_protocol>icmp</Ip_protocol>
                    <Group>
                        <Tenant_id>null</Tenant_id>
                        <Name>null</Name>
                    </Group>
                </Rules>
                <Rules>
                    <Ip_range>
                        <Cidr>0.0.0.0/0</Cidr>
                    </Ip_range>
                    <Ipprotocol>tcp</Ipprotocol>
                    <Group_id>null</Group_id>
                    <Parent_group_id>98a26a0d-5734-4e1b-a973-e8da89221f08</Parent_group_id>
                    <Name>null</Name>
                    <Range>
                        <Cidr>0.0.0.0/0</Cidr>
                    </Range>
                    <To_port>22</To_port>
                    <Cidr>null</Cidr>
                    <Id>d86ab118-9c5b-4c67-8366-19bf214bb0f3</Id>
                    <From_port>22</From_port>
                    <Ip_protocol>tcp</Ip_protocol>
                    <Group>
                        <Tenant_id>null</Tenant_id>
                        <Name>null</Name>
                    </Group>
                </Rules>
            </RulesContainer>
            <Links>null</Links>
            <Id>98a26a0d-5734-4e1b-a973-e8da89221f08</Id>
        </Data>
    </DataContainer>
    <RequestId>36e6badf-5637-4c3f-b7c1-c61fedb5a78c</RequestId>
    <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>
    <RequestId>e5637aee-cf30-4333-b571-99322c6a43ad</RequestId>
    <Message>null</Message>
</AddSecurityGroupResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

移除安全组

描述

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

请求参数

名称 类型 是否必须 描述
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>
    <RequestId>efb2bdde-83c1-4f41-ba26-d059ff9ffd5f</RequestId>
    <Message>null</Message>
</RemoveSecurityGroupResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

修改云服务器内网地址

描述

  • 本接口用于修改云服务器内网地址

请求参数

名称 类型 是否必须 描述
Action String 公共参数,取值:UpdatePrivateIp
Portid String 待操作云服务器portid
Fixedip String 新内网ip

示例

请求示例

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

返回值

请参考通用请求返回值

错误码

请参考错误码

磁盘相关接口

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

描述

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

请求参数

名称 类型 是否必须 描述
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>
        <VolumeAttachmentsContainer></VolumeAttachmentsContainer>
    </Data>
    <RequestId>60ea8e90-f0bb-45a0-b392-82291cd2d38b</RequestId>
    <Message>OK</Message>
</ListVolumeAttachmentsByServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

密钥相关接口

创建或导入密钥对

描述

  • 创建或导入一个密钥

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

请求参数

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

示例

请求示例

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

响应示例

<CreateOrImportKeypairResponse>
    <Code>201</Code>
    <Data>
        <Keypair>
            <Public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDRzPYtZCQ54i75xwOMjcFhQdSMqbjv9spiuY3WynTXW9DyRu8VRWY1VQ5v0pnxqfo9ODixvTrQH24qyn5nisiHtZ/mSVLtKnhJk4XExaFfpnuu96oDjuaOQRNtKZpAl++yyBqGWcQnTPhCaYgKFpUhW5Vx1XkxEvl2BxPtLIZN0eWmf3YFiadHQdjjDop9KFhbf9uIpprIxRkiMymcZKoZJUKci8fxT5LGLS/MvY+/MvRXQWS1PeqyV3bXWVM3mK1+/y4hRdh39+Q2iaSI/bwo6JjaOuGRW6femGiYkXU12GlTNZRZjXeK+XZedDvj3g9p0Wg6iCpkGJmUOFryf1+n Generated-by-Nova</Public_key>
            <User_id>400967434e704dce94add520a80a4ad5</User_id>
            <Name>SSZG001</Name>
            <Fingerprint>84:75:c4:1f:0e:66:24:38:f9:2b:ed:a3:d5:54:cc:25</Fingerprint>
            <Private_key>-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEA0cz2LWQkOeIu+ccDjI3BYUHUjKm47/bKYrmN1sp011vQ8kbv
FUVmNVUOb9KZ8an6PTg4sb060B9uKsp+Z4rIh7Wf5klS7Sp4SZOFxMWhX6Z7rveq
A47mjkETbSmaQJfvssgahlnEJ0z4QmmIChaVIVuVcdV5MRL5dgcT7SyGTdHlpn92
BYmnR0HY4w6KfShYW3/biKaayMUZIjMpnGSqGSVCnIvH8U+Sxi0vzL2PvzL0V0Fk
tT3qsld211lTN5itfv8uIUXYd/fkNomkiP28KOiY2jrhkVun3phomJF1NdhpUzWU
WY13ivl2XnQ7494PadFoOogqZBiZlDha8n9fpwIDAQABAoIBAQCnGwHaFbFlCWsx
N/rzsNUeijip8WWEfKWnDPSU6J04C8HZt/YmkyhdwmnFV5GWkzTmHinKKFb3/pDZ
NICKKFig/2FlI3IRxYoZ0I7ztBZdAVXyfwHD48Zv+BVpFYHvgRVC6W93I3jBdOUo
wLXCk0olT7Uw/j+RfvODtw+AEb7Hq71FOnJHZGN16mY8Fjgc7pRLblNxR/PLEzp9
T7cgxQ2eoSc9NYmAqBUU+gBr3/JV4eoK2sqachsyWz5Osswg74oT/ZUF5kuXbZ8G
WANSbNBmFmi1QBtiiDnRebdjJuMSE0469IhLTlQWVqNK5APjUeuNm5ApZixKxgkC
V+Audu0BAoGBAPsxuRrmIYuNMtIhvG2hJwaMVZ/SUnsRl4p5iC+v7EioabbqyUmr
gMH7a2EG4nT4NIsQ6+J4DHyS46x0tKuzj9RRiAo9bUhvDcer0rqI6MccQQSakbMq
OeIQ72D4eAiMSjHHYRxOUuiglH8/JeM4ZDZEAMKCJkHWHAYI9VHHlLhXAoGBANXQ
gTB3dCOZ+dvrW4IbLYeq0lrxtjj3msGzA8eVoCHdGiYMP52rJArVRrR/J6iKFQyo
55adaQkxHXkfbi8g33syDrHwMDQVCCID33k7DKpBeBKuVc52ppjBNLKVAS/OXV6X
oDGUtd9whWdSvq2xSxZQvbVZpCVw0xZ3DVoJVkExAoGAV5WvyBxDyAfUl4Yh0Evn
cpYN6OsJzVWF9EeJ367EgVUPfzMAOkqtW3XRrAQdg9FjaLXeuZlIKUuCTQhoUpIK
bWp8N63RY/cs49kaYeYI3BwS44sNkF4Bzrw+6x3XpItd91tgleENcYVEIdYf3Mk1
z+IILcn5ku0X2lbXSst/JIMCgYAxLCKJ4u7ywRaVXStOYLG34bE++RfPQiJ1KZZU
8DRDlXXOCkMXH6TKWQJJwHR+bkMpBi88lDbzxjfhAzlz3TuIOZrnkTWExNF6ASoD
13CyNxxGL5HMSb1GpChaaao8NFmEx5ovzOOG33nOqVjw2TVLjIYUjukRM0FYiUio
zDzqAQKBgQCG/GjkiPxyKCc+n6Ic8sx/n9Pz7m0pFoh1twE1cjWV1+nLltS28d6E
UqfH6IjKdqTGJNMs+QSpxB89m9Q5NC8STDBcpKXAm5bG2i2yZ2DI9UmA6auNzaDr
zNCqXNDuHndRw4NPUBlkVUugryGFKQVinVMK0xxFaZFxPqfwzAQbeg==
-----END RSA PRIVATE KEY-----
</Private_key>
            <Type>ssh</Type>
        </Keypair>
    </Data>
    <RequestId>e85de5c3-12d5-4a1e-8617-f59fe5701d54</RequestId>
    <Message>Created</Message>
</CreateOrImportKeypairResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除密钥对

描述

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

请求参数

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

示例

请求示例

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

响应示例

<DeleteKeypairResponse>
    <Code>202</Code>
    <Data>null</Data>
    <RequestId>3b99a7e5-0c73-409b-a490-8c548ce53a57</RequestId>
    <Message>Delete success</Message>
</DeleteKeypairResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询密钥对列表

描述

  • 查询SSH密钥信息列表。

请求参数

名称 类型 是否必须 描述
Action String 公共参数,取值:ListKeypairs

返回参数

不涉及

示例

请求示例

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

响应示例

<ListKeypairsResponse>
    <Code>200</Code>
    <Data>
        <PageNo>1</PageNo>
        <PageSize>0</PageSize>
        <TotalCount>0</TotalCount>
        <KeypairsContainer></KeypairsContainer>
    </Data>
    <RequestId>a096d400-fb84-4321-9448-888ad5628f82</RequestId>
    <Message>OK</Message>
</ListKeypairsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询秘钥详情

描述

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

请求参数

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

返回参数

不涉及

示例

请求示例

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

响应示例

<ShowKeypairDetailsResponse>
    <Code>200</Code>
    <Data>
        <Keypair>
            <Public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDxFUn2pc51CQjTn/ZM+o0H0jlQcmfcXgxka7TjQjdakV5CiM8ox/9m/QJkVPet7wzIjgaIoVGlbmboB6P7nIF7osmqd+gPHzRORu0gnhU7VG3x8o6b1nsvgms97fp4bZF/WOTGMmZipRyL1Aq262jJjGJIGyrvazet2w0hCgOhnZT1oq2AOJjbsYjgRlBBr0XUQEz6M+F7uD2UAmZq7jfE+VY8NGDCSysXWi6u8fADR8dtEJVfDpX+GyiureBKYfXPqK6zgURvkfoWrqaTM/yIJXzcN/3/d17+5hz0dYaJxQKFWOArjhyr7TDy2oeX6Fm+xFIvbk4o3uuUMN+5ZC1z Generated-by-Nova</Public_key>
            <Deleted>false</Deleted>
            <Updated_at>null</Updated_at>
            <User_id>400967434e704dce94add520a80a4ad5</User_id>
            <Name>SSZG001</Name>
            <Fingerprint>f2:1f:9b:6d:70:50:64:35:b8:f2:00:88:bb:d7:be:08</Fingerprint>
            <Created_at>2019-07-25T09:31:26.000000</Created_at>
            <Id>723</Id>
            <Type>ssh</Type>
            <Deleted_at>null</Deleted_at>
        </Keypair>
    </Data>
    <RequestId>d1306522-23a2-41db-ad2a-3c2c2d57a816</RequestId>
    <Message>OK</Message>
</ShowKeypairDetailsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

其他接口

获取token

描述

  • 获取用户token,用于鉴权

URL

https:// + 请求域名 + /getToken

请求参数

名称 类型 是否必须 描述
UserName String 用户名
Password String 密码

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com/getToken?
&UserName=inspurtest08
&Password=123456abc!
&<公共请求参数>

响应示例

<GetTokenResponse>
    <Code>200</Code>
    <Data>eyJhbGciOiJSU...UTDbN4ouwL_yg</Data>
    <RequestId>16e55b7d-109c-4a0a-a2ac-1be4ecb6b380</RequestId>
</GetTokenResponse>

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
401 Invalid user credentials 401