全部产品

CORS 配置

更新时间:2020-04-21 11:33:47

本文列出了 CORS 跨域资源共享相关的所有 OpenAPI 及其请求参数、返回参数。

创建 CORS 配置

sofa.apigateway.cors.create 用于创建 CORS 配置。

请求参数

名称 类型 是否必填 示例 描述
param CorsInfoVO - CORS 配置信息
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

删除 CORS 配置

sofa.apigateway.cors.delete 用于删除一个指定的 CORS 规则。

请求参数

名称 类型 是否必填 示例 描述
cors_id STRING cors_id1 CORS 规则标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

更新 CORS 配置

sofa.apigateway.cors.update 用于更新一个指定的 CORS 规则。

请求参数

名称 类型 是否必填 示例 描述
param CorsInfoVO - CORS 配置信息
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

通过 ID 查询 CORS 配置

sofa.apigateway.cors.get 用于查询指定 ID 的 CORS 配置。

请求参数

名称 类型 是否必填 示例 描述
cors_id STRING cors_id1 CORS 规则标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

查询 CORS 列表

sofa.apigateway.cors.all 用于查询所有 CORS 规则列表。

请求参数

名称 类型 是否必填 示例 描述
param CorsInfoQueryVO - CORS 查询参数
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

查询 CORS 分页列表

sofa.apigateway.cors.list 用于查询 CORS 分页列表。

请求参数

名称 类型 是否必填 示例 描述
param CorsInfoQueryVO - CORS 查询参数
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

根据 CORS ID 查询 API 列表

sofa.apigateway.cors.api.all 用于查询指定 ID 的 CORS 绑定的所有 API 列表。

请求参数

名称 类型 是否必填 示例 描述
cors_id STRING cors_id1 CORS 标识
param ApiInfoQueryVO - API 查询信息
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

根据 CORS ID 查询 API 分页列表

sofa.apigateway.cors.api.list 用于查询指定 ID 的 CORS 绑定的 API 分页列表。

请求参数

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

返回参数

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

根据 CORS ID 绑定 API

sofa.apigateway.cors.api.mount 用于将指定 CORS 绑定 API。

请求参数

名称 类型 是否必填 示例 描述
api_id_list ARRAY[STRING] - 绑定的 API ID 列表
cors_id STRING cors_id1 CORS 标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data BatchActionResult data

根据 CORS ID 解绑 API

sofa.apigateway.cors.api.unmount 用于根据 CORS ID 解绑 API。

请求参数

名称 类型 是否必填 示例 描述
api_id_list ARRAY[STRING] - 绑定的 API ID 列表
cors_id STRING cors_id1 cors标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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