tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyEnvironmentAttributes

Last updated: 2023-08-09 14:43:27

1. API Description

Domain name for API request: tdmq.tencentcloudapi.com.

This API is used to modify the attributes of the specified namespace.

A maximum of 20 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: ModifyEnvironmentAttributes.
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 Namespace name.
MsgTTL Yes Integer Retention period for unconsumed messages in seconds. Value range: 60s to 1,296,000s (or 15 days).
Remark No String Remarks (up to 128 characters).
ClusterId No String Cluster ID
RetentionPolicy No RetentionPolicy Message retention policy
AutoSubscriptionCreation No Boolean Whether to enable "Auto-Create Subscription"

3. Output Parameters

Parameter Name Type Description
EnvironmentId String Namespace name.
MsgTTL Integer TTL for unconsumed messages in seconds.
Remark String Remarks (up to 128 characters).
Note: this field may return null, indicating that no valid values can be obtained.
NamespaceId String Namespace ID
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the attributes of a specified namespace

This example shows you how to modify the attributes of a specified namespace.

Input Example

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

{
    "EnvironmentId": "test",
    "MsgTTL": "100",
    "ClusterId": "pulsar-xxxxxxxx"
}

Output Example

{
    "Response": {
        "EnvironmentId": "test",
        "NamespaceId": "namespace-5r59xen74x",
        "MsgTTL": 100,
        "Remark": "",
        "RequestId": "7db00a30-933c-4f6f-bba9-79cdf6be7d8c"
    }
}

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
AuthFailure.UnauthorizedOperation CAM authentication failed.
FailedOperation Operation failed.
FailedOperation.SetRetentionPolicy Failed to set the message retention policy.
FailedOperation.SetTTL Failed to configure the message TTL.
FailedOperation.UpdateEnvironment Failed to update the environment.
InternalError.BrokerService The broker service is exceptional.
InternalError.SystemError System error.
InvalidParameterValue.InvalidParams The parameter value is out of the value range.
InvalidParameterValue.TTL The message TTL value is invalid.
LimitExceeded.RetentionTime The message retention period limit has been exceeded. Please enter a valid value.
MissingParameter.NeedMoreParams A required parameter is missing.
OperationDenied.DefaultEnvironment Operations on the default environment are not allowed.
ResourceNotFound.Cluster The cluster does not exist.
ResourceNotFound.Environment The environment does not exist.
ResourceNotFound.Namespace The namespace does not exist.
ResourceUnavailable.FundRequired You must top up before proceeding.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy