文档中心

云服务器 ECS API 参考手册

最近更新时间：2023-04-16 17:00:00

1 云服务器管理

1.1 CreateInstance

调用 CreateInstance 接口创建一个云服务器 ECS。

1.1.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POST https://{Endpoint}/ecs/v1.0/ecs

1.1.2 请求参数

表1-1 body 中的请求参数

表1-2 SecurityGroups 字段数据结构说明

表1-3 Networks 字段数据结构说明

表1-4 BlockDeviceMapping 字段数据结构说明

表1-5 QosSpecs 字段数据结构说明

表1-6 CustomFlaovr 字段数据结构说明

1.1.3 返回数据

表1-7 VolumesAttached 字段数据结构说明

1.1.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance

{

"FlavorId": "0e8476db-0c18-4596-b4a1-d3f3b5cb8a88",

"ImageId": "img-z9lc2iyvvog4w6",

……

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"RegionId": "test-19",

"EcsId": "openapi",

"FlavorId": "21408821-c95a-448f-9292-73986c790911",

"FlavorName": "ecs.c1h.c2i_xlarge",

"EcsName": "EcsName",

"EcsStatus":"CREATING",

"TenantId": "210512011001***",

"VolumesAttached":[{

"AttachedVolumeId":"99d9d709-8478-4b46-9f3f-2206b1023fd3",

"AttachedVolumeDeleteOnTermination":true

}],

"ZoneId": "dev31",

"ImageId": "img-6qhsqa4mfrrzok",

"SecurityGroups":[{

"SecurityGroupId":"sg-1tyvsuz07v"

}],

"Networks":[{

"VpcId":"vpc-514yemj4hm",

"SubnetId":"snet-0f1v4mcb30",

"PortId":"port-14zjprmqz7",

"FixedIp":"10.10.0.2"

}],

"CreatedAt": "2021-12-27T10:37:41+08:00",

"UpdatedAt": "2021-12-27T10:37:52+08:00",

"CpuArchitecture":"x86",

"EcsUserData":"IyEvYmluL3NoCmVjaG8gIkhlbGxvIFdvcmxkLiBUaGUgdGltZSBpcyBub3cgJChk

YXRlIC1SKSEiIHwgdGVlIC9yb290L3VzZXJkYXRhX3Rlc3QudHh0",

"Description":"我是一段描述"

}

1.2 DeleteEcs

调用 DeleteEcs 接口删除/退订若干云产品。

1.2.1 使用说明

DELETE https://{Endpoint}/ecs/v1.0/instance 旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：DELETE https://{Endpoint}/ecs/v1.0/ecs/delete

1.2.2 请求参数

表1-8 body 中请求参数

1.2.3 返回数据

1.2.4 示例

1. 请求示例

DELETE https://{Endpoint}/ecs/v1.0/instance

{

"EcsId":"ecs-haduxs9fmhy7ls",

"EbsIds": ["vol-haiuznaw5nxosu"],

"EipIds": ["eip-sn3gw3ar0mmn"]

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.3 AttachEip

调用 AttachEip 接口绑定一个弹性公网 EIP。

1.3.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/attacheip/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/attacheip/{EcsId}

1.3.2 请求参数

表1-9 body 中参数

1.3.3 返回数据

1.3.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/attacheip/ecs-de6c8a1m8zymwy

{

"EipId": "eip-ipjisy3xdva9",

"PortId": "port-6k8yili2bx"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.4 DetachEip

调用 DetachEip 接口解绑一个弹性公网 IP。

1.4.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/detacheip/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POST

https://{Endpoint}/ecs/v1.0/ecs/detacheip/{EcsId}

1.4.2 请求参数

表1-10 body 中的请求参数

1.4.3 返回数据

1.4.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/detacheip/{EcsId}

{

"EipId": "eip-yl9fhvzyur94",

"PortId": "port-6k8yili2bx"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.5 GetFlavorClass

调用 GetFlavorClass 接口获取规格族列表。

1.5.1 使用说明

GET https://{Endpoint}/ecs/v1.0/flavorclass ?PageSize=10&PageNumber=1旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：GET

https://{Endpoint}/ecs/v1.0/ecs/flavorclass

1.5.2 请求参数

表1-11 请求参数

1.5.3 返回数据

表1-12 FlavorClassFlags 字段数据结构说明

1.5.4 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/flavorclass?PageSize=10&PageNumber=1

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "GetFlavorClass",

"FlavorClass": [

{

"FlavorClassId": 1,

"FlavorClassName": "计算型 C2",

"CreatedAt": "2022-08-31T13:42:35+08:00",

"UpdatedAt": "2022-08-31T13:42:35+08:00",

"FlavorClassFlags": null,

"CpuExceedRatio": "未指定",

"RamExceedRatio": "未指定"

}

"PageSize": 0,

"PageNumber": 0,

"TotalCount": 20

}

1.6 GetFlavors

调用 GetFlavors 接口获取规格列表。

1.6.1 使用说明

GET https://{Endpoint}/ecs/v1.0/flavor/list?PageSize=10&PageNumber=1旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：GET

https://{Endpoint}/ecs/v1.0/ecs/flavorlist

1.6.2 请求参数

表1-13 请求参数

1.6.3 返回数据

表1-14 Stock 结构

表1-15 FlavorClass 结构

表1-16 FlavorFlags 结构

表1-17 ExtraDevices 结构

1.6.4 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/flavor/list?PageSize=10&PageNumber=1

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"Flavors": [

{

"FlavorId": "099d7c68-cab0-4cc8-99cc-d02d2a176256",

"FlavorName": "ecs.c1.small",

"ZoneId": "beijing01",

"FlavorTitle": "通用型 C1h",

"ClassId": "dev01",

"Description": "描述",

"Arch": "x86",

"Ram": 1024,

"Vcpus": 2,

"CpuBaseHZ": 0,

"CpuPeakHZ": 0,

"CpuModel": "",

"IntranetBandwidth": 0,

"IntranetPPS": 0,

"StorageBaseIOPS": 0,

"StoragePeakIOPS": 0,

"IPV6": 0,

"Status": "",

"CteatedAt": "2021-06-09T16:09:00.973+08:00",

"UpdatedAt": "2021-06-09T16:09:00.973+08:00",

"Stock": {

"StockTotal": 116,

"StockUsage": 3,

"StockRemain": 113

"FlavorClass": {

"FlavorClassId": 1,

"FlavorClassName": "计算型",

"CreatedAt": "",

"UpdatedAt": "",

"FlavorClassFlags": null,

"CpuExceedRatio": 0,

"RamExceedRatio": 0

"FlavorFlags": [

{

"FlavorId": "099d7c68-cab0-4cc8-99cc-d02d2a176256",

"FlavorName": "credible",

"FlavorValue": "false"

}

"ExtraDeviceJson": "",

"ExtraDevices": null

}

"total_count": 1

}

1.7 GetZones

调用 GetZones 接口获取可用区列表。

1.7.1 使用说明

GET https://{Endpoint}/ecs/v1.0/zones?PageSize=10&PageNumber=1旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：GET

https://{Endpoint}/ecs/v1.0/ecs/zones

1.7.2 请求参数

表1-18 请求参数

1.7.3 返回数据

1.7.4 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/zones?PageSize=10&PageNumber=1

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "GetZones",

"Zones": [

{

"ZoneId": "g15-com686-z",

"ZoneName": "可用区 Z",

"CreatedAt": 1661924555,

"UpdatedAt": 1661924555

}

"PageSize": 10,

"PageNumber": 1,

"TotalCount": 1

}

1.8 GetFlavorFamilyList

调用 GetFlavorFamilyList 接口获取规格 family 列表。

1.8.1 使用说明

GET https://{Endpoint}/ecs/v1.0/flavor/family/list

1.8.2 返回参数

表1-20 FlavorFamilyList 数组内结构说明

表1-21 ExtraCap 数组内字段结构说明

表1-22 ResourceParams 内字段结构说明

1.9 GetInstanceList

调用 GetInstanceList 接口获取云服务器 ECS 的列表。

1.9.1 使用说明

GET https://{Endpoint}/ecs/v1.0/instance/list?PageSize=10&PageNumber=1旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：GET

https://{Endpoint}/ecs/v1.0/ecs/list

1.9.2 请求参数

表1-23 请求参数

1.9.3 返回数据

表1-24 Ecs 结构

1.9.4 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/instance/list?PageSize=10&PageNumber=1

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"TotalCount": 1,

"Ecs": [

{

"RegionId": "test-19",

"EcsId": "openapi",

"FlavorId": "21408821-c95a-448f-9292-73986c790911",

"EcsName": "EcsName",

"EcsStatus":"CREATING",

"TenantId": "210512011001***",

"VolumesAttached":[{

"AttachedVolumeId":"99d9d709-8478-4b46-9f3f-2206b1023fd3",

"AttachedVolumeDeleteOnTermination":true

}],

"ZoneId": "dev31",

"ImageId": "img-6qhsqa4mfrrzok",

"SecurityGroups":[{

"SecurityGroupId":"sg-1tyvsuz07v"

}],

"Networks":[{

"VpcId":"vpc-514yemj4hm",

"SubnetId":"snet-0f1v4mcb30",

"PortId":"port-14zjprmqz7",

"FixedIp":"10.10.0.2"

}],

"CreatedAt": "2021-12-27T10:37:41+08:00",

"UpdatedAt": "2021-12-27T10:37:52+08:00",

"CpuArchitecture":"x86",

"EcsUserData":"IyEvYmluL3NoCmVjaG8gIkhlbGxvIFdvcmxkLiBUaGUgdGltZSBpcyBub3cgJChk

YXRlIC1SKSEiIHwgdGVlIC9yb290L3VzZXJkYXRhX3Rlc3QudHh0",

"Description":"我是一段描述"

}

"PageSize":10,

"PageNumber"：1

}

1.10 GetInstanceDetail

调用 GetInstanceDetail 接口获取云服务器 ECS 的详情。

1.10.1 使用说明

GET https://{Endpoint}/ecs/v1.0/instance/detail/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：GET

https://{Endpoint}/ecs/v1.0/ecs/detail/{EcsId}

1.10.2 请求参数

表1-25 URL 中

1.10.3 返回数据

表1-26 KeyPairs 结构

1.10.4 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/instance/detail/ecs-jhadjs1231

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json {

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"RegionId": "test-19",

"EcsId": "openapi",

"FlavorId": "21408821-c95a-448f-9292-73986c790911",

"EcsName": "EcsName",

"EcsStatus":"CREATING",

"TenantId": "210512011001***",

"VolumesAttached":[{

"AttachedVolumeId":"99d9d709-8478-4b46-9f3f-2206b1023fd3",

"AttachedVolumeDeleteOnTermination":true

}],

"ZoneId": "dev31",

"ImageId": "img-6qhsqa4mfrrzok",

"SecurityGroups":[{

"SecurityGroupId":"sg-1tyvsuz07v"

}],

"Networks":[{

"VpcId":"vpc-514yemj4hm",

"SubnetId":"snet-0f1v4mcb30",

"PortId":"port-14zjprmqz7",

"FixedIp":"10.10.0.2"

}],

"CreatedAt": "2021-12-27T10:37:41+08:00",

"UpdatedAt": "2021-12-27T10:37:52+08:00",

"CpuArchitecture":"x86",

"EcsUserData":"IyEvYmluL3NoCmVjaG8gIkhlbGxvIFdvcmxkLiBUaGUgdGltZSBpcyBub3cgJChk

YXRlIC1SKSEiIHwgdGVlIC9yb290L3VzZXJkYXRhX3Rlc3QudHh0",

"Description":"我是一段描述",

"KeyPairs":null

}

1.11 StopInstance

调用 StopInstance 接口关闭一个云服务器 ECS。

1.11.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/stop/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POSThttps://{Endpoint}/ecs/v1.0/ecs/stopecs/{EcsId}

1.11.2 请求参数

表1-27 body 中请求参数

1.11.3 返回数据

1.11.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/stop/ecs-de6c8a1m8zymwy

{

"Type": "SOFT"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.12 StartInstance

调用 StartInstance 接口开启一个云服务器 ECS。

1.12.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/start/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POST

https://{Endpoint}/ecs/v1.0/ecs/startecs/{EcsId}

1.12.2 返回数据

1.12.3 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/start/ecs-de6c8a1m8zymwy

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.13 GetAttachedVolumeList

调用 GetAttachedVolumeList 接口获取云服务器 ECS 的挂盘信息。

1.13.1 使用说明

GET https://{Endpoint}/ecs/v1.0/instance/attachedvolumelist/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：GET https://{Endpoint}/ecs/v1.0/ecs/attachedvolumelist/{EcsId}

1.13.2 请求参数

表1-28 URL 中请求参数

1.13.3 返回数据

表1-29 AttachedVolume 字段数据结构说明

1.13.4 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/instance/attachedvolumelist/ecs-de6c8a1m8zymwy

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"AttachedVolumes": [

{

"VolumeSize": 50,

"CreatedAt": "2022-01-18 15:17:20",

"HaveSnapshot": 0,

"VolumeId": "vol-haxxuj1ddlff9b",

"DeleteWithEcs": 0,

"VolumeName": "myTestVolume4571",

"RegionId": "hanmei03",

"Type": 1,

"VolumeTypeName": "inspur-ipsan-hdd",

"Status": 4,

"ZoneId": "zone-1",

"ZoneName": "可用区 01"

}

"TotalCount": 3

}

1.14 CreateSnapshot

调用 CreateSnapshot 接口创建云服务器 ECS 的一个快照。

1.14.1 使用说明

POST https://{Endpoint}/ecs/v1.0/snapshot/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POSThttps://{Endpoint}/ecs/v1.0/ecs/snapshot/{EcsId}

1.14.2 请求参数

表1-30 body 中请求参数

1.14.3 返回数据

1.14.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/snapshot/ecs-de6c8a1m8zymwy

{

"SnapshotName": "Test01"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

"InstaceId": "snap-564654654df"

}

1.15 GetKeyPairList

调用 GetKeyPairList 接口获取密钥对列表。

1.15.1 使用说明

GET https://{Endpoint}/ecs/v1.0/keypairs旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：GET https://{Endpoint}/ecs/v1.0/ecs/keypairs

1.15.2 返回数据

1.15.3 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/keypairs

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"KeyPairs":[

{

"TenantId": "t1",

"KeyPairName": "test01",

"Fingerprint": "5b95004353c18585fa5fc53542e9e9b8",

"CreatedAt": "2022-01-02T15:04:05Z07:00",

"UpdatedAt": "2022-01-02T15:04:05Z07:00"

}

"TotalCount":1

}

1.16 RebootInstance

调用 RebootInstance 接口重启云服务器 ECS。

1.16.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/reboot/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/reboot/:EcsId

1.16.2 请求参数

表1-31 body 中请求参数

1.16.3 返回数据

1.16.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/reboot/ecs-hak0cgepjdsfvb

{

"Type": "SOFT"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.17 RenameInstance

调用 RenameInstance 接口重命名云服务器 ECS。

1.17.1 使用说明

PUT https://{Endpoint}/ecs/v1.0/instance/rename/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/rename/:EcsId

1.17.2 请求参数

表1-32 body 中请求参数

1.17.3 返回数据

1.17.4 示例

1. 请求示例

PUT https://{Endpoint}/ecs/v1.0/instance/rename/ecs-hak0cgepjdsfvb

{

"EcsName": "daiTest01"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.18 CreateTemplate

调用 CreateTemplate 接口创建模板。

1.18.1 使用说明

POST https://{Endpoint}/ecs/v1.0/template/create/:{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/template/create/:EcsId

1.18.2 请求参数

表1-33 body 中请求参数

1.18.3 返回数据

1.18.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/template/create/ecs-hak0cgepjdsfvb

{

"TemplateName": "daiTest123",

"TemplateDesc": "dadsaisda hiahlisid"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.19 GetTemplateList

调用 GetTemplateList 接口获取模板列表。

1.19.1 使用说明

GET https://{Endpoint}/ecs/v1.0/template/list?PageSize=10&PageNumber=1旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：GET

https://{Endpoint}/ecs/v1.0/ecs/template/list

1.19.2 请求参数

表1-34 请求参数

1.19.3 返回数据

表1-35 TemplateList 结构

1.19.4 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/template/list?PageSize=10&PageNumber=1

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"TemplateList": [

{

"TemplateId": "lt-havuos5ftiqmlz",

"TemplateName": "daiTest123",

"TemplateDesc": "dadsaisda hiahlisid",

"CreateAtDesc": "2022-02-22 11:10:14",

"DefaultVersion": 1,

"CurrentVersion": 1,

"ConfigValue":

"{\"ecsName\":\"daiTest03\",\"region_id\":\"hanmei03\",\"availabilityZone\":\"zone-

1\",\"cpuArchitecture\":\"x86\",\"flavorId\":\"5214086f-2542-460f-8b7f-

0306ff58b9f9\",\"flavorClassID\":4,\"imageId\":\"img-

haeybphgkui4ko\",\"networks\":[{\"vpcId\":\"vpc-8zkd82peeh\",\"subnetId\":\" 34 ent-

2dg06oy3rg\",\"ipv6Enabled\":false,\"fixedIp\":\"\"}],\"volumes\":[{\"volumeTypeId\":\"vtype-

ojp96fw88b9o6o\",\"volumeSize\":20,\"deleteOnTermination\":true,\"osOrData\":\"osDisk\"}],\"sgId

List\":[\"sg-ozsqk9bwvt\"],\"eip\":{\"34ent34idth\":\"\"}}"

}

"PageSize": 1,

"PageNumber": 1,

"TotalCount": 2

}

1.20 GetTemplateDetail

调用 GetTemplateDetail 接口获取模板详情。

1.20.1 使用说明

GET https://{Endpoint}/ecs/v1.0/template/detail/{TemplateId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/template/:TemplateId

1.20.2 请求参数

表1-36 写入 URL 的请求参数

1.20.3 返回数据

表1-37 Volume 字段数据结构说明

1.20.4 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/template/detail/lt-ha53nyy6br5avo

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"TemplateId": "lt-ha53nyy6br5avo",

"TemplateName": "daiTest123",

"TemplateDesc": "dadsaisda hiahlisid",

"TenantId": "220002061700520",

"EcsName": "daiTest1234",

"RegionId": "hanmei03",

"ZoneId": "zone-1",

"CpuArchitecture": "x86",

"FlavorID": "d19627aa-b847-48a0-ae9f-e0e3a47f03f2",

"FlavorClassID": 4,

"ImageId": "img-haeybphgkui4ko",

"Networks": [

{

"VpcId": "vpc-8zkd82peeh",

"SubnetId": "36ent-2dg06oy3rg",

"FixedIp": "",

"Ipv6Enabled": false

}

"Volumes": [

{

"VolumeTypeId": "vtype-ojp96fw88b9o6o",

"VolumeSize": 20,

"DeleteOnTermination": false,

"OsOrData": "osDisk"

}

"SecurityGroupIds": [

"sg-ozsqk9bwvt"

"Bandwidth": "",

"DefaultVersion": 1,

"CurrentVersion": 1,

"FlavorName": "ecs.c1h.c2i_xlarge",

"Ram": 8192,

"Cpu": 4

}

1.21 DeleteTemplate

调用 DeleteTemplate 接口删除模板。

1.21.1 使用说明

DELETE https://{Endpoint}/ecs/v1.0/template旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：DELETEhttps://{Endpoint}/ecs/v1.0/ecs/template

1.21.2 请求参数

表1-38 body 中参数

1.21.3 返回数据

1.21.4 示例

1. 请求示例

DELETE https://{Endpoint}/ecs/v1.0/template

{

"TemplateIdList":["lt-ha53nyy6br5avo"]

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.22 CreateInstance（通过模板创建ECS）

调用 CreateInstance 接口从模板创建云服务器 ECS。

1.22.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/template/{TemplateId}旧的 URL，不推荐使用，且 313 及 313 之后的版本后续不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/template/ecs/:TemplateId

1.22.2 请求参数

表1-39 body 中参数

1.22.3 返回数据

1.22.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/template/lt-ha53nyy6br5avo

{

"ChargingMode": "1",

"PeriodType": "month",

"Duration": 1,

"AdminPass": "dai88CESTC"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

}

1.23 ResizeInstance

调用 ResizeInstance 接口变配（升配/降配）云服务器 ECS。

1.23.1 使用说明

PUT https://{Endpoint}/ecs/v1.0/instance/resize/{:EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本不会维护：POSThttps://{Endpoint}/ecs/v1.0/ecs/resize/:EcsId

1.23.2 请求参数

表1-40 body 中参数

表1-41 CustomFlavor 字段数据结构说明

1.23.3 返回数据

1.23.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/resize/ecs-haz1grwqw033rj

{

"FlavorId": "d19627aa-b847-48a0-ae9f-e0e3a47f03f2"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.24 HotPlugoutNIC

调用 HotPlugoutNIC 接口卸载网卡。

1.24.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/detachinterface/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/detachinterface/:EcsId

1.24.2 请求参数

表1-42 body 中参数

1.24.3 返回数据

1.24.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/detachinterface/ecs-haou4zsnydq5vp

{

"PortId": "port-vnvhclnvgl"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.25 HotPluginNIC

调用 HotPluginNIC 接口挂载网卡。

1.25.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/attachinterface/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/attachinterface/:EcsId

1.25.2 请求参数

表1-43 body 中参数

1.25.3 返回数据

1.25.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/attachinterface/ecs-haou4zsnydq5vp

{

"VpcId": "vpc-8zkd82peeh",

"SubnetId": "snet-2dg06oy3rg",

"SecurityGroupIds": ["sg-ozsqk9bwvt"]

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.26 ChangeIP

调用 ChangeIP 接口更改主网卡 IP。

1.26.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/changeip/{EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/changeip/:EcsId

1.26.2 请求参数

表1-44 body 中参数

1.26.3 返回数据

1.26.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/changeip/ecs-haou4zsnydq5vp

{

"PortId": "port-g9gk0x90f3",

"FixedIp": "192.168.0.200",

"SecurityGroupIds": ["sg-ozsqk9bwvt"]

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.27 GetImageList

调用 GetImageList 接口获取镜像列表。

1.27.1 使用说明

GET https://{Endpoint}/ecs/v1.0/image/list旧的 URL，不推荐使用，且 313 及 313 之后的版本不会维护：GET https://{Endpoint}/ecs/v1.0/ecs/image/list

1.27.2 请求参数

表1-45 请求参数

1.27.3 返回数据

表1-46 Images 字段数据结构说明

1.27.4 示例

1. 请求示例

GET https://{Endpoint}/ecs/v1.0/image/list?PageSize=10&PageNumber=1&VirtualEnvType=

"KVM"& Visibility="private"

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"Images": [

{

"ImageType": "os_image",

"ArchType": "x86",

"CreatedAt": "2022-02-22T10:33:12+08:00",

"ImageId": "img-haeybphgkui4ko",

"Downloadable": false,

"MaxRam": "",

"MinDisk": 5,

"MinRam": 1024,

"ImageName": "CentOS-8.2-dai.raw",

"OsType": "linux",

"OsVersion": "8.2",

"RegionId": "",

"Remark": "",

"ResourceCode": "",

"Status": "active",

"Type": "public",

"Uid": "img-haeybphgkui4ko",

"UpdatedAt": "2022-02-22T10:36:42+08:00",

"Visibility": "public",

"VolumeTypes": null,

"Platform": "CentOS",

"OsBit": "64",

"Description": "CentOS-8.2-amd64-20211122024016.raw-Aut0Test",

"DiskFormat": "raw",

"ImageClass": "ecs"

}

"PageSize": 10,

"PageNumber": 1,

"TotalCount": 1

}

1.28 CreateImage

调用 CreateImage 接口创建镜像。

1.28.1 使用说明

POST https://{Endpoint}/ecs/v1.0/image旧的 URL，不推荐使用，且 313 及 313 之后的版本不会维护：POST https://{Endpoint}/ecs/v1.0/ecs/image

1.28.2 请求参数

表1-47 body 中请求参数

1.28.3 返回数据

1.28.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/image

{

"ImageName": "ImageTest02",

"Description": "123dar567wdgyuau",

"EcsId": "ecs-hak0cgepjdsfvb",

"WholeVm": true

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

"InstaceId": "image-1245f4dg54df56g4d"

}

1.29 DeleteImage

调用 DeleteImage 接口删除镜像。

1.29.1 使用说明

DELETE https://{Endpoint}/ecs/v1.0/image/:{ImageId}旧的 URL，不推荐使用，且 313 及 313 之后的版本不会维护：DELETEhttps://{Endpoint}/ecs/v1.0/ecs/image/:ImageId

1.29.2 请求参数

表1-48 URL 中参数

1.29.3 返回数据

1.29.4 示例

1. 请求示例

DELETE https://{Endpoint}/ecs/v1.0/image/img-hal8rcocu7xvck

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

1.30 Rollback

调用 Rollback 接口恢复云服务器 ECS 至某一快照。

1.30.1 使用说明

POST https://{Endpoint}/ecs/v1.0/instance/restore/{:EcsId}旧的 URL，不推荐使用，且 313 及 313 之后的版本不会维护：POST

https://{Endpoint}/ecs/v1.0/ecs/restore/:EcsId

1.30.2 请求参数

表1-49 body 中请求参数

1.30.3 返回数据

1.30.4 示例

1. 请求示例

POST https://{Endpoint}/ecs/v1.0/instance/restore/ecs-hak0cgepjdsfvb

{

"GroupSnapshotId": "gs-ha0782rcgq8x7c"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"

}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服