Video Security Monitoring R4 API Document
- 1 Introduction
- 2 API Definitions
- 2.1 otestack v1
- 2.1.1 User Management
- 2.1.2 Business Management
- 2.1.3 Cluster Management
- 2.1.4 Node Management
- 2.1.5 Repository Management
- 2.1.6 Application Management
- 2.1.7 Deployment Management
- 2.1 otestack v1
Introduction
These APIs provide services for manipulating ote-stack platform on AI Edge Blueprint.
API Definitions
otestack v1
User Management
1.Login
POST /v1/authorization
Description
An access token, which contains user information and expiry time, will be returned by presenting username and password. The client should includes the token in the authorization header of HTTP request to access subsequent request until the token is expired. During the validity period (1 hour), the new token with new expiry time can be obtained through the Update token API with current token.
Parameters
Name | Type | Required | Default | Description |
|---|---|---|---|---|
user | string | yes |
| user name |
password | string | yes |
| user password |
Response codes
Code | Description |
|---|---|
200 | Successful |
500 | Unexpected internal errors |
422 | Parameter validation error |
Example
2.Update Token
PUT /v1/authorization
Description
Returns a new authorization token with new expiry time.
Parameters
Name | Type | Required | Default | Description |
|---|---|---|---|---|
Authorization | string | yes |
| token string in Authorization Header |
Response codes
Code | Description |
|---|---|
200 | Successful |
500 | Unexpected internal errors |
422 | Parameter validation error |
Example
3.Create User
POST /v1/user
Description
Create a user without access token authorization. This user will be available after system administrator approval.
Parameters
Name | Type | Required | Default | Description |
|---|---|---|---|---|
user | string | yes |
| User name |
password | string | yes |
| Password should be 8-20 characters long with at least 1 uppercase, 1 lowercase and 1 number. |
phone | string | yes |
| Phone number |
isAdmin | bool | yes |
| true: general administrator, false: general user |
realName | string | yes |
| Real name |
Response code
Code | Description |
|---|---|
200 | Success |
500 | Unexpected internal errors |
422 | Parameter validation error |
Example
4.Update Password
PUT /v1/user
Description
Change the password of the logged-in user.
Parameters