tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

BindEnvironment

Last updated: 2024-10-10 21:40:41

    1. API Description

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

    This API is used to bind a usage plan to a service or API.
    After you publish a service to an environment, if the API requires authentication and can be called only when it is bound to a usage plan, you can use this API to bind a usage plan to the specified environment.
    Currently, a usage plan can be bound to an API; however, under the same service, usage plans bound to a service and usage plans bound to an API cannot coexist. Therefore, in an environment to which a service-level usage plan has already been bound, please use the DemoteServiceUsagePlan API to degrade it.

    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: BindEnvironment.
    Version Yes String Common Params. The value used for this API: 2018-08-08.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    UsagePlanIds.N Yes Array of String List of unique IDs of the usage plans to be bound.
    BindType Yes String Binding type. Valid values: API, SERVICE. Default value: SERVICE.
    Environment Yes String Environment to be bound.
    ServiceId Yes String Unique ID of the service to be bound.
    ApiIds.N No Array of String Unique API ID array, which is required if bindType is API.

    3. Output Parameters

    Parameter Name Type Description
    Result Boolean Whether binding succeeded.
    Note: this field may return null, indicating that no valid values can be obtained.
    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.

    4. Example

    Example1 Binding a usage plan

    Input Example

    https://apigateway.tencentcloudapi.com/?Action=BindEnvironment
&BindType=SERVICE
&Environment=test
&ServiceId=service-ody35h5e
&UsagePlanIds.0=usagePlan-quqxvett
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Result": true,
        "RequestId": "a6c567f9-7a55-43b9-81d2-f721da5e271a"
    }
}

    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
    FailedOperation.ServiceError Service error.
    InternalError.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
    InvalidParameter.FormatError Incorrect parameter format.
    InvalidParameterValue.InvalidApiIds Incorrect API ID
    LimitExceeded.RequestLimitExceeded The request frequency has reached the limit. Please try again later.
    ResourceNotFound.InvalidApi Incorrect ApiId.
    ResourceNotFound.InvalidService The corresponding service is invisible.
    ResourceNotFound.InvalidUsagePlan The usage plan does not exist.
    UnsupportedOperation.UnsupportedBindEnvironment The environment cannot be bound.
    UnsupportedOperation.UnsupportedUnBindEnvironment The environment cannot be unbound, as there are APIs that are not bound to a usage plan.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy