tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CreateReserveIpAddresses

最后更新时间：2024-11-25 20:07:24

1. API Description

Domain name for API request: vpc.intl.tencentcloudapi.com.

This API is used to create a reserved private IP address.

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: CreateReserveIpAddresses.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
VpcId Yes String Unique ID of the VPC.
IpAddresses.N No Array of String Reserved private IP address to be applied for.
IpAddressCount No Integer Number of reserved private IP addresses that can be automatically assigned with no IP address specified.
SubnetId No String Unique ID of the subnet.
Name No String Name of the reserved private IP address.
Description No String Description of the reserved private IP address.
Tags.N No Array of Tag List of tags to be bound, for example, [{"Key": "city", "Value": "shanghai"}].
ClientToken No String A string used to ensure the idempotence of the request. This string is generated by the customer and should be unique across different requests, with a maximum length of 64 ASCII characters. If this parameter is not specified, the idempotence of the request cannot be guaranteed.

3. Output Parameters

Parameter Name Type Description
ReserveIpAddressSet Array of ReserveIpAddressInfo Information returned from the reserved private IP address.
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 Applying for Automatic Assignment of a Specified Number of Reserved Private IP Addresses

This example shows you how to apply for automatic assignment of a specified number of reserved private IP addresses.

Input Example

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

{
    "VpcId": "vpc-mcqaoy0f",
    "IpAddressCount": 2,
    "Name": "name_ivan",
    "Description": "desc_ivan"
}

Output Example

{
    "Response": {
        "RequestId": "14c27c62-fc90-4922-a20c-fca60c6b5330",
        "ReserveIpAddressSet": [
            {
                "CreatedTime": "2024-11-21 16:57:22",
                "Description": "desc_ivan",
                "IpType": 0,
                "Name": "name_ivan",
                "ReserveIpAddress": "10.0.5.99",
                "ReserveIpId": "rsvip-eaq2f4pc",
                "ResourceId": "",
                "State": "UnBind",
                "VpcId": "vpc-mcqaoy0f"
            },
            {
                "CreatedTime": "2024-11-21 16:57:22",
                "Description": "desc_ivan",
                "IpType": 0,
                "Name": "name_ivan",
                "ReserveIpAddress": "10.0.5.50",
                "ReserveIpId": "rsvip-2g134x24",
                "ResourceId": "",
                "State": "UnBind",
                "VpcId": "vpc-mcqaoy0f"
            }
        ]
    }
}

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
InvalidParameterValue The parameter value is invalid.
MissingParameter Missing parameter.
UnknownParameter Unknown parameter error.
UnknownParameter.WithGuess Unknown parameter. Try similar parameters.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款