华为云用户手册

  • 网络管理 权限 对应的API接口 授权项(Action) 依赖的授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 查询网络列表(OpenStack原生)(废弃) GET /v2.1/{project_id}/os-networks ecs:networks:list vpc:networks:get √ × × × 父主题: 权限和授权项
  • 获取Token 接口调用前需要认证鉴权,因此需要提前获取token信息。后续调用API的消息头中“X-Auth-Token”的值即为Token值。 本例以获取华东-上海二区域的Token为例: 请求URI:POST https://iam.cn-east-2.myhuaweicloud.com/v3/auth/tokens 请求消息头:Content-Type=application/json 请求消息体: { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "请填写用户名", "password": "$ADMIN_PASS", //建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "domain": { "name": "用户所属的账号名称" } } } }, "scope": { "project": { "name": "区 域名 称,本例为cn-east-2" } } }} 查看获取的Token:单击响应头,x-subject-token的取值即为获取的Token。请妥善保存Token信息,在后续的创建云服务器的请求头信息中需要使用Token认证。 General: Request URL: https://iam.cn-east-2.myhuaweicloud.com/v3/auth/tokens Request Method: POST Status Code: 201Response Headers: cache-control: no-cache, no-store, must-revalidate connection: keep-alive content-length: 18401 content-type: application/json; charset=UTF-8 date: Thu, 27 May 2021 01:24:49 GMT expires: Thu, 01 Jan 1970 00:00:00 GMT pragma: no-cache server: api-gateway strict-transport-security: max-age=31536000; includeSubdomains; via: proxy A x-content-type-options: nosniff x-download-options: noopen x-frame-options: SAMEORIGIN x-iam-trace-id: token_cn-east-2_null_9bbec3983f3c7a5c146e709251760467 x-request-id: d7796611318416bc8ffb2948a47fede8 x-subject-token: MIISMAYJKoZIhvcNAQ...7xMUw== x-xss-protection: 1; mode=block; 查看Token过期时间:响应体中“expires_at”表示该Token过期时间。 {"token": {"expires_at": "2021-05-28T01:24:49.905000Z", ...}}
  • 安全组管理 权限 对应的API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 创建安全组(OpenStack原生)(废弃) POST /v2.1/{project_id}/os-security-groups ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:create vpc:securityGroups:update √ × × × 删除安全组(OpenStack原生)(废弃) DELETE /v2.1/{project_id}/os-security-groups/{security_group_id} ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:delete vpc:securityGroups:update √ × × × 查询安全组详细信息(OpenStack原生)(废弃) GET /v2.1/{project_id}/os-security-groups/{security_group_id} ecs:securityGroups:use vpc:securityGroups:get √ × × × 查询安全组列表(OpenStack原生)(废弃) GET /v2.1/{project_id}/os-security-groups ecs:securityGroups:use vpc:securityGroups:get √ × × × 创建安全组规则(OpenStack原生)(废弃) POST /v2.1/{project_id}/os-security-group-rules ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:update vpc:securityGroupRules:get vpc:securityGroupRules:create √ × × × 删除安全组规则(OpenStack原生)(废弃) DELETE /v2.1/{project_id}/os-security-group-rules/{security_group_rule_id} ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:update vpc:securityGroupRules:get vpc:securityGroupRules:delete √ × × × 更新安全组信息(OpenStack原生)(废弃) PUT /v2.1/{project_id}/os-security-groups/{security_group_id} ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:update √ × × × 查询指定云服务器安全组列表(OpenStack原生)(废弃) GET /v2.1/{project_id}/servers/{server_id}/os-security-groups ecs:securityGroups:use vpc:securityGroups:get vpc:ports:get √ × × × 添加安全组(OpenStack原生)(废弃) POST /v2.1/{project_id}/servers/{server_id}/action ecs:securityGroups:use ecs:servers:get ecs:servers:list ecs:serverVolumes:use ecs:diskConfigs:use ecs:serverKeypairs:get vpc:securityGroups:get vpc:securityGroups:create vpc:securityGroups:update vpc:securityGroupRules:get vpc:networks:get vpc:subnets:get vpc:routers:get vpc:ports:get vpc:ports:update √ × × × 移除安全组(OpenStack原生)(废弃) POST /v2.1/{project_id}/servers/{server_id}/action ecs:securityGroups:use ecs:servers:get ecs:servers:list ecs:serverVolumes:use ecs:diskConfigs:use ecs:serverKeypairs:get vpc:securityGroups:get vpc:securityGroups:delete vpc:securityGroups:update vpc:securityGroupRules:get vpc:networks:get vpc:subnets:get vpc:routers:get vpc:ports:get vpc:ports:update √ × × × 父主题: 权限和授权项
  • 响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 flavor Object 云服务器规格,详情请参见表3。 表3 flavor数据结构说明 参数 参数类型 描述 id String 云服务器规格ID。 name String 云服务器规格名称。 vcpus Integer 云服务器规格对应的CPU核数。 ram Integer 云服务器规格对应的内存大小,单位为MB。 disk Integer 云服务器规格对应要求系统盘大小。 当前未使用该参数,缺省值为0。 swap String 云服务器规格对应要求的交换分区大小。 当前未使用该参数,缺省值为""。 OS-FLV-EXT-DATA:ephemeral Integer 扩展属性,临时盘大小。 当前未使用该参数,缺省值为0。 OS-FLV-DISABLED:disabled Boolean 扩展属性,该云服务器规格是否禁用。 当前未使用该参数,缺省值为false。 rxtx_factor Float 云服务器可使用网络带宽与网络硬件带宽的比例。 当前未使用该参数,缺省值为1.0。 os-flavor-access:is_public Boolean 扩展属性,flavor是否给所有租户使用。 true:表示给所有租户使用。 false:表示给指定租户使用。 缺省值为true。 links Array of objects 规格相关快捷链接地址,详情请参见表4。 表4 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 href String 对应快捷链接。
  • 响应示例 { "keypairs": [ { "keypair": { "fingerprint": "15:b0:f8:b3:f9:48:63:**:**:**:**:**:**:**:**:**", "name": "keypair-601a2305-4f25-41ed-89c6-2a966fc8027a", "type": "ssh", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79Kkl****************************************************************************************************************************************************** Generated-by-Nova\n" } } ]}
  • 响应示例 { "flavor": { "name": "c3.2xlarge.2", "links": [ { "href": "https://compute.region.example.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "self" }, { "href": "https://compute.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "bookmark" } ], "ram": 16384, "OS-FLV-DISABLED:disabled": false, "vcpus": 8, "swap": "", "os-flavor-access:is_public": true, "rxtx_factor": 1, "OS-FLV-EXT-DATA:ephemeral": 0, "disk": 0, "id": "c3.2xlarge.2" }}
  • 响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 keypairs Array of objects 密钥信息列表,详情请参见表3。 表3 keypairs字段数据结构说明 参数 参数类型 描述 keypair Object 密钥信息详情,详情请参见表4。 表4 keypair字段数据结构说明 参数 参数类型 描述 fingerprint String 密钥对应指纹信息。 name String 密钥名称。 type String 密钥类型,默认“ssh” 微版本2.2及以上版本支持。 public_key String 密钥对应publicKey信息。
  • 请求示例 POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action { "addFloatingIp" : { "address" : "10.144.2.1", "fixed_address" : "192.168.1.3" }}
  • 接口约束 使用此接口时,请指定微版本不低于2.6。 "微版本号": 通过Http请求头X-OpenStack-Nova-API-Version来或者OpenStack-API-Version添加。 示例:X-OpenStack-Nova-API-Version:2.6 或者OpenStack-API-Version:compute 2.6 获取的登录地址有效时间10min,超过10min请重新获取。
  • 响应消息 响应参数如表4所示。 表4 响应参数 参数 参数类型 描述 remote_console Object 弹性云服务器获取远程登录地址,参考表5。 表5 remote_console参数信息 参数 参数类型 描述 type String 远程登录的类型。 protocol String 远程登录的协议。 url String 远程登录的url。 该url有效时间10min,超过10min请重新获取。
  • 请求示例 获取指定云服务器的VNC远程登录地址。 POST https://{endpoint}/v2.1/13c67a214ced4afb88d911ae4bd5721a/servers/47bc79ae-df61-4ade-9197-283a74e5d70e/remote-consoles{ "remote_console" : { "type" : "novnc", "protocol": "vnc" }}
  • URI PUT /v2.1/{project_id}/servers/{server_id}/tags/{tag} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方法请参见获取项目ID。 server_id 是 云服务器ID。 tag 是 待添加标签的key。 说明: 系统近期对标签功能进行了升级。如果之前添加的Tag为“Key.Value”的形式,则查询的时候需要使用“Key”来查询。 例如:之前添加的tag为“a.b”,查询时采用“tag=a.b”,则现在查询时需采用“tag=a”。
  • 响应消息 响应参数如表9所示。 表9 响应参数 参数 参数类型 描述 server Object 云服务器信息,详情请参见表10。 表10 server字段数据结构说明 参数 参数类型 描述 id String 弹性云服务器ID,UUID格式。 links Array of objects 弹性云服务器URI自描述信息,详情参见表11。 security_groups Array of objects 弹性云服务器所在安全组,详情参见表12。 OS-DCF:diskConfig String diskConfig方式。 MANUAL,镜像空间不会扩展。 AUTO,系统盘镜像空间会自动扩展为与flavor大小一致。 reservation_id String reservation_id:通过返回的reservation_id,可以过滤查询到本次创建的弹性云服务器。 说明: 批量创建弹性云服务器时,支持使用该字段。 adminPass String Windows弹性云服务器Administrator用户的密码。 表11 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 href String 对应快捷链接。 表12 security_groups字段数据结构说明 参数 参数类型 描述 name String 安全组名称或者uuid。
  • 请求示例 通过block_device_mapping_v2扩展属性使用镜像创建一台云服务器,采用密钥方式登录鉴权。 POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers{ "server": { "flavorRef": "s3.xlarge.2", "name": "wjvm48", "metadata": { "name": "name_xx1", "id": "id_xxxx1" }, "block_device_mapping_v2": [{ "source_type": "image", "destination_type": "volume", "uuid": "b023fe17-11db-4efb-b800-78882a0e394b", "delete_on_termination": "False", "boot_index": "0", "volume_type": "SAS", "volume_size": "40" }], "security_groups": [{ "name": "name_xx5_sg" }], "networks": [{ "uuid": "fd40e6f8-942d-4b4e-a7ae-465287b02a2c", "port": "e730a11c-1a19-49cc-8797-cee2ad67af6f", "fixed_ip": "10.20.30.137" }], "key_name": "test", "user_data": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA==", "availability_zone":"az1-dc1" } } 通过block_device_mapping_v2扩展属性使用快照创建一台云服务器,其中,boot_index为0,且该快照对应的云硬盘必须为系统盘。 POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers{ "server":{ "name":"wjvm48", "availability_zone":"az1-dc1", "block_device_mapping_v2": [ { "source_type":"snapshot", "boot_index":"0", "uuid":"df51997d-ee35-4fb3-a372-e2ac933a6565", // snapshot id,创建snapshot接口会返回id "destination_type":"volume" } ], "flavorRef":"s3.xlarge.2", "max_count":1, "min_count":1, "networks": [ { "uuid":"79a68cef-0936-4e21-b1f4-b800ecb70246" } ] } } 通过block_device_mapping_v2使用卷创建一台弹性云服务器。 POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers{ "server": { "flavorRef": "s3.xlarge.2", "name": "wjvm48", "metadata": { "name": "name_xx1", "id": "id_xxxx1" }, "block_device_mapping_v2": [{ "source_type": "volume", "destination_type": "volume", "uuid": "bd7e4f86-b004-4745-bea2-a55b1085f107", "delete_on_termination": "False", "boot_index": "0", "volume_type": "dsware", "volume_size": "40" }], "security_groups": [{ "name": "name_xx5_sg" }], "networks": [{ "uuid": "fd40e6f8-942d-4b4e-a7ae-465287b02a2c", "port": "e730a11c-1a19-49cc-8797-cee2ad67af6f", "fixed_ip": "10.20.30.137" }], "key_name": "test", "user_data": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA==", "availability_zone":"az1-dc1" } } 使用imageRef创建一台弹性云服务器,建议将密码在配置文件或者环境变量中密文存放,使用时解密,确保安全。 POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers{ "server": { "flavorRef": "s3.xlarge.2", "name": "wjvm48", "metadata": { "name": "name_xx1", "id": "id_xxxx1" }, "adminPass": "$ADMIN_PASS", "imageRef": "6b344c54-d606-4e1a-a99e-a7d0250c3d14", "security_groups": [{ "name": "name_xx5_sg" }], "networks": [{ "uuid": "fd40e6f8-942d-4b4e-a7ae-465287b02a2c", "port": "e730a11c-1a19-49cc-8797-cee2ad67af6f", "fixed_ip": "10.20.30.137" }], "key_name": "test", "user_data": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA==", "availability_zone":"az1-dc1" } } 批量创建弹性云服务器,最小数量为2,最大数量为3。 POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers{ "server": { "availability_zone":"az1.dc1", "name": "test", "imageRef": "10ff4f01-35b6-4209-8397-359cb4475fa0", "flavorRef": "s3.xlarge.2", "return_reservation_id": "true", "networks": [ { "uuid": "51bead38-d1a3-4d08-be20-0970c24b7cab" } ], "min_count": "2", "max_count": "3" }}
  • 响应示例 创建弹性云服务器: { "server": { "security_groups": [ { "name": "name_xx5_sg" } ], "OS-DCF:diskConfig": " MANUAL", "id": "567c1557-0eca-422c-bfce-149d6b8f1bb8", "links": [ { "href": "http://xxx/v2/dc4059e8e7994f2498b514ca04cdaf44/servers/567c1557-0eca-422c-bfce-149d6b8f1bb8", "rel": "self" }, { "href": "http://xxx/dc4059e8e7994f2498b514ca04cdaf44/servers/567c1557-0eca-422c-bfce-149d6b8f1bb8", "rel": "bookmark" } ], "adminPass": "*********" }} 批量创建弹性云服务器: { "reservation_id": "r-3fhpjulh"}
  • 接口约束 该接口为原生接口,不支持整机镜像创建弹性云服务器功能。如需使用整机镜像创建弹性云服务器,请使用创建云服务器(按需)。 该接口为原生接口,不支持创建竞价实例。如需创建竞价实例请使用创建云服务器、创建云服务器(按需)。 该接口为原生接口,不支持创建包年/包月计费模式的实例。如需创建包年/包月计费模式的云服务器请使用创建云服务器。 使用该接口创建的云服务器,不支持在创建过程中绑定弹性公网IP,推荐使用创建云服务器(按需)创建云服务器并绑定弹性公网IP。 网络的三个参数(port、uuid和fixed_ip)中,port优先级最高;指定fixed_ip时必须指明uuid。 注入文件失败,将导致创建弹性云服务器失败。 使用镜像创建弹性云服务器时,存在下面约束: 不支持指定Host创建弹性云服务器。 租户如果对弹性云服务器中的卷进行了备份,则需要租户自行删除该卷所对应的快照等数据后,才能删除卷。 调整镜像创建的弹性云服务器规格时,不支持resource_type不同的flavor之间的规格调整。 云服务平台提供的原生接口/v2/{project_id}/servers 和 /v2.1/{project_id}/servers 是基于社区版OpenStack原生接口加固而成的,兼容社区版OpenStack原生接口。 较之社区版的OpenStack原生接口,在使用指定镜像的方式创建弹性云服务器时存在如下差异: 社区OpenStack原生接口:默认使用服务器本地磁盘创建弹性云服务器。 云服务平台提供的原生接口:为了保障可靠性,使用共享存储作为系统盘创建弹性云服务器。 该差异的具体表现为,当您使用提供的原生接口创建云服务器时: 可以查询到云服务器挂载的系统盘信息。 云服务器的系统盘会占用云硬盘的配额。 不支持使用image过滤查询指定镜像方式创建的弹性云服务器。 指定卷创建弹性云服务器场景下,指定的卷与创建的弹性云服务器必须处于相同的AZ(availability_zone)。 用户创建弹性云服务器时在block_device_mapping_v2设置的device_name字段不会生效,系统会默认生成一个device_name。 请勿使用“provider:network_type”为“geneve”的网络来创建弹性云服务器。 “provider:network_type”为“geneve”时,表示裸金属服务器使用的内部高速网络。 如果使用密钥方式远程登录云服务器,请使用key_name参数。如果使用密码方式远程登录云服务器,可使用adminPass参数;对于Linux云服务器,还可使用user_data进行注入,对于Windows云服务器,还可通过元数据admin_pass进行注入。
  • 操作步骤 指定limit查询云服务器详情列表 接口相关信息 URI格式: GET /v1/{project_id}/cloudservers/detail 详情请参见“查询云服务器详情列表”。 请求示例 GET https://{endpoint}/v1/743b4c0428d945316666666666666666/cloudservers/detail?offset=1&limit=100 {endpoint}信息请从地区和终端节点获取。 limit值可根据云服务器数据调整。 响应示例 { "count":2, "servers":[ { "fault":null, "id":"743b4c0428d945316666666666666666", "name":"ecs-5e70", "addresses":{ "140fd038-c4ae-4c32-ac07-34b525eb6b95":[ { "version":"4", "addr":"192.168.0.206", "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:95:88:3f", "OS-EXT-IPS:port_id":"7b5d615c-186d-4646-9cb8-444addfe9b92", "OS-EXT-IPS:type":"fixed" }, { "version":"4", "addr":"192.168.0.8", "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:1d:88:43", "OS-EXT-IPS:port_id":"dda2027b-2f03-497b-8d42-620da2baacc3", "OS-EXT-IPS:type":"fixed" } ] }, "flavor":{ "disk":"0", "vcpus":"2", "ram":"1024", "id":"c3.large.2", "name":"c3.large.2", "gpus": [], "asic_accelerators": [] }, "accessIPv4":"", "accessIPv6":"", "status":"SHUTOFF", "image":{ "id":"1ce5800a-e487-4c1b-b264-3353a39e2b4b" }, "hostId":"f92345b97fd291f67a29ed735a82a8983f370175d2ba3d18d66893f4", "updated":"2018-08-14T07:26:49Z", "created":"2018-08-13T13:46:09Z", "metadata":{ "metering.image_id":"af60e0d5-6952-4f3d-b0ed-31bb19d4a692", "metering.resourcespeccode":"c3.large.2.linux", "image_name":"HEC_Public_Cloudinit_CentOS_7.4_64bit", "metering.product_id":"00301-253164-0--0", "os_bit":"64", "lockSourceId":"", "lockScene":"", "metering.order_id":" CS 1808132145NRVRE", "lockCheckEndpoint":"", "metering.imagetype":"gold", "lockSource":"", "metering.resourcetype":"1", "vpc_id":"164489f6-cbf7-45b4-b6d0-d407c48cf7fc", "os_type":"Linux", "charging_mode":"1" }, "tags":[ ], "description":"ecs-4cff", "locked":false, "config_drive":"", "tenant_id":"edcb94a885a84ed3a3fdf8ea4d2741da", "user_id":"bb7f23e27e7e46f3aaceb5f53a158bdc", "os-extended-volumes:volumes_attached":[ { "device":"/dev/sda", "bootIndex":"0", "id":"2edc879f-022e-4bd6-b079-95a27564d449", "delete_on_termination":"false" } ], "OS-EXT-STS:task_state":null, "OS-EXT-STS:power_state":4, "OS-EXT-STS:vm_state":"stopped", "OS-EXT-SRV-ATTR:host":"az1.dc1", "OS-EXT-SRV-ATTR:instance_name":"instance-00137941", "OS-EXT-SRV-ATTR:hypervisor_hostname":"nova001@248", "OS-DCF:diskConfig":"MANUAL", "OS-EXT-AZ:availability_zone":"az1-dc1", "os:scheduler_hints":{ }, "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda", "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a62-4014-89be-1743ff3a5daf", "enterprise_project_id":"441d5677-b76a-4dd4-a97a-ef7fd633c095", "OS-EXT-SRV-ATTR:user_data":"IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRKQ2FzUWQkbm5wVmhJUFZlNVMwc3pXbnJGLnZVZ1FCWk4xTEo5Vy8wd09WTmFZaWpBRXdtRnhuQmZaTllVZXhBWktVWFVTeVhEeERuSUMzV2JjZEJyQUVBZkZvLy8nIHwgY2hwYXNzd2QgLWU7", "OS-SRV-USG:launched_at":"2018-08-13T13:46:46.000000", "OS-EXT-SRV-ATTR:kernel_id":"", "OS-EXT-SRV-ATTR:launch_index":0, "host_status":"UP", "OS-EXT-SRV-ATTR:reservation_id":"r-a8mg9vwr", "OS-EXT-SRV-ATTR:hostname":"ecs-4cff", "sys_tags":[ { "key":"_sys_enterprise_project_id", "value":"441d5677-b76a-4dd4-a97a-ef7fd633c095" } ], "security_groups":[ { "id":"71846bf6-1cda-4515-8590-3707be295e76", "name":"Sys-FullAccess" }, { "id":"b1786350-da65-11e7-b312-0255ac101b03", "name":"default" } ] }, { "fault":null, "id":"e3d3f219-b445-4a7a-8f00-e31412481f8c", "name":"ecs-1f30", "addresses":{ "00159d7d-b3c3-4108-8bc4-6658814e6422":[ { "version":"4", "addr":"192.168.20.197", "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:41:5a:32", "OS-EXT-IPS:port_id":"cfa2e055-54fb-427a-bde4-128bda47ae5c", "OS-EXT-IPS:type":"fixed" } ] }, "flavor":{ "disk":"0", "vcpus":"2", "ram":"1024", "id":"c3.large.2", "name":"c3.large.2", "gpus": [], "asic_accelerators": [] }, "accessIPv4":"", "accessIPv6":"", "status":"ACTIVE", "image":{ "id":"1ce5800a-e487-4c1b-b264-3353a39e2b4b" }, "progress":0, "hostId":"f92345b97fd291f67a29ed735a82a8983f370175d2ba3d18d66893f4", "updated":"2018-08-15T08:16:01Z", "created":"2018-08-13T11:57:29Z", "metadata":{ "sadfasfasf":"sdffffd", "metering.order_id":"CS180813193577ORO", "metering.imagetype":"gold", "metering.resourcespeccode":"c3.large.2.win", "metering.image_id":"65cb40e6-f67e-4bef-a1e7-808166a5999d", "image_name":"HEC_Public_Windows2008R2_Ent_64bit40G_English", "aaaaaa":"0", "metering.resourcetype":"1", "aaaa":"0", "metering.product_id":"00301-146042-0--0", "os_bit":"64", "vpc_id":"00159d7d-b3c3-4108-8bc4-6658814e6422", "os_type":"Windows", "charging_mode":"1" }, "tags":[ "_sys_root_resource_id=4514d9b0-d611-4744-bdf9-60802fd5198a", "_sys_root_resource_type=xxx.resource.type.vm" ], "description":"ecs-1f30", "locked":false, "config_drive":"", "tenant_id":"edcb94a885a84ed3a3fdf8ea4d2741da", "user_id":"bb7f23e27e7e46f3aaceb5f53a158bdc", "key_name":"Autotest_Init_TC_OriginalAPI_Create_Keypairs_02_keypair", "os-extended-volumes:volumes_attached":[ { "device":"/dev/sda", "bootIndex":"0", "id":"5043f66b-a0d8-4eb2-8c48-49976bcdc253", "delete_on_termination":"false" } ], "OS-EXT-STS:task_state":null, "OS-EXT-STS:power_state":1, "OS-EXT-STS:vm_state":"active", "OS-EXT-SRV-ATTR:host":"az1.dc1", "OS-EXT-SRV-ATTR:instance_name":"instance-0013772d", "OS-EXT-SRV-ATTR:hypervisor_hostname":"nova001@248", "OS-DCF:diskConfig":"MANUAL", "OS-EXT-AZ:availability_zone":"az1-dc1", "os:scheduler_hints":{ }, "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda", "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a62-4014-92be-1743ff3a5daf", "enterprise_project_id":"441d5677-b76a-4dd4-a97a-ef7fd633c095", "OS-SRV-USG:launched_at":"2018-08-13T11:57:53.576640", "OS-EXT-SRV-ATTR:kernel_id":"", "OS-EXT-SRV-ATTR:launch_index":0, "host_status":"UP", "OS-EXT-SRV-ATTR:reservation_id":"r-xmjj4pnm", "OS-EXT-SRV-ATTR:hostname":"ecs-1f30", "sys_tags":[ { "key":"_sys_enterprise_project_id", "value":"441d5677-b76a-4dd4-a97a-ef7fd633c095" } ], "security_groups":[ { "name":"default" } ] } ]} 指定limit与marker查询云服务器详情列表 接口相关信息 URI格式: GET /v1/{project_id}/cloudservers/detail 接口与 步骤1 保持一致。 请求示例 GET https://{endpoint}/v1/743b4c0428d945316666666666666666/cloudservers/detail?limit=100&marker=f215afe8-b0c2-41cc-9191-585638166812 接口返回了下一页的接口URI,参考返回body体中的 servers_links 中的href字段,如果不存在该字段,表示已经不存在下一页。 响应示例 { "servers":[ ..... { "fault":null, "id":"743b4c0428d945316666666666666666", "name":"ecs-1f30", "addresses":{ "140fd038-c4ae-4c32-ac07-34b525eb6b95":[ { "version":"4", "addr":"192.168.20.197", "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:41:5a:32", "OS-EXT-IPS:port_id":"cfa2e055-54fb-427a-bde4-128bda47ae5c", "OS-EXT-IPS:type":"fixed" } ] }, "flavor":{ "disk":"0", "vcpus":"2", "ram":"1024", "id":"c3.large.2", "name":"c3.large.2", "gpus": [], "asic_accelerators": [] }, "accessIPv4":"", "accessIPv6":"", "status":"ACTIVE", "image":{ "id":"1ce5800a-e487-4c1b-b264-3353a39e2b4b" }, "progress":0, "hostId":"f92345b97fd291f67a29ed735a82a8983f370175d2ba3d18d66893f4", "updated":"2018-08-15T08:16:01Z", "created":"2018-08-13T11:57:29Z", "metadata":{ "sadfasfasf":"sdffffd", "metering.order_id":"CS180813193577ORO", "metering.imagetype":"gold", "metering.resourcespeccode":"c3.large.2.win", "metering.image_id":"65cb40e6-f67e-4bef-a1e7-808166a5999d", "image_name":"HEC_Public_Windows2008R2_Ent_64bit40G_English", "aaaaaa":"0", "metering.resourcetype":"1", "aaaa":"0", "metering.product_id":"00301-146042-0--0", "os_bit":"64", "vpc_id":"00159d7d-b3c3-4108-8bc4-6658814e6422", "os_type":"Windows", "charging_mode":"1" }, "tags":[ "_sys_root_resource_id=4514d9b0-d611-4744-bdf9-60802fd5198a", "_sys_root_resource_type=xxx.resource.type.vm" ], "description":"ecs-1f30", "locked":false, "config_drive":"", "tenant_id":"edcb94a885a84ed3a3fdf8ea4d2741da", "user_id":"bb7f23e27e7e46f3aaceb5f53a158bdc", "key_name":"Autotest_Init_TC_OriginalAPI_Create_Keypairs_02_keypair", "os-extended-volumes:volumes_attached":[ { "device":"/dev/sda", "bootIndex":"0", "id":"5043f66b-a0d8-4eb2-8c48-49976bcdc253", "delete_on_termination":"false" } ], "OS-EXT-STS:task_state":null, "OS-EXT-STS:power_state":1, "OS-EXT-STS:vm_state":"active", "OS-EXT-SRV-ATTR:host":"az1.dc1", "OS-EXT-SRV-ATTR:instance_name":"instance-0013772d", "OS-EXT-SRV-ATTR:hypervisor_hostname":"nova001@248", "OS-DCF:diskConfig":"MANUAL", "OS-EXT-AZ:availability_zone":"az1-dc1", "os:scheduler_hints":{ }, "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda", "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a62-4014-92be-1743ff3a5daf", "enterprise_project_id":"441d5677-b76a-4dd4-a97a-ef7fd633c095", "OS-SRV-USG:launched_at":"2018-08-13T11:57:53.576640", "OS-EXT-SRV-ATTR:kernel_id":"", "OS-EXT-SRV-ATTR:launch_index":0, "host_status":"UP", "OS-EXT-SRV-ATTR:reservation_id":"r-xmjj4pnm", "OS-EXT-SRV-ATTR:hostname":"ecs-1f30", "sys_tags":[ { "key":"_sys_enterprise_project_id", "value":"441d5677-b76a-4dd4-a97a-ef7fd633c095" } ], "security_groups":[ { "name":"default" } ] } ]} 汇总查询结果。 参考1持续调用,如果查询的云服务器列表为空,或者返回的body体中不存在servers_links 字段,表明所有云服务器查询完成。 汇总所有查询到的云服务器即当前查询条件下的所有云服务器。
  • 操作步骤 查询弹性云服务器详情 接口相关信息 URI格式: GET /v1/{project_id}/cloudservers/{server_id} 详情请参见“查询云服务器详情”。 请求示例 GET https://{endpoint}/v1/743b4c0428d945316666666666666666/cloudservers/893c7791-f1df-4c3d-8383-3caae9656c62 {endpoint}信息请从地区和终端节点获取。 响应示例 {"server": {"fault": null,"id": "b8b1b475-d6c9-4733-a3db-c3a526407286","name": "ecs-test","addresses": {"24bbb54c-659f-4141-8db9-a957e12b6ee8": [{"version": "4","addr": "192.168.0.16","OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:37:de:ee","OS-EXT-IPS:type": "fixed","OS-EXT-IPS:port_id": "390b39b0-9a77-4ec2-ae1e-3af358f78999"},{"version": "4","addr": "121.xx.xx.64","OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:37:de:ee","OS-EXT-IPS:type": "floating","OS-EXT-IPS:port_id": "390b39b0-9a77-4ec2-ae1e-3af358f78999"}]},"flavor": {"disk": "0","vcpus": "2","ram": "4096","id": "c6s.large.2","name": "c6s.large.2"},"accessIPv4": "","accessIPv6": "","status": "SHUTOFF","progress": null,"hostId": "604599c4eeeaa05d8865749e4c97979e14d74c6639a08460051b3a97","updated": "2021-02-18T12:38:39Z","created": "2021-02-18T12:37:42Z","metadata": {"metering.image_id": "6674d782-54ba-4f04-896d-95edd50f2eb9","metering.imagetype": "gold","metering.resourcespeccode": "c6s.large.2.linux","image_name": "CentOS 8.2 64bit","os_bit": "64","cascaded.instance_extrainfo": "stopped_release_resource:True,pcibridge:1","metering.resourcetype": "1","vpc_id": "24bbb54c-659f-4141-8db9-a957e12b6ee8","os_type": "Linux","charging_mode": "0","__support_agent_list": "ces"},"tags": [],"description": "","locked": false,"config_drive": "","tenant_id": "0b3ade290700f3612f29c005b9d16666","user_id": "0b3ade2a03800fec1f20c005d6116666","key_name": null,"os-extended-volumes:volumes_attached": [{"device": "/dev/vda","bootIndex": "0","id": "0dc13ef4-dcf6-49d2-8d34-395d94767917","delete_on_termination": "true"}],"OS-EXT-STS:task_state": null,"OS-EXT-STS:power_state": 4,"OS-EXT-STS:vm_state": "stopped","OS-EXT-SRV-ATTR:host": "604599c4eeeaa05d8865749e4c97979e14d74c6639a08460051b3a97","OS-EXT-SRV-ATTR:instance_name": "instance-003ef12a","OS-EXT-SRV-ATTR:hypervisor_hostname": "5edb1b44af14ebaaa784cfba010f78f113b1fd0865fef854c264a925","OS-DCF:diskConfig": "MANUAL","OS-EXT-AZ:availability_zone": "cn-east-3c","os:scheduler_hints": {},"OS-EXT-SRV-ATTR:root_device_name": "/dev/vda","OS-EXT-SRV-ATTR:ramdisk_id": "","enterprise_project_id": "0","OS-EXT-SRV-ATTR:user_data": null,"OS-SRV-USG:launched_at": "2021-02-18T12:37:57.000000","OS-EXT-SRV-ATTR:kernel_id": "","OS-EXT-SRV-ATTR:launch_index": 0,"host_status": "UP","OS-EXT-SRV-ATTR:reservation_id": "r-q8xjhqzk","OS-EXT-SRV-ATTR:hostname": "ecs-test","OS-SRV-USG:terminated_at": null,"sys_tags": [{"key": "_sys_enterprise_project_id","value": "0"}],"security_groups": [{"id": "d0d30ee2-5b34-44d4-b5a3-68b9d64e7286","name": "Sys-WebServer"}],"image": {"id": "6674d782-54ba-4f04-896d-95edd50f2eb9"},"hypervisor": null,"auto_terminate_time": ""}} 根据公网IP查询公网IP详情 接口相关信息 URI格式: GET /v1/{project_id}/publicips 详情请参见“查询弹性公网IP列表”。 请求示例 GET https://{endpoint}/v1/743b4c0428d945316666666666666666/publicips?public_ip_address=121.xx.xx.64 {endpoint}信息请从地区和终端节点获取。 public_ip_address参数传入的公网IP地址从1的返回信息中获取,从返回body体中的"server"下的"address"信息中找到"OS-EXT-IPS:type"为"floating"的"addr"字段,即为公网IP地址。 响应示例 {"publicips": [{"id": "92597d39-b81d-42b0-8d02-fe8afe7ef076","type": "5_bgp","port_id": "390b39b0-9a77-4ec2-ae1e-3af358f78999","public_ip_address": "121.xx.xx.64","private_ip_address": "192.168.0.16","status": "ACTIVE","tenant_id": "0b3ade290700f3612f29c005b9d16666","create_time": "2021-02-18 12:38:08","bandwidth_id": "3a087bbd-0bcf-4401-9e2b-6a96fa2e3471","bandwidth_name": "ecs-test-bandwidth-891e","bandwidth_share_type": "PER","bandwidth_size": 5,"profile": {},"enterprise_project_id": "0","ip_version": 4}]}
  • 响应示例 { "snapshot": { "createdAt": "2016-05-20T16:54:14.981520", "displayDescription": null, "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583", "displayName": "test", "size": 1, "status": "creating", "volumeId": "ba5730ea-8621-4ae8-b702-ff0ffc12c209" }}
  • 响应消息 响应参数 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 id String 卷快照ID,UUID格式 status String 卷快照的状态 displayName String 卷快照名称 displayDescription String 卷快照描述信息 createdAt String 卷快照创建时间 volumeId String 快照所属的卷ID,UUID格式。 size Integer 卷快照大小
  • 元数据管理 权限 对应的API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 查询云服务器元数据列表(OpenStack原生)(废弃) GET /v2.1/{project_id}/servers/{server_id}/metadata ecs:servers:listMetadata - √ × × × 获取云服务器指定Key的元数据(OpenStack原生)(废弃) GET /v2.1/{project_id}/servers/{server_id}/metadata/{key} ecs:servers:getMetadata ecs:servers:get √ × × × 删除云服务器指定元数据(OpenStack原生)(废弃) DELETE /v2.1/{project_id}/servers/{server_id}/metadata/{key} ecs:servers:setMetadata - √ × × × 修改云服务器指定Key的元数据(OpenStack原生)(废弃) PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key} ecs:servers:setMetadata - √ × × × 更新云服务器元数据(OpenStack原生)(废弃) POST /v2.1/{project_id}/servers/{server_id}/metadata ecs:servers:setMetadata - √ × × × 设置云服务器元数据(OpenStack原生)(废弃) PUT /v2.1/{project_id}/servers/{server_id}/metadata ecs:servers:setMetadata ecs:servers:get √ × × × 更新云服务器元数据 POST /v1/{project_id}/cloudservers/{server_id}/metadata ecs:cloudServers:updateMetadata - √ √ × × 删除云服务器指定元数据 DELETE /v1/{project_id}/cloudservers/{server_id}/metadata/{key} ecs:cloudServers:deleteMetadata - √ √ × × 父主题: 权限和授权项
  • 浮动IP管理 权限 对应的API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 创建浮动IP(OpenStack原生) POST /v2.1/{project_id}/os-floating-ips ecs:serverFloatingIps:use vpc:floatingIps:get vpc:floatingIps:create vpc:floatingIps:update vpc:ports:get √ × × × 查询浮动IP列表(OpenStack原生) GET /v2.1/{project_id}/os-floating-ips ecs:serverFloatingIps:use vpc:floatingIps:get vpc:ports:get √ × × × 查询浮动IP(OpenStack原生) GET /v2.1/{project_id}/os-floating-ips/{floating_ip_id} ecs:serverFloatingIps:use vpc:floatingIps:get vpc:ports:get √ × × × 删除浮动IP(OpenStack原生) DELETE /v2.1/{project_id}/os-floating-ips/{floating_ip_id} ecs:serverFloatingIps:use vpc:floatingIps:get vpc:floatingIps:delete vpc:floatingIps:update vpc:ports:get √ × × × 父主题: 权限和授权项
  • 数据结构(查询云服务器详情) 表1 address参数 参数 参数类型 描述 version String IP地址版本。 “4”:代表IPv4。 “6”:代表IPv6。 addr String IP地址。 primary Boolean 是否是主网卡。 true:主网卡。 false:辅助网卡。 OS-EXT-IPS:type String IP地址类型。 fixed:代表私有IP地址。 floating:代表浮动IP地址。 OS-EXT-IPS-MAC:mac_addr String MAC地址。 OS-EXT-IPS:port_id String IP地址对应的端口ID。 表2 flavor参数 参数 参数类型 描述 id String 云服务器规格ID。 name String 云服务器规格名称。 disk String 该云服务器规格对应要求系统盘大小,0为不限制。 此字段在本系统中无效。 vcpus String 该云服务器规格对应的CPU核数。 ram String 该云服务器规格对应的内存大小,单位为MB。 gpus Array of objects 该云服务器规格对应的GPU卡信息。 详细内容,请参见表8。 asic_accelerators Array of objects 该云服务器规格对应的ASIC加速卡信息。 详细内容,请参见表9。 表3 security_groups参数 参数 参数类型 描述 name String 安全组名称或者UUID。 id String 安全组ID。 表4 os-extended-volumes:volumes_attached 参数 参数 参数类型 描述 id String 磁盘ID,格式为UUID。 delete_on_termination String 删除云服务器时是否一并删除该磁盘。 true:是 false:否 微版本2.3及以上版本支持。 bootIndex String 云硬盘启动顺序。 0为系统盘。 非0为数据盘。 device String 云硬盘挂载盘符,即磁盘挂载点。 表5 metadata参数 参数 参数类型 描述 charging_mode String 云服务器的计费类型。 “0”:按需计费(即postPaid-后付费方式)。 “1”:按包年包月计费(即prePaid-预付费方式)。 "2":竞价实例计费 metering.order_id String 按“包年/包月”计费的云服务器对应的订单ID。 metering.product_id String 按“包年/包月”计费的云服务器对应的产品ID。 vpc_id String 云服务器所属的虚拟私有云ID。 EcmResStatus String 云服务器的冻结状态。 normal:云服务器正常状态(未被冻结)。 freeze:云服务器被冻结。 freeze字段格式为“freeze,冻结场景,资源释放状态”。 冻结场景包括: arrear:欠费冻结 police:公安冻结 illegal:违规冻结 verify:客户未实名认证冻结 资源释放状态包括: deletable:冻结可释放 not_delete:冻结不可释放 说明: 当云服务器被冻结或者解冻后,系统默认添加该字段,且该字段必选。 metering.image_id String 云服务器操作系统对应的镜像ID。 metering.imagetype String 镜像类型,目前支持: 公共镜像(gold) 私有镜像(private) 共享镜像(shared) metering.resourcespeccode String 云服务器对应的资源规格。 metering.resourcetype String 云服务器对应的资源类型。 取值为“1”,代表资源类型为云服务器。 cascaded.instance_extrainfo String 系统内部虚拟机扩展信息。 image_name String 云服务器操作系统对应的镜像名称。 agency_name String 委托的名称。 委托是由租户管理员在 统一身份认证 服务(Identity and Access Management,IAM)上创建的,可以为弹性云服务器提供访问云服务器的临时凭证。 os_bit String 操作系统位数,一般取值为“32”或者“64”。 os_type String 操作系统类型,取值为:Linux、Windows。 __support_agent_list String 云服务器是否支持主机安全服务、主机监控。 “hss”:主机安全服务 “ces”:主机监控 lockCheckEndpoint String 回调URL,用于检查云服务器的加锁是否有效。 如果有效,则云服务器保持锁定状态。 如果无效,解除锁定状态,删除失效的锁。 lockSource String 云服务器来自哪个服务。 订单加锁(ORDER) lockSourceId String 云服务器的加锁来自哪个ID。 lockSource为“ORDER”时,lockSourceId为订单ID。 lockScene String 云服务器的加锁类型。 按需转包年/包月(TO_PERIOD_LOCK) virtual_env_type String IOS镜像创建虚拟机,"virtual_env_type": "IsoImage" 属性; 非IOS镜像创建虚拟机,在19.5.0版本以后创建的虚拟机将不会添加virtual_env_type 属性,而在此之前的版本创建的虚拟机可能会返回"virtual_env_type": "FusionCompute"属性 。 说明: virtual_env_type属性不允许用户增加、删除和修改。 表6 sys_tags参数 参数 参数类型 描述 key String 系统标签的Key值 value String 系统标签的value值 表7 image参数 参数 参数类型 描述 id String 镜像id 您可以根据镜像ID查询更多镜像信息,详细内容,请参见查询镜像列表。 表8 gpus参数 参数 参数类型 描述 name String GPU卡名称。 count Integer GPU卡数量。 memory_mb Integer GPU卡显存大小,单位为MB。 表9 asic_accelerators参数 参数 参数类型 描述 name String ASIC加速卡名称。 count Integer ASIC加速卡数量。 memory_mb Integer ASIC加速卡内存大小,单位为MB。 父主题: 数据结构
  • 响应(任务类) 正常响应要素说明 名称 参数类型 说明 job_id String 提交任务成功后返回的任务ID,用户可以使用该ID对任务执行情况进行查询。如何根据job_id来查询Job的执行状态,请参考查询Job状态。 异常响应要素说明 名称 参数类型 说明 error Object 提交任务异常时返回的异常信息,详情请参见表1。 表1 error数据结构 名称 参数类型 说明 message String 任务异常错误信息描述。 code String 任务异常错误信息编码。 details Array of objects 任务异常时错误详情。 该信息主要包含任务异常时的细化错误编码和错误描述信息,便于使用本服务API的客户端应用代码处理错误。 该字段属于非必选字段。 表2 details数据结构 名称 参数类型 说明 message String 任务异常错误信息描述。 该字段属于非必选字段。 code String 任务异常错误信息编码。 该字段属于非必选字段。 响应示例 正常响应: { "job_id": "ff80808288d41e1b018990260955686a"} 异常响应: { "error": {"message": "", "code": XXX,""}} 包含错误详情的异常响应: { "error": { "message": "xxxx", "code": "xxxx", "details": [ { "code": "xxxx", "message": "xxxx" } ] }} 父主题: 提交任务类请求结果
  • 功能介绍 变更单台云服务器规格。 对于运行中的弹性云服务器,系统会自动关机,并将弹性云服务器中的数据拷贝到目标节点(目标节点可与源节点相同)后重新启动弹性云服务器。 底层资源不足时,该接口会自动回滚。 该接口不单独使用,需要轮询判断虚拟机状态,当虚拟机同时满足"status"为"VERIFY_RESIZE"、"OS-EXT-STS:task_state"为""、"OS-EXT-STS:vm_state"为"RESIZED"时,配合“确认变更云服务器规格(POST /v2.1/{project_id}/servers/{server_id}/action)”或“回退变更云服务器规格(POST /v2.1/{project_id}/servers/{server_id}/action)”两个接口一起使用。 当前API已废弃,请使用变更云服务器规格(按需)。
  • 响应示例 { "availability_zones": [ { "availability_zone_id": "br-iaas-test1a", "type": "Edge", "mode": "dedicated", "alias": "IES_test", "public_border_group": "br-iaas-test1a", "az_group_ids": [ "br-iaas-test1a" ], "category": 21 } ] }
  • 请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 security_group 是 Object security_group对象,在消息体中指定,请参见表3。 表3 请求参数security_group的对象 参数 是否必选 参数类型 描述 name 否 String 安全组名称,长度0-255。 description 否 String 安全组描述,长度0-255。
  • 响应消息 响应参数如表4所示。 表4 响应参数 参数 参数类型 描述 security_group Object security_group对象,参见表5。 表5 响应参数security_group的对象 参数 参数类型 描述 description String 安全组描述信息 id String 安全组ID,UUID格式 name String 安全组名字 rules Array of objects 安全组规则列表,当前该列表为空列表 tenant_id String 租户ID或项目ID
  • 响应示例 { "security_group": { "rules": [], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "description": "desc-sg", "id": "81f1d23b-b1e2-42cd-bdee-359b4a065a42", "name": "test-sg" }}
  • 响应消息 响应参数请参见表2。 表2 响应参数 参数 参数类型 描述 id String 镜像ID,UUID格式。 links Array of objects 镜像相关快捷链接地址 name String 镜像名称 metadata Object metadata键值对 OS-EXT-IMG-SIZE:size Integer 镜像大小。大于0。 minDisk Integer 镜像要求的最小磁盘大小。大于0。 minRam Integer 镜像要求的最小内存大小。大于0。 progress Integer 镜像上传百分比。大于0。 status String 镜像状态 created String 镜像创建时间。ISO8601时间格式,例如:2013-06-09T06:42:18Z updated String 镜像更新时间。ISO8601时间格式,例如:2013-06-09T06:42:18Z 表3 links参数信息 参数 是否必选 参数类型 描述 href 是 String 相应资源的链接。 rel 是 String 有三种取值。self:自助链接包含版本链接的资源。立即链接后使用这些链接。bookmark:书签链接提供了一个永久资源的永久链接,该链接适合于长期存储。alternate:备用链接可以包含资源的替换表示形式。例如,OpenStack计算映像可能在OpenStack映像服务中有一个替代表示。 type 否 String type属性提供了一个提示,用于在跟踪该链接时期望的表示类型。
共99315条