ekuiper-new/etc/sinks/rest.json

{
  "about": {
    "trial": false,
    "author": {
      "name": "EMQ",
      "email": "contact@emqx.io",
      "company": "EMQ Technologies Co., Ltd",
      "website": "https://www.emqx.io"
    },
    "helpUrl": {
      "en_US": "https://ekuiper.org/docs/en/latest/guide/sinks/builtin/rest.html",
      "zh_CN": "https://ekuiper.org/docs/zh/latest/guide/sinks/builtin/rest.html"
    },
    "description": {
      "en_US": "The action is used for publish output message into a RESTful API.",
      "zh_CN": "该动作用于将输出消息发布到 RESTful API 中。"
    }
  },
  "properties": [
    {
      "name": "url",
      "default": "",
      "optional": false,
      "control": "text",
      "type": "string",
      "hint": {
        "en_US": "The RESTful API endpoint, such as https://www.example.com/api/dummy",
        "zh_CN": "RESTful API 终端地址，例如 https://www.example.com/api/dummy"
      },
      "label": {
        "en_US": "URL",
        "zh_CN": "地址"
      }
    },
    {
      "name": "method",
      "optional": true,
      "control": "select",
      "default": "GET",
      "type": "string",
      "values": [
        "GET",
        "POST",
        "PUT",
        "DELETE",
        "HEAD"
      ],
      "hint": {
        "en_US": "The HTTP method for the RESTful API.",
        "zh_CN": "RESTful API 的 HTTP 方法。"
      },
      "label": {
        "en_US": "HTTP method",
        "zh_CN": "HTTP 方法"
      }
    },
    {
      "name": "bodyType",
      "optional": true,
      "control": "select",
      "default": "none",
      "type": "string",
      "values": [
        "none",
        "json",
        "text",
        "html",
        "xml",
        "javascript",
        "form"
      ],
      "hint": {
        "en_US": "The type of the body. For \"get\" and \"head\", no body is required so the default value is \"none\". For other http methods, the default value is \"json\" For \"html\", \"xml\" and \"javascript\", the dataTemplate must be carefully set up to make sure the format is correct.",
        "zh_CN": "消息体的类型。对于 \"get\" 和 \"head\"，不需要正文，因此默认值为 \"none\"。 对于其他 http 方法，默认值为 \"json\"。对于 \"html\"，\"xml\" 和 \"javascript\"，必须仔细设置 dataTemplate 以确保格式正确。"
      },
      "label": {
        "en_US": "Body type",
        "zh_CN": "消息体类型"
      }
    },
    {
      "name": "timeout",
      "default": 5000,
      "optional": true,
      "control": "text",
      "type": "int",
      "hint": {
        "en_US": "The timeout (milliseconds) for a HTTP request, defaults to 5000 ms",
        "zh_CN": "HTTP 请求超时的时间（毫秒），默认为5000毫秒"
      },
      "label": {
        "en_US": "Timeout(ms)",
        "zh_CN": "超时(ms)"
      }
    },
    {
      "name": "headers",
      "default": {},
      "optional": true,
      "control": "list",
      "type": "object",
      "hint": {
        "en_US": "The additional headers to be set for the HTTP request.",
        "zh_CN": "要为 HTTP 请求设置的其他标头"
      },
      "label": {
        "en_US": "HTTP headers",
        "zh_CN": "HTTP 头"
      }
    },
    {
      "name": "certificationPath",
      "default": "",
      "optional": true,
      "connection_related": true,
      "control": "text",
      "type": "string",
      "hint": {
        "en_US": "The location of certification path. It can be an absolute path, or a relative path.",
        "zh_CN": "证书路径。可以为绝对路径，也可以为相对路径。如果指定的是相对路径，那么父目录为执行 server 命令的路径。"
      },
      "label": {
        "en_US": "Certification path",
        "zh_CN": "证书路径"
      }
    },
    {
      "name": "privateKeyPath",
      "default": "",
      "optional": true,
      "connection_related": true,
      "control": "text",
      "type": "string",
      "hint": {
        "en_US": "The location of private key path. It can be an absolute path, or a relative path. ",
        "zh_CN": "私钥路径。可以为绝对路径，也可以为相对路径。"
      },
      "label": {
        "en_US": "Private key path",
        "zh_CN": "私钥路径"
      }
    },
    {
      "name": "rootCaPath",
      "default": "",
      "optional": true,
      "connection_related": true,
      "control": "text",
      "type": "string",
      "hint": {
        "en_US": "The location of root ca path. It can be an absolute path, or a relative path. ",
        "zh_CN": "根证书路径，用以验证服务器证书。可以为绝对路径，也可以为相对路径。"
      },
      "label": {
        "en_US": "Root CA path",
        "zh_CN": "根证书路径"
      }
    },
    {
      "name": "insecureSkipVerify",
      "default": true,
      "optional": true,
      "control": "radio",
      "type": "bool",
      "hint": {
        "en_US": "Control if to skip the certification verification. If it is set to true, then skip certification verification; Otherwise, verify the certification.",
        "zh_CN": "控制是否跳过证书认证。如果被设置为 true，那么跳过证书认证；否则进行证书验证。"
      },
      "label": {
        "en_US": "Skip Certification verification",
        "zh_CN": "跳过证书验证"
      }
    },
    {
      "name": "debugResp",
      "default": true,
      "optional": true,
      "control": "radio",
      "type": "bool",
      "hint": {
        "en_US": "Control if print the response information into the console. If set it to true, then print response; If set to false, then skip print log.",
        "zh_CN": "控制是否将响应信息打印到控制台中。 如果将其设置为 true，则打印响应；如果设置为 false，则跳过打印日志。"
      },
      "label": {
        "en_US": "Print HTTP response",
        "zh_CN": "打印 HTTP 响应"
      }
    },
    {
      "name": "responseType",
      "default": "code",
      "optional": true,
      "control": "select",
      "type": "string",
      "values": [
        "code",
        "body"
      ],
      "hint": {
        "en_US": "Response type, could be `code` or `body`. If it is `code`, then eKuiper will check the HTTP response code for response status. If it is `body`, then eKuiper will check the HTTP response body with JSON format and examine the value of the code field.",
        "zh_CN": "响应类型,可以是 `code` 或者 `body`，如果是 `code`，那么 eKuiper 会检查 HTTP 响应码来判断响应状态。如果是 `body`，那么 eKuiper 会检查 HTTP 响应正文，要求其为 JSON 格式，并且检查 code 字段的值。"
      },
      "label": {
        "en_US": "Response type",
        "zh_CN": "响应类型"
      }
    },
    {
      "name": "oauth",
      "optional": true,
      "control": "list",
      "type": "list_object",
      "hint": {
        "en_US": "Configure the oauth authentication flow.",
        "zh_CN": "配置 OAuth 验证流程。"
      },
      "label": {
        "en_US": "OAuth",
        "zh_CN": "OAuth"
      },
      "default":[
        {
          "name": "access",
          "optional": true,
          "control": "list",
          "type": "list_object",
          "hint": {
            "en_US": "Configure how to fetch the access token.",
            "zh_CN": "配置如何获取访问令牌。"
          },
          "label": {
            "en_US": "Access token request",
            "zh_CN": "访问令牌请求"
          },
          "default": [
            {
              "name": "url",
              "default": "",
              "optional": true,
              "control": "text",
              "type": "string",
              "hint": {
                "en_US": "The URL where to get the access token.",
                "zh_CN": "获取访问令牌的 URL"
              },
              "label": {
                "en_US": "Access Token URL",
                "zh_CN": "访问令牌 URL"
              }
            },
            {
              "name": "body",
              "default": "",
              "optional": true,
              "control": "textarea",
              "type": "string",
              "hint": {
                "en_US": "The body of access token request",
                "zh_CN": "访问令牌请求的正文"
              },
              "label": {
                "en_US": "Access Token Request Body",
                "zh_CN": "访问令牌请求的正文"
              }
            },
            {
              "name": "expire",
              "default": "",
              "optional": true,
              "control": "text",
              "type": "string",
              "hint": {
                "en_US": "The expire time or expire time template",
                "zh_CN": "过期时间"
              },
              "label": {
                "en_US": "Expire Time",
                "zh_CN": "过期时间"
              }
            }
          ]
        },
        {
          "name": "refresh",
          "optional": true,
          "control": "list",
          "type": "list_object",
          "hint": {
            "en_US": "Configure how to refresh token after expiration.",
            "zh_CN": "配置令牌过期后如何更新令牌。"
          },
          "label": {
            "en_US": "Refresh token request",
            "zh_CN": "更新令牌请求"
          },
          "default": [
            {
              "name": "url",
              "default": "",
              "optional": true,
              "control": "text",
              "type": "string",
              "hint": {
                "en_US": "The URL where to get the refresh token.",
                "zh_CN": "获取更新令牌的 URL"
              },
              "label": {
                "en_US": "Refresh Token URL",
                "zh_CN": "更新令牌 URL"
              }
            },
            {
              "name": "headers",
              "optional": true,
              "control": "list",
              "type": "list_object",
              "hint": {
                "en_US": "The HTTP request headers that you want to send along with the HTTP refresh request.",
                "zh_CN": "需要与刷新 Token HTTP 请求一起发送的 HTTP 请求标头。"
              },
              "label": {
                "en_US": "Refresh token request headers",
                "zh_CN": "刷新令牌请求标头"
              }
            },
            {
              "name": "body",
              "default": "",
              "optional": true,
              "control": "textarea",
              "type": "string",
              "hint": {
                "en_US": "The body of refresh token request",
                "zh_CN": "刷新令牌请求的正文"
              },
              "label": {
                "en_US": "Refresh token request body",
                "zh_CN": "刷新令牌请求的正文"
              }
            }
          ]
        }
      ]
    }
  ],
  "node": {
    "category": "sink",
    "icon": "iconPath",
    "label": {
      "en": "Rest",
      "zh": "Rest"
    }
  }
}