tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateBoundIP

Last updated: 2024-07-01 09:54:41

    1. API Description

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

    This API is used to bind an IP to an Anti-DDoS Pro instance Both single IP instances and multi-IP instances are available. Note that you should wait until the current binding or unbinding completes before using this async API for new operations.

    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: CreateBoundIP.
    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.
    Business Yes String Anti-DDoS service type. bgp: Anti-DDoS Pro (Single IP); bgp-multip: Anti-DDoS Pro (Multi-IP)
    Id Yes String Anti-DDoS instance ID
    BoundDevList.N No Array of BoundIpInfo Array of IPs to bind to the Anti-DDoS instance. For Anti-DDoS Pro Single IP instance, the array contains only one IP. If there are no IPs to bind, it is empty; however, either BoundDevList or UnBoundDevList must not be empty.
    UnBoundDevList.N No Array of BoundIpInfo Array of IPs to unbind from the Anti-DDoS instance. For Anti-DDoS Pro Single IP instance, the array contains only one IP; if there are no IPs to unbind, it is empty; however, either BoundDevList or UnBoundDevList must not be empty.
    CopyPolicy No String Disused

    3. Output Parameters

    Parameter Name Type Description
    Success SuccessCode Success code
    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 an IP to an Anti-DDoS Pro instance

    Input Example

    https://antiddos.tencentcloudapi.com/?Action=CreateBoundIP
&Business=bgp
&Id=bgp-000000xe
&BoundDevList.0.Ip=1.1.1.1
&BoundDevList.0.BizType=public
&BoundDevList.0.DeviceType=cvm
&BoundDevList.0.InstanceId=ins-f2f9ssbo
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "Success": {
            "Code": "Success",
            "Message": "Success"
        }
    }
}

    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
    LimitExceeded The quota limit should not be exceeded.
    ResourceInUse The resource is occupied.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy