docs
api
Basic Network(UNet)
DescribePrivateIP

DescribePrivateIP - DescribePrivateIP

Overview

Obtain PrivateIP information for resource binding

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribePrivateIP.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.Yes
VPCIdstringThe ID of the VPCNo
SubnetIdstringThe subnet IDNo
ObjectIdstringThe object ID of UNI;When the Objectid is empty, obtain the primary and secondary IP information of all virtual network cards under the projectNo
LimitintQuantity of information obtained, default to 20;Not allowed to be 0No
OffsetintList start offset, default to 0No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
TotalCountintReturn resource quantityYes
DataSetarray[DescribeSecondaryIPDataSet]Detailed information of PrivateIPYes

Data Model

DescribeSecondaryIPDataSet

Field NameTypeDescription InformationRequired
PrivateIPTypestringType of internal network IP; Enumerated values: PrimaryIP: Main internal network IP, SecondaryIP: Auxiliary internal network IPNo
VPCIDstringVPCIDNo
EIPstringEIPNo
ResourceIDstringResource IDNo
ResourceNamestringResource NameNo
PrivateIPstringPrivate IPNo
SubnetIDstringSubnet IDNo
EIPIdstringEIP Resource IDNo

Example

Request Example

https://api.surfercloud.com/?Action=DescribePrivateIP
&Region=cn-bj2
&ProjectId=org-XXXXX
&VPCId=vnet-XXXXX
&SubnetId=subnet-XXXXX
&ObjectId=uni-XXXXX
&Offset=0
&Limit=10

Response Example

{
  "Action": "DescribePrivateIPResponse",
  "DataSet": [
    {
      "EIP": "X.X.X.X",
      "EIPId": "eip-XXXXX",
      "PrivateIP": "X.X.X.X",
      "PrivateIPType": "PrimaryIP",
      "ResourceID": "uni-XXXXX",
      "ResourceName": "test-1",
      "SubnetID": "subnet-XXXXX",
      "VPCID": "uvnet-XXXXX"
    },
    {
      "EIP": "",
      "EIPId": "",
      "PrivateIP": "X.X.X.X",
      "PrivateIPType": "SecondaryIP",
      "ResourceID": "uni-XXXXX",
      "ResourceName": "test-1",
      "SubnetID": "subnet-XXXXX",
      "VPCID": "uvnet-XXXXX"
    }
  ],
  "RetCode": 0,
  "TotalCount": 2
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.