基本信息
CAM中产品名 | CAM中简称 | 控制台访问 | 按标签授权 | 授权粒度 | IP限制 |
---|---|---|---|---|---|
实时音视频 | trtc | 支持 | 支持 | 资源级 | 部分支持 |
说明:云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。
- 服务级:定义对服务的整体是否拥有访问权限,分为允许对服务拥有全部操作权限或者拒绝对服务拥有全部操作权限。服务级授权粒度的云产品,不支持对具体的接口进行授权。
- 操作级:定义对服务的特定接口(API)是否拥有访问权限,例如:授权某账号对云服务器服务进行只读操作。
- 资源级:定义对特定资源是否有访问权限,这是最细的授权粒度,例如:授权某账号仅读写操作某台云服务器实例。能支持资源级接口授权的产品,则会被认定为资源级授权粒度。
接口授权粒度
接口授权粒度分为资源级和操作级两个级别:
- 资源级接口:此类型接口支持对某一个具体特定的资源进行授权。
- 操作级接口:此类型接口不支持对某一个特定的资源进行授权。授权时策略语法若限定了具体的资源,CAM会判断此接口不在授权范围,判断为无权限。
写操作
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
AlterRecording | 新增或者修改用户录制模板信息 | 资源级 | qcs::trtc::uin/:sdkappid/${Sdkappid} | 支持 |
ChangeSecretKeyFlag | 修改权限密钥状态 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
CreateCloudRecording | 启动伴生云端录制。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
CreateSecret | 创建新版对称式加密密钥 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
CreateSecretUserSig | 使用密钥生成签名(UserSig) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
CreateSpearConf | 新增画面设定配置 | 操作级 | * | 支持 |
CreateTroubleInfo | 创建异常信息 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
CreateTrtcApp | 注册一个实时音视频应用 | 操作级 | * | 支持 |
CreateTrtcFreeLicense | 创建音视频通话能力(体验版) | 操作级 | * | 支持 |
CreateWatermark | 上传水印图片 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DeleteCloudRecording | 停止伴生云端录制任务。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
DeleteSpearConf | 删除画面设定配置 | 操作级 | * | 支持 |
DeleteTRTCApp | 删除TRTC应用服务 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DeleteWatermark | 删除水印图片 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DismissRoom | 解散房间(数字房间号) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DismissRoomByStrRoomId | 解散房间(字符串房间号) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
ModifyAbilityStatus | 修改增值功能开关 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${SdkAppId} | 支持 |
ModifyAppInfo | 修改应用信息 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
ModifyCloudRecording | 更新伴生云端录制任务。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
ModifyMixConf | 开启/关闭自动旁路推流 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
ModifyPushSwitch | 修改应用的推流总开关 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
ModifySpearConf | 修改画面设定配置 | 操作级 | * | 支持 |
ModifyTRTCAppStatus | 设置TRTC应用服务状态 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
ModifyTRTCPostPaySwitch | 设置TRTC后付费开关 | 操作级 | * | 支持 |
ModifyTRTCScreenshotConfig | 修改视频截图上传配置 | 资源级 | qcs::trtc::uin/:sdkappid/${SdkAppId} | 支持 |
ModifyTRTCUsageMode | 修改TRTC集成类型 | 资源级 | qcs::trtc::uin/:sdkappid/${SdkAppId} | 支持 |
ModifyTRTCUserBusinessInfo | 提交业务信息 | 操作级 | * | 支持 |
ModifyTrtcCallback | 修改Trtc事件回调 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
ModifyWatermark | 修改水印图片 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
RemoveUser | 移出用户(数字房间号) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
RemoveUserByStrRoomId | 移出用户(字符串房间号) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
SetUserBlocked | 设置数字房间号mute,unmute状态 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
SetUserBlockedByStrRoomId | 设置字符串房间mute,unmute状态 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
StartCrossAppMixStream | 启动跨AppId混流。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
StartMCUCommonMixStream | MCU通用混流。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
StartMCUMixTranscode | 启动云端混流 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
StartMCUMixTranscodeByStrRoomId | 启动云端混流(字符串房间号) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
StartPublishCdnStream | 启动转推任务。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
StartStreamIngest | 开启输入在线媒体流 | 操作级 | * | 支持 |
StartWebRecord | 开始页面录制 | 操作级 | * | 支持 |
StopCrossAppMixStream | 停止跨AppId混流。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
StopMCUCommonMixStream | 停止通用混流。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
StopMCUMixTranscode | 结束云端混流 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
StopMCUMixTranscodeByStrRoomId | 结束云端混流(字符串房间号) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
StopPublishCdnStream | 停止转推任务。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
StopWebRecord | 停止页面录制 | 操作级 | * | 支持 |
ToggleSecretVersion | 切换密钥版本 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
ToggleSpearScheme | 切换画面设定场景 | 操作级 | * | 支持 |
UpdatePublishCdnStream | 更新转推任务。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
读操作
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
CheckTRTCUserStatus | 检测当前账号是否已被封禁或拉黑 | 操作级 | * | 支持 |
CheckUserInQCWhiteList | 检查用户是否在仪表盘白名单中,并获取白名单版本 | 操作级 | * | 支持 |
CreateTrtcFreeLicenseForIntl | 创建音视频通话能力(国际站体验版) | 操作级 | * | 支持 |
DescribeAbnormalEvent | 查询异常体验事件 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeCallDetail | 查询用户列表与通话指标 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeCallDetailInfo | 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。接口用于查询质量问题,不推荐作为计费使用。注意:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。(同老接口DescribeCallDetail) | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
DescribeCloudRecording | 查询伴生录制状态。 | 资源级 | qcs::${ApiModule}::uin/:sdkappid/${SdkAppId} | 支持 |
DescribeDetailEvent | 查询详细事件 | 操作级 | * | 支持 |
DescribeDurationPackages | 获取时长套餐包列表 | 操作级 | * | 支持 |
DescribeHistoryScale | 查询历史房间和用户数 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeMeasureResources | 查询计量侧套餐包详情列表。 | 操作级 | * | 支持 |
DescribeMixTranscodingUsage | 查询TRTC混流转码用量 | 操作级 | * | 支持 |
DescribeOldRecordUsage | 查询老录制时长 (产品化录制) | 操作级 | * | 支持 |
DescribeOnlineRoomInformation | 查询sdkappid下当前在线的房间列表。默认返回100条房间信息,一次最多返回500条房间信息。 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeOnlineUserInformation | 查询sdkappid下某个房间当前在线的用户列表。通话模式返回所有用户,直播模式返回所有主播及最 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeRealtimeNetwork | 查询实时网络状态 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeRealtimeQuality | 查询实时质量数据 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeRealtimeScale | 查询实时规模 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeRecordStatistic | 获取录制的时长统计数据 | 操作级 | * | 支持 |
DescribeRecordingUsage | 查询TRTC录制用量 | 操作级 | * | 支持 |
DescribeRelayUsage | 查询TRTC旁路转推用量 | 操作级 | * | 支持 |
DescribeRoomInformation | 查询房间列表 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeSdkAppAbility | 获取SdkAppId的能力信息 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${SdkAppId} | 支持 |
DescribeSdkAppInfo | 获取一个SkdAppID的信息 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeSecret | 获取密钥 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeSig | 获取旧版公私钥签名(UserSig) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeSpearConf | 获取画面设定配置 | 操作级 | * | 支持 |
DescribeTRTCAbility | 获取TRTC用户能力-内部接口 | 操作级 | * | 支持 |
DescribeTRTCFreeLicenseLimit | 判断账号或应用是否超过体验版领取限制 | 操作级 | * | 支持 |
DescribeTRTCHybridCloudUsage | 查询混合云服务用量 | 资源级 | qcs::trtc::uin/:sdkappid/${SdkAppId} | 支持 |
DescribeTRTCLicense | 获取当前用户的TRTC License。 | 操作级 | * | 支持 |
DescribeTRTCLiveUsage | 查询极速直播用量 | 操作级 | * | 支持 |
DescribeTRTCMarketQualityData | 查询TRTC数据大盘质量相关数据 | 资源级 | qcs::trtc::uin/:sdkappid/${SdkAppId} | 支持 |
DescribeTRTCMarketScaleData | 查询TRTC数据大盘规模数据 | 资源级 | qcs::trtc::uin/:sdkappid/${SdkAppId} | 支持 |
DescribeTRTCRealTimeQualityData | 查询TRTC实时监控质量数据 | 资源级 | qcs::trtc::uin/:sdkappid/${SdkAppId} | 支持 |
DescribeTRTCRealTimeScaleData | 查询TRTC实时监控规模数据 | 资源级 | qcs::trtc::uin/:sdkappid/${SdkAppId} | 支持 |
DescribeTRTCRealTimeScaleMetricData | 查询TRTC实时监控规模指标 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${SdkAppId} | 支持 |
DescribeTRTCScreenshotConfig | 获取视频截图上传配置 | 资源级 | qcs::trtc::uin/:sdkappid/${SdkAppId} | 支持 |
DescribeTRTCUserAbility | 获取TRTC用户所有应用的能力位信息 | 操作级 | * | 支持 |
DescribeTRTCUserGlobalConfig | 获取TRTC用户全局通用配置 | 操作级 | * | 支持 |
DescribeTranscodeStatistic | 获取Trtc的转码统计数据 | 操作级 | * | 支持 |
DescribeTrtcAppAndAccountInfo | 获取应用和账户信息 | 资源级 | qcs::trtc::uin/:sdkappid/${SdkAppId} | 支持 |
DescribeTrtcCallback | 订阅Trtc事件回调 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeTrtcInteractiveTime | 获取音视频互动计费时长 | 操作级 | * | 支持 |
DescribeTrtcMcuTranscodeTime | 查询旁路转码计费时长 | 操作级 | * | 支持 |
DescribeTrtcMcuTranscodeUsage | 查询旁路转码计费时长,计量三期 | 操作级 | * | 支持 |
DescribeTrtcRoomUsage | 查询TRTC音视频房间维度用量 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${SdkAppId} | 支持 |
DescribeTrtcStatistic | 获取 TRTC 的时长用量统计数据 | 操作级 | * | 支持 |
DescribeTrtcUsage | 查询TRTC音视频用量 | 操作级 | * | 支持 |
DescribeUserInformation | 查询用户信息 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeUserState | 查询用户在房间中的状态(数字房间号) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeUserStateByStrRoomId | 查询用户在房间中的状态(字符串房间号) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeWatermark | 查找水印图片 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
DescribeWebRecord | 查询页面录制 | 操作级 | * | 支持 |
GetCommState | 获取通话状态(控制台使用) | 操作级 | * | 支持 |
GetElasticSearchData | 查询实时质量数据(控制台使用) | 操作级 | * | 支持 |
GetRecordTemplate | 通过sdkappid 获取录制模板 | 资源级 | qcs::trtc::uin/:sdkappid/${Sdkappid} | 支持 |
GetRecordingInfo | 通过sdkappid 获取录制模板配置和sdkappid 一一对应 | 资源级 | qcs::trtc::uin/:sdkappid/${Sdkappid} | 不支持 |
GetRoomList | 获取房间列表(控制台使用) | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
GetRoomUserList | 获取房间用户列表 | 操作级 | * | 支持 |
GetUserInfo | 获取用户信息(控制台使用) | 操作级 | * | 支持 |
GetUserList | 获取用户列表(控制台使用) | 操作级 | * | 支持 |
GetUserTotalCount | 获取房间内参与用户总数 | 操作级 | * | 支持 |
HardDescribeMixConf | 查询自动旁路推流状态 | 操作级 | * | 支持 |
IsInDemoApplyList | 查看是否在demo体验申请名单中 | 操作级 | * | 支持 |
IsSgFirstBuyUser | 判断用户是否首次购买国际站套餐包 | 操作级 | * | 支持 |
RemindBalance | 余额提醒 | 操作级 | * | 支持 |
VerifySecretUserSig | 签名(UserSig)校验 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
VerifySig | 旧版公私钥签名(UserSig)校验 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/${sdkappid} | 支持 |
其他操作
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
DescribeAITranscription | 查询AI转录状态 | 操作级 | * | 支持 |
StartAITranscription | 开始AI转录 | 操作级 | * | 支持 |
StopAITranscription | 停止AI转录 | 操作级 | * | 支持 |
SummarizeTranscription | 总结转录文本 | 操作级 | * | 支持 |
列表操作
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
DescribeAppStatList | 获取用户名下的应用列表 | 资源级 | qcs::trtc::uin/${uin}:sdkappid/{SdkAppId} | 不支持 |