Instance Management Api
InstanceRestful class
Microservice instance list
Interface address: /api/rest_j/v1/microservice/allInstance
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
Get the list of microservice management module instances to get single or multiple default all
Request Parameters:
No
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
1. {
2. "method": null,
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "instances": [{
7. "id": ,
8. "updateTime": ,
9. "createTime": ,
10. "applicationName": ",
11. "instance": "",
12. "labels": [{
13. "stringValue": "",
14. "labelKey": "",
15. "feature": "",
16. "id": 5,
17. "labelValueSize": 0,
18. "modifiable": true,
19. "updateTime": ,
20. "createTime": ,
21. "featureKey": "",
22. "empty":
23. }]
24. }]
25. }
26. }
Get eurekaURL
Interface address: /api/rest_j/v1/microservice/eurekaURL
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
return eurekaURL
Request Parameters:
No
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
1. {
2. "method": null,
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "url": ""
7. }
8. }
Edit the microservice instance
Interface address: /api/rest_j/v1/microservice/instanceLabel
Request method: PUT
Request data type: application/json
Response data type: */*
Interface description:
Edit or modify the instance in microservice management
Request example:
1. {
2. applicationName: "linkis-ps-cs"
3. instance: "bdpdws110004:9108"
4. labels: [{
5. labelKey: "route",
6. stringValue: "cs_2_dev"
7. }]
8. }
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| applicationName | Engine Label | String | false | String | |
| instance | Engine instance name | String | false | String | |
| labelKey | The label in the added content belongs to the key in the map in the labels collection | String | false | String | |
| labels | The engine instance updates the parameter content, and the collection stores the map type | List | false | List | |
| stringValue | The value of the label in the added content belongs to the value in the map in the labels collection | String | false | String |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
1. {
2. "method": null,
3. "status": 0,
4. "message": "success",
5. "data": {
6. "labels": [{
7. "stringValue": "",
8. "labelKey": "",
9. "feature": null,
10. "modifiable": ,
11. "featureKey": "",
12. "empty":
13. }]
14. }
15. }
Modifiable label types
Interface address:/api/rest_j/v1/microservice/modifiableLabelKey
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
Get a list of label types that can be modified, such as ‘userCreator, route’
Request Parameters:
No
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
1. {
2. "method": null,
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "keyList": []
7. }
8. }
