前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >腾讯云 SDK 小课堂(一):产品名与模块名

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

原创
作者头像
zqfan
修改2021-01-12 09:47:26
1.1K0
修改2021-01-12 09:47:26
举报
文章被收录于专栏:腾讯云API腾讯云API

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

模块名=>产品名

有两种方法:

1、官网文档搜索

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

image.png
image.png

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

image.png
image.png

2、使用 SDK products.md文档

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

image.png
image.png

产品名=>模块名

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

image.png
image.png

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

特殊模块

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

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

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 模块名=>产品名
    • 1、官网文档搜索
      • 2、使用 SDK products.md文档
      • 产品名=>模块名
      • 特殊模块
      相关产品与服务
      云 API
      云 API 是腾讯云开放生态的基石。通过云 API,只需少量的代码即可快速操作云产品;在熟练的情况下,使用云 API 完成一些频繁调用的功能可以极大提高效率;除此之外,通过 API 可以组合功能,实现更高级的功能,易于自动化, 易于远程调用, 兼容性强,对系统要求低。
      领券
      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档