tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AssignPrivateIpAddresses

Last updated: 2023-08-18 14:28:14

1. API Description

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

This API is used to apply for a private IP for 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: AssignPrivateIpAddresses.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
NetworkInterfaceId Yes String ENI instance ID, such as eni-m6dyj72l.
EcmRegion Yes String ECM region, such as ap-xian-ecm.
PrivateIpAddresses.N No Array of PrivateIpAddressSpecification Information of the specified private IPs. You can specify up to 10 IPs at a time. You must provide either this parameter or SecondaryPrivateIpAddressCount, or both.
SecondaryPrivateIpAddressCount No Integer Number of private IP addresses applied for. You must provide either this parameter or PrivateIpAddresses, or both. The total number of private IP addresses cannot exceed the quota.

3. Output Parameters

Parameter Name Type Description
PrivateIpAddressSet Array of PrivateIpAddressSpecification Private IP details.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Applying for private IP for ENI

Input Example

https://ecm.tencentcloudapi.com/?Action=AssignPrivateIpAddresses
&NetworkInterfaceId=eni-12121212
&SecondaryPrivateIpAddressCount=2
&EcmRegion=ap-hangzhou-ecm
&<Common request parameters>

Output Example

{
    "Response": {
        "PrivateIpAddressSet": [
            {
                "PrivateIpAddress": "172.16.32.237"
            },
            {
                "PrivateIpAddress": "172.16.32.84"
            }
        ],
        "RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
    }
}

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.InternalOperationFailure Internal error.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.InvalidPublicParam The common parameter is invalid.
InvalidParameterValue.InvalidRegion The ECM region is invalid.
InvalidParameterValue.Malformed The input parameter format is invalid.
InvalidParameterValue.Range The parameter value is not in the specified range.
LimitExceeded.PrivateIPQuotaLimitExceeded The number of private IPs exceeds the limit.
ResourceInUse The resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
UnsupportedOperation.InvalidState The resource status is invalid.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy