Batch detach network instances - DetachUGNNetworks

Overview

Batch detach network instances

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DetachUGNNetworks`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
ProjectId	string	Project ID. If left blank, the default project will be used. Sub-accounts must fill in this field. Please refer to the GetProjectList	Yes
UGNID	string	UGNID	Yes
Networks.N	string	NetworkID	Yes

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
Networks	array[Network]	Array, with each element containing the following fields: NetworkID: string, network instance ID, such as uvnet-xxxx; Type: string, network instance type, with enumerated values: VPC/UCVR/...; Region: string, region to which the network instance belongs, such as cn-sh2; OrgName: string, project name to which the network instance belongs, such as org-xxx	Yes

Data Model

Network

Field Name	Type	Description Information	Required
Region	string	Region of the Network Instance	Yes
NetworkID	string	ID of the network instance, such as vnet-xxxxx	Yes
Name	string	Network Instance Name	Yes
Type	string	Network Instance Type: VPC/UCVR/...	Yes
OrgName	string	Project name where the network instance is located	Yes
RegionID	int	Region ID of the network instance	No
OrgID	int	ID of the project where the network instance is located	No
VNI	int	The unique identifier of the network instance, such as the tunnel_id of vpc	No
InsertTime	int	Creation Time	No

Example

Request Example

https://api.surfercloud.com/?Action=DetachUGNNetworks
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=OYrJdefD
&UGNID=PFsyuYNs
&Networks.N=XYZqarpI
&ProjectId=xAWefAzC

Response Example

{
  "Action": "DetachUGNNetworksResponse",
  "Message": "vwQGcwaD",
  "Networks": [
    {
      "CreateTime": "KSPTmeyt",
      "Name": "RBmdyKKH",
      "NetworkID": "MXqqOBna",
      "RegionID": "cn-zj",
      "Type": "CorznUMt",
      "VNI": 3
    }
  ],
  "RetCode": 0
}

DescribeSimpleUGN EnableRoutePolicy