云服务器相关接口

创建云服务器

描述

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

  • 单次最多能创建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
&ServerName=q190102test
&BillType=hourlySettlement
&FlavorRef=S1.small.1
&ImageRef=5c610cbe-f5cb-46a8-8ae7-4fe78e1a2be1
&RootVolumeSize=40
&DataVolumeSize.1=20
&DataVolumeSize.2=30
&EipBandWidth=1&VpcId=vpc0000000207
&SubnetId=446269ec-47f0-4928-ba81-d0fed3c60785
&SecurityGroups.1=6dc744e5-b7dc-4a1f-a41c-ef3c4e082d90
&AdminPass=Lc13yfwpW
&count=1
&<公共请求参数>

响应示例

<CreateServerResponse>
    <RequestId>ea6da4f4-7c1f-49a8-9a0d-6b58aabd3cde</RequestId>
    <Result>
        <OrderDetailFlowIdListContainer>
            <OrderDetailFlowIdList>132855317828804608</OrderDetailFlowIdList>
            <OrderDetailFlowIdList>132855317837193216</OrderDetailFlowIdList>
            <OrderDetailFlowIdList>132855317841387520</OrderDetailFlowIdList>
            <OrderDetailFlowIdList>132855317845581824</OrderDetailFlowIdList>
        </OrderDetailFlowIdListContainer>
        <OrderId>132855316377575424</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>
</CreateServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

启动云服务器

启动一台云服务器

描述

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

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

请求参数

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

示例

请求示例

启动一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=StartServer
&Serverid=8a466247-b4f9-407a-af3a-bcdb9c56b0c3
&<公共请求参数>

响应示例

<StartServerResponse>
    <RequestId>67d08839-2ac8-4a2b-a9e5-c8823025ac67</RequestId>
    <Code>202</Code>
    <Data>null</Data>
    <Message>null</Message>
</StartServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量启动云服务器

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

请求参数

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

示例

请求示例

启动两台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action= StartMultipleServers
&Serversid.0=8a466247-b4f9-407a-af3a-bcdb9c56b0c3
&Serversid.1=d7f2c443-1c7c-4c3c-99c3-516e80a1a36f
&<公共请求参数>

响应示例

<StartMultipleServersResponse>
    <RequestId>b4d38755-ee3e-4365-9427-fab8e30f8c17</RequestId>
    <Code>202</Code>
    <Data>null</Data>
<Message>The following server start success:
[{8a466247-b4f9-407a-af3a-bcdb9c56b0c3},{d7f2c443-1c7c-4c3c-99c3-516e80a1a36f}]
</Message>
</StartMultipleServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

关闭云服务器

关闭一台云服务器

请求参数

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

示例

请求示例

关闭一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=StopServer
&Serverid=8a466247-b4f9-407a-af3a-bcdb9c56b0c3
&<公共请求参数>

响应示例

<StopServerResponse>
    <RequestId>81856177-6b56-4c9f-83f5-bd1ce16232aa</RequestId>
    <Code>202</Code>
    <Data>null</Data>
    <Message>null</Message>
</StopServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

批量关闭云服务器

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

请求参数

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

示例

请求示例

关闭两台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=StopMultipleServers
&Serversid.0=8a466247-b4f9-407a-af3a-bcdb9c56b0c3
&Serversid.1=d7f2c443-1c7c-4c3c-99c3-516e80a1a36f
&<公共请求参数>

响应示例

<StopMultipleServersResponse>
    <RequestId>6c370c50-a2b5-462b-adc0-d76b9ddc7c6b</RequestId>
    <Code>202</Code>
    <Data>null</Data>
    <Message>The following server stop success:[{8a466247-b4f9-407a-af3a-bcdb9c56b0c3},{d7f2c443-1c7c-4c3c-99c3-516e80a1a36f}]</Message>
</StopMultipleServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

重启云服务器

重启一台云服务器。

请求参数

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

示例

请求示例

重启一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=RebootServer
&Serverid=8a466247-b4f9-407a-af3a-bcdb9c56b0c3
&Type= SOFT
&<公共请求参数>

响应示例

<RebootServerResponse>
    <RequestId>b3d04a54-fa49-4619-83d8-f4339ab59805</RequestId>
    <Code>202</Code>
    <Data>null</Data>
    <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=8a466247-b4f9-407a-af3a-bcdb9c56b0c3
&Serversid.1=d7f2c443-1c7c-4c3c-99c3-516e80a1a36f
&<公共请求参数>

响应示例

<RebootMultipleServersResponse>
    <RequestId>5b0c4bd5-cffd-473a-bfa7-087ed4ce2987</RequestId>
    <Code>202</Code>
    <Data>null</Data>
    <Message>The following server reboot success:[{50ee5c92-6fb7-4431-aa7f-0693aa542a2e},{eeaeb08b-07ff-4d8f-bc7d-32fcc16e58da}]</Message>
</RebootMultipleServersResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除云服务器

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

请求参数

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

请求示例

请求示例

删除一台云服务器

https://ecs.cn-north-3.inspurcloudapi.com?Action=DeleteServer
&serversid.0=8a466247-b4f9-407a-af3a-bcdb9c56b0c3
&BillType=hourlySettlement
&<公共请求参数>

响应示例

<DeleteServerResponse>
    <RequestId>830ee8cf-dd35-4bac-a421-0c7ba4b90f3a</RequestId>
    <Result>
        <OrderDetailFlowIdListContainer>
            <OrderDetailFlowIdList>131435743128395776</OrderDetailFlowIdList>
        </OrderDetailFlowIdListContainer>
        <OrderId>131435743015149568</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>
</DeleteServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查看云服务器列表

请求参数

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

示例

请求示例

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

响应示例

<ListServersResponse>
    <RequestId>e77022be-b484-46f9-8888-d101a73b8711</RequestId>
    <Code>200</Code>
    <Data>
        <ServersContainer>
            <Servers>
                <Image>
                    <System>Windows 2008 R2标准版 中文版 64位</System>
                    <Name>WIN2008R2STDx86_64</Name>
                    <SystemType>windows</SystemType>
                    <Id>35c22a73-5ef6-45a9-83bc-653b96e898ff</Id>
                    <TagsContainer>
                        <Tags>Windows Server 2008 R2 STD 64bit</Tags>
                    </TagsContainer>
                </Image>
                <Availability_zone>cn-north-3a</Availability_zone>
                <Addresses>
                    <Vxlan_0000000049Container>
                        <Vxlan_0000000049>
                            <OS-EXT-IPS-MAC:mac_addr>fa:16:3e:8f:a6:6f</OS-EXT-IPS-MAC:mac_addr>
                            <OS-EXT-IPS:type>fixed</OS-EXT-IPS:type>
                            <Addr>10.158.144.12</Addr>
                            <Version>4</Version>
                        </Vxlan_0000000049>
                    </Vxlan_0000000049Container>
                </Addresses>
                <Created>2018-12-26 10:44:49</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>4</Power_state>
                <TagsContainer>
                    <Tags>ECS</Tags>
                </TagsContainer>
                <Flavor>
                    <Disk>40</Disk>
                    <Swap>0</Swap>
                    <Original_name>ecs_4C16G40G_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>4</Vcpus>
                    <Ram>16.0</Ram>
                </Flavor>
                <Key_name>null</Key_name>
                <Vm_state>stopped</Vm_state>
                <Vpcname>vxlan_0000000049</Vpcname>
                <Security_groupsContainer>
                    <Security_groups>
                        <Name>default</Name>
                    </Security_groups>
                </Security_groupsContainer>
                <FeeData>
                    <CreateTime>2018-12-26 10:44:49</CreateTime>
                    <DeleteTime>null</DeleteTime>
                    <ServiceStatus>normal</ServiceStatus>
                    <BillType>monthly</BillType>
                    <StartFeeTime>2018-12-27 00:00:00</StartFeeTime>
                    <DaysOfDelete>null</DaysOfDelete>
                    <NextFeeTime>2019-01-27 00:00:00</NextFeeTime>
                </FeeData>
                <RegionID>cn-north-3</RegionID>
                <DiskConfig>MANUAL</DiskConfig>
                <Vpcid>99</Vpcid>
                <Name>ECS-20181226102832-0002</Name>
                <NicsContainer>
                    <Nics>
                        <Network_id>3ce9bd13-fdd8-490d-895c-f910e126262d</Network_id>
                        <Mac_address>fa:16:3e:8f:a6:6f</Mac_address>
                        <Subnet_cidr>10.158.144.0/24</Subnet_cidr>
                        <Subnet_id>55f86bd8-4edc-4496-9b7a-28f460feb82a</Subnet_id>
                        <Fixed_ip>10.158.144.12</Fixed_ip>
                        <Subnet_name>vxlan_0000000049</Subnet_name>
                        <Portid>c315d552-1a77-40a2-9f75-9838a1a202d5</Portid>
                    </Nics>
                </NicsContainer>
                <Id>d7f2c443-1c7c-4c3c-99c3-516e80a1a36f</Id>
                <Updated>2018-12-30 10:08:24</Updated>
                <Status>shutoff</Status>
            </Servers>
        </ServersContainer>
        <TotalCount>8</TotalCount>
    </Data>
    <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
