华为云用户手册

2020年12月 序号 功能名称 功能描述 阶段 相关文档 1 接口更新 线上服务请求URI由v1.0接口统一切换成v2接口，例如 通用文字识别 URI由/v1.0/ocr/general-text更新成/v2/{project_id}/ocr/general-text。 原有的v1.0接口任然可以正常使用。 商用 - 2 飞机行程单识别功能优化 飞机行程单识别服务精度优化，支持不同场景下图片的识别。 商用 -

2020年3月 序号 功能名称 功能描述 阶段 相关文档 1 行驶证识别 功能优化 行驶证识别服务支持新能源车牌号码识别。 商用 - 2 通用 表格识别 功能优化 通用表格识别服务精度优化，新增入参 return_text_location，支持文本和单元格的坐标返回。 商用 - 3 网络图片识别功能优化 网络图片识别服务性能提升1倍。 商用 - 4 价格更新 OCR线上服务降价50%。 商用 - 5 移动端界面适配 华为云移动端控制台界面适配，支持移动端便捷购买套餐包。 商用 -

自定义策略样例 如下以定制一个 IAM 用户禁止创建及删除微服务引擎的策略为例。 { "Version": "1.1", "Statement": [ { "Action": [ "cse:*:*" ], "Effect": "Allow" }, { "Action": [ "cse:engine:create", "cse:engine:delete" ], "Effect": "Deny" } ] } 拒绝策略需要同时配合其他策略使用，否则没有实际作用。用户被授予的策略中，一个授权项的作用如果同时存在Allow和Deny，则遵循Deny优先原则。 权限授予成功后，用户可以通过控制台以及REST API等多种方式验证。 此处以上述自定义策略为例，介绍用户如何通过登录ServiceStage控制台验证自定义禁止创建微服务引擎的权限： 使用新创建的用户登录华为云，登录方法选择为“IAM用户”。 租户名为该IAM用户所属华为云账号的名称。 IAM用户名和IAM用户密码为以租户名在IAM创建用户时输入的用户名和密码。 在“微服务引擎”页面，创建微服务引擎，返回403错误，表示权限配置正确并已生效。

亲和性概念阐述 在应用没有容器化之前，原先一个虚拟机上会装多个组件，进程间会有通信。 但在做容器化拆分的时候，通常直接按进程拆分容器。比如业务进程一个容器，监控日志处理或者本地数据放在另一个容器，并且有独立的生命周期。这时如果进程分布在网络中两个较远的点，请求经过多次转发，性能会很差。 亲和性可以实现就近部署，增强网络能力实现通信上的就近路由，减少网络的损耗。 反亲和性主要是出于高可靠性考虑，尽量分散实例，某个节点故障的时候，对应用的影响只是N分之一或者只是一个实例。 应用与可用区的亲和性 亲和：决定应用组件部署在特定的可用区中。 反亲和：决定应用组件不能部署在特定的可用区中。 应用与节点间的亲和性 亲和：决定应用组件部署在某些特定的主机中。 反亲和：决定应用组件不能部署在某些特定的主机中。 应用间的亲和性 决定应用组件部署在相同或不同节点中。 亲和：用户可根据业务需求进行应用组件的就近部署，应用组件间通信就近路由，减少网络消耗。如图1所示，APP1、APP2、APP3和APP4部署在相同节点上，为亲和性部署。 图1 应用间亲和 反亲和：同个应用组件的多个实例反亲和部署，减少宕机影响；互相干扰的应用反亲和部署，避免干扰。 如图2所示，APP1、APP2、APP3和APP4分别部署在不同节点上，这四个应用为反亲和性部署。 图2 应用间反亲和

