Skip to main content
API Explorer|API Explorer
Resource Center/Network Resource/Policy Routing Operations
GETPolicy Routing OperationsSince 3.9.0SynchronousAuth Required

GetPolicyRouteRuleSetFromVirtualRouter

GetPolicyRouteRuleSetFromVirtualRouter

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • vmInstanceUuidStringRequired

    The VM instance UUID.

Query Parameters

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

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

    • codeStringRequired

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

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

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

  • inventoriesListRequired

    See inventories.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • typeStringRequired

      类型。

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • rulesListRequired

      See rules.

      • uuidStringRequired

        The resource UUID.

      • ruleNumberintRequired

        规则数量。

      • ruleSetUuidStringRequired

        规则设置UUID。

      • tableUuidStringRequired

        No description provided.

      • destIpStringRequired

        No description provided.

      • sourceIpStringRequired

        源IP地址。

      • destPortStringRequired

        No description provided.

      • sourcePortStringRequired

        源端口。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • protocolPolicyRouteRuleProtocolRequired

        See protocol.

        • tcpPolicyRouteRuleProtocolRequired

          No description provided.

        • udpPolicyRouteRuleProtocolRequired

          No description provided.

      • statePolicyRouteRuleStateRequired

        See state.

        • enablePolicyRouteRuleStateRequired

          启用。

        • disablePolicyRouteRuleStateRequired

          禁用。

    • l3RefsListRequired

      See l3Refs.

      • idlongRequired

        资源ID。

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • ruleSetUuidStringRequired

        规则设置UUID。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

GET/zstack/v1/policy-routes/rulesets/virtualrouter/{vmInstanceUuid}

/zstack/v1/policy-routes/rulesets/virtualrouter/{vmInstanceUuid}

Operation ID

GetPolicyRouteRuleSetFromVirtualRouter

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/policy-routes/rulesets/virtualrouter/{vmInstanceUuid}?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "de191bb7f4763ce580fd7e2ed457cde8", "name": "policy-rule-set", "description": "policy rule set", "type": "User", "rules": [], "l3Refs": [] } ] }

Change History

This API has no change history records yet.

View all change history