PyScripts 模块 REST API¶

GET /v1/rating/module_config/pyscripts/scripts¶

获取脚本列表

参数：

no_data (bool) – 设置为 True 以从输出中移除脚本数据。
deleted (bool) – 显示已删除的映射。
start (datetime) – 映射开始时间晚于该日期。
end (datetime) – 映射结束时间早于该日期。
updated_by (str) – 用于筛选的用户 uuid。
created_by (str) – 用于筛选的用户 uuid。
deleted_by (str) – 用于筛选的用户 uuid。
description (str) – 描述中包含该文本的映射。
is_active (bool) – 仅活动映射。

返回:

所有脚本的列表。

返回类型:

ScriptCollection

GET /v1/rating/module_config/pyscripts/scripts/(script_id)¶

返回一个脚本。

参数：

script_id (uuid) – 用于筛选的脚本的 UUID。

返回类型:

脚本

POST /v1/rating/module_config/pyscripts/scripts¶

创建 pyscripts 脚本。

参数：

force (bool) – 允许过去开始和结束时间。
script_data (Script) – 要创建的脚本的信息。

返回类型:

脚本

PUT /v1/rating/module_config/pyscripts/scripts¶

更新 pyscripts 脚本。

参数：

script_id (uuid) – 要更新的脚本的 UUID。
script_data (Script) – 要更新的脚本数据。

返回类型:

脚本

DELETE /v1/rating/module_config/pyscripts/scripts¶

删除脚本。

参数：

script_id (uuid) – 要删除的脚本的 UUID。

type Script¶

描述脚本的类型。

数据示例

Json

{
    "created_at": "2023-01-01T10:10:10",
    "created_by": "7977999e2e2511e6a8b2df30b233ffcb",
    "deleted": "2023-01-15T00:00:00",
    "deleted_by": "7977999e2e2511e6a8b2df30b233ffcb",
    "description": "description",
    "end": "2023-03-01T00:00:00",
    "name": "rule 1",
    "start": "2023-02-01T00:00:00",
    "updated_by": "7977999e2e2511e6a8b2df30b233ffcb"
}

XML

b'<value>\n  <name>rule 1</name>\n  <created_at>2023-01-01T10:10:10</created_at>\n  <start>2023-02-01T00:00:00</start>\n  <end>2023-03-01 00:00:00</end>\n  <description>description</description>\n  <deleted>2023-01-15T00:00:00</deleted>\n  <created_by>7977999e2e2511e6a8b2df30b233ffcb</created_by>\n  <updated_by>7977999e2e2511e6a8b2df30b233ffcb</updated_by>\n  <deleted_by>7977999e2e2511e6a8b2df30b233ffcb</deleted_by>\n</value>'

checksum¶: 脚本数据的校验和。

created_at¶: 创建规则的日期。

created_by¶: 创建规则的用户的 ID。

data¶: 脚本的数据。

deleted¶: 删除规则的日期。

deleted_by¶: 删除规则的用户的 ID。

description¶: 规则的描述。

end¶: 必须为 None 或未来的日期。要设置过去的日期，请在 POST 查询中使用 force 参数。

name¶: 脚本的名称。

script_id¶: 脚本的 UUID。

start¶: 必须为 None 或未来的日期。要设置过去的日期，请在 POST 查询中使用 force 参数。

updated_by¶: 最后更新规则的用户的 ID。

type ScriptCollection¶

描述脚本列表的类型。

数据示例

Json

{
    "scripts": [
        {
            "created_at": "2023-01-01T10:10:10",
            "created_by": "7977999e2e2511e6a8b2df30b233ffcb",
            "deleted": "2023-01-15T00:00:00",
            "deleted_by": "7977999e2e2511e6a8b2df30b233ffcb",
            "description": "description",
            "end": "2023-03-01T00:00:00",
            "name": "rule 1",
            "start": "2023-02-01T00:00:00",
            "updated_by": "7977999e2e2511e6a8b2df30b233ffcb"
        }
    ]
}

XML

b'<value>\n  <scripts>\n    <item>\n      <name>rule 1</name>\n      <created_at>2023-01-01T10:10:10</created_at>\n      <start>2023-02-01T00:00:00</start>\n      <end>2023-03-01 00:00:00</end>\n      <description>description</description>\n      <deleted>2023-01-15T00:00:00</deleted>\n      <created_by>7977999e2e2511e6a8b2df30b233ffcb</created_by>\n      <updated_by>7977999e2e2511e6a8b2df30b233ffcb</updated_by>\n      <deleted_by>7977999e2e2511e6a8b2df30b233ffcb</deleted_by>\n    </item>\n  </scripts>\n</value>'

scripts¶: 脚本列表。

PyScripts Module REST API

PyScripts 模块 REST API¶

cloudkitty 23.0.1.dev1

页面内容