Application management

Updated at:
Copy as MD

This topic lists all OpenAPI operations for application management and their request and response parameters.

Create an application

The sofa.apigateway.app.create operation creates an application.

Request parameters

Name

Type

Required

Example

Description

param

AppInfoVO

Yes

Parameter

tenant_id

STRING

Yes

TSCPDICNT

The tenant identity.

workspace_id

STRING

Yes

default

The workspace identity.

Response parameters

Name

Type

Example

Description

data

AppInfoVO

-

data

Code examples

Request example

{
"param":{
"app_type":"STANDARD",
"app_name":"app3",
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

Response example

{
"data":{
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo",
"app_name":"app3",
"app_type":"STANDARD",
"authentication_config":{
"secret_key":"5790AHAxbUjxXMEzMFV74l6wtzZH****",
"authentication_type":"SECRET"
},
"app_id":"TGcdFd3i1v4EOUXD",
"operator":""
},
"result_code":"OK"
}

Delete an application

The sofa.apigateway.app.delete operation deletes the application with the specified App ID.

Request parameters

Name

Type

Required

Example

Description

app_id

STRING

Yes

app_id1

Application Identity

tenant_id

STRING

Yes

TSCPDICNT

The tenant identity.

workspace_id

STRING

Yes

default

The workspace identity.

Response parameters

Name

Type

Example

Description

data

BOOLEAN

true, false

Data

Code examples

Request example

{
"app_id":"UfBAJ5bA0nJMSTm9",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

Example Response

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

Update an application

The sofa.apigateway.app.update operation updates an application.

Request parameters

Name

Type

Required

Example

Description

param

AppInfoVO

No

-

param

tenant_id

STRING

Yes

TSCPDICNT

The tenant identity.

workspace_id

STRING

Yes

default

The workspace identity.

Response Parameters

Name

Type

Example

Description

data

BOOLEAN

true, false

The data.

Code examples

Request Example

{
"param":{
"app_type":"STANDARD",
"app_name":"app1",
"description":"abc",
"app_id":"uOQQqaGBYif5oChg"
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

Sample Response

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

Query an application by ID

The sofa.apigateway.app.get operation retrieves information about an application based on its App ID.

Request parameters

Name

Type

Required

Example

Description

app_id

STRING

Yes

123

App ID

tenant_id

STRING

Yes

TSCPDICNT

The tenant identity.

workspace_id

STRING

Yes

default

Workspace identity

Response parameters

Name

Type

Example

Description

data

AppInfoVO

true, false

data

Code examples

Example Request

{
"app_id":"uOQQqaGBYif5oChg",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

Response Example

{
"data":{
"tenant_id":"JADDGOCN",
"gmt_create":"2020-03-25 16:38:18",
"workspace_id":"antdemo",
"app_name":"app1",
"app_type":"STANDARD",
"api_count":1,
"description":"abc",
"authentication_config":{
"secret_key":"1KxGmLMpBQxqZAkZJXZBwObHCmSl****",
"authentication_type":"SECRET"
},
"gmt_modified":"2020-03-27 10:09:28",
"app_id":"uOQQqaGBYif5oChg",
"operator":""
},
"result_code":"OK"
}

Query a paginated list of applications

The sofa.apigateway.app.list operation retrieves a paginated list of applications.

Request parameters

Name

Type

Required

Example

Description

param

AppInfoQueryVO

No

-

The parameter.

tenant_id

STRING

Yes

TSCPDICNT

The tenant identity.

workspace_id

STRING

Yes

default

The workspace identity.

Response parameters

Name

Type

Example

Description

data

AppInfoPagedListVO

The data.

Code examples

Sample request

{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"app_id":null
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

Response example

{
"data":{
"page_info":{
"total":2,
"page_index":1,
"page_size":10
},
"list":[
{
"gmtModified":"2020-03-27 10:09:28",
"appName":"app1",
"appType":"MPAAS",
"appId":"uOQQqaGBYif5oChg",
"tenantId":"JADDGOCN",
"apiCount":1,
"description":"abc",
"gmtCreate":"2020-03-25 16:38:18",
"operator":"",
"workspaceId":"antdemo"
},
{
"gmtModified":"2020-03-27 10:02:04",
"appName":"app4",
"appType":"MPAAS",
"appId":"mpaas_TGcdFd3i1v4EOUXD",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-27 10:02:04",
"operator":"",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}

Query a list of applications

The sofa.apigateway.app.all operation retrieves a list of all applications.

Request parameters

Name

Type

Required

Example

Description

param

AppInfoQueryVO

No

-

Parameter

page_info

PageInfo

No

-

pageInfo

query

AppInfoVO

No

-

The query.

tenant_id

STRING

Yes

TSCPDICNT

The tenant identity.

workspace_id

STRING

Yes

default

The workspace identity.

Response parameters

Name

Type

Example

Description

data

ARRAY[AppInfoVO]

-

Data

Code examples

Request Example

{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"app_id":null
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

Response Example

{
"data":[
{
"gmtModified":"2020-03-27 10:09:28",
"appName":"app1",
"appType":"MPAAS",
"appId":"uOQQqaGBYif5oChg",
"tenantId":"JADDGOCN",
"apiCount":1,
"description":"abc",
"gmtCreate":"2020-03-25 16:38:18",
"operator":"",
"workspaceId":"antdemo"
},
{
"gmtModified":"2020-03-27 10:02:04",
"appName":"app4",
"appType":"MPAAS",
"appId":"mpaas_TGcdFd3i1v4EOUXD",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-27 10:02:04",
"operator":"",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}

Query a list of APIs by App ID

The sofa.apigateway.app.api.all operation returns a list of all APIs subscribed to by a specified application.

Request parameters

Name

Type

Required

Example

Description

app_id

STRING

Yes

app_id1

The App ID.

param

ApiInfoQueryVO

No

-

Parameter

tenant_id

STRING

Yes

TSCPDICNT

The tenant identity.

workspace_id

STRING

Yes

default

The workspace identity.

Response Parameters

Name

Type

Example

Description

data

ARRAY[ApiInfoVO]

-

Data

Code examples

Sample request

{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"api_name":null
}
},
"app_id":"uOQQqaGBYif5oChg",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

Sample response

{
"data":{
"page_info":{
"total":1,
"page_index":1,
"page_size":10
},
"list":[
{
"apiName":"test_aaaa",
"gmtModified":"2020-03-26 20:26:01",
"functionName":"fsdfsdf",
"authAppCount":2,
"gmtCreate":"2020-03-25 15:06:29",
"timeout":3000,
"operator":"",
"apiGroupId":"dumebnn9gbnyy02y",
"downstreamProtocol":"SOFA",
"domainName":"dumebnn9gbnyy02y.apigateway.inc.alipay.net",
"apiGroupName":"test_aalq",
"tenantId":"JADDGOCN",
"operationType":"asdfasdf.asdfasdf",
"contentType":"application/json",
"upstreamType":"NONE",
"apiId":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}

Query a paginated list of APIs by App ID

The sofa.apigateway.app.api.list operation returns a paginated list of APIs to which the application with the specified App ID subscribes.

Request parameters

Name

Type

Required

Example

Description

app_id

STRING

Yes

app_id1

Application ID (APPID)

param

ApiInfoQueryVO

No

-

parameter

tenant_id

STRING

Yes

TSCPDICNT

The tenant identity.

workspace_id

STRING

Yes

default

Workspace Identity

Response parameters

Name

Type

Example

Description

data

ARRAY[ApiInfoVO]

data

Code examples

Example Request

{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"api_name":null
}
},
"app_id":"uOQQqaGBYif5oChg",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

Example response

{
"data":[
{
"apiName":"test_aaaa",
"gmtModified":"2020-03-26 20:26:01",
"functionName":"fsdfsdf",
"authAppCount":2,
"gmtCreate":"2020-03-25 15:06:29",
"timeout":3000,
"operator":"",
"apiGroupId":"dumebnn9gbnyy02y",
"downstreamProtocol":"SOFA",
"tenantId":"JADDGOCN",
"operationType":"asdfasdf.asdfasdf",
"contentType":"application/json",
"upstreamType":"NONE",
"apiId":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}