ListSegment
Get Segment list of a Dataset
GET /v1/datasets/{id}/segment
Request Parameters
Path
| Name | Necessary or Not | Description |
|---|---|---|
| id | True | Dataset ID |
Query
| Name | Type | Necessary or Not | Description |
|---|---|---|---|
| commit | string | False | Commit Id or Tag of Commit |
| limit | int | False | default: 128 (one-time) |
| offset | int | False | default: 0 |
Request Example
1curl --location --request GET '{service}/v1/datasets/154e35ba-e895-4f09-969e-f8c9445efd2c/segment?commit='\
2--header 'x-token: {your_accesskey}'\
3--header 'Content-Type: application/json'
Return Result common dataset
1# response status
2HttpStatus 200
3{
4 "segments": ["graviti"],
5 "offset": 0,
6 "pageNumber": 0,
7 "pageSize": 1,
8 "pageCount": 1,
9 "recordSize": 1,
10 "totalCount": 1
11}
Error Code
| code | message | http status |
|---|---|---|
| AccessDenied | The request was rejected. You do not have the access to view the dataset | 403 |
| ResourceNotExist | Dataset {id} does not exist | 404 |
| InvalidParamsValue | Invalid parameter value | 400 |
| Unauthorized | Incorrect Accesskey | 401 |
