1
0

fix: doc and interfaces

This commit is contained in:
2023-12-21 20:12:44 +08:00
parent 448aec4e86
commit 92a6e62f98
5 changed files with 4909 additions and 0 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,108 @@
---
---
# 核心网 HTTP RESTful API 服务接口/UE Management/NSSF Available AMF and Subscription
## GET Available AMFs List from NSSF
GET /api/rest/ueManagement/v1/elementType/nssf/objectType/availableAMFs
获取NSSF当前所有可用的AMF列表接口
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------------- |
| neId | query | string | yes | 网管发往网元的不用带NE ID |
| Referer | header | string | yes | Use the specified declared Referer |
| User-Agent | header | string | yes | User agent |
| Accept-Language | header | string | yes | zh_CN;q=0.9 en_US;q=0.9 |
> Response Examples
> 成功
```json
{
"data": [
{
"nfId": "001",
"amfSetId": "001"
},
{
"nfId": "002",
"amfSetId": "[001,002]"
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| ------------- | -------- | -------- | ------------ | ------------ | ----------- |
| » data | [object] | true | none | 返回的数据集 | 数据数组 |
| »» nfId | string | true | none | NF ID | 网元ID |
| »» amfSetId | string | true | none | AMF Set ID | none |
## GET Subscriptions from NSSF
GET /api/rest/ueManagement/v1/elementType/nssf/objectType/subscriptions
获取NSSF在线订阅数
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------------- |
| neId | query | string | yes | 网管发往网元的不用带NE ID |
| Referer | header | string | yes | Use the specified declared Referer |
| User-Agent | header | string | yes | User agent |
| Accept-Language | header | string | yes | zh_CN;q=0.9 en_US;q=0.9 |
> Response Examples
> 成功
```json
{
"data": [
{
"subscriptionId": "1",
"nfNssaiAvailabilityUri": "http://192.168.2.166/test",
"event": "test event 1"
},
{
"subscriptionId": "2",
"nfNssaiAvailabilityUri": "http://192.168.2.166/test",
"event": "test event 2"
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| --------------------------- | -------- | -------- | ------------ | ------------------------- | ----------- |
| » data | [object] | true | none | | none |
| »» subscriptionId | string | true | none | Subscription ID | 订阅ID |
| »» nfNssaiAvailabilityUri | string | true | none | NF NSSAI Availability Uri | none |
| »» event | string | true | none | Event | none |

Binary file not shown.