文档中心>云 API>快速入门>使用云 API 控制台

使用云 API 控制台

最近更新时间:2024-08-22 15:44:11

我的收藏
云 API 控制台 提供了用户查看调用产品情况的可视化界面,方便用户了解腾讯云 API 调用次数、错误率、使用 API 调用的产品分布以及错误码分布。同时还提供了 API 库、API Explorer 工具及错误码中心,您可按需选择并开始使用。
注意:
云 API 控制台仅展示您使用 API 3.0调用的数据情况(包括 API Explorer、TCCLI 及 SDK 调用),不包括控制台关联的 API 调用。
API 中心 具有3.0标识代表该产品具备 API 3.0。

使用信息中心

您可通过云 API 控制台信息中心页查看以下信息:
可根据账号、产品、接口及时间段进行筛选,查看对应条件下的 API 调用次数及错误率分布情况。如下图所示:
说明:
若当前账号为主账号,则可选择查看主账号或对应子账号的 API 调用信息。若当前账号为子账号,则仅能查看当前账号的 API 调用信息。
若子账号如需查看当前或其他账号下的 API 调用信息,则需主账号进行授权。具体操作请参见 子账号权限配置



可查看 API 产品使用分布,了解具体产品的调用情况。如下图所示:



可查看错误码分布详情。如下图所示:




使用 API 库

您可选择云 API 控制台左侧导航栏中的 API 库,进入产品 API 文档库查看对应文档。也可直接使用腾讯云 API 平台,详情请参见 使用腾讯云 API 平台。如下图所示:




使用 API Explorer 工具

您可选择云 API 控制台左侧导航栏中的 API Explorer,进入工具页面开始使用。腾讯云 API Explorer 工具 是一款自动化工具,目前已支持云服务器 CVM、私有网络 VPC、云硬盘 CBS 等 腾讯云产品 的 API 接口调用自动化。可实现自动生成 Java、Python、Node.js、PHP、GO 及 .NET 等语言的接入示例代码、在线调用、发送真实请求及签名串自动生成等功能,降低腾讯云 API 的使用难度。更多关于 API Explorer 工具介绍请参见 使用 API Explorer

使用诊断能力

诊断能力是云 API 提供的一项帮助开发者更高效地定位使用 API 过程中问题的网页版工具。用户可通过该能力轻松找出调用 API 过程中的出错点,并获取解决方案,同时可清楚的查看整个调用过程及日志等信息。详情请参见 使用诊断能力

使用错误码中心

您可选择云 API 控制台左侧导航栏中的错误码,进入错误码中心快速定位并解决问题。如下图所示:




相关操作

子账号权限配置

子账号如需查看当前或其他账号下的 API 调用信息,则需主账号进行授权。步骤如下:
1. 使用主账号登录访问管理控制台,选择左侧导航栏中的 策略
2. 策略页面,选择新建自定义策略
3. 在弹出的选择创建方式窗口中,单击按策略生成器创建,进入编辑策略页面。
4. 编辑策略步骤中,选择 JSON 页签,并输入以下自定义策略:
{
"version": "2.0",
"statement": [
{
"effect": "allow",
"action": [
"api:*",
"cam:ListMaskedSubAccounts"
],
"resource": [
"*"
]
}
]
}
添加完成后如下图所示:



5. 单击下一步
6. 关联用户/用户组/角色步骤中,单击选择用户。如下图所示:



7. 在弹出的关联用户窗口中,选择需授权子账号,并单击确定
8. 单击完成即可。