Skip to Content
云联网获取简洁版UGN详情 - DescribeSimpleUGN

获取简洁版UGN详情 - DescribeSimpleUGN

简介

获取简洁版UGN详情

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 DescribeSimpleUGNYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口No
UGNIDstringUGN IDYes

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
UGNUGNYes
Networksarray[SimpleNetwork]Yes
BwPackagesarray[SimpleBwPackage]Yes
Routesarray[SimpleRoute]Yes

数据模型

UGN

字段名类型描述信息必填
UGNIDstring云联网资源 IDYes
Namestring云联网名称Yes
Remarkstring云联网备注Yes
CreateTimeint云联网创建时间Yes
NetworkCountint关联网络实例数量Yes
BwPackageCountint绑定带宽包数量Yes

SimpleNetwork

字段名类型描述信息必填
Regionstring网络实例所在地域Yes
NetworkIDstring网络实例的ID，如 vnet-xxxxxYes
Namestring网络实例名称Yes
Typestring网络实例类型：VPC/HybridGW/…Yes
OrgNamestring网络实例所在项目名Yes
RegionIDint网络实例所在地域IDNo
OrgIDint网络实例所在项目的IDNo
CreateTimeintNo

SimpleBwPackage

字段名类型描述信息必填
PackageIDstringYes
UGNIDstringYes
PayModestring计费模式 FixedBw:固定带宽｜Peak95:经典95｜Max5:第五峰值｜Traffic:流量计费Yes
RegionAstring地域A名称Yes
RegionBstring地域B名称Yes
BandWidthfloat带宽值Yes
Qosstring服务质量
Diamond:钻石｜Platinum:铂金｜Gold:黄金		Yes
Pathstring智能路径
Delay:最低时延｜IGP:普通线路｜TCO:最低成本		Yes
CreateTimeint创建时间Yes
NamestringNo
RemarkstringNo
ExpireTimeint过期时间No
ChangeStatusint带宽包切换状态No
ChangeTimeint带宽包切换时间No
ChangePayModestring带宽包切换计费类型No

SimpleRoute

字段名类型描述信息必填
DstAddrstring目的网段No
NextHopIDstring下一跳网络实例 IDNo
NextHopTypestring下一跳网络实例类型No
NextHopRegionstring下一跳网络实例所属地域No
NextHopRegionIDint下一跳网络实例所属地域 idNo
Priorityint路由优先级No
Denybooleantrue: 由于命中路由策略而失效No
Restrictbooleantrue: 由于优先级比其他前缀相同的路由低而失效No
Conflictbooleantrue: 由于优先级相同但插入数据库的时间比其他前缀相同的路由晚而失效No
InPolicyIdstring匹配中的入向路由策略idNo
InPolicyNamestring匹配中的入向路由策略名称No
OutPolicyIdstring匹配中的出向路由策略idNo
OutPolicyNamestring匹配中的出向路由策略名称No

示例

请求示例

https://api.netlake.cn/?Action=DescribeSimpleUGN
&ProjectId=GoyMEaqI
&UGNID=BqXFlXPM

响应示例

{
  "Action": "DescribeSimpleUGNResponse",
  "BwPackages": [
    {
      "ChangePayMode": "pcnbFlpQ",
      "ChangeStatus": 6,
      "ChangeTime": 1,
      "CreateTime": 5,
      "ExpireTime": 9,
      "IsCrossBorder": true,
      "Message": "upqtoHLo",
      "Name": "BIueGIVJ",
      "PackageID": "vjpUMeWg",
      "Path": "TCO|IGP|Delay",
      "PayMode": "Free|SolidBw|Peak95|Max5|Traffic",
      "Qos": "金|银|铜",
      "RegionA": "dxBALSbx",
      "RegionABwMax": 8,
      "RegionABwMin": 5,
      "RegionB": "OTEAkkrX",
      "RegionBBwMax": 9,
      "RegionBBwMin": 6,
      "Remark": "xLwRqlaF",
      "UGNID": "IokLUMlQ"
    }
  ],
  "Message": "ekWmsxEt",
  "Networks": [
    {
      "NICs": [
        {
          "IP": "mDJBSJNd",
          "Mac": "vaxygoWB"
        }
      ]
    }
  ],
  "Policies": [
    "mgWCSWoN"
  ],
  "RetCode": 0,
  "Routes": [
    {
      "DstAddr": "MnPDhhax",
      "NexthopID": "TCwWNQyx",
      "NexthopRegion": "PzANTsVh",
      "NexthopRegionID": 1,
      "NexthopType": "NKCXpCxj",
      "Priority": 4
    }
  ],
  "UGN": {}
}
删除带宽包 - DeleteUGNBwPackage批量解除关联网络实例 - DetachUGNNetworks