前提条件 已经创建集群，请参考购买集群操作。 构建任务会在CCE集群节点上启动一个构建容器，执行构建相关的操作。为了确保构建的安全性，建议您对CCE集群节点进行安全加固，请参考禁止容器获取宿主机元数据进行操作。 构建任务依赖预置在构建容器中的JDK、Golang、Maven、Gradle、Ant或Node.js编译工具。 支持同一个账号下的不同IAM用户操作同一个构建集群。如需对特定IAM用户取消构建权限，请参考创建ServiceStage自定义策略为该用户设置自定义策略，将“servicestage:assembling:create”、“servicestage:assembling:modify”和“servicestage:assembling:delete”权限设置为拒绝策略。 已为构建节点绑定弹性公网IP，请参考绑定弹性公网IP。

前提条件 已经创建集群，请参考购买集群操作。 构建任务会在CCE集群节点上启动一个构建容器，执行构建相关的操作。为了确保构建的安全性，建议您对CCE集群节点进行安全加固，请参考禁止容器获取宿主机元数据进行操作。 构建任务依赖预置在构建容器中的JDK、Golang、Maven、Gradle、Ant或Node.js编译工具。 支持同一个账号下的不同IAM用户操作同一个构建集群。如需对特定IAM用户取消构建权限，请参考创建ServiceStage自定义策略为该用户设置自定义策略，将“servicestage:assembling:create”、“servicestage:assembling:modify”和“servicestage:assembling:delete”权限设置为拒绝策略。 已为构建节点绑定弹性公网IP，请参考绑定弹性公网IP。

创建密钥 登录ServiceStage控制台。 在“环境管理”页面，单击待操作环境名称。 在“资源配置”下左侧列表，选择“计算”资源类型下的资源名称“云容器引擎 CCE”。 选择“密钥”页签，单击“创建密钥”。 ServiceStage支持“可视化”和“YAML”两种方式来创建密钥。 方式一：可视化。参照表1设置参数，其中带“*”标志的参数为必填参数。 表1 可视化方式创建密钥参数设置说明 参数 参数说明 *密钥名称 新建密钥的名称，同一个命名空间内命名必须唯一。 *所属集群 使用新建密钥的集群。 单击“创建集群”，可以新建集群。 *命名空间 新建密钥所在的命名空间，默认为default。 描述 密钥的描述信息。 *密钥类型 根据业务需要选择新建的密钥类型。 Opaque：一般密钥类型。当密钥配置文件中未作显式设定时，默认的密钥类型是Opaque。 kubernetes.io/dockerconfigjson：存放拉取私有仓库镜像所需的认证信息。 IngressTLS：存放7层负载均衡服务所需的证书。 其他：若需要创建其他类型的密钥，请手动输入密钥类型。 *镜像仓库地址 当“密钥类型”选择kubernetes.io/dockerconfigjson时有效。输入镜像仓库的地址。 *密钥数据 应用密钥的文件data字段值。 当密钥为Opaque类型时，输入键、值。其中“值”必须使用Base64进行编码，Base64编码方法请参考Base64编码。 单击“添加更多配置数据”，可以增加密钥数据。 当密钥为kubernetes.io/dockerconfigjson类型时，输入“用户名”和“密码”。 当密钥为IngressTLS类型时，上传“证书文件”和“私钥文件”。 当密钥为其他类型时，输入对应的“键”、“值”。 密钥标签 标签以Key/value键值对的形式附加到各种对象上（如应用、节点、服务等）。 标签定义了这些对象的可识别属性，用来对它们进行管理和选择。 单击“添加标签” 。 输入键、值。 图1 可视化方式设置密钥参数 方式二：YAML。 若需要通过上传文件的方式创建密钥，请确保密钥描述文件已创建。ServiceStage支持YAML格式，详情请参考Secret资源文件配置说明。 在“所属集群”下拉框中，选择相应的集群。 （可选）单击“上传文件”，选择已创建的Secret类型资源文件后，单击“打开”，等待文件上传完成。 在“编排内容”中写作或者修改上传的Secret资源文件。 图2 YAML方式设置密钥参数 单击“创建密钥”。 密钥列表中会出现新创建的密钥。

