获取数据流认证Token

最近更新时间:2024-06-11 11:14:41

我的收藏

1. 接口描述

接口请求域名: cam.tencentcloudapi.com 。

获取数据流认证Token

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:BuildDataFlowAuthToken。
Version String 公共参数,本接口取值:2019-01-16。
Region String 公共参数,详见产品支持的 地域列表
ResourceId String 资源ID
示例值:cbd-esq42
ResourceRegion String 资源地域
示例值:ap-guangzhou
ResourceAccount String 资源用户名
示例值:readOnly

3. 输出参数

参数名称 类型 描述
Credentials AuthToken 认证凭据AuthToken信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 生成AuthToken

生成AuthToken

输入示例

POST / HTTP/1.1
Host: cam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BuildDataFlowAuthToken
<公共请求参数>

{
    "ResourceId": "cdb-12dd3d",
    "ResourceRegion": "ap-shanghai",
    "ResourceAccount": "ReadOnly"
}

输出示例

{
    "Response": {
        "Credentials": {
            "CurrentTime": 12332343423,
            "LastRotationTimeCost": 343,
            "NextRotationTime": 10,
            "RotationMessage": "success",
            "RotationStatus": "success",
            "Token": "944a***mtHS"
        },
        "RequestId": "5bc7f0df-18a3-426b-84ce-ddbc8d1c95d1"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.BuildAuthToken 生成AuthToken异常。
FailedOperation.FlowAuthIllegal 凭据操作失败。
InvalidParameter.ParamError 非法入参。
ResourceNotFound.DataFlowAuthClose 未开启CAM数据流认证。
ResourceUnavailable.FlowAuthSecet 凭据信息异常。