修改分类名称 - UpdateClassifications
功能介绍
功能介绍:修改识别模板分类的名称及属性。 关键参数说明:classification_name必填;可更新description、security_level_id、sample_data。 返回值说明:返回操作状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/scan-templates/{template_id}/classifications/{classification_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
| template_id | 是 | String | 参数解释: 识别模板ID,标识分类所属的识别扫描模板,可通过调用查询模板列表接口获取,或可在数据安全中心控制台的模板管理页面查看 约束限制: 符合正则匹配"^[a-zA-Z0-9\-]{10,64}$" 取值范围: 不涉及 默认取值: 不涉及 |
| classification_id | 是 | String | 参数解释: 分类ID,标识需要修改名称的数据分类,可通过调用查询分类列表接口获取,或可在数据安全中心控制台的分类管理页面查看 约束限制: 符合正则匹配"^[a-zA-Z0-9\-]{10,64}$" 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| classification_name | 是 | String | 参数解释: 分类名称 约束限制: 符合正则匹配"^[\u4E00-\u9FA5\uF900-\uFA2D()()-_\w\-]{1,255}$" 取值范围: 不涉及 默认取值: 不涉及 |
| description | 否 | String | 参数解释: 资源描述信息 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| security_level_id | 否 | String | 参数解释: 安全级别ID,标识分类对应的安全等级,可通过调用查询安全级别列表接口获取,或可在数据安全中心控制台的安全级别管理页面查看 约束限制: 不涉及 取值范围: 字符串类型,长度不超过1024个字符 默认取值: 不涉及 |
| sample_data | 否 | String | 参数解释: 样本数据,用于展示该分类下的数据样例 约束限制: 不涉及 取值范围: 最大长度为255字符 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
请求示例
修改分类名称
{
"classification_name" : "classification-01",
"description" : "classification示例描述",
"security_level_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
"sample_data" : "classification-01"
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "更新分类成功",
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。