跳转至

域名配置

POST 查询函数配置

POST /prod-api/cdn/layer7/function/describeFunctions

functionName 查询域名下的函数配置。functionName 不传时,返回该域名下全部函数列表。

Body 请求参数

查询 IP 白名单

{
  "domainId": "215",
  "functionName": "IPWhitelist"
}

查询 HTTP/3、TLS 等开关类配置functionName 分别为 http3tls_version

{
  "domainId": "215",
  "functionName": "http3"
}

查询全部函数(不传 functionName

{
  "domainId": "215"
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string -
body body DescribeFunctionVO DescribeFunctionVO -

返回示例

200 Response

{
  "msg": "成功",
  "code": 200,
  "data": [
    {
      "functionArgs": [
        { "argName": "values", "argValue": "[\"1.1.1.1\",\"22.2.2.2\"]" }
      ],
      "functionName": "IPWhitelist",
      "functionId": 77
    },
    {
      "functionArgs": [
        { "argName": "status", "argValue": 0 }
      ],
      "functionName": "http3"
    },
    {
      "functionArgs": [
        { "argName": "status", "argValue": 0 }
      ],
      "functionName": "tls_version"
    }
  ]
}

functionNamefunctionArgs 对照

根据返回中的 functionName,读取对应的 functionArgs

functionName 含义 argName argValue 类型 说明
IPWhitelist IP 白名单 values 字符串 IP 列表的 JSON 字符串,如 "[\"1.1.1.1\",\"22.2.2.2\"]"。更新时见 更新函数
http3 HTTP/3 status 整数 0:开启;1:关闭
tls_version TLS 版本 status 整数 0:开启 TLS 1.0 / 1.1 / 1.2;1:开启 TLS 1.2 / 1.3

同一域名下,上述函数各仅一条配置(functionId 在更新时如需指定可一并返回)。

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK Inline
201 Created Created -
401 Unauthorized Unauthorized -
403 Forbidden Forbidden -
404 Not Found Not Found -

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» msg string true - 提示信息 -
» code integer true - 状态码 -
» data [object] true - 函数列表 见上方对照表
»» functionName string true - 函数名称 -
»» functionId integer false - 函数 ID 更新时可传入 更新函数
»» functionArgs [object] true - 函数参数 argNameargValuefunctionName 变化

数据模型

DescribeFunctionVO

{
  "domainId": 0,
  "functionId": 0,
  "functionName": "string"
}

DescribeFunctionVO

属性

名称 类型 必选 约束 中文名 说明
domainId integer(int64) true - 域名 ID -
functionId integer(int64) false - 函数 ID 可选,按 ID 精确查询
functionName string false - 函数名称 可选,取值见上方对照表:IPWhitelisthttp3tls_version 等;不传则返回全部