服务接口

服务API与参数管理 - 为服务下所有API配置全局参数（例如：认证头信息、版本控制）

---

更新当前API服务器配置

PATCH

/api/v1/services/{serviceId}/apis/server

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/services/{serviceId}/apis/server

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

主体

示例

cURL

JavaScript

PHP

Python

---

添加API数据集引用

PUT

/api/v1/services/{serviceId}/apis/dataset/reference

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

names*

数据集名称

类型array

必填

最大项数200

最小项数0

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/apis/dataset/reference

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

names*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

示例

cURL

JavaScript

PHP

Python

---

删除API数据集引用

DELETE

/api/v1/services/{serviceId}/apis/dataset/reference

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

names*

数据集名称

类型array

必填

最大项数200

最小项数0

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/services/{serviceId}/apis/dataset/reference

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

names*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

示例

cURL

JavaScript

PHP

Python

---

更新接口授权

PATCH

/api/v1/services/{serviceId}/apis/authentication

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/services/{serviceId}/apis/authentication

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

主体

示例

cURL

JavaScript

PHP

Python

---

添加API变量引用

PUT

/api/v1/services/{serviceId}/apis/variable/reference

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

names*

变量名

类型array

必填

最大项数200

最小项数0

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/apis/variable/reference

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

names*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

示例

cURL

JavaScript

PHP

Python

---

删除API变量引用

DELETE

/api/v1/services/{serviceId}/apis/variable/reference

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

names*

变量名

类型array

必填

最大项数200

最小项数0

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/services/{serviceId}/apis/variable/reference

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

names*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

示例

cURL

JavaScript

PHP

Python

---

全文搜索HTTP和WebSocket API

GET

/api/v1/services/{serviceId}/apis/search

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

id

接口ID

类型integer

格式"int64"

protocol

类型string

有效值

"http""https""ws""wss"

summary

类型string

operationId

类型string

admin

当应用管理员查询所有项目时必填

类型boolean

hasPermission

当用户查询具有单一权限项目时必填

类型string

有效值

"ADD""VIEW""MODIFY""DELETE""TEST""GRANT""SHARE""RELEASE""EXPORT"

endpoint

类型string

createdDate

类型string

格式"date-time"

createdBy

类型integer

格式"int64"

ownerId

类型integer

格式"int64"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

格式"int32"

最大值2000

最小值1

orderBy

排序字段

类型string

orderSort

排序方式

类型string

有效值

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

过滤条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

过滤条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

过滤条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

有效值

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/apis/search

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

id

protocol

summary

operationId

admin

hasPermission

endpoint

createdDate

createdBy

ownerId

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

添加API参数

PUT

/api/v1/services/{serviceId}/apis/parameter

添加API的参数，若参数已存在则覆盖其值

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/apis/parameter

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

主体

示例

cURL

JavaScript

PHP

Python

---

删除API参数

DELETE

/api/v1/services/{serviceId}/apis/parameter

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

names*

参数名称

类型array

必填

最大项数200

最小项数0

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/services/{serviceId}/apis/parameter

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

names*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

示例

cURL

JavaScript

PHP

Python

---

更新API参数

PATCH

/api/v1/services/{serviceId}/apis/parameter

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/services/{serviceId}/apis/parameter

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

主体

示例

cURL

JavaScript

PHP

Python

---

启用或禁用API参数

PATCH

/api/v1/services/{serviceId}/apis/parameter/enabled

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

names*

参数名称

类型array

必填

最大项数200

最小项数0

enabled*

启用或禁用

类型boolean

必填

scope*

修改参数API范围，默认为'ALL'

类型string

必填

有效值

"ALL""SELECTED_APIS""MATCH_APIS"

selectedApisIds

选定的API ID列表，当作用域为SELECTED_APIS时必填

类型array

唯一项true

matchEndpointRegex

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

matchMethod

匹配API的正则表达式，当作用域为MATCH_APIS时可选。

类型string

有效值

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

filterTags

匹配API标签，当作用域为MATCH_APIS时此项为可选

类型array

唯一项true

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/services/{serviceId}/apis/parameter/enabled

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

names*

enabled*

scope*

selectedApisIds

matchEndpointRegex

matchMethod

filterTags

示例

cURL

JavaScript

PHP

Python

---

查询HTTP和WebSocket API列表

GET

/api/v1/services/{serviceId}/apis

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

格式"int64"

查询参数

id

接口ID

类型integer

格式"int64"

protocol

类型string

有效值

"http""https""ws""wss"

summary

类型string

operationId

类型string

admin

当应用管理员查询所有项目时必填

类型boolean

hasPermission

当用户查询具有单一权限项目时必填

类型string

有效值

"ADD""VIEW""MODIFY""DELETE""TEST""GRANT""SHARE""RELEASE""EXPORT"

endpoint

类型string

createdDate

类型string

格式"date-time"

createdBy

类型integer

格式"int64"

ownerId

类型integer

格式"int64"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

格式"int32"

最大值2000

最小值1

orderBy

排序字段

类型string

orderSort

排序方式

类型string

有效值

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

过滤条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

过滤条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

过滤条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

有效值

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/apis

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

id

protocol

summary

operationId

admin

hasPermission

endpoint

createdDate

createdBy

ownerId

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---