System clusters
This topic describes the OpenAPI operations for system clusters and lists their request and response parameters.
Create a system cluster
sofa.apigateway.sys.create creates a backend system cluster.
Request parameters
Name | Type | Required | Example | Description |
param | SystemClusterVO | Yes | - | param |
tenant_id | STRING | Yes | TSCPDICNT | tenant_id |
workspace_id | STRING | Yes | default | workspace_id |
Response parameters
Name | Type | Example | Description |
data | SystemClusterVO | - | data |
Code examples
Request example
{
"param":{
"sys_name":"sys2",
"upstream_protocol":"HTTP",
"sys_type":"URL",
"lb_type":"ROUND_ROBIN",
"authentication_type":"SECRET",
"host":[
"192.157.1.3:80",
"192.168.2.3:80"
]
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}Response example
{
"data":{
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo",
"sys_id":"bh4ufj0dFgEp5LoZjOJbN3h3y8cWxrZD",
"upstream_protocol":"HTTP",
"host":[
"192.157.1.3:80",
"192.168.2.3:80"
],
"sys_name":"sys2",
"sys_type":"URL",
"authentication_config":{
"secret_key":"aaOVjo7iU5cFo7YENoPjUgMWgrZh****",
"access_key":"Kie4pNJj5nGi****",
"authentication_type":"SECRET"
},
"authentication_type":"SECRET",
"lb_type":"ROUND_ROBIN",
"operator":""
},
"result_code":"OK"
}Delete a system cluster
sofa.apigateway.sys.delete deletes a specified system cluster.
Request parameters
Name | Type | Required | Example | Description |
sys_id | STRING | Yes | 8Amfi67dmE9wpY46 | Backend cluster identity. |
tenant_id | STRING | Yes | TSCPDICNT | Tenant identity. |
workspace_id | STRING | Yes | default | Workspace identity. |
Response parameters
Name | Type | Example | Description |
data | BOOLEAN | true, false | data |
Code examples
Request example
{
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}Response example
{
"data":true,
"result_code":"OK"
}Update a system cluster
sofa.apigateway.sys.update updates the configuration of a specified system cluster.
Request parameters
Name | Type | Required | Example | Description |
param | SystemClusterVO | No | param | |
tenant_id | STRING | Yes | TSCPDICNT | Tenant identity. |
workspace_id | STRING | Yes | default | Workspace Identity |
Response parameters
Name | Type | Example | Description |
data | BOOLEAN | true, false | data |
Code examples
Request example
{
"data":{
"sys_name":"sys3",
"upstream_protocol":"HTTP",
"sys_type":"URL",
"lb_type":"ROUND_ROBIN",
"authentication_type":"SECRET",
"host":[
"127.0.0.1:80",
"127.0.0.1:80"
]
"sys_id":"bh4ufj0dFgEp5LoZjOJbN3h3y8cWxrZD",
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}Response example
{
"data":true,
"result_code":"OK"
}Query a system cluster by ID
sofa.apigateway.sys.get queries for a specified system cluster.
Request parameters
Name | Type | Required | Example | Description |
sys_id | STRING | Yes | 8Amfi67dmE9wpY46 | Backend cluster identity. |
tenant_id | STRING | Yes | TSCPDICNT | Tenant identity. |
workspace_id | STRING | Yes | default | Workspace identity. |
Response parameters
Name | Type | Example | Description |
data | SystemClusterVO | data |
Code examples
Request example
{
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}Response Example
{
"data":{
"gmt_create":"2020-03-27 10:46:33",
"tenant_id":"JADDGOCN",
"api_count":1,
"sys_type":"URL",
"gmt_modified":"2020-03-27 14:17:30",
"authentication_type":"SECRET",
"lb_type":"ROUND_ROBIN",
"operator":"",
"workspace_id":"antdemo",
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"upstream_protocol":"HTTP",
"host":[
"192.157.1.3:80",
"192.168.2.3:80"
],
"sys_name":"sys2",
"authentication_config":{
"secret_key":"vtEnfnU6XNNpI4Wln66OCJd8FRWG********",
"access_key":"YqRIovzEtBjk****",
"authentication_type":"SECRET"
}
},
"result_code":"OK"
}Query a paginated list of system clusters
sofa.apigateway.sys.list retrieves a paginated list of system clusters.
Request parameters
Name | Type | Required | Example | Description |
param | SystemClusterQueryVO | No | - | param |
tenant_id | STRING | Yes | TSCPDICNT | tenant_id |
workspace_id | STRING | Yes | default | workspace_id |
Response parameters
Name | Type | Example | Description |
data | SystemClusterPagedListVO | - | data |
Code examples
Sample request
{
"param":{
"query":{
"upstream_protocol":"HTTP"
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}Example Response
{
"data":[
{
"gmtModified":"2020-03-27 14:17:30",
"sysType":"URL",
"sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"host":[
"127.0.0.1:80",
"127.0.0.1:80"
],
"lbType":"ROUND_ROBIN",
"sysName":"sys2",
"tenantId":"JADDGOCN",
"upstreamProtocol":"HTTP",
"apiCount":1,
"gmtCreate":"2020-03-27 10:46:33",
"operator":"",
"workspaceId":"antdemo"
},
{
"gmtModified":"2020-03-25 15:14:27",
"sysType":"URL",
"sysId":"cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8",
"host":[
"123.4.2:80"
],
"sysName":"ffff",
"tenantId":"JADDGOCN",
"upstreamProtocol":"HTTP",
"apiCount":1,
"gmtCreate":"2020-03-25 15:14:18",
"operator":"",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}Query a list of system clusters
sofa.apigateway.sys.all returns a list of all system clusters.
Request parameters
Name | Type | Required | Example | Description |
param | SystemClusterQueryVO | No | param | |
tenant_id | STRING | Yes | TSCPDICNT | tenant_id |
workspace_id | STRING | Yes | default | workspace_id |
Response parameters
Name | Type | Example | Description |
data | ARRAY[SystemClusterVO] | - | data |
Code examples
Example Request
{
"param":{
"query":{
"upstream_protocol":"HTTP"
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}Response Example
{
"data":[
{
"gmtModified":"2020-03-27 14:17:30",
"sysType":"URL",
"sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIpl****",
"host":[
"192.157.1.3:80",
"192.168.2.3:80"
],
"lbType":"ROUND_ROBIN",
"sysName":"sys2",
"tenantId":"JADDGOCN",
"upstreamProtocol":"HTTP",
"apiCount":1,
"gmtCreate":"2020-03-27 10:46:33",
"operator":"",
"workspaceId":"antdemo"
},
{
"gmtModified":"2020-03-25 15:14:27",
"sysType":"URL",
"sysId":"cBfmcHFVNMXmTrEWFH4FsZf9wDPL****",
"host":[
"123.4.2:80"
],
"sysName":"ffff",
"tenantId":"JADDGOCN",
"upstreamProtocol":"HTTP",
"apiCount":1,
"gmtCreate":"2020-03-25 15:14:18",
"operator":"",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}Query a paginated list of APIs by system cluster ID
sofa.apigateway.sys.api.list retrieves a paginated list of APIs from a specified system cluster.
Request parameters
Name | Type | Required | Example | Description |
param | ApiInfoQueryVO | No | - | param |
sys_id | STRING | Yes | 8Amfi67dmE9wpY46 | Backend cluster identity. |
tenant_id | STRING | Yes | TSCPDICNT | Tenant identity. |
workspace_id | STRING | Yes | default | Workspace identity. |
Response parameters
Name | Type | Example |
data | ApiInfoPagedListVO | data |
Code examples
Sample request
{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"api_name":null
}
},
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIpl****"
}Response Example
{
"data":{
"page_info":{
"total":1,
"page_index":1,
"page_size":10
},
"list":[
{
"charset":"UTF-8",
"apiName":"api-test2",
"gmtModified":"2020-03-27 15:51:48",
"method":"GET",
"sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIpl****",
"authAppCount":1,
"upstreamPath":"/openapi/apigateway/test/api1",
"routerType":"PATH",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-27 14:12:43",
"timeout":3000,
"operator":"",
"path":"/openapi/apigateway/test/api1",
"apiGroupId":"fifhwqgcsmqo9ycl",
"appType":"STANDARD",
"downstreamProtocol":"HTTP",
"domainName":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"apiGroupName":"apigroup2",
"tenantId":"JADDGOCN",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"apiStatus":"OPENED",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}Query a list of APIs by system cluster ID
sofa.apigateway.sys.api.all retrieves a list of all APIs in a specified system cluster.
Request parameters
Name | Type | Required | Example | Description |
param | ApiInfoQueryVO | No | - | param |
sys_id | STRING | Yes | 8Amfi67dmE9wpY46 | Backend cluster identity. |
tenant_id | STRING | Yes | TSCPDICNT | Tenant identity. |
workspace_id | STRING | Yes | default | Workspace identity. |
Response parameters
Name | Type | Example | Description |
data | ARRAY[ApiInfoVO] | - | data |
Code examples
Request Example
{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"api_name":null
}
},
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIpl****"
}Sample response
{
"data":[
{
"charset":"UTF-8",
"apiName":"api-test2",
"gmtModified":"2020-03-27 15:51:48",
"method":"GET",
"sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIpl****",
"authAppCount":1,
"upstreamPath":"/openapi/apigateway/test/api1",v
"routerType":"PATH",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-27 14:12:43",
"timeout":3000,
"operator":"",
"path":"/openapi/apigateway/test/api1",
"apiGroupId":"fifhwqgcsmqo9ycl",
"appType":"STANDARD",
"downstreamProtocol":"HTTP",
"tenantId":"JADDGOCN",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqS****",
"apiStatus":"OPENED",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}