DRF Docs

Document Web APIs made with Django REST Framework.

api

获取个人信息

Fields:

  • email: EmailField 电子邮件地址
  • id: IntegerField ID
  • username: CharField 用户名

获取用户Token

Fields:

  • username: CharField 用户名 R
  • password: CharField 密码 R

获取节点信息

Fields:

  • os: ChoiceField 系统类型
  • stationname: CharField 系统名称
  • os_detail: CharField 系统详细描述
  • token: CharField None
  • remarks: CharField 备注信息
  • pk: IntegerField ID
  • lock: ChoiceField 锁定状态

单个节点信息的修改和删除

Fields:

  • os: ChoiceField 系统类型
  • stationname: CharField 系统名称
  • os_detail: CharField 系统详细描述
  • token: CharField None
  • remarks: CharField 备注信息
  • pk: IntegerField ID
  • lock: ChoiceField 锁定状态

获取域名信息

Fields:

  • pk: IntegerField ID
  • full_domain: CharField 完整域名 R
  • root_domain: CharField 根域名(可不填写)
  • remarks: CharField 描述信息
  • setting: PrimaryKeyRelatedField 关联配置
  • zone: PrimaryKeyRelatedField 关联节点分组 R
  • port: IntegerField 监听端口
  • https: BooleanField 网站协议,启用https
  • backend_https: BooleanField 回源协议,启用https
  • ssl: PrimaryKeyRelatedField 证书
  • server: CharField 源站服务器IP:源站端口
  • http_redirect_https: BooleanField HTTP强制跳转到HTTPS
  • isalive: ChoiceField 状态

单个域名信息的修改和删除

Fields:

  • pk: IntegerField ID
  • full_domain: CharField 完整域名 R
  • root_domain: CharField 根域名(可不填写)
  • remarks: CharField 描述信息
  • setting: PrimaryKeyRelatedField 关联配置
  • zone: PrimaryKeyRelatedField 关联节点分组 R
  • port: IntegerField 监听端口
  • https: BooleanField 网站协议,启用https
  • backend_https: BooleanField 回源协议,启用https
  • ssl: PrimaryKeyRelatedField 证书
  • http_redirect_https: BooleanField HTTP强制跳转到HTTPS
  • back_source: BooleanField IP回源
  • isalive: ChoiceField 状态

获取域名证书

Fields:

  • pk: IntegerField ID
  • name: CharField 证书名称 R
  • ssl_certificate: CharField 证书公钥 R
  • ssl_certificate_key: CharField 证书私钥 R

单个域名证书信息的修改和删除

Fields:

  • pk: IntegerField ID
  • name: CharField 证书名称 R
  • ssl_certificate: CharField 证书公钥 R
  • ssl_certificate_key: CharField 证书私钥 R

获取分组列表

Fields:

  • pk: IntegerField ID
  • zonename: CharField 分组名称 R
  • remarks: CharField 备注
  • created: DateTimeField 创建时间
  • updated: DateTimeField 更新时间
  • default_zone: BooleanField 是否为默认分组

获取配置列表

Fields:

  • pk: IntegerField ID
  • remarks: CharField 配置名称
  • created: DateTimeField 创建时间
  • updated: DateTimeField 更新时间

获取清除缓存任务历史列表

Fields:

  • pk: IntegerField ID
  • urls: JSONField URL列表,需要为数组 R
  • remark: CharField 备注
  • count: IntegerField 引用次数
  • created: DateTimeField 创建时间
  • updated: DateTimeField 更新时间

重新下发清除缓存任务

Fields:

  • pk: IntegerField ID
  • urls: JSONField URL列表,需要为数组 R
  • remark: CharField 备注
  • count: IntegerField 引用次数
  • created: DateTimeField 创建时间
  • updated: DateTimeField 更新时间