CORS 配置
本文列出了 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 |