Jump to

• Request
• Response

Export PCC Rules

get

ss/oc-cnpolicy-configuration/v1/policydata/pcfsm/pccrules/export

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : PccRuleIEData

Type: object

Title: PccRuleIEData

Show Source

• date(optional): string
• errors(optional): array errors
• exportData: array exportData
• key(optional): string
• sourceVersion(optional): string
• topic: string

{
    "type":"object",
    "required":[
        "exportData",
        "topic"
    ],
    "properties":{
        "date":{
            "type":"string"
        },
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ImportExportErrorMessage"
            }
        },
        "exportData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PccRule"
            }
        },
        "key":{
            "type":"string"
        },
        "sourceVersion":{
            "type":"string"
        },
        "topic":{
            "type":"string"
        }
    },
    "title":"PccRuleIEData"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object ImportExportErrorMessage
  Title: ImportExportErrorMessage

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ImportExportErrorMessage"
    }
}

Nested Schema : exportData

Type: array

Show Source

• Array of: object PccRule
  Title: PccRule

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PccRule"
    }
}

Nested Schema : ImportExportErrorMessage

Type: object

Title: ImportExportErrorMessage

Show Source

• message(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"ImportExportErrorMessage"
}

Nested Schema : PccRule

Type: object

Title: PccRule

Show Source

• afSigProtocol(optional): string
  Allowed Values: [ "NO_INFORMATION", "SIP" ]
• appId(optional): string
• appReloc(optional): boolean
• contVer(optional): string
• description(optional): string
• flowInfos(optional): array flowInfos
• name: string
• pccRuleId: string
• precedence(optional): string
• refChgData(optional): array refChgData
• refCondData(optional): string
• refQosData(optional): array refQosData
• refTcData(optional): array refTcData
• refUmData(optional): array refUmData
• type: string
  Allowed Values: [ "DYNAMIC", "PREDEFINED" ]

{
    "type":"object",
    "required":[
        "name",
        "pccRuleId",
        "type"
    ],
    "properties":{
        "afSigProtocol":{
            "type":"string",
            "enum":[
                "NO_INFORMATION",
                "SIP"
            ]
        },
        "appId":{
            "type":"string"
        },
        "appReloc":{
            "type":"boolean"
        },
        "contVer":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "flowInfos":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FlowInfos"
            }
        },
        "name":{
            "type":"string"
        },
        "pccRuleId":{
            "type":"string"
        },
        "precedence":{
            "type":"string"
        },
        "refChgData":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "refCondData":{
            "type":"string"
        },
        "refQosData":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "refTcData":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "refUmData":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "type":{
            "type":"string",
            "enum":[
                "DYNAMIC",
                "PREDEFINED"
            ]
        }
    },
    "title":"PccRule"
}

Nested Schema : flowInfos

Type: array

Show Source

• Array of: object FlowInfos
  Title: FlowInfos

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FlowInfos"
    }
}

Nested Schema : refChgData

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : refQosData

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : refTcData

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : refUmData

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : FlowInfos

Type: object

Title: FlowInfos

Show Source

• ethFlowDescription(optional): object EthFlowDescription
  Title: EthFlowDescription
• flowDescription(optional): string
• flowDirection(optional): string
  Allowed Values: [ "BIDIRECTIONAL", "DOWNLINK", "UNSPECIFIED", "UPLINK" ]
• flowLabel(optional): string
• name: string
• packetFilterUsage(optional): boolean
• packFiltId(optional): string
• spi(optional): string
• tosTrafficClass(optional): string

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "ethFlowDescription":{
            "$ref":"#/definitions/EthFlowDescription"
        },
        "flowDescription":{
            "type":"string"
        },
        "flowDirection":{
            "type":"string",
            "enum":[
                "BIDIRECTIONAL",
                "DOWNLINK",
                "UNSPECIFIED",
                "UPLINK"
            ]
        },
        "flowLabel":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "packFiltId":{
            "type":"string"
        },
        "packetFilterUsage":{
            "type":"boolean"
        },
        "spi":{
            "type":"string"
        },
        "tosTrafficClass":{
            "type":"string"
        }
    },
    "title":"FlowInfos"
}

Nested Schema : EthFlowDescription

Type: object

Title: EthFlowDescription

Show Source

• destMacAddr(optional): string
  enter a MAC address ,such as'3D-F2-C9-A6-B3-4F'.
• ethType(optional): string
• fDesc(optional): string
• fdesc(optional): string
• fDir(optional): string
  Allowed Values: [ "BIDIRECTIONAL", "DOWNLINK", "UNSPECIFIED", "UPLINK" ]
• fdir(optional): string
  Allowed Values: [ "BIDIRECTIONAL", "DOWNLINK", "UNSPECIFIED", "UPLINK" ]
• sourceMacAddr(optional): string
  enter a MAC address ,such as'3D-F2-C9-A6-B3-4F'
• vlanTags(optional): array vlanTags

{
    "type":"object",
    "properties":{
        "destMacAddr":{
            "type":"string",
            "description":"enter a MAC address ,such as'3D-F2-C9-A6-B3-4F'."
        },
        "ethType":{
            "type":"string"
        },
        "fDesc":{
            "type":"string"
        },
        "fDir":{
            "type":"string",
            "enum":[
                "BIDIRECTIONAL",
                "DOWNLINK",
                "UNSPECIFIED",
                "UPLINK"
            ]
        },
        "fdesc":{
            "type":"string"
        },
        "fdir":{
            "type":"string",
            "enum":[
                "BIDIRECTIONAL",
                "DOWNLINK",
                "UNSPECIFIED",
                "UPLINK"
            ]
        },
        "sourceMacAddr":{
            "type":"string",
            "description":"enter a MAC address ,such as'3D-F2-C9-A6-B3-4F'"
        },
        "vlanTags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"EthFlowDescription"
}

Nested Schema : vlanTags

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

429 Response

Too Many Requests

500 Response

Internal Server Error

503 Response

Service Unavailable

Back to Top