Forwarding Rules API¶
GET Get Package Details¶
GET /cdn/layer4/rules/getPackageDetails/{oid}
Request Parameters¶
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| oid | path | string | Yes | Represents a package |
| Authorization | header | string | No | none |
Example Response
200 Response
{
"msg": "Operation successful",
"code": 200,
"data": {
"oid": "123456789",
"isTest": 0,
"alias": "",
"name": "Test TCP Package",
"cname": "",
"fdesc": "",
"nodes": [["123456789_0000-tcp.demo.om", "line_0"]],
"ctime": 1682319372,
"utime": 1682319372,
"packages": [
{
"name": "Layer 4 DDoS Protection Package",
"alias": "123",
"oid": "123456789"
}
],
"activate": 1,
"mday": "2024-04-26",
"consumptionPort": 2003,
"totalPort": 65535,
"isParsing": "off"
}
}
401 Response
Responses¶
| Status Code | Status Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | Inline |
| 403 | Forbidden | none | Inline |
| 404 | Not Found | none | Inline |
Response Data Structure¶
Status Code 200
| Name | Type | Required | Constraints | Chinese Name | Description |
|---|---|---|---|---|---|
| » msg | string | true | none | none | |
| » code | integer | true | none | none | |
| » data | object | true | none | none | |
| »» oid | string | true | none | Current package | none |
| »» isTest | integer | true | none | Package Type | 0:Test status 1:Official status |
| »» alias | string | true | none | Alias | none |
| »» name | string | true | none | Package name | none |
| »» nodes | [array] | true | none | Instances | none |
| »» ctime | integer | true | none | Creation time | none |
| »» packages | [object] | true | none | Package array | Used for switching data between different packages |
| »»» name | string | true | none | Name | none |
| »»» alias | string | true | none | Alias | none |
| »»» oid | string | true | none | Value | none |
| »» mday | string | true | none | Expiry date | none |
| »» consumptionPort | integer | true | none | Port usage | none |
| »» totalPort | integer | true | none | Total ports | none |