Docs
api
Cloud Network(UGN)
ListUGN

Get UGN resource list - ListUGN

Overview

Get all UGN resources under the current project

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListUGN.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.Yes
LimitintPage size, default is 20No
OffsetintOffset, default 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
UGNsarray[UGN]Yes
TotalCountintNo
OffsetintNo
LimitintNo

Data Model

UGN

Field NameTypeDescription InformationRequired
UGNIDstringUGN Resource IDYes
NamestringUGN NameYes
RemarkstringUGN NotesYes
CreateTimeintCreation Time of Cloud NetworkYes
NetworkCountintAssociated Network Instance QuantityYes
BwPackageCountintNumber of Bound Bandwidth PackagesYes

Example

Request Example

https://api.dezai.com/?Action=GetUGNLists
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=Uwdjwjay
&PageSize=8
&Page=6
&UGNID=WwZYkmsO
&ProjectId=WjWMQqHg

Response Example

{
  "Action": "ListUGNResponse",
  "Instances": [
    {
      "CreateTime": 5,
      "Instances": [
        "NMwjIrsh"
      ],
      "InterRegionBandwidths": [
        "fVZVRYGy"
      ],
      "Name": "jVivsVdF",
      "Remark": "aNvxOLBM",
      "RouteRules": [
        "KlTczjrb"
      ],
      "Tag": "vebDnrWg",
      "UGNId": "SdLBDxvC"
    }
  ],
  "Message": "PQjUPsBS",
  "Page": 3,
  "PageSize": 5,
  "RetCode": 0,
  "TotalCount": 4
}