POST zstack/v1/routerAreaAuthorization: OAuth the-session-uuid{ "params": { "areaId": "1.1.1.1" }, "systemTags": [], "userTags": [] }
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"areaId":"1.1.1.1"}}' http://localhost:8080/zstack/v1/routerArea| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| areaId | String | body (contained in the params structure) | The area ID. | 3.4.0 | |
| areaAuth | String | body (contained in the params structure) | Optional. The authentication mode of the OSPF area. | 3.4.0 | |
| areaType | String | body (contained in the params structure) | Optional. The area type. | 3.4.0 | |
| password | String | body (contained in the params structure) | Optional. The password when the authentication mode is plaintext. | 3.4.0 | |
| keyId | Integer | body (contained in the params structure) | Optional. The key ID when the authentication mode is MD5 checksum. | 3.4.0 | |
| resourceUuid | String | body (contained in the params structure) | Optional. The area resource UUID. | 3.4.0 | |
| tagUuids | List | body (contained in the params structure) | Optional. The tag UUID list. | 3.4.0 | |
| systemTags | List | body | Optional. The system tags. | 3.4.0 | |
| userTags | List | body | Optional. The user tags. | 3.4.0 |
{ "inventory": { "uuid": "d82d2b6108b0331b90161b939987e5ae", "areaId": "1", "type": "Stub", "authentication": "Plaintext", "password": "password", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } }| Name | Type | Description | Starting Version |
|---|---|---|---|
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 3.4.0 |
| inventory | RouterAreaInventory | See inventory. | 3.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 3.4.0 |
| description | String | The brief description of the error. | 3.4.0 |
| details | String | The details about the error. | 3.4.0 |
| elaboration | String | The reserved field. Default value: null. | 3.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 3.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 3.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 3.4.0 |
| areaId | String | 3.4.0 | |
| type | String | 3.4.0 | |
| authentication | String | 3.4.0 | |
| password | String | 3.4.0 | |
| keyId | Integer | 3.4.0 | |
| createDate | Timestamp | The creation date. | 3.4.0 |
| lastOpDate | Timestamp | The last operation date. | 3.4.0 |
CreateVRouterOspfAreaAction action = new CreateVRouterOspfAreaAction(); action.areaId = "1.1.1.1"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateVRouterOspfAreaAction.Result res = action.call();CreateVRouterOspfAreaAction action = CreateVRouterOspfAreaAction() action.areaId = "1.1.1.1" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateVRouterOspfAreaAction.Result res = action.call()DELETE zstack/v1/routerArea/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X DELETE http://localhost:8080/zstack/v1/routerArea/8c7d2c714e1231549dd2a66a3f140ae5| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 3.4.0 | |
| deleteMode | String | body | Optional. The delete mode. | 3.4.0 | |
| systemTags | List | body | Optional. The system tags. | 3.4.0 | |
| userTags | List | body | Optional. The user tags. | 3.4.0 |
{ "error": { "code": "SYS.1001", "description": "A message or a operation timeout", "details": "Create VM on KVM timeout after 300s" } }DeleteVRouterOspfAreaAction action = new DeleteVRouterOspfAreaAction(); action.uuid = "8c7d2c714e1231549dd2a66a3f140ae5"; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DeleteVRouterOspfAreaAction.Result res = action.call();DeleteVRouterOspfAreaAction action = DeleteVRouterOspfAreaAction() action.uuid = "8c7d2c714e1231549dd2a66a3f140ae5" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" DeleteVRouterOspfAreaAction.Result res = action.call()GET zstack/v1/routerArea/{vRouterUuid}/neighborAuthorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X GET http://localhost:8080/zstack/v1/routerArea/dfb6151287b632599becfc5716b8c374/neighbor| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| vRouterUuid | String | url | The vRouter UUID. | 3.4.0 | |
| systemTags | List | query | Optional. The system tags. | 3.4.0 | |
| userTags | List | query | Optional. The user tags. | 3.4.0 |
{ "neighbors": [ null, null ] }| Name | Type | Description | Starting Version |
|---|---|---|---|
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 3.4.0 |
| neighbors | List | See neighbors. | 3.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 3.4.0 |
| description | String | The brief description of the error. | 3.4.0 |
| details | String | The details about the error. | 3.4.0 |
| elaboration | String | The reserved field. Default value: null. | 3.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 3.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 3.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | String | 3.4.0 | |
| priority | String | 3.4.0 | |
| state | String | 3.4.0 | |
| deadTime | String | 3.4.0 | |
| neighborAddress | String | 3.4.0 | |
| device | String | 3.4.0 |
GetVRouterOspfNeighborAction action = new GetVRouterOspfNeighborAction(); action.vRouterUuid = "dfb6151287b632599becfc5716b8c374"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; GetVRouterOspfNeighborAction.Result res = action.call();GetVRouterOspfNeighborAction action = GetVRouterOspfNeighborAction() action.vRouterUuid = "dfb6151287b632599becfc5716b8c374" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" GetVRouterOspfNeighborAction.Result res = action.call()
© 2023, Shanghai Yunzhou Information and Technology Ltd (云轴科技). All Rights Reserved.
Back to Top
Email Us
contact@zstack.ioEmail Us
contact@zstack.ioEmail Us
contact@zstack.ioThe download link is sent to your email address.
If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.Thank you for using ZStack products and services.
Submit successfully.
We'll connect soon.Thank you for using ZStack products and services.