tencent cloud

Feedback

Manageable Resources and Actions

Last updated: 2022-09-26 15:34:32
    notice
    This document describes the management of access to TRTC. For access management of other Tencent Cloud services, see CAM-Enabled Products.
    In essence, CAM enables you to allow or forbid specified accounts to access certain resources. TRTC access management supports resource-level authorization. The granularity of manageable resources is TRTC applications, and the granularity of authorizable actions is TencentCloud APIs, including server APIs and APIs that may be needed to access the TRTC console.
    If you need to manage access to TRTC, please log in to the console with a Tencent Cloud root account and use a preset policy or a custom policy to grant permissions.

    Type of Manageable Resources

    TRTC access management allows you to control access to applications.

    APIs Supporting Resource-Level Authorization

    Barring a few exceptions, all API actions listed in this section support resource-level authorization. Authorization policies related to these API actions use the same syntax conventions. See below for details.
    Authorizing access to all applications: qcs::trtc::uin/${uin}:sdkappid/*
    Authorizing access to single applications: qcs::trtc::uin/${uin}:sdkappid/${SdkAppId}.

    Server API actions

    API
    Category
    Description
    Room management
    Closes a room.
    Room management
    Removes a user.
    Room management
    Removes a user (string room ID).
    Room management
    Closes a room (string room ID).
    Stream mixing and transcoding
    Starts On-Cloud MixTranscoding.
    Stream mixing and transcoding
    Stops On-Cloud MixTranscoding.
    Stream mixing and transcoding
    Starts On-Cloud MixTranscoding (string room ID).
    Stream mixing and transcoding
    Stops On-Cloud MixTranscoding (string room ID).
    Call quality monitoring
    Generates information about exceptional conditions.
    Call quality monitoring
    Queries abnormal events.
    Call quality monitoring
    Queries user list and call metrics.
    Call quality monitoring
    Queries room and user numbers in the past.
    Call quality monitoring
    Queries room list.
    Call quality monitoring
    Queries the list of historical users.

    Console API actions

    API
    Console
    Description
    DescribeAppStatList
    TRTC console:
    
    Gets application list.
    DescribeSdkAppInfo
    Gets application information.
    ModifyAppInfo
    Modifies application information.
    ChangeSecretKeyFlag
    Enables/Disables encryption keys.
    CreateWatermark
    Uploads an image.
    DeleteWatermark
    Deletes an image.
    ModifyWatermark
    Edits an image.
    DescribeWatermark
    Searches an image.
    CreateSecret
    Generates a symmetric encryption key.
    ToggleSecretVersion
    Switches between asymmetric keys (private and public keys) and symmetric keys.
    DescribeSecret
    TRTC console:
    
    Gets a symmetric encryption key.
    DescribeTrtcAppAndAccountInfo
    Gets application and account information to obtain a pair of public and private keys.
    CreateSecretUserSig
    Uses a symmetric encryption key to generate a UserSig.
    DescribeSig
    TRTC console:
    
    Gets a UserSig generated using a pair of public and private keys.
    VerifySecretUserSig
    Verifies a UserSig generated using a symmetric encryption key.
    VerifySig
    Verifies a UserSig generated using a pair of public and private keys.
    CreateSpearConf
    Adds an image setting. This module is available only in iLiveSDK 1.9.6 and earlier versions. For TRTC SDK 6.0 and later versions, see Setting Image Quality
    DeleteSpearConf
    Deletes an image setting. This module is available only in iLiveSDK 1.9.6 and earlier versions. For TRTC SDK 6.0 and later versions, see Setting Image Quality
    ModifySpearConf
    Modifies image settings. This module is available only in iLiveSDK 1.9.6 and earlier versions. For TRTC SDK 6.0 and later versions, see Setting Image Quality
    DescribeSpearConf
    Gets image settings. This module is available only in iLiveSDK 1.9.6 and earlier versions. For TRTC SDK 6.0 and later versions, see Setting Image Quality
    ToggleSpearScheme
    Switches image setting scenarios. This module is available only in iLiveSDK 1.9.6 and earlier versions. For TRTC SDK 6.0 and later versions, see Setting Image Quality
    

    APIs Not Supporting Resource-Level Authorization

    Due to special restrictions, the following APIs do not support resource-level authorization.

    Server API actions

    API
    Category
    Description
    Restriction
    DescribeDetailEvent
    Call quality monitoring
    Queries specific events.
    The parameters entered do not include SDKAppID, making resource-level authorization impossible.
    DescribeRecordStatistic
    Other APIs
    Queries the billing period of on-cloud recording.
    For business reasons, resource-level authorization is not supported currently.
    DescribeTrtcInteractiveTime
    Other APIs
    Queries the billing period for audio/video interactive features.
    For business reasons, resource-level authorization is not supported currently.
    DescribeTrtcMcuTranscodeTime
    Other APIs
    Queries the billing period of relayed transcoding.
    For business reasons, resource-level authorization is not supported currently.

    Console API actions

    API
    Console
    Description
    Restriction
    DescribeTrtcStatistic
    TRTC console:
    
    Gets usage statistics.
    This API returns the statistics of all `SDKAppIDs`. Limiting a query to specific `SDKAppIDs` will lead to an error. You can use `DescribeAppStatList` to specify a list of applications to query.
    DescribeDurationPackages
    TRTC console:
    
    Gets the list of prepaid packages.
    A prepaid package is shared by all TRTC applications under the same Tencent Cloud account. There is no `SDKAppID` parameter in the package information, so resource-level authorization cannot be performed.
    GetUserList
    TRTC console: Monitoring Dashboard
    Gets user list.
    The parameters entered do not include `SDKAppID`, making resource-level authorization impossible. You can use `DescribeAppStatList` to specify a list of applications to query.
    GetUserInfo
    TRTC console: Monitoring Dashboard
    Gets user information.
    The parameters entered do not include `SDKAppID`, making resource-level authorization impossible. You can use `DescribeAppStatList` to specify a list of applications to query.
    GetCommState
    TRTC console: Monitoring Dashboard
    Gets call status.
    The parameters entered do not include `SDKAppID`, making resource-level authorization impossible. You can use `DescribeAppStatList` to specify a list of applications to query.
    GetElasticSearchData
    TRTC console: Monitoring Dashboard
    Queries Elasticsearch data.
    The parameters entered do not include `SDKAppID`, making resource-level authorization impossible. You can use `DescribeAppStatList` to specify a list of applications to query.
    CreateTrtcApp
    TRTC console:
    
    Creates a TRTC application.
    The parameters entered do not include `SDKAppID`, making resource-level authorization impossible. `SDKAppID` is the unique ID of a TRTC application and is generated after application creation.
    HardDescribeMixConf
    Queries relayed push status.
    The parameters entered do not include `SDKAppID`, making resource-level authorization impossible. You can use `DescribeAppStatList` to specify a list of applications to query.
    ModifyMixConf
    Enables/Disables relayed push.
    The parameters entered do not include `SDKAppID`, making resource-level authorization impossible. You can use `DescribeAppStatList` to specify a list of applications to query.
    RemindBalance
    TRTC console: Package Management
    Gets the balance alarm information of a prepaid package.
    A prepaid package is shared by all TRTC applications under the same Tencent Cloud account. There is no `SDKAppID` parameter in the package information, so resource-level authorization cannot be performed.
    
    notice
    You can use a custom policy to control access to an API that does not support resource-level authorization. In the policy statement, set the resource element to *.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support