Secret资源文件配置说明 本内容主要介绍Secret类型的资源描述文件的配置示例。例如现在有一个应用需要获取账号密码，可以通过Secret来实现： username: my-username password: my-password 定义的Secret文件内容如下。其中值需要用Base64进行编码，Base64编码方法请参考Base64编码。 apiVersion: v1 kind: Secret metadata: name: mysecret # secret的名称 namespace: default #命名空间，默认为default data: username: ****** #username的值需要用Base64编码 password: ****** #password的值需要用Base64编码 type: Opaque # type建议不要做修改

后续操作 密钥创建完成后，您可参考表2查找、查看、更新和删除密钥。 删除操作无法恢复，请谨慎操作。 密钥列表中包含系统密钥资源，系统密钥资源不可更新，也不能删除，只能查看。 表2 密钥管理操作说明 操作项 操作说明 查找密钥 在命名空间下拉列表选择密钥所在命名空间。 在搜索框输入密钥名称。 查看密钥 单击目标密钥“操作”列的“查看YAML”，查看配置项YAML格式文件内容。 更新密钥 单击目标密钥“操作”列的“更新”。 根据表1更改信息。 单击“更新密钥”。 删除单个密钥 单击目标密钥“操作”列的“删除”。 在弹出的对话框，单击“确定”。 批量删除密钥 勾选需要删除的密钥。 单击“删除密钥”。 在弹出的对话框，单击“确定”。

添加访问方式 单击“应用管理”。 单击创建应用时创建的应用名称（例如：weathermap），进入“应用概览”页。 在“组件列表”，单击weathermapweb所在行“外部访问地址”列的“设置”，进入“访问方式”页面。 单击“TCP/UDP路由配置”区域的“添加服务”，参考下表设置参数。 参数 说明 服务名称 保持默认。 访问方式 选择“公网访问”。 访问类型 选择“弹性IP”。 服务亲和 保持默认。 协议 选择TCP。 容器端口 填写3000。 访问端口 选择“自动生成”。 图5 添加访问方式 单击“确定”，生成访问地址。 图6 访问地址

用户故事 在本实践中，您可以通过容器部署的方式部署应用并将微服务实例注册到 微服务引擎CSE 中，weathermap应用需要创建以下组件： 前台组件：weathermapweb，基于Node.js语言开发的界面。 后台组件：weather、fusionweather、forecast、edge-service，基于Java语言开发。 微服务部署有以下几个操作过程： 创建并部署后台应用组件 设置edge-service组件访问方式 创建并部署前台组件 确认部署结果 添加访问方式 访问应用

设置edge-service组件访问方式 单击左上角，返回“应用管理”页面。 单击创建应用时创建的应用名称（例如：weathermap），进入“应用概览”页。 在“组件列表”，单击edge-service所在行“外部访问地址”列的“设置”，进入“访问方式”页面。 单击“TCP/UDP路由配置”区域的“添加服务”，参考下表设置参数。 参数 说明 服务名称 保持默认。 访问方式 选择“公网访问”。 访问类型 选择“弹性IP”。 服务亲和 保持默认。 协议 选择TCP。 容器端口 填写3010。 访问端口 选择“自动生成”。 图3 设置edge-service组件访问方式 单击“确定”，生成访问地址。

配置构建触发器 配置Jenkins构建触发器。 勾选“Build when a change is pushed to GitLab”，保存GitLab webhook URL（配置Gitlab webhook时需使用），然后单击右下角“高级”。 选择“Filter branches by regex ”，配置指定分支变更后触发构建任务，示例中的分支名称为main，单击右下角“Generate”生成Secret token并保存，在配置Gitlab webhook时需使用。 配置Gitlab webhook。 登录Gitlab，进入代码仓库，示例中的仓库名称是“test”，选择settings中的“Webhooks”，URL和Secret token填写1获取到的GitLab webhook URL和Secret token。 取消勾选SSL verification的“Enable SSL verification”，单击“Add webhook”。

