docs
api
Cloud Network(UGN)
UpdateRoutePolicy

Modify Routing Policy - UpdateRoutePolicy

Overview

Modify Routing Policy

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is UpdateRoutePolicy.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
ProjectIdstringProject ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the GetProjectList APIYes
UGNIDstringUGN Instance IDYes
Policy.PolicyIdstringRouting Policy IDYes
Policy.NamestringPolicy Name, limited to 255 charactersNo
Policy.DirectionstringPolicy direction, limited values: "In"/"OutNo
Policy.PriorityintPolicy priority, range: [1,255], the smaller the value, the higher the priority. In the same direction, policy priorities cannot be duplicated.No
Policy.ActionstringPolicy execution actions, restricted values: "Permit"/"Deny"No
Policy.RoutePriorityintWhen the action is "Permit", set the routing priority for the matched routes, range: [1,255], with smaller values indicating higher priority.No
SrcRegions.NstringThe array of regions where the routes to be matched by the routing policy are locatedNo
SrcNetworkTypes.NstringThe array of network instance types for routes that need to match the routing policy, limited to the value: "VPCNo
SrcNetworks.N.NetworkIdstringArray of network instance IDs for the routing policy to matchNo
Prefixes.NstringThe array of network segments under the network instance of the route that needs to be matched by the routing policyNo
DstNetworkTypes.NstringArray of network instance types that the routing policy needs to apply to, limited to the value: "VPCNo
DstNetworks.N.NetworkIdstringArray of network instance IDs that the routing policy needs to apply toNo

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.surfercloud.com/?Action=UpdateRoutePolicy
&ProjectId=EQAZLuPL
&UGNID=SKPFqLiQ
&Policy.PolicyId=AVXBdPux
&Policy.Direction=ylmeXuIv
&Policy.Priority=2
&Policy.Action=uuvJNtOH
&Policy.RoutePriority=9
&Policy.SrcRegions.n=7
&Policy.SrcNetworkTypes.n=yuJrxWqH
&Policy.SrcNetworks.n.NetworkId=ZaNqcstG
&Policy.SrcNetworks.n.Prefixes.n=BNHNIAkv
&Policy.DstNetworkTypes.n=nYLLCpvL
&Policy.DstNetworks.n.NetworkId=FRfzTgwJ
&Policy.Name=KCQlOqzq

Response Example

{
  "Action": "UpdateRoutePolicyResponse",
  "Policies": [
    {
      "Action": "AwZDVVAZ",
      "Direction": "aBjehwSB",
      "DstNetworkTypes": [
        "RAEkuDrc"
      ],
      "DstNetworks": [
        {
          "NetworkId": "BemGsZrk",
          "Prefixes": [
            "xuWLesLI"
          ]
        }
      ],
      "Enabled": false,
      "PolicyId": "CJnQwTDh",
      "Priority": 3,
      "Region": 3,
      "RoutePriority": 8,
      "SrcNetworkTypes": [
        "ySwFhOIV"
      ],
      "SrcNetworks": [
        {
          "NetworkId": "KZOyuKxH",
          "Prefixes": [
            "zAYqRNUG"
          ]
        }
      ],
      "SrcRegions": [
        5
      ]
    }
  ],
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved