Skip to main content
Version: 1.5.0

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 codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"method": null,
"status": 0,
"message": "OK",
"data": {
"instances": [{
"id": ,
"updateTime": ,
"createTime": ,
"applicationName": ",
"instance": "",
"labels": [{
"stringValue": "",
"labelKey": "",
"feature": "",
"id": 5,
"labelValueSize": 0,
"modifiable": true,
"updateTime": ,
"createTime": ,
"featureKey": "",
"empty":
}]
}]
}
}

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 codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"method": null,
"status": 0,
"message": "OK",
"data": {
"url": ""
}
}

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:

{
applicationName: "linkis-ps-cs"
instance: "localhost110004:9108"
labels: [{
labelKey: "route",
stringValue: "cs_2_dev"
}]
}

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
applicationNameEngine LabelStringfalseString
instanceEngine instance nameStringfalseString
labelKeyThe label in the added content belongs to the key in the map in the labels collectionStringfalseString
labelsThe engine instance updates the parameter content, and the collection stores the map typeListfalseList
stringValueThe value of the label in the added content belongs to the value in the map in the labels collectionStringfalseString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"method": null,
"status": 0,
"message": "success",
"data": {
"labels": [{
"stringValue": "",
"labelKey": "",
"feature": null,
"modifiable": ,
"featureKey": "",
"empty":
}]
}
}

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 codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"method": null,
"status": 0,
"message": "OK",
"data": {
"keyList": []
}
}