Domain name for API request: dlc.tencentcloudapi.com.
This API is used to enumerate user roles.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeUserRoles. |
Version | Yes | String | Common Params. The value used for this API: 2021-01-25. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
Limit | Yes | Integer | The number limit of enumerated user roles. |
Offset | Yes | Integer | The offset for starting enumeration. |
Fuzzy | No | String | Fuzzy enumeration by arn. |
SortBy | No | String | The field for sorting the returned results. |
Sorting | No | String | The sorting order, descending or ascending, such as desc . |
Parameter Name | Type | Description |
---|---|---|
Total | Integer | The total number of user roles meeting the enumeration conditions. |
UserRoles | Array of UserRole | The user roles. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserRoles
<Common request parameters>
{
"Limit": 0,
"Offset": 0,
"Fuzzy": "abc",
"SortBy": "abc",
"Sorting": "abc"
}
{
"Response": {
"Total": 0,
"UserRoles": [
{
"RoleId": 0,
"AppId": "abc",
"Uin": "abc",
"Arn": "abc",
"ModifyTime": 0,
"Desc": "abc",
"RoleName": "abc",
"Creator": "abc",
"CosPermissionList": [
{
"CosPath": "abc",
"Permissions": [
"abc"
]
}
],
"PermissionJson": "abc"
}
],
"RequestId": "abc"
}
}
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserRoles
<Common request parameters>
{
"Fuzzy": "1",
"Limit": 0,
"Offset": 0
}
{
"Response": {
"Total": 1,
"UserRoles": [
{
"RoleId": 0,
"AppId": "1234",
"Uin": "1234",
"ModifyTime": 1650424290,
"Arn": "11",
"Desc": "test role"
}
],
"RequestId": "2ae4707a-9f72-44aa-9fd4-65cb739d6301"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | The operation failed. |
Was this page helpful?