热门活动
全部活动
1. 接口描述
接口请求域名： iss.tencentcloudapi.com 。
用于设置推拉流鉴权配置。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AddStreamAuth。 |
| Version | 是 | String | 公共参数，本接口取值：2023-05-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Id | 是 | String | 鉴权配置ID（uuid） 示例值：e8317c5b-7087-4126-bca0-**** |
| PullState | 是 | Integer | 是否开播放鉴权（1:开启,0:关闭） 示例值：1 |
| PullSecret | 是 | String | 播放密钥（仅支持字母数字，长度0-10位） 示例值：aaaaaaaaaa |
| PullExpired | 是 | Integer | 播放过期时间（单位：分钟） 示例值：10 |
| PushState | 是 | Integer | 是否开启推流鉴权（1:开启,0:关闭） 示例值：1 |
| PushSecret | 是 | String | 推流密钥（仅支持字母数字，长度0-10位） 示例值：bbbbbbbbbb |
| PushExpired | 是 | Integer | 推流过期时间（单位：分钟） 示例值：10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | AddStreamAuthData | 设置推拉流鉴权返回数据 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
输出示例
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败 |
| InvalidParameter | 无效的输入参数 |
| InvalidParameterValue.InvalidPullState | 无效的拉流鉴权开关值 |
| InvalidParameterValue.InvalidPushState | 无效的推流鉴权开关值 |
| InvalidParameterValue.InvalidSecret | 无效的密钥值，长度或内容不符合规则 |
| ResourceNotFound | 资源不存在 |
