系统集群 - SOFAStack API 统一网关

本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。

创建系统集群
删除系统集群
更新系统集群
通过 ID 查询系统集群
查询系统集群分页列表
查询系统集群列表
通过系统集群 ID 查询 API 分页列表
通过系统集群 ID 查询 API 列表

创建系统集群

sofa.apigateway.sys.create 用于创建一个后端系统集群。

请求参数

名称	类型	是否必填	示例	描述
param	SystemClusterVO	是	-	param
tenant_id	STRING	是	TSCPDICNT	tenant_id
workspace_id	STRING	是	default	workspace_id

返回参数

名称	类型	示例	描述
data	SystemClusterVO	-	data

代码示例

请求示例

{
    "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"
}

返回示例

{
    "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": "aaOVjo7iU5cFo7YENoPjUgMWgrZhAh6Q",
            "access_key": "Kie4pNJj5nGiNAGx",
            "authentication_type": "SECRET"
        },
        "authentication_type": "SECRET",
        "lb_type": "ROUND_ROBIN",
        "operator": ""
    },
    "result_code": "OK"
}

删除系统集群

sofa.apigateway.sys.delete 用于快速删除指定 ID 的系统集群。

请求参数

名称	类型	是否必填	示例	描述
sys_id	STRING	是	8Amfi67dmE9wpY46	后端集群标识
tenant_id	STRING	是	TSCPDICNT	租户标识
workspace_id	STRING	是	default	工作空间标识

返回参数

名称	类型	示例	描述
data	BOOLEAN	true, false	data

代码示例

请求示例

{
    "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
    "tenant_id": "JADDGOCN",
    "workspace_id": "antdemo"
}

返回示例

{
    "data": true,
    "result_code": "OK"
}

更新系统集群

sofa.apigateway.sys.update 用于更新一个系统集群的配置信息。

请求参数

名称	类型	是否必填	示例	描述
param	SystemClusterVO	否		param
tenant_id	STRING	是	TSCPDICNT	租户标识
workspace_id	STRING	是	default	工作空间标识

返回参数

名称	类型	示例	描述
data	BOOLEAN	true, false	data

代码示例

请求示例

{
    "data": {
            "sys_name": "sys3",
        "upstream_protocol": "HTTP",
        "sys_type": "URL",
        "lb_type": "ROUND_ROBIN",
        "authentication_type": "SECRET",
        "host": [
            "192.157.1.3:80",
            "192.168.2.3:80"
        ]
        "sys_id": "bh4ufj0dFgEp5LoZjOJbN3h3y8cWxrZD",
    },
    "tenant_id": "JADDGOCN",
    "workspace_id": "antdemo"
}

返回示例

{
    "data": true,
    "result_code": "OK"
}

通过 ID 查询系统集群

sofa.apigateway.sys.get 用于查询指定 ID 的系统集群。

请求参数

名称	类型	是否必填	示例	描述
sys_id	STRING	是	8Amfi67dmE9wpY46	后端集群标识
tenant_id	STRING	是	TSCPDICNT	租户标识
workspace_id	STRING	是	default	工作空间标识

返回参数

名称	类型	示例	描述
data	SystemClusterVO		data

代码示例

请求示例

{
    "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
    "tenant_id": "JADDGOCN",
    "workspace_id": "antdemo"
}

返回示例

{
    "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": "vtEnfnU6XNNpI4Wln66OCJd8FRWGgNhv",
            "access_key": "YqRIovzEtBjkS6MV",
            "authentication_type": "SECRET"
        }
    },
    "result_code": "OK"
}

查询系统集群分页列表

sofa.apigateway.sys.list 用于查询系统集群的分页列表。

请求参数

名称	类型	是否必填	示例	描述
param	SystemClusterQueryVO	否	-	param
tenant_id	STRING	是	TSCPDICNT	tenant_id
workspace_id	STRING	是	default	workspace_id

返回参数

名称	类型	示例	描述
data	SystemClusterPagedListVO	-	data

代码示例

请求示例

{
    "param": {
        "query": {
            "upstream_protocol": "HTTP"
        }
    },
    "tenant_id": "JADDGOCN",
    "workspace_id": "antdemo"
}

返回示例

{
    "data": [
        {
            "gmtModified": "2020-03-27 14:17:30",
            "sysType": "URL",
            "sysId": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
            "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": "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"
}

查询系统集群列表

sofa.apigateway.sys.all 用于查询系统集群的所有列表。

请求参数

名称	类型	是否必填	示例	描述
param	SystemClusterQueryVO	否		param
tenant_id	STRING	是	TSCPDICNT	tenant_id
workspace_id	STRING	是	default	workspace_id

返回参数

名称	类型	示例	描述
data	ARRAY[SystemClusterVO]	-	data

代码示例

请求示例

{
    "param": {
        "query": {
            "upstream_protocol": "HTTP"
        }
    },
    "tenant_id": "JADDGOCN",
    "workspace_id": "antdemo"
}

返回示例

{
    "data": [
        {
            "gmtModified": "2020-03-27 14:17:30",
            "sysType": "URL",
            "sysId": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
            "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": "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"
}

通过系统集群 ID 查询 API 分页列表

sofa.apigateway.sys.api.list 用于查询指定系统集群下的 API 分页列表。

请求参数

名称	类型	是否必填	示例	描述
param	ApiInfoQueryVO	否	-	param
sys_id	STRING	是	8Amfi67dmE9wpY46	后端集群标识
tenant_id	STRING	是	TSCPDICNT	租户标识
workspace_id	STRING	是	default	工作空间标识

返回参数

名称	类型	示例	描述
data	ApiInfoPagedListVO	data

代码示例

请求示例

{
    "param": {
        "page_info": {
            "page_size": 10,
            "page_index": 1
        },
        "query": {
            "api_name": null
        }
    },
    "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd"
}

返回示例

{
    "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": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
                "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"
}

通过系统集群 ID 查询 API 列表

sofa.apigateway.sys.api.all 用于查询指定系统集群下所有的 API 列表。

请求参数

名称	类型	是否必填	示例	描述
param	ApiInfoQueryVO	否	-	param
sys_id	STRING	是	8Amfi67dmE9wpY46	后端集群标识
tenant_id	STRING	是	TSCPDICNT	租户标识
workspace_id	STRING	是	default	工作空间标识

返回参数

名称	类型	示例	描述
data	ARRAY[ApiInfoVO]	-	data

代码示例

请求示例

{
    "param": {
        "page_info": {
            "page_size": 10,
            "page_index": 1
        },
        "query": {
            "api_name": null
        }
    },
    "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd"
}

返回示例

{
    "data": [
        {
            "charset": "UTF-8",
            "apiName": "api-test2",
            "gmtModified": "2020-03-27 15:51:48",
            "method": "GET",
            "sysId": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
            "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",
            "tenantId": "JADDGOCN",
            "contentType": "application/json",
            "upstreamType": "SYSTEM_CLUSTER",
            "apiId": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
            "apiStatus": "OPENED",
            "workspaceId": "antdemo"
        }
    ],
    "result_code": "OK"
}