Docs
api
Private Network(UVPC)
EnableWhiteList

Modify NAT Gateway Whitelist Switch - EnableWhiteList

Overview

Modify NAT Gateway Whitelist Switch

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is EnableWhiteList.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.No
NATGWIdstringNAT Gateway IdYes
IfOpenintWhitelist switch flag. 0: Off; 1: On. Default is 0.Yes

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

Example

Request Example

https://api.ucloud-global.com/?Action=EnableWhiteList
&Region=cn-bj222
&ProjectId=xxxx
&NATGWId=LtarYISU
&IfOpen=0

Response Example

{
  "Action": "EnableWhiteListResponse",
  "RetCode": 0
}