跳转到主要内容
POST
更新映射 API

限制说明

使用说明

  • 不传的字段保持原值。headers 一旦传入即整体替换请求头,传 {} 可清空全部请求头;team_id 传 0 表示解除团队关联。
  • 传入的字段按创建时的规则校验(url 协议与内网地址检查、请求头规则、timeout 1–3、retry_count 0–1);description 超过 500 字符会被截断。
  • api_id 不存在时返回 InvalidParameter;新的 api_name 不能与其他映射 API 重名。
  • 仅账户管理员、映射 API 创建者或映射 API 所属团队的成员可以调用,其他人返回 AccessDenied。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json
api_id
string
必填

映射 API ID(MongoDB ObjectID 十六进制)。

api_name
string | null

新名称,在未删除的映射 API 中唯一(最长 199 字符)。不传则保持不变。

Maximum string length: 199
description
string | null

新描述,超过 500 字符会被截断。不传则保持不变,传 "" 清空。

url
string<uri> | null

新的 http/https 地址(最长 500 字符);SaaS 环境下主机名不得解析到内网 IP。不传则保持不变。

Maximum string length: 500
insecure_skip_verify
boolean | null

新的跳过 TLS 证书校验设置。不传则保持不变。

headers
object

传入时整体替换请求头,传 {} 清空全部请求头;不传则保持不变。SaaS 环境下会拒绝敏感请求头(见 /enrichment/mapping/api/create);键最长 1,024 字符,值最长 4,096 字符。

timeout
integer | null

新的整个请求超时时间,单位秒(1–3)。不传则保持不变。

必填范围: 1 <= x <= 3
retry_count
integer | null

新的重试次数(0–1)。不传则保持不变。

必填范围: 0 <= x <= 1
team_id
integer<int64> | null

新的所属团队 ID,可通过 POST /team/list 获取;传 0 解除团队关联。不传则保持不变。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

无返回数据。不同接口的 data 可能是 {},也可能不出现在响应中;请只根据 HTTP 200 且没有 error 判断成功。