Skip to main content
ZStack
Resource Center/Network Resource/Route Resource Operations/vRouter Route Table Operations

AddVRouterRouteEntry

AddVRouterRouteEntry

POST/zstack/v1/vrouter-route-tables/{routeTableUuid}/route-entries

Operation ID

AddVRouterRouteEntry

Since

2.1

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • routeTableUuid
    StringRequired

    The vRouter route table UUID.

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • description
      String

      Optional. The detailed description of the resource.

    • type
      String

      Optional. The type. You can add two types of routes: static route and black hole route. The system will automatically determine the type by judging whether to enter the next hop.

    • destination
      StringRequired

      The destination network address, in CIDR format. If you enter a non-standard CIDR, note that the system will automatically transform it to the standard CIDR format.

    • target
      String

      Optional. The next hop address. The IP address that can be accessed directly by vRouter VM instances. If the IP address cannot be accessed directly, the route recursion will be triggered.

    • distance
      Integer

      Optional. The route priority. In the minimum match mode, if multiple route rules are available, the rule with the lowest integer has the highest priority to be matched.

    • resourceUuid
      String

      Optional. The resource UUID.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventory
    VRouterRouteEntryInventoryRequired

    See inventory.

    • uuid
      StringRequired

      The resource UUID.

    • description
      StringRequired

      The detailed description of the resource.

    • type
      StringRequired

      The type. You can add two types of routes: static route and black hole route. The system will automatically determine the type by judging whether to enter the next hop.

    • routeTableUuid
      StringRequired

      The vRouter route table UUID.

    • destination
      StringRequired

      The destination network address.

    • target
      StringRequired

      The next hop address. The IP address that can be accessed directly by vRouter VM instances. If the IP address cannot be accessed directly, the route recursion will be triggered.

    • distance
      IntegerRequired

      The route priority. In the minimum match mode, if multiple route rules are available, the rule with the lowest integer has the highest priority to be matched.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.