文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Tenant/ 修改租户ip白名单
更新时间：2025-03-28 GMT+08:00
查看PDF
分享

修改租户ip白名单

功能介绍

修改租户ip白名单

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v4/tenant/trusted-ip-addresses/{ip_id}

表1 路径参数

参数

是否必选

参数类型

描述

ip_id

是

Integer

参数解释：

ip白名单id。

取值范围：

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

ip_type

否

Integer

参数解释：

格式类型。

  • 0，表示指定ip。

  • 1，表示ip范围。

  • 2，表示CIDR。

默认取值：

0

枚举值：

  • 0

  • 1

  • 2

ip_start

否

String

参数解释：

起始ip。

ip_end

否

String

参数解释：

结束ip。

view_flag

否

Integer

参数解释：

是否允许访问代码仓库。

  • 0，表示禁止访问。

  • 1，表示允许访问。

默认取值：

0

枚举值：

  • 0

  • 1

download_flag

否

Integer

参数解释：

是否允许下载代码。

  • 0，表示禁止下载。

  • 1，表示允许下载。

默认取值：

0

枚举值：

  • 0

  • 1

upload_flag

否

Integer

参数解释：

是否允许提交代码。

  • 0，表示禁止提交。

  • 1，表示允许提交。

默认取值：

0

枚举值：

  • 0

  • 1

remark

否

String

参数解释：

备注。

取值范围：

字符串长度不少于0，不超过200。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释：

ip白名单id。

user_id

Integer

参数解释：

用户id。

取值范围：

0-2147483647

domain_id

String

参数解释：

租户id。

ip_range

String

参数解释：

ip范围。

ip_type

Integer

参数解释：

格式类型。

  • 0，表示指定IP。

  • 1，表示ip范围。

  • 2，表示CIDR。

默认取值：

0

枚举值：

  • 0

  • 1

  • 2

ip_start

String

参数解释：

起始ip。

ip_end

String

参数解释：

结束ip。

view_flag

Integer

参数解释：

是否允许访问代码仓库。

  • 0，表示禁止访问。

  • 1，表示允许访问。

默认取值：

0

枚举值：

  • 0

  • 1

download_flag

Integer

参数解释：

是否允许下载代码。

  • 0，表示禁止下载。

  • 1，表示允许下载。

默认取值：

0

枚举值：

  • 0

  • 1

upload_flag

Integer

参数解释：

是否允许提交代码。

  • 0，表示禁止提交。

  • 1，表示允许提交。

默认取值：

0

枚举值：

  • 0

  • 1

remark

String

参数解释：

备注。

取值范围：

字符串长度不少于0，不超过200。

created_at

String

参数解释：

创建时间。

参数解释：

MMM dd, yyyy hh:mm:ss a

updated_at

String

参数解释：

更新时间。

参数解释：

MMM dd, yyyy hh:mm:ss a

order_flag

Integer

参数解释：

排序。

  • 0，表示默认规则。

  • 1，表示自定义规则。

枚举值：

  • 0

  • 1

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

PUT https://{endpoint}/v4/tenant/trusted-ip-addresses/1

{
  "ip_type" : 0,
  "ip_start" : "1.1.1.1",
  "ip_end" : "1.1.1.1",
  "view_flag" : 1,
  "download_flag" : 1,
  "upload_flag" : 1,
  "remark" : "xxx办公网"
}

响应示例

状态码：200

OK

{
  "id" : 19326,
  "user_id" : 7574,
  "ip_range" : "1.1.1.1",
  "ip_start" : "1.1.1.1",
  "ip_end" : "1.1.1.1",
  "ip_type" : 0,
  "view_flag" : 1,
  "download_flag" : 1,
  "upload_flag" : 1,
  "order_flag" : 1,
  "domain_id" : "159b65b41ead484d8ddff250a4731781",
  "remark" : ""
}

状态码：401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

OK

401

Unauthorized

错误码

请参见错误码。

父主题： Tenant