ModifyForwardStrategyBindingItems - 更新转发策略绑定的对象

更新时间:
复制 MD 格式

修改转发策略绑定项目

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ForwardId

string

是

转发策略 ID。

fs-849ac29396d9ea98

MatchMode

string

否

策略匹配目标类型。必填。取值:

  • UserGroupAll:关联全体用户。

  • UserGroupNormal:关联部分用户组。

  • ApplicationAll: 所有内网应用。

  • Application: 部分内网应用。

  • Tag: 内网应用标签。

取值为 UserGroupAll 或 ApplicationAll 时,ItemIds 必须为空;取值为 UserGroupNormal、Application 或 Tag 时,ItemIds 必填。

ModifyType 不为 Cover 时不允许切换匹配目标类型:Application、Tag、ApplicationAll 三者互斥,UserGroupNormal 与 UserGroupAll 互斥。同一转发策略上已存在互斥类型的绑定项时,请求会被拒绝。

Application

ModifyType

string

否

修改方式。必填。取值:

  • Append:在现有绑定项上追加。ItemIds 中不能包含已绑定的对象。

  • Delete:删除指定的绑定项。ItemIds 中必须全部为已绑定的对象。

  • Cover:覆盖同类绑定项,即先清空该转发策略上同类的全部绑定项,再写入 ItemIds。同类范围为 ApplicationAll、Application、Tag,或 UserGroupAll、UserGroupNormal。

取值为 Append 或 Delete 时,MatchMode 不能为 UserGroupAll 或 ApplicationAll。

Cover

ItemIds

array

否

绑定项 ID 列表。MatchMode 为 UserGroupAll 或 ApplicationAll 时必须为空,其余取值时必填。列表内不允许重复,且所指定的对象必须已存在。

string

否

绑定项 ID。格式由 MatchMode 决定:

  • UserGroupNormal:用户组 ID,格式为 usergroup- 加 16 位小写字母或数字。

  • Application:内网访问应用 ID,格式为 pa-application- 加 16 位小写字母或数字。

  • Tag:内网访问标签 ID,格式为 tag- 加 16 位小写字母或数字。

pa-application-104b6b97b7f0c5d9

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

本次请求的 ID。

5F79AE39-6622-5292-87EF-DE45631DE4D7

ForwardStrategyBindingItems

object

本次修改后该转发策略的绑定项。

Items

array<object>

绑定内容。MatchMode 为 UserGroupAll 或 ApplicationAll 时不返回该参数。

object

数据项。

ApplicationName

string

内网访问应用名称。

OA系统

ApplicationId

string

内网访问应用 ID。

pa-application-104b6b97b7f0c5d9

TagName

string

标签名称。

财务系统

TagId

string

内网访问标签 ID。

tag-4c8b988bb0ffdfb3

UserGroupName

string

用户组名称。

研发部

UserGroupId

string

用户组 ID。

usergroup-3f9a2c7e10b4d856

MatchMode

string

策略匹配目标类型。取值:

  • UserGroupAll:关联全体用户。

  • UserGroupNormal:关联部分用户组。

  • ApplicationAll: 所有内网应用。

  • Application: 部分内网应用。

  • Tag: 内网应用标签。

Application

ForwardId

string

转发策略 ID。

fs-849ac29396d9ea98

示例

正常返回示例

JSON格式

{
  "RequestId": "5F79AE39-6622-5292-87EF-DE45631DE4D7",
  "ForwardStrategyBindingItems": {
    "Items": [
      {
        "ApplicationName": "OA系统",
        "ApplicationId": "pa-application-104b6b97b7f0c5d9",
        "TagName": "财务系统",
        "TagId": "tag-4c8b988bb0ffdfb3",
        "UserGroupName": "研发部",
        "UserGroupId": "usergroup-3f9a2c7e10b4d856"
      }
    ],
    "MatchMode": "Application",
    "ForwardId": "fs-849ac29396d9ea98"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。