配置流水线脚本 流水线脚本是构建时运行的构建命令，脚本参数说明见表1。 表1 表1 流水线脚本参数说明 参数 是否必须 参数类型 描述 git_url 是 String Gitlab代码仓库地址。 credentials_id 是 String 使用账号密码配置的Gitlab凭据id，请参考创建Gitlab凭证。 branch_name 是 String Gitlab代码仓库分支名称。 maven 是 String maven安装的可执行文件路径，例如：/root/app/maven/apache-maven-3.8.6/bin/mvn。 upgrade_shell 是 String upgrade.sh脚本在Jenkins所在虚拟机上存放的路径，例如：/root/jar/upgrade.sh。内容请参见upgrade.sh脚本说明。 完成“构建触发器”配置之后，在“流水线”页签，在下拉框选择“Pipeline script”。 配置流水线脚本，示例中使用的是构建jar包场景，脚本如下： 请使用您环境下的实际参数替换脚本中的参数变量。 node { // 定义代码仓库地址，例如：http://10.95.156.58:8090/zmg/test.git def git_url = '{代码仓库地址}' // Gitlab凭据id def credentials_id = '{Gitlab凭据id}' // git代码仓库分支名称，例如：main def branch_name = '{git代码仓库分支名称}' // maven安装的可执行文件路径，例如 :/root/app/maven/apache-maven-3.8.6/bin/mvn def maven = '{maven安装的可执行文件路径}' // upgrade.sh脚本存放路径，例如：/root/jar/upgrade.sh def upgrade_shell = '{upgrade.sh脚本存放路径}' stage('Clone sources') { git branch: branch_name, credentialsId: credentials_id, url: git_url } stage('Build') { // 构建jar包 sh "'$maven' clean package -Dmaven.test.failure.ignore=true -Dmaven.wagon.http.ssl.insecure=true -Dmaven.wagon.http.ssl.allowall=true" } stage('upgrade') { // 执行脚本，使用构建上传到obs的jar包升级ServiceStage组件，超时时间5分钟 sh "timeout 300s '$upgrade_shell'" } } 流水线脚本运行时会调用upgrade.sh，该脚本详细说明请参见upgrade.sh脚本说明。 设置脚本文件upgrade.sh为可执行文件。

生成Gitlab访问令牌 登录Gitlab。 鼠标移动到右上角的账号名上，单击“Edit profile”。 单击“Access Tokens”，输入“Token name”，勾选“api”，单击“Create personal access token”创建访问令牌。 完成后在页面上方的“Personal Access Tokens”右侧显示token令牌。 令牌仅在初次生成时显示，否则下次需要重新创建。该令牌仅用于Gitlab对接测试。

用户故事 在本实践中，您可以通过容器部署的方式部署应用并将微服务实例注册到微服务引擎 CS E中，weathermap应用需要创建并部署以下组件： 前台组件：weathermapweb，基于Node.js语言开发的界面。 后台组件：weather、fusionweather、forecast、edge-service，基于Java语言开发。 微服务部署有以下几个操作过程： 创建并部署后台应用组件 设置edge-service组件访问方式 创建并部署前台组件 确认部署结果 添加访问方式 访问应用

设置edge-service组件访问方式 单击左上角，返回“应用管理”页面。 单击创建应用时创建的应用名称（例如：weathermap），进入“应用概览”页。 在“组件列表”，单击edge-service所在行“外部访问地址”列的“设置”，进入“访问方式”页面。 单击“TCP/UDP路由配置”区域的“添加服务”，参考下表设置参数。 参数 说明 服务名称 保持默认。 访问方式 选择“公网访问”。 访问类型 选择“弹性IP”。 服务亲和 保持默认。 协议 选择TCP。 容器端口 填写3010。 访问端口 选择“自动生成”。 图2 设置edge-service组件访问方式 单击“确定”，生成访问地址。

添加访问方式 单击“应用管理”。 单击创建应用时创建的应用名称（例如：weathermap），进入“应用概览”页。 在“组件列表”，单击weathermapweb所在行“外部访问地址”列的“设置”，进入“访问方式”页面。 单击“TCP/UDP路由配置”区域的“添加服务”，参考下表设置参数。 参数 说明 服务名称 保持默认。 访问方式 选择“公网访问”。 访问类型 选择“弹性IP”。 服务亲和 保持默认。 协议 选择TCP。 容器端口 填写3000。 访问端口 选择“自动生成”。 图5 添加访问方式 单击“确定”，生成访问地址。 图6 访问地址

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则Content-type中需声明字符编码方式为utf-8，例如，Content-Type: application/json;utf-8。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中： username为登录用户名。 ********为用户登录密码。 domainname为用户所属的账号名称。 xxxxxxxxxxxxxxxxxx为project的名称，即从地区和终端节点处获取到的“区域”名称。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } scope参数定义了Token的作用范围，取值为project或domain。上面示例中取值为project，表示获取的Token仅能访问指定project下的资源。取值为domain时，表示获取的token可以访问指定账号下所有资源。scope参数的详细说明，请参考获取用户Token。 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl命令行、postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID：子项目ID，可选，在多项目场景中使用。 X-Domain-ID：帐号ID。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求方法 HTTP方法，它告诉服务您正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点处获取。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.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-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

