tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeReserveIpAddresses

Last updated: 2024-11-25 20:07:16

1. API Description

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

This API is used to query reserved private IP addresses.

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: DescribeReserveIpAddresses.
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.
ReserveIpIds.N No Array of String List of unique IDs of reserved private IP addresses.
Filters.N No Array of Filter Filter criteria. ReserveIpIds and Filters cannot be specified at the same time.

reserve-ip-id - String - (Filter criteria) Unique ID of a reserved private IP address, for example, rsvip-pvqgv9vi.
vpc-id - String - (Filter criteria) VPC instance ID, for example, vpc-f49l6u0z.
subnet-id - String - (Filter criteria) Subnet instance ID, for example, subnet-f49l6u0z.
address-ip - String - (Filter criteria) Reserved private IP address, for example, 192.168.0.10.
ip-type - String - (Filter criteria) Business type (IpType), for example, 0.
name - String - (Filter criteria) Name.
state - String - (Filter criteria) Status. Valid values: Bind and UnBind.
resource-id - String - (Filter criteria) Bound instance resource, for example, eni-059qmnif.
tag-key - String - (Filter criteria) Tag key.
tag:tag-key - String - (Filter criteria) Tag key-value pair. Replace tag-key with the specific tag key.
Offset No Integer Offset.
Limit No Integer Number of request objects.

3. Output Parameters

Parameter Name Type Description
ReserveIpAddressSet Array of ReserveIpAddressInfo Information returned from the reserved private IP address.
TotalCount Integer Number of reserved private IP addresses returned.
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 Querying Reserved Private IP Addresses

This example shows you how to query reserved private IP addresses.

Input Example

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

{
    "ReserveIpIds": [
        "rsvip-eaq2f4pc",
        "rsvip-2g134x24"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "2d32beeb-0750-4ef9-a2f9-e4e7bbb0ec7f",
        "ReserveIpAddressSet": [
            {
                "CreatedTime": "2024-11-06 12:01:57",
                "Description": "desc_ivan",
                "IpType": 0,
                "Name": "name_ivan",
                "ReserveIpAddress": "10.0.5.99",
                "ReserveIpId": "rsvip-eaq2f4pc",
                "ResourceId": "",
                "State": "UnBind",
                "TagSet": [],
                "VpcId": "vpc-mcqaoy0f"
            },
            {
                "CreatedTime": "2024-11-06 12:01:57",
                "Description": "desc_ivan",
                "IpType": 0,
                "Name": "name_ivan",
                "ReserveIpAddress": "10.0.5.50",
                "ReserveIpId": "rsvip-2g134x24",
                "ResourceId": "",
                "State": "UnBind",
                "TagSet": [],
                "VpcId": "vpc-mcqaoy0f"
            }
        ],
        "TotalCount": 2
    }
}

Example2 Filtering and Querying Reserved Private IP Addresses by Tag

This example shows you how to filter and query reserved private IP addresses by tag.

Input Example

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

{
    "Filters": [
        {
            "Name": "tag-key",
            "Values": [
                "ivan_reserve_ip"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "e168d943-d647-4c0a-ada4-50a90015ded8",
        "ReserveIpAddressSet": [
            {
                "CreatedTime": "2024-11-06 17:30:06",
                "Description": "desc_ivan",
                "IpType": 0,
                "Name": "name_ivan",
                "ReserveIpAddress": "10.0.5.89",
                "ReserveIpId": "rsvip-du6lo6fu",
                "ResourceId": "",
                "State": "UnBind",
                "TagSet": [
                    {
                        "Key": "ivan_reserve_ip",
                        "Value": "hello"
                    }
                ],
                "VpcId": "vpc-mcqaoy0f"
            }
        ],
        "TotalCount": 1
    }
}

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
InternalError.ModuleError Internal module error
InvalidParameter.Coexist The parameters cannot be specified at the same time.
InvalidParameter.FilterInvalidKey The specified filter condition does not exist.
InvalidParameter.FilterNotDict The specified filter condition should be a key-value pair.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.ResourceNotFound This resource is not found.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy