tencent cloud

Cloud Access Management

Product Introduction
CAM Overview
Features
Scenarios
Basic Concepts
Use Limits
User Types
Purchase Guide
Getting Started
Creating Admin User
Creating and Authorizing Sub-account
Logging In to Console with Sub-account
User Guide
Overview
Users
Access Key
User Groups
Role
Identity Provider
Policies
Permissions Boundary
Troubleshooting
Downloading Security Analysis Report
CAM-Enabled Role
Overview
Compute
Container
Microservice
Essential Storage Service
Data Process and Analysis
Data Migration
Relational Database
Enterprise Distributed DBMS
NoSQL Database
Database SaaS Tool
Database SaaS Service
Networking
CDN and Acceleration
Network Security
Data Security
Application Security
Domains & Websites
Big Data
Middleware
Interactive Video Services
Real-Time Interaction
Media On-Demand
Media Process Services
Media Process
Cloud Real-time Rendering
Game Services
Cloud Resource Management
Management and Audit Tools
Developer Tools
Monitor and Operation
More
CAM-Enabled API
Overview
Compute
Edge Computing
Container
Distributed cloud
Microservice
Serverless
Essential Storage Service
Data Process and Analysis
Data Migration
Relational Database
Enterprise Distributed DBMS
NoSQL Database
Database SaaS Tool
Networking
CDN and Acceleration
Network Security
Endpoint Security
Data Security
Business Security
Application Security
Domains & Websites
Office Collaboration
Big Data
Voice Technology
Image Creation
Tencent Big Model
AI Platform Service
Natural Language Processing
Optical Character Recognition
Middleware
Communication
Interactive Video Services
Real-Time Interaction
Stream Services
Media On-Demand
Media Process Services
Media Process
Cloud Real-time Rendering
Game Services
Education Sevices
Medical Services
Cloud Resource Management
Management and Audit Tools
Developer Tools
Monitor and Operation
More
Use Cases
Security Practical Tutorial
Multi-Identity Personnel Permission Management
Authorizing Certain Operations by Tag
Supporting Isolated Resource Access for Employees
Enterprise Multi-Account Permissions Management
Reviewing Employee Operation Records on Tencent Cloud
Implementing Attribute-Based Access Control for Employee Resource Permissions Management
During tag-based authentication, only tag key matching is supported
Business Use Cases
TencentDB for MySQL
CLB
CMQ
COS
CVM
VPC
VOD
Others
API Documentation
History
Introduction
API Category
Making API Requests
User APIs
Policy APIs
Role APIs
Identity Provider APIs
Data Types
Error Codes
FAQs
Role
Key
Others
CAM Users and Permissions
Glossary

DescribeRoleList

PDF
Focus Mode
Font Size
Last updated: 2025-10-30 21:29:59

1. API Description

Domain name for API request: cam.intl.tencentcloudapi.com.

This API (DescribeRoleList) is used to get the role list under the account.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeRoleList.
Version Yes String Common Params. The value used for this API: 2019-01-16.
Region No String Common Params. This parameter is not required for this API.
Page Yes Integer Page number, beginning from 1
Rp Yes Integer Number of lines per page, no greater than 200
Tags.N No Array of RoleTags A parameter used to filter the list of roles under a tag.

3. Output Parameters

Parameter Name Type Description
List Array of RoleInfo Role details list
Note: This field may return null, indicating that no valid value was found.
TotalNum Integer Total number of roles
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the role list

Input Example

POST / HTTP/1.1
Host: cam.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoleList
<Common request parameters>

{
    "Rp": "5",
    "Page": "1"
}

Output Example

{
    "Response": {
        "List": [
            {
                "AddTime": "2020-11-28 10:05:52",
                "ConsoleLogin": 0,
                "DeletionTaskId": null,
                "Description": "The current role is the TencentCloud Automation Tools (TAT) service-linked role, and it will access your other Tencent Cloud resources within the permissions granted by the associated policies.",
                "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"service\":[\"command.tat.cloud.tencent.com\"]}}]}",
                "RoleId": "4611686018433460000",
                "RoleName": "TAT_QCSLinkedRoleInCommand",
                "RoleType": "service_linked",
                "SessionDuration": 43200,
                "Tags": [],
                "UpdateTime": "2020-11-28 10:05:52"
            },
            {
                "AddTime": "2020-06-28 12:07:06",
                "ConsoleLogin": 0,
                "DeletionTaskId": null,
                "Description": "The current role is the CVM service-linked role, and it will access your other Tencent Cloud resources within the permissions granted by the associated policies.",
                "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"service\":[\"cvmsmartdiagnostic.cvm.cloud.tencent.com\"]}}]}",
                "RoleId": "4611686018432380000",
                "RoleName": "CVM_QCSLinkedRoleInCVMSmartDiagnostic",
                "RoleType": "service_linked",
                "SessionDuration": 43200,
                "Tags": [
                    {
                        "Key": "K1",
                        "Value": "V7"
                    }
                ],
                "UpdateTime": "2020-06-28 12:07:06"
            }
        ],
        "RequestId": "36d78422-f6ce-4edb-a5a0-a217b366aa70",
        "TotalNum": 2
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError.SystemError Internal error.
InvalidParameter.ParamError Invalid input parameter.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback