创建项目下的保护tag
功能介绍
创建项目下的保护tag
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v4/projects/{project_id}/protected-tags
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 取值范围: 字符串长度32。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
参数解释: 保护tag名称。 取值范围 字符串长度不少于1,不超过1000。 |
actions |
否 |
Array of ProjectProtectedTagActionDto objects |
参数解释: 事件列表。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
否 |
String |
参数解释: 事件名称。 取值范围:read 查询,create-delete 增删,create 创建 字符串长度不少于1,不超过1000。 枚举值:
|
enable |
否 |
Boolean |
参数解释: 是否启用。 |
user_ids |
否 |
Array of integers |
参数解释: 用户ID列表。 约束限制: 不涉及。 取值范围: Integer 默认取值: 不涉及。 取值范围: 1-2147483647 |
user_names |
否 |
Array of strings |
参数解释: 用户name列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
user_team_ids |
否 |
Array of integers |
参数解释: 成员组ID列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 取值范围: 1-2147483647 |
user_team_names |
否 |
Array of strings |
参数解释: 成员组name列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
related_role_ids |
否 |
Array of strings |
参数解释: 关联角色ID列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 保护tag名称。 取值范围 字符串长度不少于1,不超过1000。 |
actions |
Array of ProjectProtectedTagActionDto objects |
参数解释: 事件列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
action |
String |
参数解释: 事件名称。 取值范围:read 查询,create-delete 增删,create 创建 字符串长度不少于1,不超过1000。 枚举值:
|
enable |
Boolean |
参数解释: 是否启用。 |
user_ids |
Array of integers |
参数解释: 用户ID列表。 约束限制: 不涉及。 取值范围: Integer 默认取值: 不涉及。 取值范围: 1-2147483647 |
user_names |
Array of strings |
参数解释: 用户name列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
user_team_ids |
Array of integers |
参数解释: 成员组ID列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 取值范围: 1-2147483647 |
user_team_names |
Array of strings |
参数解释: 成员组name列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
related_role_ids |
Array of strings |
参数解释: 关联角色ID列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
创建项目下的保护tag
PUT https://{endpoint}/v4/projects/{project_id}/protected-tags { "name" : "123", "actions" : [ { "action" : "create", "enable" : true, "user_ids" : [ 9124 ], "user_team_ids" : [ 247 ], "related_role_ids" : [ "6115a3ddd9044e288c558d1ae827a732", "8425999e92974f2980b76b08ad423aa1", "f2464b129b064a6a988734a73c3f366b", "24f72d0b611746c3a43da596ea5065f5" ] }, { "action" : "read", "enable" : true, "user_ids" : [ 9124 ], "user_team_ids" : [ 247 ], "related_role_ids" : [ "6115a3ddd9044e288c558d1ae827a732", "8425999e92974f2980b76b08ad423aa1", "f2464b129b064a6a988734a73c3f366b", "24f72d0b611746c3a43da596ea5065f5" ] } ] }
响应示例
状态码:200
创建的项目下保护tag详情
{ "name" : "123", "actions" : [ { "action" : "create", "enable" : true, "user_ids" : [ 9124 ], "user_names" : [ ], "user_team_ids" : [ 247 ], "user_team_names" : [ ], "related_role_ids" : [ "6115a3ddd9044e288c558d1ae827a732", "8425999e92974f2980b76b08ad423aa1", "f2464b129b064a6a988734a73c3f366b", "24f72d0b611746c3a43da596ea5065f5" ] } ] }
状态码
状态码 |
描述 |
---|---|
200 |
创建的项目下保护tag详情 |
错误码
请参见错误码。