XCan Cloud

English

简体中文

English

简体中文

Appearance

ServicesApis​

Service apis and parameters management - Configure global parameters (e.g., authentication headers, versioning) for all APIs under a service

Add api variable references​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

names*

Variable names

类型array
必填
最大项数200
最小项数0
scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Delete api variable references​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

names*

Variable names

类型array
必填
最大项数200
最小项数0
scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Add api parameters​

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

Add the parameters of apis, override parameter value if it exists

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

请求体​

application/json
JSON
[
{
"name": "string",
"in": "string",
"description": "string",
"required": true,
"deprecated": true,
"allowEmptyValue": true,
"get$ref": "string",
"style": "string",
"explode": true,
"allowReserved": true,
"schema": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": "[Circular Reference]",
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"examples": {
"additionalProperties": {
}
},
"example": {
},
"content": {
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
}
}
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值
主体

示例​

cURL
JavaScript
PHP
Python

Delete api parameters​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

names*

Parameter names

类型array
必填
最大项数200
最小项数0
scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Update api parameters​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

请求体​

application/json
JSON
[
{
"name": "string",
"in": "string",
"description": "string",
"required": true,
"deprecated": true,
"allowEmptyValue": true,
"get$ref": "string",
"style": "string",
"explode": true,
"allowReserved": true,
"schema": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": "[Circular Reference]",
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"examples": {
"additionalProperties": {
}
},
"example": {
},
"content": {
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
}
}
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值
主体

示例​

cURL
JavaScript
PHP
Python

Add api dataset reference​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

names*

Dataset names

类型array
必填
最大项数200
最小项数0
scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Delete api dataset references​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

names*

Dataset names

类型array
必填
最大项数200
最小项数0
scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Update the current api server configuration​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

请求体​

application/json
JSON
{
"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",
"description": "The production API server",
"variables": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
},
"emptyContent": true,
"notEmptyContent": true
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值
主体

示例​

cURL
JavaScript
PHP
Python

Enable or disable api parameters​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

names*

Parameter names

类型array
必填
最大项数200
最小项数0
enabled*

Enabled or Disabled

类型boolean
必填
scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Update api authentication​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

scope*

Modify parameter API scope, default 'ALL'

类型string
必填
有效值
"ALL""SELECTED_APIS""MATCH_APIS"
selectedApisIds

Selected apis ids, it is required when the scope is a SELECTED_APIS

类型array
唯一项true
matchEndpointRegex

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
matchMethod

Match apis regex, it is optional when the scope is a MATCH_APIS

类型string
有效值
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
filterTags

Match apis tags, it is optional when the scope is a MATCH_APIS

类型array
唯一项true

请求体​

application/json
JSON
{
"type": "string",
"description": "string",
"name": "string",
"get$ref": "string",
"in": "string",
"scheme": "string",
"bearerFormat": "string",
"flows": {
"implicit": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"password": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"clientCredentials": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"authorizationCode": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"extensions": {
"additionalProperties": {
}
}
},
"openIdConnectUrl": "string",
"extensions": {
"additionalProperties": {
}
}
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值
主体

示例​

cURL
JavaScript
PHP
Python

Query the list of HTTP and WebSocket apis​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

id

Apis id

类型integer
格式"int64"
protocol
类型string
有效值
"http""https""ws""wss"
summary
类型string
operationId
类型string
admin

Required when app administrators query all projects

类型boolean
hasPermission

Required when the user query has the one permission project

类型string
有效值
"ADD""VIEW""MODIFY""DELETE""TEST""GRANT""SHARE""RELEASE""EXPORT"
endpoint
类型string
createdDate
类型string
格式"date-time"
createdBy
类型integer
格式"int64"
ownerId
类型integer
格式"int64"
pageNo

Page data size, default 1, maximum 100000

类型integer
格式"int32"
最大值100000
最小值1
pageSize

Page data size, default 10, maximum 2000

类型integer
格式"int32"
最大值2000
最小值1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
有效值
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string
有效值
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Fulltext search the HTTP and WebSocket apis​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

路径参数

serviceId*

Services id

类型integer
必填
格式"int64"

查询参数

id

Apis id

类型integer
格式"int64"
protocol
类型string
有效值
"http""https""ws""wss"
summary
类型string
operationId
类型string
admin

Required when app administrators query all projects

类型boolean
hasPermission

Required when the user query has the one permission project

类型string
有效值
"ADD""VIEW""MODIFY""DELETE""TEST""GRANT""SHARE""RELEASE""EXPORT"
endpoint
类型string
createdDate
类型string
格式"date-time"
createdBy
类型integer
格式"int64"
ownerId
类型integer
格式"int64"
pageNo

Page data size, default 1, maximum 100000

类型integer
格式"int32"
最大值100000
最小值1
pageSize

Page data size, default 10, maximum 2000

类型integer
格式"int32"
最大值2000
最小值1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
有效值
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string
有效值
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}
授权
变量
键
值
cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.

Copyright © 2021-2025 XCan Cloud