&BillType=hourlySettlement
&Resizevcpus=2
&Resizevram=2
&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=50ee5c92-6fb7-4431-aa7f-0693aa542a2e
&<公共请求参数>

响应示例

<ShowServersDetailsResponse>
    <RequestId>926889d6-63a3-458e-bd6e-baedb2236f42</RequestId>
    <Code>200</Code>
    <Data>
        <Server>
            <Image>
                <System>CentOS 7.4 64位</System>
                <Name>centos74x86_64</Name>
                <SystemType>linux</SystemType>
                <Id>5c610cbe-f5cb-46a8-8ae7-4fe78e1a2be1</Id>
                <TagsContainer>
                    <Tags>CentOS 7.4 64bit</Tags>
                </TagsContainer>
            </Image>
            <Availability_zone>cn-north-3a</Availability_zone>
            <Addresses>
                <Vxlan_0000000049Container>
                    <Vxlan_0000000049>
                        <OS-EXT-IPS-MAC:mac_addr>fa:16:3e:97:c2:af</OS-EXT-IPS-MAC:mac_addr>
                        <OS-EXT-IPS:type>fixed</OS-EXT-IPS:type>
                        <Addr>10.158.144.15</Addr>
                        <Version>4</Version>
                    </Vxlan_0000000049>
                </Vxlan_0000000049Container>
            </Addresses>
            <Created>2018-12-19 03:04:12</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_custom_4C4G40G_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>4</Vcpus>
                <Ram>4.0</Ram>
            </Flavor>
            <Key_name>null</Key_name>
            <Vm_state>active</Vm_state>
            <Vpcname>vxlan_0000000049</Vpcname>
            <Security_groupsContainer>
                <Security_groups>
                    <Name>default</Name>
                </Security_groups>
            </Security_groupsContainer>
            <FeeData>
                <CreateTime>2018-12-19 03:04:12</CreateTime>
                <DeleteTime>null</DeleteTime>
                <ServiceStatus>normal</ServiceStatus>
                <BillType>monthly</BillType>
                <StartFeeTime>2018-12-20 00:00:00</StartFeeTime>
                <DaysOfDelete>null</DaysOfDelete>
                <NextFeeTime>2019-01-20 00:00:00</NextFeeTime>
            </FeeData>
            <RegionID>cn-north-3</RegionID>
            <DiskConfig>MANUAL</DiskConfig>
            <Vpcid>99</Vpcid>
            <Name>ECS-20181219105935-0003</Name>
            <NicsContainer>
                <Nics>
                    <Network_id>3ce9bd13-fdd8-490d-895c-f910e126262d</Network_id>
                    <Mac_address>fa:16:3e:97:c2:af</Mac_address>
                    <Subnet_cidr>10.158.144.0/24</Subnet_cidr>
                    <Subnet_id>55f86bd8-4edc-4496-9b7a-28f460feb82a</Subnet_id>
                    <Fixed_ip>10.158.144.15</Fixed_ip>
                    <Subnet_name>vxlan_0000000049</Subnet_name>
                    <Portid>5b0a9e45-cb92-44b5-9d6c-a4190e4d03a3</Portid>
                </Nics>
            </NicsContainer>
            <Id>50ee5c92-6fb7-4431-aa7f-0693aa542a2e</Id>
            <Updated>2018-12-30 11:02:20</Updated>
            <Status>active</Status>
        </Server>
    </Data>
    <Message>OK</Message>
</ShowServersDetailsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

修改云服务器密码

修改云服务器密码

描述

请求参数

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

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ChangeAdministrativePassword
&Serverid=50ee5c92-6fb7-4431-aa7f-0693aa542a2e
&AdminPass=123456Aa 
&<公共请求参数>

响应示例

返回值

请参考通用请求返回值

错误码

请参考错误码

重置操作系统

重置操作系统

描述

请求参数

名称 类型 是否必须 描述
Action String 公共参数,取值:ShowServersDetails
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=dc19fd18-c656-4553-87e5-8c29074ada8f
&Type=novnc
&<公共请求参数>

响应示例

<GetVncConsoleResponse>
    <RequestId>5557e3b1-8172-4cb8-8c11-ae56f0df1493</RequestId>
    <Code>200</Code>
    <Data>
        <Console>
            <Type>novnc</Type>
            <Url>https://console1.cloud.inspur.com/ecs/vnc/vnc_auto.html?token=71186536-02fa-4588-96a8-4772c7888068</Url>
        </Console>
    </Data>
    <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=dc19fd18-c656-4553-87e5-8c29074ada8f