概述 云应用模型（Cloud Application Model）是一个面向终态的应用交付自动化服务，包含应用模型与执行引擎两部分。 开发者通过应用模型描述应用交付三个阶段的内容： 资源编排 、应用发布、应用运维；执行引擎解析模板、编排并执行任务，实现应用交付自动化。 本示例通过使用CAM内置系统模板“简易应用模板(ECS)”，自动创建ECS实例，并绑定EIP，快速完成Ngnix搭建，供您体验CAM部署功能。 目前仅“华南-广州”区域支持该功能。

身份认证 用户访问ServiceStage的方式有两种，包括ServiceStage控制台、API。其本质都是通过ServiceStage提供的REST风格的API接口进行请求。调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权: Token认证：通过Token认证调用请求。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证获得操作API的权限。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。请求认证总是需要包含一个签名值，该签名值以请求者的AK/SK作为加密因子，结合请求体携带的特定信息计算而成。通过AK/SK认证方式进行认证鉴权，即使用AK/SK加密的方法来验证某个请求发送者身份。关于访问密钥的详细介绍及获取方式，请参见访问密钥。

微服务引擎实例规格说明 微服务引擎分为微服务引擎专业版和微服务引擎专享版两种产品规格： 微服务引擎专业版：专业版引擎Cloud Service Engine是ServiceStage提供的 免费体验 引擎。专业版引擎可以体验ServiceStage的所有产品能力，比如服务治理、配置管理等。引擎资源为所有租户共享，性能可能会受其他租户影响；专业版引擎不支持升级到专享版。 微服务引擎专享版：专享版引擎，是可支持大规模微服务应用管理的商用引擎。您可根据业务需要选择不同规格，不支持规格变更；专享版引擎资源独享，性能不受其他租户影响。 引擎支持的最大实例规格说明如下。 表2 微服务引擎实例规格说明 引擎类型 微服务实例数配额 配置条目数配额 微服务引擎专业版 20 - 微服务引擎专享版 100 600 200 600 500 3,000 2,000 12,000

