Skip to content

Issue 4795: docs: fix missing HTTP API endpoints in versioned admin REST API docs #4796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shawyeok wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Issue 4795: docs: fix missing HTTP API endpoints in versioned admin REST API docs #4796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 117 additions & 3 deletions site3/website/versioned_docs/version-4.14.8/admin/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Currently all the HTTP endpoints could be divided into these 5 components:
* Description: Get heartbeat status for a specific bookie
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
| Code | Description |
|:-------|:------------|
|200 | Successful operation |

## Config

Expand Down Expand Up @@ -234,6 +234,37 @@ Currently all the HTTP endpoints could be divided into these 5 components:
}
```

### Endpoint: /api/v1/bookie/cluster_info
1. Method: GET
* Description: Get top-level info of this cluster.
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Response Body format:

```json
{
"auditorElected" : false,
"auditorId" : "",
"clusterUnderReplicated" : false,
"ledgerReplicationEnabled" : true,
"totalBookiesCount" : 1,
"writableBookiesCount" : 1,
"readonlyBookiesCount" : 0,
"unavailableBookiesCount" : 0
}
```
`clusterUnderReplicated` is true if there is any underreplicated ledger known currently.
Trigger audit to increase precision. Audit might not be possible if `auditorElected` is false or
`ledgerReplicationEnabled` is false.

`totalBookiesCount` = `writableBookiesCount` + `readonlyBookiesCount` + `unavailableBookiesCount`.


### Endpoint: /api/v1/bookie/last_log_mark
1. Method: GET
* Description: Get the last log marker.
Expand Down Expand Up @@ -373,9 +404,92 @@ Currently all the HTTP endpoints could be divided into these 5 components:
|503 | Bookie is not ready |
* Body: <empty>

### Endpoint: /api/v1/bookie/state/readonly
1. Method: GET
* Description: Get bookie readOnly state.
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Body:
```json
{
"readOnly" : false
}
```

2. Method: PUT
* Description: Set bookie readOnly state.
* Body:
```json
{
"readOnly": true
}
```
* Parameters:

| Name | Type | Required | Description |
|:-----|:-----|:---------|:------------|
| readOnly | Boolean | Yes | Whether bookie readOnly state. |
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Body:
```json
{
"readOnly": true
}
```


## Auto recovery

### Endpoint: /api/v1/autorecovery/status?enabled=<boolean>
1. Method: GET
* Description: Get autorecovery enable status with cluster.
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Response Body format:

```json
{
"enabled": true
}
```

2. Method: PUT
* Description: Set autorecovery enable status with cluster.
* Parameters:

| Name | Type | Required | Description |
|:-----|:---------|:-----------------------------------|:------------|
|enabled | Boolean | Yes | Whether autorecovery enable status |
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Body:
```json
{
"enabled": true
}
```

### Endpoint: /api/v1/autorecovery/bookie/
1. Method: PUT
* Description: Ledger data recovery for failed bookie
Expand Down
120 changes: 117 additions & 3 deletions site3/website/versioned_docs/version-4.15.5/admin/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Currently all the HTTP endpoints could be divided into these 5 components:
* Description: Get heartbeat status for a specific bookie
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
| Code | Description |
|:-------|:------------|
|200 | Successful operation |

## Config

Expand Down Expand Up @@ -234,6 +234,37 @@ Currently all the HTTP endpoints could be divided into these 5 components:
}
```

### Endpoint: /api/v1/bookie/cluster_info
1. Method: GET
* Description: Get top-level info of this cluster.
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Response Body format:

```json
{
"auditorElected" : false,
"auditorId" : "",
"clusterUnderReplicated" : false,
"ledgerReplicationEnabled" : true,
"totalBookiesCount" : 1,
"writableBookiesCount" : 1,
"readonlyBookiesCount" : 0,
"unavailableBookiesCount" : 0
}
```
`clusterUnderReplicated` is true if there is any underreplicated ledger known currently.
Trigger audit to increase precision. Audit might not be possible if `auditorElected` is false or
`ledgerReplicationEnabled` is false.

`totalBookiesCount` = `writableBookiesCount` + `readonlyBookiesCount` + `unavailableBookiesCount`.


### Endpoint: /api/v1/bookie/last_log_mark
1. Method: GET
* Description: Get the last log marker.
Expand Down Expand Up @@ -373,9 +404,92 @@ Currently all the HTTP endpoints could be divided into these 5 components:
|503 | Bookie is not ready |
* Body: <empty>

### Endpoint: /api/v1/bookie/state/readonly
1. Method: GET
* Description: Get bookie readOnly state.
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Body:
```json
{
"readOnly" : false
}
```

2. Method: PUT
* Description: Set bookie readOnly state.
* Body:
```json
{
"readOnly": true
}
```
* Parameters:

| Name | Type | Required | Description |
|:-----|:-----|:---------|:------------|
| readOnly | Boolean | Yes | Whether bookie readOnly state. |
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Body:
```json
{
"readOnly": true
}
```


## Auto recovery

### Endpoint: /api/v1/autorecovery/status?enabled=<boolean>
1. Method: GET
* Description: Get autorecovery enable status with cluster.
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Response Body format:

```json
{
"enabled": true
}
```

2. Method: PUT
* Description: Set autorecovery enable status with cluster.
* Parameters:

| Name | Type | Required | Description |
|:-----|:---------|:-----------------------------------|:------------|
|enabled | Boolean | Yes | Whether autorecovery enable status |
* Response:

| Code | Description |
|:-------|:------------|
|200 | Successful operation |
|403 | Permission denied |
|404 | Not found |
* Body:
```json
{
"enabled": true
}
```

### Endpoint: /api/v1/autorecovery/bookie/
1. Method: PUT
* Description: Ledger data recovery for failed bookie
Expand Down
Loading