新手入门 |
您所在的位置：网站首页 › 421文档百度云资源 › 新手入门 |
新手入门
| 前言
云API是百度智能云开放能力的基础，借助API可以极大的节省人力成本，提高效率，用更高效的方式完成对云上资源的管控。对于开发者来说，使用云 API 完成一些重复性强的工作可以极大节约时间和精力；除此之外，API还有便于组合能力、便于自动化、扩展性强、对系统要求低等优点。 也许你已经了解过API和HTTP相关的知识概念，但刚刚使用百度智能云产品，不知道该从哪里开始API的调用工作。本文将带您理解百度智能云API签名算法，并以创建BCC云服务器实例为例，让您掌握调用百度智能云API的方法。 本文可以看做是鉴权认证机制文档的精简提炼版，更关注流程，忽略了一些具体的要求和细节。如果您在本文中遇到需要进一步了解的内容，请到鉴权认证机制中进行查阅。 要调用API，我们需要先获取API请求的结构和参数,了解API请求应该如何组织、以及含有哪些信息；再构造认证字符串；将认证字符串以及其他信息按要求填到API请求的各个位置后，即可发送API请求，并接收服务端发回的响应。 获取API请求的结构和参数全篇以 云服务器BCC创建实例为例，完成一遍完整的API调用过程。 BCC 是什么？ 云服务器BCC（Baidu Cloud Compute）是百度智能云可弹性伸缩的计算服务。管理方式比物理服务器更简单高效，API可以实现批量创建实例、释放任意多台云服务器实例，提升运维效率。更多详情请参考 BCC API文档。 要获取调用该接口所需要的信息，我们要先查阅该接口的API文档。登录百度智能云官网，在顶部导航栏中选择"帮助与支持>文档"，选择云服务器BCC，在文档左侧导航栏里选择"API参考>实例相关接口>创建实例"。
接口文档中的请求结构部分向我们展示了待发送的API请求的请求方法，URL、请求头和请求体该分别如何进行组织，而请求参数向我们介绍了API请求里的各个变量该如何进行取值。 参数位置 说明 方法 请求的方法，包括PUT、 POST、 GET、 DELETE等。具体取哪个方法需要以接口文档的请求结构和请求示例为准。 URL绝对路径（URL参数） 指整段URL里用/分隔的部分，如本例中的/v2/instance,v2是API版本号 查询字符串（Query参数） 指整段URL里？后边的部分。如果查询字符串中含有多组参数，用&连接。 请求头（header参数） 大多数API请求都需要提交一些公共的内容（必要的有服务域名host和认证字符串Authorization，认证字符串的生成步骤见下方构造认证字符串），将这些内容统一放在请求头header里，就被称为公共请求头。 请求体（RequestBody参数） 填写待创建的BCC实例的各项参数，请求体使用JSON格式 构造认证字符串API请求中的大部分信息只需要您根据请求参数中的要求填好即可，比较容易获取。但请求头中的认证字符串Authorization需要利用众多参数，经过多次运算和拼接得到。 认证字符串的目的主要是为了对API调用发起者进行身份验证，同时也有防止非法篡改，防止重放攻击的作用。为了生成认证字符串，我们需要如下信息： 参数名称 参数解释 accessKeyId 简称AK，相当于您调用API时的用户名，获取方式见获取AK/SK SecretAccessKey 简称SK，相当于您调用API时的密码，获取方式见获取AK/SK authStringPrefix 认证字符串前缀，由"bce-auth-v1"、{accessKeyId}、{timestamp}、{expirationPeriodInSeconds}用/拼接而成。三个参数的取值说明详见生成认证字符串 SigningKey 由SK和authStringPrefix经过HMAC-SHA256-HEX运算得到 CanonicalRequest 由请求方法、处理过的URL绝对路径、处理过的QueryString、处理过的header用换行符"\n"拼接而成。处理方法详见生成canonicalrequest signature 由SigningKey和CanonicalRequest经过HMAC-SHA256-HEX运算得到 Authorization 认证字符串，是鉴权认证工作的最终成果。由authStringPrefix、signedHeaders和signature用/拼接而成 signedHeaders 签名算法中涉及到的HTTP头域列表，也就是说，让哪些头域参与签名运算是可以由调用者自行决定的（host必须参与）。具体参见CanonicalHeaders综上，生成Authorization的过程可以用下面这张图来表示：
认证字符串构造完毕后，将其放入请求头，就完成了鉴权认证工作。 客户端发送API请求并接收响应在编程环境中将所有信息都准备好之后，即可发送API请求。发送方法可以参考用Python完成API接口调用。 将API发送出去后，分两种情况： 如果API请求的内容正确无误，对于有返回值的API接口来说，会收到API请求所要求的返回值信息；对于没有返回值的API接口来说，只会收到状态码和响应头，响应体为空。 如果API请求内容存在问题，则会收到含有错误码和错误说明的响应。您可以根据错误码对API请求的各个部分做检查，排除问题。 Python示例讲解官网帮助中心提供了Python编程的签名函数方法，以下讲解是在官网demo基础上增加请求函数，完成调用BCC API创建实例。 代码下载 1、demo代码示例请到官网下载 Python demo签名示例。 2、本文使用的实操代码 点击下载。 前置条件 1、已注册百度账号 2、实名认证 3、购买实例前需保证账户无欠款，且保证账户余额和可用代金券总和大于或等于100元 数据准备 1、获取AK/SK，参见 获取AK/SK 2、创建BCC实例所需数据，参见API参考文档 创建BCC实例 说明： 下载官网demo的Php示例、Java示例、Javascript示例请访问 帮助中心-》相关参考-》鉴权认证-》示例下载 配置说明 本次举例中全部使用指定header_to_sign方法进行配置，实现创建BCC实例。 操作步骤 1、在官网demo示例中，要导入requests等模块，以便支持请求函数和幂等性函数 。
demo示例中使用的函数有：保存AK/SK、正规化字符串、生成规范时间戳、生成规范URI、生成规范查询字符串。 2、生成规范header。 需注意：
当不指定header_to_sign时，默认使用如下5项参与签名算法 。
3、以下开始均使用指定header_to_sign方法进行配置。 4、签名主算法模块。 其中timestamp=0, expiration_in_seconds=18000, headers_to_sign=None已经给出默认值。
本次举例使用非默认配置，要指定header_to_sign，在步骤7里，完成最终签名字符串的拼接。
5、使用幂等性函数。 可以保证创建BCC时，避免同一个请求被重复调用。
6、主工程中填写配置数据。 在【数据准备】获得的AK、Sk、请求方法、请求路径，请求头域，幂等性，填入主工程响应参数中。
7、构造body数据。 在请求体body数据构造中，为了是举例简单易懂，仅使用创建BCC的最小配置，包括 实例类型、CPU核数、实例名、内存容量、镜像ID，付费方式，可用区。
8、本步骤是重点，指定header_to_sign参与鉴权编码。 通过查看文档中给出的请求参数，从中挑选必选和部分可选公共头，填进指定header_to_sign中，参与鉴权编码。这里需要理解的是，选择哪些Header进行编码并不会影响API的功能，但是如果选择太少则可能遭到中间人攻击，但一定必须包含host，如本例中使用host和x-bce-data。
9、继续配置到期时间以及时间戳。 时间戳是生成鉴权生效的开始时间，可以取当前的时间点，或需要的时间点。
10、在构造和生成鉴权字符串后，加到头域中的认证字段。
11、接下来构造request请求和拼接URL，以及构造发起请求。
执行结果 现在执行一次请求，在执行结果中，http状态为200，表明已经成功创建BCC实例。同样可以在百度智能云控制台查看创建结果。
登录百度智能云控制台，选择区域北京，在实例列表页可以查看到刚刚创建的BCC云服务器实例，正在创建中。创建成功后，便可以使用实例资源。
后续操作 查询BCC实例 停止BCC实例 释放BCC实例在创建BCC代码基础上，已经完成了签名和认证的关键操作，只需要根据API文档提供的数据，就可以自学调用BCC实例的查询、停止、释放。 参考与反馈 参考资料 说明 API平台 百度智能云所有产品API文档入口、开发者工具、新手入门 如何查找自己的AK/SK 在控制台申请和管理自己的访问密钥 鉴权认证机制 鉴权介绍、使用方法、各种语言签名函数下载、常见错误故障处理 区域选择说明 有关每个服务所支持的区域信息 签名认证错误FAQ 介绍常见签名认证错误排查方法更多帮助与支持，请将意见填写到产品API参考文档页（如下图），或提交工单咨询。
|
【本文地址】
今日新闻 |
点击排行 |
|
推荐新闻 |
图片新闻 |
|
专题文章 |