blob: 3cfe4890ecd267f0e3d938f4a6016abbe32e171a [file] [log] [blame] [view]
---
{
"title": "System Action",
"language": "en"
}
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# System Action
## Request
```
GET /rest/v1/system
```
## Description
System Action is used for information about the Proc system built in Doris.
## Path parameters
None
## Query parameters
* `path`
Optional parameter, specify the path of proc
## Request body
None
## Response
Take `/dbs/10003/10054/partitions/10053/10055` as an example:
```
{
"msg": "success",
"code": 0,
"data": {
"href_columns": ["TabletId", "MetaUrl", "CompactionStatus"],
"column_names": ["TabletId", "ReplicaId", "BackendId", "SchemaHash", "Version", "VersionHash", "LstSuccessVersion", "LstSuccessVersionHash", "LstFailedVersion", "LstFailedVersionHash", "LstFailedTime", "DataSize", "RowCount", "State", "LstConsistencyCheckTime", "CheckVersion", "CheckVersionHash", "VersionCount", "PathHash", "MetaUrl", "CompactionStatus"],
"rows": [{
"SchemaHash": "1294206575",
"LstFailedTime": "\\N",
"LstFailedVersion": "-1",
"MetaUrl": "URL",
"__hrefPaths": ["http://192.168.100.100:8030/rest/v1/system?path=/dbs/10003/10054/partitions/10053/10055/10056", "http://192.168.100.100:8043/api/meta/header/10056", "http://192.168.100.100:8043/api/compaction/show?tablet_id=10056"],
"CheckVersionHash": "-1",
"ReplicaId": "10057",
"VersionHash": "4611804212003004639",
"LstConsistencyCheckTime": "\\N",
"LstSuccessVersionHash": "4611804212003004639",
"CheckVersion": "-1",
"Version": "6",
"VersionCount": "2",
"State": "NORMAL",
"BackendId": "10032",
"DataSize": "776",
"LstFailedVersionHash": "0",
"LstSuccessVersion": "6",
"CompactionStatus": "URL",
"TabletId": "10056",
"PathHash": "-3259732870068082628",
"RowCount": "21"
}]
},
"count": 1
}
```
The `column_names` in the data part is the header information, and `href_columns` indicates which columns in the table are hyperlink columns. Each element in the `rows` array represents a row. Among them, `__hrefPaths` is not the table data, but the link URL of the hyperlink column, which corresponds to the column in `href_columns` one by one.