Domain name for API request: tdmq.tencentcloudapi.com.
This API is used to get the attributes of the specified namespace.
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: DescribeEnvironmentAttributes. |
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 | Yes | String | Environment (namespace) name. |
ClusterId | No | String | Pulsar cluster ID |
Parameter Name | Type | Description |
---|---|---|
MsgTTL | Integer | TTL for unconsumed messages in seconds. Maximum value: 1296000 seconds (i.e., 15 days). |
RateInByte | Integer | Consumption rate limit in bytes/second. 0: unlimited. |
RateInSize | Integer | Consumption rate limit in messages/second. 0: unlimited. |
RetentionHours | Integer | Retention policy for consumed messages in hours. 0: deleted immediately after consumption. |
RetentionSize | Integer | Retention policy for consumed messages in GB. 0: deleted immediately after consumption. |
EnvironmentId | String | Environment (namespace) name. |
Replicas | Integer | Number of replicas. |
Remark | String | Remarks. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tdmq.tencentcloudapi.com/?Action=DescribeEnvironmentAttributes
&EnvironmentId=test1
&<Common request parameters>
{
"Response": {
"MsgTTL": 2000,
"RateInByte": 0,
"RateInSize": 0,
"Replicas": 2,
"RetentionHours": 0,
"RetentionSize": 0,
"EnvironmentId": "test1",
"Remark": "Remarks",
"RequestId": "dec113a8-599a-4e70-b143-14425d48ffc4"
}
}
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. |
FailedOperation.GetEnvironmentAttributesFailed | Failed to get the environment attributes. |
InternalError.BrokerService | The broker service is exceptional. |
InternalError.GetAttributesFailed | Failed to get attributes. |
InternalError.SystemError | System error. |
InvalidParameterValue.InvalidParams | The parameter value is out of the value range. |
MissingParameter.NeedMoreParams | A required parameter is missing. |
ResourceNotFound.Cluster | The cluster does not exist. |
ResourceNotFound.Environment | The environment does not exist. |
本页内容是否解决了您的问题?