&type=novnc
&size=50
&BillType=hourlySettlement
&<公共请求参数>

响应示例

返回值

请参考通用请求返回值

错误码

请参考错误码

镜像相关接口

创建私有镜像

描述

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

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

请求参数

名称 类型 是否必须 描述
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=dc19fd18-c656-4553-87e5-8c29074ada8f
&name=测试镜像
&<公共请求参数>

响应示例

<CreateImageResponse>
    <RequestId>d4932873-4928-476c-a0dc-ea79ad5918dc</RequestId>
    <Code>201</Code>
    <Data>
        <Image_id>daa575a9-5bc4-402e-90ea-802b2e86e871</Image_id>
    </Data>
    <Message>Created</Message>
</CreateImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询镜像列表

描述

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

请求参数

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

示例

请求示例

查询镜像列表

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

响应示例

返回值

请参考通用请求返回值

错误码

请参考错误码

查询指定镜像详情

描述

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

请求参数

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

示例

请求示例

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

https://ecs.cn-north-3.inspurcloudapi.com?Action=ShowImageDetails
&Imageid=dc19fd18-c656-4553-87e5-8c29074ada8f
&<公共请求参数>

响应示例

返回值

请参考通用请求返回值

错误码

请参考错误码

修改私有镜像

描述

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

请求参数

名称 类型 是否必须 描述
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=daa575a9-5bc4-402e-90ea-802b2e86e871
&Name=test
&Description=hahahaahahha
&<公共请求参数>

响应示例

<UpdateImageResponse>
    <RequestId>afa18294-f336-47cf-a0fd-72ab6706893c</RequestId>
    <Code>200</Code>
    <Data>
        <Schema>/v2/schemas/image</Schema>
        <Direct_url>null</Direct_url>
        <Min_disk>40</Min_disk>
        <Description>null</Description>
        <Created_at>2019-01-02 16:54:35</Created_at>
        <Container_format>bare</Container_format>
        <File>/v2/images/daa575a9-5bc4-402e-90ea-802b2e86e871/file</File>
        <Updated_at>2019-01-02 16:55:24</Updated_at>
        <Protected>false</Protected>
        <Checksum>null</Checksum>
        <SystemType>null</SystemType>
        <Links>null</Links>
        <Id>daa575a9-5bc4-402e-90ea-802b2e86e871</Id>
        <Min_ram>0</Min_ram>
        <Architecture>null</Architecture>
        <Owner>5718e87f79ee4d5dbf7e77ab02cf504e</Owner>
        <Visibility>private</Visibility>
        <SystemDisk>null</SystemDisk>
        <Os_version>null</Os_version>
        <TagsContainer></TagsContainer>
        <System>null</System>
        <Kernel_id>null</Kernel_id>
        <Size>null</Size>
        <Name>test</Name>
        <Self>/v2/images/daa575a9-5bc4-402e-90ea-802b2e86e871</Self>
        <Disk_format>raw</Disk_format>
        <LocationsContainer></LocationsContainer>
        <Ramdisk_id>null</Ramdisk_id>
        <Os_distro>null</Os_distro>
        <Instance_uuid>dc19fd18-c656-4553-87e5-8c29074ada8f</Instance_uuid>
        <Virtual_size>null</Virtual_size>
        <Status>saving</Status>
    </Data>
    <Message>OK</Message>
</UpdateImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除私有镜像

描述

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

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

请求参数

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

示例

请求示例

修改私有镜像名称和描述

https://ecs.cn-north-3.inspurcloudapi.com?Action=DeleteImage
&Imageid=daa575a9-5bc4-402e-90ea-802b2e86e871
&<公共请求参数>

响应示例

