tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TDMQ for Pulsar
    Documentation
    Download PDF

    CreateEnvironmentRole

    Last updated: 2023-08-09 14:43:30
    Download PDF

    1. API Description

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

    This API is used to create an environment role.

    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: CreateEnvironmentRole.
    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.
    RoleName Yes String Role name.
    Permissions.N Yes Array of String Permissions, which is a non-empty string array of produce and consume at the most.
    ClusterId No String Cluster ID (required)

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating environment role

    Input Example

    https://tdmq.tencentcloudapi.com/?Action=CreateEnvironmentRole
&RoleName=test_role_1
&EnvironmentId=default
&Permissions.0=produce
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "gggxxxx"
    }
}

    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.CreateEnvironmentRole Failed to create the environment role.
    FailedOperation.UpdateEnvironmentRole Failed to update the environment role.
    InvalidParameterValue.InvalidParams The parameter value is out of the value range.
    MissingParameter.NeedMoreParams A required parameter is missing.
    ResourceInUse The resource is in use.
    ResourceInUse.EnvironmentRole The environment role already exists.
    ResourceNotFound.Cluster The cluster does not exist.
    ResourceNotFound.Environment The environment does not exist.
    ResourceNotFound.Role The role does not exist.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy