云服务器内容精选

  • 请求消息 请求参数如表2 请求参数所示。 表2 请求参数 参数 参数类型 是否必选 描述 new_password String 是 新密码。 当dry_run字段为true时,该字段为非必填字段,否则为必填字段。 新密码的校验规则: 长度为8-26位。 密码至少必须包含大写字母(A-Z)、小写字母(a-z)、数字(0-9)和特殊字符(!@%-_=+[]:./?)中的三种。 密码不能包含用户名或用户名的逆序。 Windows系统密码不能包含用户名或用户名的逆序,不能包含用户名中超过两个连续字符的部分。 dry_run Boolean 否 是否只预检此次请求。取值为true或false,默认值为false。 true:发送检查请求,不会重置密码。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回响应结果。 false:发送正常请求,通过检查后并且进行重置密码请求。 servers Array of objects 是 待批量重置密码的云主机ID信息,详情参见表3 servers字段数据结构说明。 表3 表4 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云主机ID。
  • 接口约束 使用此API,需预先安装重置密码插件。 L实例提供的系统镜像、应用镜像默认已安装重置密码插件。 如果私有镜像的镜像源来自其他云平台的服务器或从第三放下载,此类私有镜像可能因为未安装一键式密码重置插件而无法重置密码。请根据安装一键式密码重置插件(遗忘私有镜像初始密码)或安装一键式密码重置插件(已知私有镜像初始密码)安装插件。 云主机的重置密码请求下发后,脚本执行失败,该API不会报错。 云主机开机或重启后,新密码生效。 该接口支持虚拟机状态为开机或者关机状态下执行。
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):私有访问密钥。与访问密钥ID结合使用,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": $ADMIN_PASS, //IAM用户密码,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。
  • URI GET /v1/{project_id}/cloudservers/detail?flavor={flavor}&name={name}&status={status}&limit={limit}&offset={offset}¬-tags={not-tags}&reservation_id={reservation_id}&enterprise_project_id={enterprise_project_id}&tags={tags}&ip={ip} 参数说明请参见表1。 表1 路径参数 参数 是否必选 描述 project_id 是 项目ID。 获取方法请参见获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 offset 否 Integer 页码。 当前页面数,默认值为1,取值范围大于等于0。 当取值为0时,系统默认返回第1页,与取值为1时相同。 建议设置该参数大于等于1。 flavor 否 String 云主机规格ID。 name 否 String 名称,匹配规则为模糊匹配。 支持特殊字符,例如,"." 匹配除换行符(\n、\r)之外的任何单个字符,相等于 [^\n\r]。 status 否 String 云主机状态。 取值范围: ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED、SHELVED、SHELVED_OFFLOADED 、UNKNOWN 状态说明请参考云服务器状态。 说明: 当处于中间状态时,查询范围如下: ACTIVE,查询范围:ACTIVE,REBOOT,HARD_REBOOT,REBUILD,MIGRATING、RESIZE SHUTOFF,查询范围:SHUTOFF,RESIZE,REBUILD ERROR,查询范围:ERROR,REBUILD VERIFY_RESIZE,查询范围:VERIFY_RESIZE,REVERT_RESIZE limit 否 Integer 查询返回列表当前页面的数量。 每页默认值是25,最多返回1000台的信息,如果数据量过大建议设置成100。 tags 否 String 查询tag字段中包含该值的。 not-tags 否 String 查询tag字段中不包含该值的。 示例:查询的列表中不包含裸金属服务器,该字段设置如下:not-tags=__type_baremetal reservation_id 否 String 使用Openstack Nova 接口批量创建时,会返回该ID,用于查询本次批量创建的。 enterprise_project_id 否 String 查询绑定某个企业项目的。 若需要查询当前用户所有企业项目绑定的,请传参all_granted_eps。 说明: 查询的企业项目需具备ecs:cloudServers:list的权限。 如果用户只有某个企业项目的权限,则需要传递该参数,查询指定企业项目绑定的,否则会因权限不足而报错。 当前all_granted_eps支持查询的企业项目个数不超过100。 ip 否 String IPv4地址过滤结果,匹配规则为模糊匹配。 此处IP为的私有IP。 ip_eq 否 String IPv4地址过滤结果,匹配规则为精确匹配。 此处IP为云主机的私有IP。 server_id 否 String 云主机ID,格式为UUID,匹配规则为精确匹配 示例:server_id={id1}&server_id={id2} 说明: 在使用server_id作为过滤条件时,不能同时使用其他过滤条件。如果同时指定server_id及其他过滤条件,则以server_id条件为准,其他过滤条件会被忽略 当server_id中含有不存在的云主机ID时,返回的响应参数中该云主机ID对应的servers结构体中除了id和fault其它字段均为null 为了避免API的URI过长,建议一次查询的server_id个数不超过100个
  • 概述 欢迎使用云耀云服务器(Hyper Elastic Cloud Server,HECS)。云耀云服务器是新一代开箱即用、面向中小企业和开发者打造的全新轻量级应用云服务器。提供快速应用部署和简易的管理能力,适用于网站搭建、开发测试环境、企业应用、网站分析、音视频服务等低负载应用场景。具有易搭建、更实惠、易维护、更安全的特点。 云耀云服务器L实例是云耀云服务器的一款云服务器产品类型。云耀云服务器L实例提供丰富严选的应用镜像,实现应用一键部署,助力客户便捷高效的在云端构建电商网站、Web应用、小程序、学习环境、各类开发测试等。 本文档提供了云耀云服务器L实例API的描述、语法、参数说明及示例等内容。支持的全部操作请参见API概览。 在调用L实例API之前,请确保已经充分了解L实例相关概念,详细信息请参见L实例的产品介绍。
  • 请求消息 表2 表2 请求参数 参数 是否必选 参数类型 描述 reboot 是 Object 标记为重启云主机操作,详情请参见表3。 表3 表3 reboot字段数据结构说明 参数 是否必选 参数类型 描述 type 是 String 重启类型: SOFT:普通重启。 HARD:强制重启。 servers 是 Array of objects 云主机ID列表,详情请参见表4。 表4 表4 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云主机ID。
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,$ADMIN_PASS表示用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从地区和终端节点获取。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "$ADMIN_PASS", //建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型(格式)。推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求,或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求消息 表2 表2 请求参数 参数 是否必选 参数类型 描述 os-start 是 Object 标记为启动云主机操作,详情请参见表3。 表3 表3 os-start字段数据结构说明 参数 是否必选 参数类型 描述 servers 是 Array of objects 云主机ID列表,详情请参见表4。 表4 表4 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云主机ID。
  • 请求消息 表2 表2 请求参数 参数 是否必选 参数类型 描述 os-stop 是 Object 标记为关闭云主机操作,详情请参见表3。 表3 表3 os-stop字段数据结构说明 参数 是否必选 参数类型 描述 servers 是 Array of objects 云主机ID列表,详情请参见表4。 type 否 String 关机类型,默认为SOFT: SOFT:普通关机(默认)。 HARD:强制关机。 表4 表4 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云主机ID。
  • API概览 L实例是包含了云主机、弹性公网IP、云硬盘、云备份、主机安全、云耀负载均衡的服务组合,云主机是L实例中的服务器。 本文提供了部分L实例云主机的API接口供您操作。在使用API前,请先了解如何调用API以便顺利使用API。 表1 接口说明 接口 说明 查询云主机详情 查询云主机的详细信息,包括云主机的运行状态、云主机名称、公网IP等。 批量启动云主机 根据指定的云主机ID列表,批量开机云主机。 批量重启云主机 根据指定的云主机ID列表,批量重启云主机。 批量关闭云主机 根据指定的云主机ID列表,批量关机云主机。 批量重置云主机密码 批量重置云主机管理账号(root用户或Administrator用户)的密码。 修改云主机信息 修改云主机信息,目前支持修改云主机名称及描述和hostname。
  • HECS控制台集成的服务 HECS控制台提供了主机安全、云备份、云监控、云耀负载均衡服务,不同HECS控制台提供的服务不同。 增值服务 说明 主机安全(HSS) 主机安全(HSS)提升HECS整体安全性,通过入侵检测、漏洞管理、基线检查功能,可识别并管理云服务器中的信息资产,实时监测云服务器中的风险,降低服务器被入侵的风险。更多信息详见主机安全。 云备份(CBR) 云备份可以为云服务器、云硬盘提供简单易用的备份服务,当发生病毒入侵、人为误删除、软硬件故障等事件时,可将数据恢复到任意备份点。 更多信息详见云备份。 云监控(CES) 云监控服务为您提供一个针对云服务器、带宽等资源的立体化监控平台。使您全面了解云上的资源使用情况、业务的运行状况,并及时收到异常告警做出反应,保证业务顺畅运行。更多信息详见云监控。 云耀负载均衡 云耀负载均衡是将公网访问流量根据转发规则分发到多台云耀云服务器的流量分发控制服务,可以通过流量分发扩展应用系统对外的服务能力。同时结合健康检查功能,流量只分发到后端正常工作的服务器来消除单点故障,进而提升应用系统的可靠性。 说明: 云耀负载均衡仅和L实例配套使用,不支持和其他HECS类型配套使用。