Domain name for API request: tdmq.tencentcloudapi.com.
This API is used to get the list of namespace 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: DescribeEnvironmentRoles. |
Version | Yes | String | Common Params. The value used for this API: 2020-02-17. |
Region | No | String | Common Params. This parameter is not required for this API. |
EnvironmentId | No | String | Environment/namespace name (required). |
Offset | No | Integer | Offset, which defaults to 0 if left empty. |
Limit | No | Integer | The number of results to be returned, which defaults to 10 if left empty. The maximum value is 20. |
ClusterId | No | String | Pulsar cluster ID (required). |
RoleName | No | String | Role name. |
Filters.N | No | Array of Filter | * RoleName Filter by role name for exact query. Type: String Required: No |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The number of records. |
EnvironmentRoleSets | Array of EnvironmentRole | Namespace role set. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tdmq.tencentcloudapi.com/?Action=DescribeEnvironmentRoles
&EnvironmentId=default
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"EnvironmentRoleSets": [
{
"EnvironmentId": "default",
"RoleName": "test_role",
"Permissions": [
"produce",
"consume"
],
"RoleDescribe": "Remark1",
"CreateTime": "2020-08-03 19:46:37",
"UpdateTime": "2020-08-04 15:59:29"
}
],
"RequestId": "gggxxxx"
}
}
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 |
---|---|
AuthFailure.UnauthorizedOperation | CAM authentication failed. |
InvalidParameterValue.InvalidParams | The parameter value is out of the value range. |
MissingParameter.NeedMoreParams | A required parameter is missing. |
ResourceNotFound.BrokerCluster | The service cluster does not exist. |
ResourceNotFound.Cluster | The cluster does not exist. |
ResourceNotFound.Environment | The environment does not exist. |
ResourceNotFound.Role | The role does not exist. |
本页内容是否解决了您的问题?