查询识别规则列表
功能介绍
查询识别规则列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/security/data-classification/rule
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页显示的条目数量。 |
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,该值大于等于0。 |
secrecy_level |
否 |
String |
密级。 |
name |
否 |
String |
规则名称。 |
creator |
否 |
String |
规则创建者。 |
enable |
否 |
Boolean |
规则是否开启。 |
start_time |
否 |
Long |
开始日期。 |
end_time |
否 |
Long |
结束日期。 |
desc |
否 |
Boolean |
排序规则。 |
order_by |
否 |
String |
排序字段, createdAt, createdBy, updatedAt, updatedBy, name, description |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workspace |
是 |
String |
工作空间ID,获取方法请参见实例ID和工作空间ID。 |
X-Auth-Token |
是 |
String |
IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)使用Token认证时必选。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
content |
Array of DataClassificationRuleQueryDTO objects |
查询到的所有数据识别规则。 |
total |
Integer |
数据识别规则总数。 |
参数 |
参数类型 |
描述 |
---|---|---|
uuid |
String |
规则ID。 |
rule_type |
String |
规则类型, CUSTOM, BUILTIN |
secrecy_level |
String |
密级名称。 |
secrecy_level_num |
Long |
密级层级。 |
name |
String |
规则名称。 |
guid |
String |
guid。 |
enable |
Boolean |
规则是否开启。 |
method |
String |
规则方式, REGULAR, NONE, DEFAULT |
content_expression |
String |
内容表达式。 |
column_expression |
String |
列表达式。 |
commit_expression |
String |
备注表达式。 |
project_id |
String |
项目ID。 |
description |
String |
规则描述。 |
created_by |
String |
策略创建人。 |
created_at |
Long |
策略创建时间。 |
updated_by |
String |
策略更新人。 |
updated_at |
Long |
策略更新时间。 |
builtin_rule_id |
String |
内置规则ID。 |
category_id |
String |
分类ID。 |
instance_id |
String |
实例ID。 |
match_type |
String |
匹配类型。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
/v1/0833a5737480d53b2f25c010dc1a7b88/security/data-classification/rule?offset=0&limit=10
响应示例
状态码: 200
ok
{ "content" : [ { "builtin_rule_id" : null, "category_id" : "0cce38e7c28547828905ae9e4f10a4bf", "column_expression" : null, "commit_expression" : null, "content_expression" : ".*", "created_at" : 1698633124002, "created_by" : "chenxiaoyu", "description" : "", "enable" : true, "guid" : null, "instance_id" : "dd97167b873d4a79b2aad54d4370a3bc", "match_type" : null, "method" : "REGULAR", "name" : "matchRules", "project_id" : "0833a5737480d53b2f25c010dc1a7b88", "rule_type" : "CUSTOM", "secrecy_level" : "asd", "secrecy_level_num" : 1, "updated_at" : 1698633124002, "updated_by" : "chenxiaoyu", "uuid" : "8a94800e8b753a35018b7e6be6950023" } ], "total" : 1 }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListSecurityDataClassificationRulesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ListSecurityDataClassificationRulesRequest request = new ListSecurityDataClassificationRulesRequest(); try { ListSecurityDataClassificationRulesResponse response = client.listSecurityDataClassificationRules(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSecurityDataClassificationRulesRequest() response = client.list_security_data_classification_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSecurityDataClassificationRulesRequest{} response, err := client.ListSecurityDataClassificationRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
ok |
400 |
Bad Request |