腾讯云 SDK 小课堂(一):产品名与模块名

2021-01-12 09:47:26 浏览数 (1)

在使用腾讯云 API SDK 的时候,有些朋友会发现 SDK 中有一百多个模块。常见的如 cvmvpcclb 可能还知道分别代表了云服务器(Cloud Virtual Machine)、私有网络(Virtual Private Cloud)、负载均衡(Cloud Load Balancer),一些不太常见的可能就不知道代表哪个产品了。去官网按模块名搜关键字,可能出来一大堆结果,也不知道哪个是正确的。这里就由zqfan向大家介绍一下,如何快速找到产品名和模块名的对应关系。

模块名=>产品名

有两种方法:

1、官网文档搜索

以 SDK 中的模块 vpc 为例,打开官网 文档中心 ,在顶部的搜索框中,直接输入 vpc.tencentcloudapi.com回车搜索

image.pngimage.png

在搜索结果中,如红框所示,可以直接跳转到产品文档页面

image.pngimage.png

2、使用 SDK products.md文档

我们在每一个 SDK 的仓库根目录下都提供了文件名为products.md的文档,里面详细记录了每个模块对应的产品中文名,并提供了链接可以直接跳转到官网对应的产品文档,最后还给出了每个产品的最后更新时间。比起搜索更为便捷,且不容易找错。欢迎体验!

image.pngimage.png

产品名=>模块名

以云服务器为例,在云服务器官网 产品文档 页面,任意查阅一篇 API 文档,例如 查看实例列表 接口文档,在接口描述章节下,有告知接口请求域名为 cvm.tencentcloudapi.com。其中域名的首段的 cvm 就是产品缩写名,在 SDK 中的模块名也就是 cvm

image.pngimage.png

接口文档中有 API Explorer 的链接,便于直接跳转到该接口进行调试。在开发者资源章节,提供了各编程语言的 SDK 链接,以供开发者查阅。

特殊模块

有如下几种情况会导致特殊模块出现:

  1. 产品下线:此时 SDK 中对此模块会保留一段时间,这是为了存量用户兼容考虑的,此时会发现官网文档已经无法打开了。
  2. 产品改名:此时 SDK 中旧产品名会保留一段时间。情形同上。
  3. 编程语言关键字冲突:例如弹性伸缩(AutoScaling)产品缩写as和部分语言的关键字冲突,因此被调整为autoscaling

0 人点赞