产品套餐说明 ServiceStage提供了基础版、专业版、铂金版，您可以根据需要选择，各个版本的功能说明如表1所示。 表1 功能说明 功能 基础版 专业版 铂金版 管理规模 单个IAM账号下最大支持应用组件实例个数 100个 5000个 5000个 单个组件支持的最大实例个数 200个 微服务 套餐包赠送微服务引擎 - 专享版（高可用）最多5个 专享版（高可用）最多10个 Java语言微服务开发SDK 支持 支持 支持 Spring Cloud微服务接入 服务注册中心 服务配置中心 实时仪表盘 负载均衡 服务限流 服务降级 服务容错 服务熔断 错误注入 黑白名单 灰度发布 应用生命周期管理 多语言应用管理（Java/Php/Python/Node.js/Tomcat/Docker） 支持 支持 支持 应用生命周期管理（灰度发布、伸缩、升级、回退、启动、停止、重启、删除） 应用基础监控（运行状态、CPU、内存、磁盘使用率等） 虚机部署 云容器引擎部署 访问权限控制 应用域名管理 弹性伸缩 事件分析 日志分析 阈值告警 持续交付 构建管理 支持 支持 支持 源码仓库（GitHub/GitLab/Gitee/Bitbucket/CodeArts） 编译任务（Java/Php/Python/Node.js/Tomcat/Docker） 构建集群 流水线管理 软件仓库 SWR软件包管理 支持 支持 支持 Docker镜像包管理 仓库权限管理 容器资源 虚拟机集群 支持 支持 支持 裸金属集群 Windows集群 容器节点管理 容器存储管理

原因分析 在ServiceStage中，应用是指一个功能相对完备的业务系统，由一个或多个特性相关的组件组成，以应用维度组织多个组件。 在微服务中，可以将应用理解为完成某项完整业务场景的软件系统。应用一般由多个微服务组成，应用里面的微服务能够相互发现和调用。 在Spring Cloud微服务架构开发的项目中，应用名称通常在项目下各组件的“bootstrap.yaml”配置文件中定义。 在Java Chassis微服务架构开发的项目中，应用名称通常在项目下各组件的“microservice.yaml”配置文件中定义。 配置文件一般都存放于您当前项目各组件目录下的“/src/main/resources/”路径下。 ServiceStage应用下的各组件实例接入微服务引擎后，其微服务实例“所属应用”名称就是各组件下的配置文件中所定义的应用名称。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 父主题： 使用前必读

文档修订记录 发布日期 修改说明 2023-12-01 第二十五次正式发布。 本次变更说明如下： 新增： 批量更新带宽 更新弹性公网IP 查看租户带宽限制 2023-07-06 第二十四次正式发布。 本次变更说明如下： 新增： 共享带宽加入弹性公网IP 共享带宽批量加入弹性公网IP 共享带宽移出弹性公网IP 共享带宽批量移出弹性公网IP 弹性公网IP开启NAT64 弹性公网IP关闭NAT64 带宽 2023-06-16 第二十三次正式发布。 本次变更说明如下： 增加API接口请求示例说明。 2023-05-31 第二十二次正式发布。 本次变更说明如下： 在错误码章节，VPC.0501添加说明。 2023-05-18 第二十一次正式发布。 本次变更说明如下： 在申请EIP(按需计费)章节，修改EIP类型。 2023-03-09 第二十次正式发布。 本次变更说明如下： 在查询EIP列表、查询带宽列表章节，修改limit参数描述。 2022-12-16 第十九次正式发布。 本次变更说明如下： 新增： 查询Job状态接口 按需转包年/包月EIP 按需转包年/包月带宽 2022-11-24 第十八次正式发布。 本次变更说明如下： 新增： 批量操作弹性公网IP 带宽加油包 弹性公网IP辅助接口 查询弹性公网IP可用数 查询公网IP池列表 查询公网IP池详情 2022-11-18 第十七次正式发布。 本次变更说明如下： 新增： 弹性公网IP 共享带宽类型 公共池 2022-03-30 第十六次正式发布。 本次变更说明如下： 在以下章节，增加批量操作弹性公网IP的说明。 共享带宽插入EIP 共享带宽移除EIP 2021-11-10 第十五次正式发布。 本次变更说明如下： 在以下章节，新增弹性公网IP名称参数“alias”。 申请EIP(按需计费) 查询EIP 查询EIP列表 更新EIP 申请EIP(包年/包月) 2021-10-30 第十四次正式发布。 本次更新说明如下： 在查询EIP列表、查询EIP章节，新增响应参数“allow_share_bandwidth_types”。 在创建共享带宽章节，新增请求参数“bandwidth_type”。 2021-07-09 第十三次正式发布。 本次更新说明如下： 全文优化“marker”和“limit”参数。 全文增加“ API Explorer ”的链接。 2020-11-11 第十二次正式发布。 本次更新说明如下： 调整文档结构，删除“历史API”章节。 在更新浮动IP章节，修改接口约束说明。 2020-10-15 第十一次正式发布。 本次更新说明如下： 在查询EIP章节，新增port_id、public_ip_address、private_ip_address、id参数。 2020-08-26 第十次正式发布。 本次更新说明如下： 在申请EIP(包年/包月)章节，修改is_auto_renew、is_auto_pay参数类型并增加“publicip_id”参数。 在创建共享带宽章节，删除接口区域限制说明并在charge_mode参数中删除按流量计费。 在共享带宽插入EIP章节，删除enable_bandwidth_rules、rule_quota、bandwidth_rules字段并删除bandwidth_rules对象表格。 在共享带宽移除EIP章节，增加publicip_type参数。 在更新包周期带宽章节，修改is_auto_pay参数类型并增加publicip_id参数。 新增应用示例章节。 2020-08-06 第九次正式发布。 本次更新说明如下： 调整文档结构，新增历史API章节。 2020-07-08 第八次正式发布。 本次更新说明如下： 在带宽、带宽（V2.0）章节，增加“enable_bandwidth_rules”、“rule_quota”、“bandwidth_rules”字段及“bandwidth_rules”对象。 在查询浮动IP列表章节，增加“limit”、“marker”、“page_reverse”字段。 在查询浮动IP列表、查询浮动IP章节，增加“project_id”字段。 在创建浮动IP、查询浮动IP列表、查询浮动IP、更新浮动IP章节，删除“dns_name”、“dns_domain”字段。 在创建浮动IP、更新浮动IP章节，删除“created_at”、“updated_at”字段。 在EIP、带宽、带宽（V2.0）、EIP标签管理章节，修改请求示例及响应样例。 2020-06-02 第七次正式发布。 本次更新说明如下： 在权限策略和授权项章节，调整表格。 在错误码章节，错误码说明补充API网关错误码说明。 2020-05-13 第六次正式发布。 本次更新说明如下： 在申请EIP(按需计费)章节，修改“响应样例二（IPv6EIP共享带宽）”。 在查询EIP章节，增加public_ip_address参数。 在申请EIP(包年/包月)章节： charge_mode参数补充约束说明。 period_num参数修改取值范围。 publicip_type参数修改为type。 增加enterprise_project_id参数。 在带宽、创建共享带宽、更新包周期带宽章节，增加created_at和updated_at参数。 在查询带宽列表、更新带宽、创建共享带宽、共享带宽插入EIP、更新包周期带宽章节，增加charge_mode参数。 在查询带宽章节，修改charge_mode参数说明并修改响应样例。 在查询带宽列表章节，增加share_type参数并修改响应样例。 在更新带宽章节，增加status参数并修改请求样例。 在查询浮动IP列表章节，增加floatingips_links参数并修改响应样例。 在创建共享带宽章节，修改响应样例。 在共享带宽插入EIP章节，增加type参数并修改请求样例 。 在更新包周期带宽章节，修改响应样例。 2020-04-21 第五次正式发布。 本次更新说明如下： 新增配额章节。 2020-02-24 第四次正式发布。 本次更新说明如下： 新增EIP标签管理。 在“错误码”章节，新增资源标签相关错误码。 2020-01-20 第三次正式发布。 本次更新说明如下： 修改“策略及授权项说明”章节内容。 2019-12-26 第二次正式发布。 本次更新说明如下： 新增弹性公网IP标签章节。 2019-12-10 第一次正式发布。

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不同，使用时请注意。