<DeleteImageResponse>
    <RequestId>d2e19747-0eb9-46d3-837b-5e962a4e2711</RequestId>
    <Code>200</Code>
    <Data>
        <Schema>/v2/schemas/image</Schema>
        <Direct_url>null</Direct_url>
        <Min_disk>40</Min_disk>
        <Description>null</Description>
        <Created_at>2019-01-02 16:54:35</Created_at>
        <Container_format>bare</Container_format>
        <File>/v2/images/daa575a9-5bc4-402e-90ea-802b2e86e871/file</File>
        <Updated_at>2019-01-02 16:55:24</Updated_at>
        <Protected>false</Protected>
        <Checksum>null</Checksum>
        <SystemType>null</SystemType>
        <Links>null</Links>
        <Id>daa575a9-5bc4-402e-90ea-802b2e86e871</Id>
        <Min_ram>0</Min_ram>
        <Architecture>null</Architecture>
        <Owner>5718e87f79ee4d5dbf7e77ab02cf504e</Owner>
        <Visibility>private</Visibility>
        <SystemDisk>null</SystemDisk>
        <Os_version>null</Os_version>
        <TagsContainer></TagsContainer>
        <System>null</System>
        <Kernel_id>null</Kernel_id>
        <Size>null</Size>
        <Name>测试镜像</Name>
        <Self>/v2/images/daa575a9-5bc4-402e-90ea-802b2e86e871</Self>
        <Disk_format>raw</Disk_format>
        <LocationsContainer></LocationsContainer>
        <Ramdisk_id>null</Ramdisk_id>
        <Os_distro>null</Os_distro>
        <Instance_uuid>dc19fd18-c656-4553-87e5-8c29074ada8f</Instance_uuid>
        <Virtual_size>null</Virtual_size>
        <Status>saving</Status>
    </Data>
    <Message>OK</Message>
</DeleteImageResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

网络相关接口

查询云服务器所属安全组

描述

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

请求参数

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

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ListSecurityGroupsByServer
&Serverid=4bff4cb5-02fa-4a8f-9959-a68f96931137
&<公共请求参数>

响应示例

<ListSecurityGroupsByServerResponse>
    <Code>200</Code>
    <DataContainer>
        <Data>
            <Tenant_id>894c48b5bc4247c3a1841e5ff43d0d88</Tenant_id>
            <Name>default</Name>
            <Description>Default security group</Description>
            <RulesContainer>
                <Rules>
                    <Ip_range>
                        <Cidr>0.0.0.0/0</Cidr>
                    </Ip_range>
                    <Ipprotocol>tcp</Ipprotocol>
                    <Group_id>null</Group_id>
                    <Parent_group_id>2939d5a6-976d-4df0-9951-10feff06b964</Parent_group_id>
                    <Name>null</Name>
                    <Range>
                        <Cidr>0.0.0.0/0</Cidr>
                    </Range>
                    <To_port>22</To_port>
                    <Cidr>null</Cidr>
                    <Id>428ebc70-4865-482d-9941-90485e9e5dfc</Id>
                    <From_port>22</From_port>
                    <Ip_protocol>tcp</Ip_protocol>
                    <Group>
                        <Tenant_id>null</Tenant_id>
                        <Name>null</Name>
                    </Group>
                </Rules>
                <Rules>
                    <Ip_range>
                        <Cidr>null</Cidr>
                    </Ip_range>
                    <Ipprotocol>tcp</Ipprotocol>
                    <Group_id>null</Group_id>
                    <Parent_group_id>2939d5a6-976d-4df0-9951-10feff06b964</Parent_group_id>
                    <Name>null</Name>
                    <Range>
                        <Cidr>null</Cidr>
                    </Range>
                    <To_port>80</To_port>
                    <Cidr>null</Cidr>
                    <Id>5859f008-1372-4566-845b-076bb1fd154a</Id>
                    <From_port>80</From_port>
                    <Ip_protocol>tcp</Ip_protocol>
                    <Group>
                        <Tenant_id>894c48b5bc4247c3a1841e5ff43d0d88</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>2939d5a6-976d-4df0-9951-10feff06b964</Parent_group_id>
                    <Name>null</Name>
                    <Range>
                        <Cidr>null</Cidr>
                    </Range>
                    <To_port>0</To_port>
                    <Cidr>null</Cidr>
                    <Id>65b72b3c-c7f4-4137-a727-03d6beeb8f26</Id>
                    <From_port>0</From_port>
                    <Ip_protocol>null</Ip_protocol>
                    <Group>
                        <Tenant_id>894c48b5bc4247c3a1841e5ff43d0d88</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>2939d5a6-976d-4df0-9951-10feff06b964</Parent_group_id>
                    <Name>null</Name>
                    <Range>
                        <Cidr>null</Cidr>
                    </Range>
                    <To_port>0</To_port>
                    <Cidr>null</Cidr>
                    <Id>a0fab121-e78e-4bb4-b878-9c6b2becdeeb</Id>
                    <From_port>0</From_port>
                    <Ip_protocol>null</Ip_protocol>
                    <Group>
                        <Tenant_id>894c48b5bc4247c3a1841e5ff43d0d88</Tenant_id>
                        <Name>default</Name>
                    </Group>
                </Rules>
            </RulesContainer>
            <Links>null</Links>
            <Id>2939d5a6-976d-4df0-9951-10feff06b964</Id>
        </Data>
    </DataContainer>
    <RequestId>8bd810a1-a896-4a80-b366-86e97b3b2909</RequestId>
    <Message>OK</Message>
</ListSecurityGroupsByServerResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

添加安全组

描述

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

请求参数

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

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=AddSecurityGroup
&Serverid=4bff4cb5-02fa-4a8f-9959-a68f96931137
&Name=test
&<公共请求参数>

响应示例

<AddSecurityGroupResponse>
    <Code>200</Code>
    <Data>null</Data>
    <RequestId>f901e9ec-fbd5-465d-9ac3-3c9ec10af3b6</RequestId>
    <Message>null</Message>
</AddSecurityGroupResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

移除安全组

描述

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

请求参数

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

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=RemoveSecurityGroup
&Serverid=4bff4cb5-02fa-4a8f-9959-a68f96931137
&Name=test
&<公共请求参数>

响应示例

<RemoveSecurityGroupResponse>
    <Code>200</Code>
    <Data>null</Data>
    <RequestId>5cfcb18f-95d1-45ec-9c22-2d8e848e76ad</RequestId>
    <Message>null</Message>
</RemoveSecurityGroupResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

修改云服务器内网地址

描述

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

请求参数

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

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=UpdatePrivateIp
&Portid=c07976be-0346-43d6-a298-5148e82fa235
&Fixedip=172.31.0.36
&<公共请求参数>

响应示例

<UpdatePrivateIpResponse>
    <Code>200</Code>
    <Data>
        <Port>
            <Nics>
                <Port_id>e7870bf0-454c-41ae-acfd-ecbdde418f19</Port_id>
                <Fixed_ip>172.31.0.21</Fixed_ip>
            </Nics>
        </Port>
    </Data>
    <RequestId>fc44795a-43d5-4f48-bd07-ff3e3203be72</RequestId>
    <Message>OK</Message>
</UpdatePrivateIpResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

磁盘相关接口

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

描述

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

请求参数

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

返回参数

不涉及

示例

请求示例

https://ecs.cn-north-3.inspurcloudapi.com?Action=ListVolumeAttachmentsByServer
&Serverid=7f2c443-1c7c-4c3c-99c3-516e80a1a36f
&<公共请求参数>

响应示例

<ListVolumeAttachmentsByServerResponse>
    <Code>200</Code>
    <Data>
        <VolumeAttachmentsContainer></VolumeAttachmentsContainer>
    </Data>
    <RequestId>56a02b32-f352-4c58-8959-1bc13c86075c</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=keypair-test_2
&Type=ssh
&<公共请求参数>

响应示例

