tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AssociateDDoSEipAddress

Last updated: 2024-07-01 09:55:40

    1. API Description

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

    This API is used to bind an EIP to an Anti-DDoS Advanced instance or a specified private IP of an ENI.

    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: AssociateDDoSEipAddress.
    Version Yes String Common Params. The value used for this API: 2020-03-09.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Anti-DDoS instance ID (only Anti-DDoS Advanced). For example, bgpip-0000011x.
    Eip Yes String EIP of the Anti-DDoS instance ID
    CvmInstanceID Yes String Instance ID to bind. For example, ins-11112222. It can be queried in the console or obtained from InstanceId returned by DescribeInstances.
    CvmRegion Yes String Region of the CVM instance. For example, ap-hongkong.

    3. Output Parameters

    Parameter Name Type Description
    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 EIPs to Anti-DDoS Advanced instances

    Input Example

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

{
    "InstanceId": "bgpip-0000011x",
    "Eip": "1.1.1.1",
    "CvmInstanceID": "ins-11112222",
    "CvmRegion": "ap-hongkong"
}

    Output Example

    {
    "Response": {
        "RequestId": "5063ab0a-a8a7-41e8-ace2-263b2c1c8794"
    }
}

    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 CAM signature/authentication error.
    DryRunOperation The DryRun operation means that the request will be successful, but an extra DryRun parameter is passed.
    FailedOperation Operation failed.
    InternalError Internal error. Please try again later.
    InvalidParameter Parameter error.
    InvalidParameterValue Invalid parameter value.
    LimitExceeded The quota limit should not be exceeded.
    MissingParameter Missing parameters. Please check and try again.
    OperationDenied Operation denied.
    RequestLimitExceeded The number of requests should not exceed the frequency limit.
    ResourceInUse The resource is occupied.
    ResourceInsufficient Insufficient resource.
    ResourceNotFound The resource does not exist. Please try again later.
    ResourceUnavailable The resource is unavailable.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation The operation is unauthorized.
    UnknownParameter Unknown parameter error. Please check and try again.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy