全部产品

API 分组

本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。

创建 API 分组

sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。

请求参数

名称

类型

是否必填

示例

描述

param

ApiGroupVO

param

tenant_id

STRING

TSCPDICNT

tenant_id

workspace_id

STRING

default

workspace_id

返回参数

名称

类型

示例

描述

data

ApiGroupVO

data

代码示例

请求示例

{
"param":{
"group_name":"apigroup2"
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
    "data":{
        "api_group_id":"gjrjknp1s4alzubn",
        "tenant_id":"JADDGOCN",
        "workspace_id":"antdemo",
        "domain_name":"gjrjknp1s4alzubn.apigateway.inc.alipay.net",
        "group_name":"apigroup2",
        "operator":""
    },
    "result_code":"OK"
}

删除 API 分组

sofa.apigateway.apigroup.delete 用于删除一个 API 分组。

请求参数

名称

类型

是否必填

示例

描述

api_group_id

STRING

saffccca

api_group_id

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

BOOLEAN

true, false

data

代码示例

请求示例

{
"api_group_id":"evrtxymrpxkep6bc",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

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

更新 API 分组

sofa.apigateway.apigroup.update 用于更新一个 API 分组的配置信息。

请求参数

名称

类型

是否必填

示例

描述

param

ApiGroupVO

param

tenant_id

STRING

TSCPDICNT

tenant_id

workspace_id

STRING

default

workspace_id

返回参数

名称

类型

示例

描述

data

BOOLEAN

true, false

data

代码示例

请求示例

{
    "param":{
        "group_name":"apigroup3",
        "api_group_id":"gjrjknp1s4alzubn",
        "description":"abcd"
    },
    "tenant_id":"JADDGOCN",
    "workspace_id":"antdemo"
}

返回示例

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

通过 ID 查询 API 分组

sofa.apigateway.apigroup.get 用于通过指定 API 分组 ID 查询该分组的具体信息。

请求参数

名称

类型

是否必填

示例

描述

api_group_id

STRING

sdf12ccccss

api_group_id

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

ApiGroupVO

-

data

代码示例

请求示例

{
"api_group_id":"fifhwqgcsmqo9ycl",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
    "data":{
        "api_group_id":"fifhwqgcsmqo9ycl",
        "tenant_id":"JADDGOCN",
        "gmt_create":"2020-03-27 01:51:36",
        "workspace_id":"antdemo",
        "domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
        "group_name":"apigroup2",
        "gmt_modified":"2020-03-27 01:51:36",
        "operator":""
    },
    "result_code":"OK"
}

查询 API 分组列表

sofa.apigateway.apigroup.all 用于快速查询所有 API 分组列表。

请求参数

名称

类型

是否必填

示例

描述

param

ApiGroupQueryVO

-

param

tenant_id

STRING

TSCPDICNT

tenant_id

workspace_id

STRING

default

workspace_id

返回参数

名称

类型

示例

描述

data

ARRAY[ApiGroupVO]

-

data

代码示例

请求示例

{
    "param":{
        "page_info":{
            "order_infos":[

            ],
            "page_index":1,
            "page_size":10
        }
    },
    "tenant_id":"JADDGOCN",
    "workspace_id":"antdemo"
}

返回示例

{
    "data":[
        {
            "groupName":"apigroup3",
            "gmtModified":"2020-03-27 01:58:40",
            "apiGroupId":"gjrjknp1s4alzubn",
            "domainName":"gjrjknp1s4alzubn.apigateway.inc.alipay.net",
            "tenantId":"JADDGOCN",
            "description":"abcd",
            "gmtCreate":"2020-03-27 01:53:20",
            "operator":"",
            "workspaceId":"antdemo"
        },
        {
            "groupName":"apigroup2",
            "gmtModified":"2020-03-27 01:51:36",
            "apiGroupId":"fifhwqgcsmqo9ycl",
            "domainName":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
            "tenantId":"JADDGOCN",
            "gmtCreate":"2020-03-27 01:51:36",
            "operator":"",
            "workspaceId":"antdemo"
        },
        {
            "groupName":"apigroup1",
            "gmtModified":"2020-03-27 01:05:46",
            "apiGroupId":"vfaqppj02kv30tx2",
            "domainName":"vfaqppj02kv30tx2.apigateway.inc.alipay.net",
            "tenantId":"JADDGOCN",
            "apiCount":3,
            "gmtCreate":"2020-03-25 16:55:03",
            "operator":"",
            "workspaceId":"antdemo"
        },
        {
            "groupName":"test_aalq",
            "gmtModified":"2020-03-26 11:58:29",
            "apiGroupId":"dumebnn9gbnyy02y",
            "domainName":"dumebnn9gbnyy02y.apigateway.inc.alipay.net",
            "tenantId":"JADDGOCN",
            "apiCount":3,
            "gmtCreate":"2020-03-25 15:06:03",
            "operator":"",
            "workspaceId":"antdemo"
        }
    ],
    "result_code":"OK"
}

查询 API 分组分页列表

sofa.apigateway.apigroup.list 用于查询 API 分组的分页列表。

请求参数

名称

类型

是否必填

示例

描述

param

ApiGroupQueryVO

param

tenant_id

STRING

TSCPDICNT

tenant_id

workspace_id

STRING

default

workspace_id

返回参数

名称

类型

示例

描述

data

ApiGroupPagedListVO

-

data

代码示例

请求示例

{
    "param":{
        "page_info":{
            "order_infos":[

            ],
            "page_index":1,
            "page_size":10
        }
    },
    "tenant_id":"JADDGOCN",
    "workspace_id":"antdemo"
}

返回示例

{
    "data":{
        "page_info":{
            "total":2,
            "page_index":1,
            "page_size":10
        },
        "list":[
            {
                "groupName":"apigroup3",
                "gmtModified":"2020-03-27 01:58:40",
                "apiGroupId":"gjrjknp1s4alzubn",
                "domainName":"gjrjknp1s4alzubn.apigateway.inc.alipay.net",
                "tenantId":"JADDGOCN",
                "description":"abcd",
                "gmtCreate":"2020-03-27 01:53:20",
                "operator":"",
                "workspaceId":"antdemo"
            },
            {
                "groupName":"apigroup2",
                "gmtModified":"2020-03-27 01:51:36",
                "apiGroupId":"fifhwqgcsmqo9ycl",
                "domainName":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
                "tenantId":"JADDGOCN",
                "gmtCreate":"2020-03-27 01:51:36",
                "operator":"",
                "workspaceId":"antdemo"
            }
        ]
    },
    "result_code":"OK"
}

通过 API 分组 ID 查询 API 列表

sofa.apigateway.apigroup.api.all 用于通过分组 ID 查询该分组下的所有 API 列表。

请求参数

名称

类型

是否必填

示例

描述

api_group_id

STRING

api_group_id1

API分组标识

param

ApiInfoQueryVO

-

param

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

ARRAY[ApiInfoVO]

-

data

代码示例

请求示例

{
    "param":{
        "page_info":{
            "page_index":1,
            "page_size":10
        }
    },
    "api_group_id":"fifhwqgcsmqo9ycl",
    "tenant_id":"JADDGOCN",
    "workspace_id":"antdemo"
}

返回示例

{
    "data":{
        "page_info":{
            "total":1,
            "page_index":1,
            "page_size":10
        },
        "list":[
            {
                "charset":"UTF-8",
                "apiName":"api-test2",
                "gmtModified":"2020-03-27 14:58:34",
                "method":"GET",
                "sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
                "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"
}

通过 API 分组 ID 查询 API 分页列表

sofa.apigateway.apigroup.api.list 用于通过分组 ID 查询该分组下的 API 分页列表。

请求参数

名称

类型

是否必填

示例

描述

api_group_id

STRING

api_group_id1

API分组标识

param

ApiInfoQueryVO

-

param

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

ApiInfoPagedListVO

-

data

代码示例

请求示例

{
    "param":{
        "page_info":{
            "page_index":1,
            "page_size":10
        }
    },
    "api_group_id":"fifhwqgcsmqo9ycl",
    "tenant_id":"JADDGOCN",
    "workspace_id":"antdemo"
}

返回示例

{
    "data":{
        "page_info":{
            "total":1,
            "page_index":1,
            "page_size":10
        },
        "list":[
            {
                "charset":"UTF-8",
                "apiName":"api-test2",
                "gmtModified":"2020-03-27 14:58:34",
                "method":"GET",
                "sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
                "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"
}