<CreateOrImportKeypairResponse>
    <Code>201</Code>
    <Data>
        <Keypair>
            <Public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDVcK/SxKFg7U/WGFcjBedLsv9uWlqh91xpnSL3JFVMgN4VGgiwudNUW+uiWE9IeHgoZnFAfIS3Cnh7R8ORkoyKwBHNzqc4WKyjvOEsrRvzeW4AAYnTdPHEcrSq8PtvjhgZPKkkocWPLobQ6aks13XUxW7GbrOH3UaqYd40z4R9emqInRActN6W2aqWaq6/zY/plOvX8N2lF68/hpvgykvZplbx4pUXs+IekqMwc7EsLzy0+OOdGUrwwCarz6CvpbUVknOR2uHOXf++Lzw02+CSlbF9Y4B0+YAKJwqCDXa41NwcprFJ/kutj+kKomux1v3GkcSqaLaMUjezIfRJNcTn Generated-by-Nova</Public_key>
            <User_id>068ddef4603b49a485b39d33ac4ba80e</User_id>
            <Name>keypair-test_2</Name>
            <Fingerprint>9f:00:29:a6:9b:44:3b:dc:1a:ae:73:85:4b:fb:a5:e5</Fingerprint>
            <Private_key>-----BEGIN RSA PRIVATE KEY-----&#xa;MIIEowIBAAKCAQEA1XCv0sShYO1P1hhXIwXnS7L/blpaofdcaZ0i9yRVTIDeFRoI&#xa;sLnTVFvrolhPSHh4KGZxQHyEtwp4e0fDkZKMisARzc6nOFiso7zhLK0b83luAAGJ&#xa;03TxxHK0qvD7b44YGTypJKHFjy6G0OmpLNd11MVuxm6zh91GqmHeNM+EfXpqiJ0Q&#xa;HLTeltmqlmquv82P6ZTr1/DdpRevP4ab4MpL2aZW8eKVF7PiHpKjMHOxLC88tPjj&#xa;nRlK8MAmq8+gr6W1FZJzkdrhzl3/vi88NNvgkpWxfWOAdPmACicKgg12uNTcHKax&#xa;Sf5LrY/pCqJrsdb9xpHEqmi2jFI3syH0STXE5wIDAQABAoIBAQCkZxgHEM39Cs3j&#xa;6vuzTmjKNiXpqk8FUrMr5o14L9RECT8GofbvqTLOV784XS00dRaYh8/UDBVtp/MF&#xa;glFxX6BBf5A3JmZHUIYp2OLYtr5A29eOyaCP8BQJbREcWmJRmvGU/tSKEtFJaF0P&#xa;retRTuTD7w9UaRCAJkC4HIo7w1waCTih2lnWcTpPw+IMPhKgF/r9Kod6fFb6vppm&#xa;RTTBnBffIZ8MsYVroxAH16Jg/UDju2e9KAFkdB4oK/yjYiBuWDQQjEIl3ysY1e2e&#xa;mkS7lwHWx3su9eI+hb+A2ehdrmpB/BS/kmZ7zRQlbcetj2Y/9O5eYw4A67hiJ5dq&#xa;xPjI5KmBAoGBAPDfqsVMy8/8V2zUb4OcUw6KydAFP8f4mF5RBqQ0PYWcF97GSVPn&#xa;gTmhCtzDpFiqaF24auvkaqIcw9ZcSak5nJTPwsiS4ZMfAkJPOoBqwBIX4umgLLdD&#xa;fYc+WchrOhXz/vNEiCcGq3wmqIzphPTUaUOb24N763uLybIxZh8gcSx1AoGBAOLX&#xa;/j3oHY0ttTBJpfnlMIeXkGuPKbvlWVDoLEFQxmrmXObGK2ECjbhremqHlp5dSDub&#xa;L8UwQZe540xBvE/SP82LrAiKctoLcsBU3qVyLF9TyNdUUtrHT63JzoJ6BtzAGOXd&#xa;MebvZ9OSQPRK3elbtWIcqtUAG7ufFUCv69miAXBrAoGAKfCX2GClwCIMyts2S3El&#xa;mQubVggD8fqb9RggkuixqZjjIxvdWqmde35J2OSLshCBuYfJvib4Vh+yDZnmDXwF&#xa;gnemT6wbcLVefFM1OXTc2omkLc+A2av7qFe35EifRYFFa/AL0Ne9dhF5GYfzaXmu&#xa;lmIF15/1AX72cHtfb54Ddp0CgYBmGujifqdGk8tZp9zgpav5bFxiPbeATtSsGUVK&#xa;RQx6s6QfcBW4fcjCuQYKC2vdbomD4u9Wp8jufYp1GaWknDOB1puh4Ief48VMEyeA&#xa;eurEIddmLRt6RHp19D9S9ZA/LuxGExFSLHKkhdFc5JIMZu428kZmx7yz8ABF9KmJ&#xa;dWWGbwKBgEi+lUZHgxYVVjFZCTsGYmL4A0H4AJnp8AhggoqsKlpmeWJ9MlfjUGYm&#xa;k1KWv9VZGYAiuGBHfGo9ll10m+DNzDF04gbABr2H8zRoHK8qwrDNSkqTugwcGE0g&#xa;aMX5R7GZUM41d4XVHmLCFJdu9WalMG3wK6sst7HnQHbHGPcbuSkj&#xa;-----END RSA PRIVATE KEY-----&#xa;</Private_key>
            <Type>ssh</Type>
        </Keypair>
    </Data>
    <RequestId>0be267d5-7b33-40b3-96e3-ba92e3c6e7dd</RequestId>
    <Message>Created</Message>
</CreateOrImportKeypairResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

删除密钥对

描述

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

请求参数

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

示例

请求示例

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

响应示例

<DeleteKeypairResponse>
    <Code>202</Code>
    <Data>null</Data>
    <RequestId>78153150-2c5f-41e1-8166-8b0449e26232</RequestId>
    <Message>Delete success</Message>
</DeleteKeypairResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询密钥对列表

描述

  • 查询SSH密钥信息列表。

请求参数

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

返回参数

不涉及

示例

请求示例

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

响应示例

<ListKeypairsResponse>
    <Code>200</Code>
    <Data>
        <TotalCount>2</TotalCount>
        <KeypairsContainer>
            <Keypairs>
                <Keypair>
                    <Public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD1JDzYBcVdbViM7M1b+DXuAIGMDamFjAvE7K3U/Ff1NyFiHYWAL6VU4EwlqKbP1wly+JlTyoMXE/qekBRL7sCh18Wpwqtcy8FG4F6e1RqEI6h64d0CXNlkISrmDEK8Uc/a/KdD7rF2lomFd08p+/JUEUWsUr9mSH8YCLpNShbSQ30kaJfyW1r43fs43Mvl6YVAMdwwq6rvMs7lHoEZRJVivoDUgIrmzGUyZllYRz1ZUhKrXmGp69F+MnvQEeIr1h1Fr6Uc1aLgy9Sc3wIDyRtbdRbrNfTmD5nh33V9+2gIb9ocghBMsMKPqDUSqSyaQ62zIIiJ5YzW6LJyo0n+X9Vf Generated-by-Nova</Public_key>
                    <Name>keypair-test_1</Name>
                    <Fingerprint>b3:b2:64:e0:e0:72:68:e8:0d:ee:0f:3a:46:34:1e:50</Fingerprint>
                    <Type>ssh</Type>
                </Keypair>
            </Keypairs>
            <Keypairs>
                <Keypair>
                    <Public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCtWbc9lVluMs0LsTFq4ew7quXpu5mp6j1TA13HoDok1XJGqKWFjCZggKIJl1ZCiXUpja05RRevYobr2thaEh788EiDyUsJ0qqSzYbT2qgpKoBV1nSFlz2YVPLpXhq6v/OG319VX+2MA531Cfgz+gSl+mOL3RhRVvIDubKeMj1E2XBDKTQCvyJ3QPgqVq6Cdx+X36Fvuh4DrGn2ng37KcZxSyOfn9AnJntZHW5AREJmQZqlRY2umeFFQNjnju9BJ+TOCHHdC4OX/TZVv81nD2zcuobqPX+fFFTMNUWC7XuS4fG0F2iGB7vw6OqJQISa+k1frqC7ee92XZr5m3VhPxZf Generated-by-Nova</Public_key>
                    <Name>keypair-test_3</Name>
                    <Fingerprint>7f:8c:e6:2e:d3:45:97:56:3e:e3:4c:5f:70:f0:40:dd</Fingerprint>
                    <Type>ssh</Type>
                </Keypair>
            </Keypairs>
        </KeypairsContainer>
    </Data>
    <RequestId>01e96c95-19d0-4ba1-a62f-36e95ebcd2cb</RequestId>
    <Message>OK</Message>
</ListKeypairsResponse>

返回值

请参考通用请求返回值

错误码

请参考错误码

查询秘钥详情

描述

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

请求参数

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

返回参数

不涉及

示例

请求示例

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

响应示例

<ShowKeypairDetailsResponse>
    <Code>200</Code>
    <Data>
        <Keypair>
            <Public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD1JDzYBcVdbViM7M1b+DXuAIGMDamFjAvE7K3U/Ff1NyFiHYWAL6VU4EwlqKbP1wly+JlTyoMXE/qekBRL7sCh18Wpwqtcy8FG4F6e1RqEI6h64d0CXNlkISrmDEK8Uc/a/KdD7rF2lomFd08p+/JUEUWsUr9mSH8YCLpNShbSQ30kaJfyW1r43fs43Mvl6YVAMdwwq6rvMs7lHoEZRJVivoDUgIrmzGUyZllYRz1ZUhKrXmGp69F+MnvQEeIr1h1Fr6Uc1aLgy9Sc3wIDyRtbdRbrNfTmD5nh33V9+2gIb9ocghBMsMKPqDUSqSyaQ62zIIiJ5YzW6LJyo0n+X9Vf Generated-by-Nova</Public_key>
            <Deleted>false</Deleted>
            <Updated_at>null</Updated_at>
            <User_id>66b5fc89cb2e4057aaacd8f3a99e1bf5</User_id>
            <Name>keypair-test_1</Name>
            <Fingerprint>b3:b2:64:e0:e0:72:68:e8:0d:ee:0f:3a:46:34:1e:50</Fingerprint>
            <Created_at>2019-02-12T06:47:14.000000</Created_at>
            <Id>3937</Id>
            <Type>ssh</Type>
            <Deleted_at>null</Deleted_at>
        </Keypair>
    </Data>
    <RequestId>d189519b-41da-4bfe-9461-237f1d61aef9</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>
  <RequestId>089a6afb-363c-4ff2-bcb5-7845a0dde522</RequestId>
  <Code>200</Code>
  <Data>eyJhbGciOiJS……amw</Data>
</GetTokenResponse>

返回值

请参考通用请求返回值

错误码

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

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