华为云用户手册

响应示例 状态码： 200 请求成功响应信息 { "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "data" : { "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "指标名称", "data_object" : { "indicator_type" : { "layout_id" : "4e2d7f64-a66d-3236-a8c1-704636ced9a7", "indicator_type" : "ipv6", "id" : "ac794b2dfab9fe8c0676587301a636d3", "category" : "ipv6" }, "value" : "ip", "data_source" : { "domain_id" : "ac7438b990ef4a37b741004eb45e8bf4", "project_id" : "5b8bb3c888db498f9eeaf1023f7ba597", "region_id" : "cn-xxx-7", "source_type" : 1 }, "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "granular_marking" : 1, "first_report_time" : "2023-07-04T16:47:01Z+0800", "status" : "Open" }, "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "dataclass_ref" : { "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "名称" }, "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800" } }

Python 更新一条指标，指标触发标志为否，值为ip。 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 48 49 50 51 52 53 54 # coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("cn-north-4")) \ .build() try: request = UpdateIndicatorRequest() dataSourceDataObject = IndicatorDataObjectDetailDataSource( source_type=1, domain_id="ac7438b990ef4a37b741004eb45e8bf4", project_id="5b8bb3c888db498f9eeaf1023f7ba597", region_id="cn-xxx-7" ) indicatorTypeDataObject = IndicatorDataObjectDetailIndicatorType( indicator_type="ipv6", id="ac794b2dfab9fe8c0676587301a636d3", category="ipv6", layout_id="4e2d7f64-a66d-3236-a8c1-704636ced9a7" ) dataObjectbody = IndicatorDataObjectDetail( indicator_type=indicatorTypeDataObject, value="ip", data_source=dataSourceDataObject, first_report_time="2023-07-04T16:47:01Z+0800", granular_marking=1, project_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", status="Open", workspace_id="909494e3-558e-46b6-a9eb-07a8e18ca620" ) request.body = UpdateIndicatorRequestBody( data_object=dataObjectbody ) response = client.update_indicator(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)

响应参数 状态码： 200 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表9 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度：32 最大长度：64 message String 错误信息 最小长度：1 最大长度：32 data IndicatorDetail object 情报详情信息 表10 IndicatorDetail 参数 参数类型 描述 id String 指标ID 最小长度：32 最大长度：64 name String 指标名称 最小长度：0 最大长度：64 data_object IndicatorDataObjectDetail object 情报详情 workspace_id String 工作空间ID 最小长度：32 最大长度：64 project_id String 项目ID 最小长度：32 最大长度：64 dataclass_ref DataClassRefPojo object 数据类对象信息 create_time String 创建时间 最小长度：0 最大长度：64 update_time String 更新时间 最小长度：0 最大长度：64 表11 IndicatorDataObjectDetail 参数 参数类型 描述 indicator_type indicator_type object 情报类型对象 value String 值，如：ip url domain等 最小长度：0 最大长度：256 update_time String 更新时间 最小长度：0 最大长度：64 create_time String 创建时间 最小长度：0 最大长度：64 environment environment object 环境信息 data_source data_source object 数据源信息 first_report_time String 首次发生时间 最小长度：0 最大长度：64 is_deleted Boolean 是否删除 last_report_time String 最近发生时间 最小长度：0 最大长度：64 granular_marking Integer 粒度（保密等级），由高到低：1（首次发现）、2（自产数据）、3（需购买）、4（外网直接查询） 最小值：1 最大值：4 name String 名称 最小长度：1 最大长度：64 id String 情报ID 最小长度：1 最大长度：64 project_id String 项目ID 最小长度：1 最大长度：64 revoked Boolean 是否作废 status String 状态， Open--打开，Closed--关闭, Revoked--作废 最小长度：1 最大长度：64 verdict String 威胁度， Black--黑,White--白，Gray--灰 最小长度：1 最大长度：64 workspace_id String 工作空间ID 最小长度：1 最大长度：64 confidence Integer 置信度，取值范围是80-100 最小值：80 最大值：100 表12 indicator_type 参数 参数类型 描述 indicator_type String 情报类型 最小长度：1 最大长度：32 id String 情报类型ID 最小长度：1 最大长度：64 category String 目录 最小长度：1 最大长度：64 layout_id String 布局ID 最小长度：1 最大长度：64 表13 environment 参数 参数类型 描述 vendor_type String 环境供应商（如HWC,AWS,Azure等） 最小长度：0 最大长度：1024 domain_id String 租户ID 最小长度：32 最大长度：64 region_id String 区域ID 最小长度：1 最大长度：64 project_id String 项目ID 最小长度：32 最大长度：64 表14 data_source 参数 参数类型 描述 source_type Integer 数据源类型，取值范围如下：1 - 华为产品 2 - 第三方产品 3 - 租户私有产品 最小值：0 最大值：9999 domain_id String 租户ID 最小长度：32 最大长度：64 project_id String 项目ID 最小长度：32 最大长度：64 region_id String 区域ID 最小长度：1 最大长度：64 表15 DataClassRefPojo 参数 参数类型 描述 id String 数据类ID 最小长度：32 最大长度：64 name String 数据类名称 最小长度：0 最大长度：64 状态码： 400 表16 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表17 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度：0 最大长度：64 message String 错误描述 最小长度：0 最大长度：1024

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户的Token 最小长度：32 最大长度：65535 content-type 是 String application/json;charset=UTF-8 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64 表3 请求Body参数 参数 是否必选 参数类型 描述 data_object 否 IndicatorDataObjectDetail object 情报详情 表4 IndicatorDataObjectDetail 参数 是否必选 参数类型 描述 indicator_type 否 indicator_type object 情报类型对象 value 否 String 值，如：ip url domain等 最小长度：0 最大长度：256 update_time 否 String 更新时间 最小长度：0 最大长度：64 create_time 否 String 创建时间 最小长度：0 最大长度：64 environment 否 environment object 环境信息 data_source 否 data_source object 数据源信息 first_report_time 否 String 首次发生时间 最小长度：0 最大长度：64 is_deleted 否 Boolean 是否删除 last_report_time 否 String 最近发生时间 最小长度：0 最大长度：64 granular_marking 否 Integer 粒度（保密等级），由高到低：1（首次发现）、2（自产数据）、3（需购买）、4（外网直接查询） 最小值：1 最大值：4 name 否 String 名称 最小长度：1 最大长度：64 id 否 String 情报ID 最小长度：1 最大长度：64 project_id 否 String 项目ID 最小长度：1 最大长度：64 revoked 否 Boolean 是否作废 status 否 String 状态， Open--打开，Closed--关闭, Revoked--作废 最小长度：1 最大长度：64 verdict 否 String 威胁度， Black--黑,White--白，Gray--灰 最小长度：1 最大长度：64 workspace_id 否 String 工作空间ID 最小长度：1 最大长度：64 confidence 否 Integer 置信度，取值范围是80-100 最小值：80 最大值：100 表5 indicator_type 参数 是否必选 参数类型 描述 indicator_type 否 String 情报类型 最小长度：1 最大长度：32 id 否 String 情报类型ID 最小长度：1 最大长度：64 category 否 String 目录 最小长度：1 最大长度：64 layout_id 否 String 布局ID 最小长度：1 最大长度：64 表6 environment 参数 是否必选 参数类型 描述 vendor_type 否 String 环境供应商（如HWC,AWS,Azure等） 最小长度：0 最大长度：1024 domain_id 否 String 租户ID 最小长度：32 最大长度：64 region_id 否 String 区域ID 最小长度：1 最大长度：64 project_id 否 String 项目ID 最小长度：32 最大长度：64 表7 data_source 参数 是否必选 参数类型 描述 source_type 否 Integer 数据源类型，取值范围如下：1 - 华为产品 2 - 第三方产品 3 - 租户私有产品 最小值：0 最大值：9999 domain_id 否 String 租户ID 最小长度：32 最大长度：64 project_id 否 String 项目ID 最小长度：32 最大长度：64 region_id 否 String 区域ID 最小长度：1 最大长度：64

URI PUT /v1/{project_id}/workspaces/{workspace_id}/soc/indicators/{indicator_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度：32 最大长度：64 workspace_id 是 String 工作空间ID 最小长度：1 最大长度：1024 indicator_id 是 String 情报ID 最小长度：32 最大长度：64

Python 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 # coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("cn-north-4")) \ .build() try: request = ShowPlaybookInstanceRequest() response = client.show_playbook_instance(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)

Go 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 package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) request := &model.ShowPlaybookInstanceRequest{} response, err := client.ShowPlaybookInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }

Java 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 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.secmaster.v2.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v2.*; import com.huaweicloud.sdk.secmaster.v2.model.*; public class ShowPlaybookInstanceSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("cn-north-4")) .build(); ShowPlaybookInstanceRequest request = new ShowPlaybookInstanceRequest(); try { ShowPlaybookInstanceResponse response = client.showPlaybookInstance(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()); } } }

响应示例 状态码： 200 Instance Informations { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version" : "v1.1.1" }, "dataclass" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "dataobject" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "status" : "TERMINATED", "trigger_type" : "string", "start_time" : "2021-01-30T23:00:00Z+0800", "end_time" : "2021-01-30T23:00:00Z+0800" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：2097152 content-type 是 String application/json;charset=UTF-8 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 id String 剧本实例ID 最小长度：32 最大长度：64 name String 剧本实例名称 最小长度：0 最大长度：1024 project_id String 项目ID 最小长度：32 最大长度：64 playbook PlaybookInfoRef object 剧本信息 dataclass DataclassInfoRef object 数据类信息 dataobject DataobjectInfo object 数据对象详情 status String 剧本实例状态. (RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止) 最小长度：32 最大长度：64 trigger_type String 触发类型. TIMER--定时触发, EVENT--事件触发 最小长度：0 最大长度：64 start_time String 创建时间 最小长度：0 最大长度：64 end_time String 更新时间 最小长度：0 最大长度：64 表5 PlaybookInfoRef 参数 参数类型 描述 id String 剧本ID 最小长度：32 最大长度：64 version_id String 剧本版本ID 最小长度：32 最大长度：64 name String 名称 最小长度：32 最大长度：64 version String 版本 最小长度：32 最大长度：64 表6 DataclassInfoRef 参数 参数类型 描述 id String 数据类ID 最小长度：32 最大长度：64 name String 数据类名称 最小长度：32 最大长度：64 表7 DataobjectInfo 参数 参数类型 描述 id String ID值 最小长度：32 最大长度：64 create_time String 创建时间 最小长度：0 最大长度：64 update_time String 更新时间 最小长度：0 最大长度：64 project_id String 项目ID 最小长度：32 最大长度：64 dataclass_id String 数据类ID 最小长度：32 最大长度：64 name String 名称 最小长度：0 最大长度：1024 content String 数据内容 最小长度：0 最大长度：4096 状态码： 400 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表9 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度：0 最大长度：64 message String 错误描述 最小长度：0 最大长度：1024

URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度：32 最大长度：36 workspace_id 是 String 工作空间ID 最小长度：32 最大长度：36 instance_id 是 String instance _id 最小长度：36 最大长度：36

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 field_details Array of FieldResponseBody objects list of informations of field 数组长度：0 - 100 total Number 数据总量 最小值：2 最大值：999999999 表6 FieldResponseBody 参数 参数类型 描述 id String Id value 最小长度：32 最大长度：64 cloud_pack_version String 订阅包版本 最小长度：2 最大长度：64 business_id String 关联业务id 最小长度：32 最大长度：64 business_type String 关联业务 最小长度：2 最大长度：64 dataclass_name String 数据类名称 最小长度：2 最大长度：64 business_code String 字段业务编码 最小长度：2 最大长度：64 field_key String 字段key 最小长度：2 最大长度：64 name String 字段名称 最小长度：2 最大长度：64 description String 字段描述 最小长度：2 最大长度：1024 default_value String 默认值 最小长度：2 最大长度：1024 display_type String 显示类型 最小长度：2 最大长度：64 field_type String 字段类型，如shorttext,radio,grid等 最小长度：2 最大长度：64 extra_json String 附加json 最小长度：2 最大长度：64 field_tooltip String 工具提示 最小长度：2 最大长度：64 iu_type String 输入输出类型 最小长度：2 最大长度：64 used_by String 使用业务 最小长度：2 最大长度：64 json_schema String json模式 最小长度：2 最大长度：64 is_built_in Boolean 是否内置，true内置，false非内置 case_sensitive Boolean 大小写敏感，true敏感，false不敏感 read_only Boolean 只读模式，true只读，false非只读 required Boolean 是否必填，true必填，false非必填 searchable Boolean 可搜索，true可搜索，false非可搜索 visible Boolean 可见，true可见，false非可见 maintainable Boolean 可维护，true可维护，false非可维护 editable Boolean 可编辑，true可编辑，false非可编辑 creatable Boolean 可创建，true可创建，false非可创建 mapping Boolean 是否展示在分类映射外的其他地方 target_api String 目标api 最小长度：0 最大长度：1024 creator_id String Creator id value 最小长度：32 最大长度：64 creator_name String Creator name value 最小长度：32 最大长度：64 modifier_id String Modifier id value 最小长度：32 最大长度：64 modifier_name String Modifier name value 最小长度：32 最大长度：64 create_time String Create time 最小长度：0 最大长度：64 update_time String Update time 最小长度：0 最大长度：64 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表8 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度：0 最大长度：64 message String 错误描述 最小长度：0 最大长度：1024

响应示例 状态码： 200 请求成功 { "total" : 41, "field_details" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "cloud_pack_version" : "订阅包版本", "business_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "business_type" : "业务类型", "dataclass_name" : "业务id", "business_code" : "My Field", "field_key" : "字段key", "name" : "字段名称", "description" : "字段描述", "default_value" : "默认值", "display_type" : "显示类型", "field_type" : "shorttext", "extra_json" : "{}", "field_tooltip" : "工具提示", "iu_type" : "输入输出类型", "used_by" : "使用业务", "json_schema" : "{}", "is_built_in" : false, "case_sensitive" : false, "read_only" : false, "required" : false, "searchable" : false, "visible" : false, "maintainable" : false, "editable" : false, "creatable" : false, "mapping" : true, "target_api" : "目标api", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "creator_name" : "张三", "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "modifier_name" : "李四", "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800" } ] }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 最小长度：0 最大长度：2097152 content-type 是 String 内容类型 缺省值：application/json;charset=UTF-8 最小长度：0 最大长度：64

URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/fields 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 最小长度：32 最大长度：36 workspace_id 是 String 工作空间id 最小长度：32 最大长度：36 dataclass_id 是 String 数据类id 最小长度：32 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Number 偏移量 最小值：0 最大值：999999999 缺省值：0 limit 否 Number 数据量 最小值：1 最大值：100 缺省值：10 name 否 String 名称查询 最小长度：0 最大长度：64 is_built_in 否 Boolean 是否内置 field_category 否 String 字段分类 最小长度：0 最大长度：1024 mapping 否 Boolean 是否展示在分类映射外的其他地方

Go 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" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) request := &model.CreateDataspaceRequest{} request.Body = &model.CreateDataspaceRequestBody{ } response, err := client.CreateDataspace(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }

响应示例 状态码： 200 { "domain_id" : "0531ed520xxxxxxebedb6e57xxxxxxxx", "region_id" : "cn-north-1", "project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx", "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed", "dataspace_name" : "dataspace-01", "dataspace_type" : "system-defined", "description" : "test dataspace", "create_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx", "create_time" : 1584883694354, "update_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx", "update_time" : 1584883694354 }

Java 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.secmaster.v2.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v2.*; import com.huaweicloud.sdk.secmaster.v2.model.*; public class CreateDataspaceSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("cn-north-4")) .build(); CreateDataspaceRequest request = new CreateDataspaceRequest(); CreateDataspaceRequestBody body = new CreateDataspaceRequestBody(); request.withBody(body); try { CreateDataspaceResponse response = client.createDataspace(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()); } } }

Python 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 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("cn-north-4")) \ .build() try: request = CreateDataspaceRequest() request.body = CreateDataspaceRequestBody( ) response = client.create_dataspace(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)

请求示例 { "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed", "pipe_name" : "pipe-01", "description" : "test pipe", "storage_period" : 30, "shards" : 3, "mapping" : { "name" : { "type" : "text" }, "id" : { "type" : "text" }, "publish_time" : { "type" : "data" } }, "timestamp_field" : "_time" }

Python 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 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("cn-north-4")) \ .build() try: request = CreatePipeRequest() request.body = CreatePipeRequestBody( ) response = client.create_pipe(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)

Go 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" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) request := &model.CreatePipeRequest{} request.Body = &model.CreatePipeRequestBody{ } response, err := client.CreatePipe(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }

Java 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.secmaster.v2.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v2.*; import com.huaweicloud.sdk.secmaster.v2.model.*; public class CreatePipeSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("cn-north-4")) .build(); CreatePipeRequest request = new CreatePipeRequest(); CreatePipeRequestBody body = new CreatePipeRequestBody(); request.withBody(body); try { CreatePipeResponse response = client.createPipe(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()); } } }

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 domain_id String 用户domainId 最小长度：32 最大长度：36 project_id String 项目id 最小长度：32 最大长度：36 dataspace_id String 数据空间id 最小长度：32 最大长度：36 dataspace_name String 数据空间名称 最小长度：32 最大长度：36 pipe_id String 管道id 最小长度：32 最大长度：36 pipe_name String 管道名称 最小长度：32 最大长度：36 pipe_type String 管道类型（system-defined，系统预定义)、1（user-defined，用户自定义) 最小长度：5 最大长度：128 description String 描述信息 最小长度：5 最大长度：128 storage_period Integer 索引存储天数 最小值：1 最大值：100000 shards Integer 索引分片数量 最小值：1 最大值：128 create_by String 创建者 最小长度：5 最大长度：128 create_time Integer 创建时间 最小值：0 最大值：1010000000 update_by String 更新者 最小长度：5 最大长度：128 update_time Integer 更新时间 最小值：0 最大值：10000000000 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 无效请求提示信息 最小长度：1 最大长度：128 error_code String 错误码 最小长度：1 最大长度：128 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 权限错误 最小长度：1 最大长度：128 error_code String 错误码 最小长度：1 最大长度：128 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 系统内部错误 最小长度：1 最大长度：128 error_code String 错误码 最小长度：1 最大长度：128

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 最小长度：0 最大长度：2097152 content-type 是 String 内容类型 缺省值：application/json;charset=UTF-8 最小长度：0 最大长度：64

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 dataclass_details Array of DataClassResponseBody objects 数据类详情 数组长度：0 - 100 total Number 数据总量 最小值：2 最大值：999999999 表6 DataClassResponseBody 参数 参数类型 描述 id String 数据类ID 最小长度：32 最大长度：64 create_time String 创建时间 最小长度：0 最大长度：64 update_time String 更新时间 最小长度：0 最大长度：64 creator_id String 创建者ID 最小长度：32 最大长度：64 creator_name String 创建者名称 最小长度：32 最大长度：64 modifier_id String 修改者ID 最小长度：32 最大长度：64 modifier_name String 修改这名称 最小长度：32 最大长度：64 cloud_pack_version String 订阅包版本 最小长度：2 最大长度：64 region_id String 区域ID 最小长度：0 最大长度：64 project_id String 租户ID 最小长度：0 最大长度：64 workspace_id String 工作空间ID 最小长度：0 最大长度：64 domain_id String domain id 最小长度：0 最大长度：64 name String 数据类名称 最小长度：2 最大长度：64 business_code String 数据类业务编码 最小长度：2 最大长度：64 description String 数据类描述 最小长度：2 最大长度：1024 is_built_in Boolean 是否内置，true内置，false非内置 parent_id String 父级id 最小长度：32 最大长度：64 type_num Number 子类型数量 最小值：0 最大值：99999 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表8 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度：0 最大长度：64 message String 错误描述 最小长度：0 最大长度：1024

响应示例 状态码： 200 请求成功 { "total" : 41, "dataclass_details" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "creator_name" : "张三", "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "modifier_name" : "李四", "cloud_pack_version" : "订阅包版本", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "证据", "business_code" : "Evidence", "description" : "我的数据类描述", "is_built_in" : false, "parent_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "type_num" : 9 } ] }

URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 最小长度：32 最大长度：36 workspace_id 是 String 工作空间id 最小长度：32 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Number 偏移量 最小值：0 最大值：999999999 缺省值：0 limit 否 Number 数据量 最小值：1 最大值：100 缺省值：10 name 否 String 名称查询 最小长度：0 最大长度：64 business_code 否 String 业务编码 最小长度：0 最大长度：64 description 否 String 描述 最小长度：0 最大长度：1024 is_built_in 否 Boolean 是否内置

响应示例 状态码： 200 请求成功 { "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "total" : 41, "limit" : 2, "offset" : 1, "success" : true, "data" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "流程名称", "description" : "描述", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "edit_role" : "编辑者", "use_role" : "使用者", "approve_role" : "审批者", "enabled" : true, "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "current_approval_version_id" : "v2", "current_rejected_versoin_id" : "v1", "aop_type" : "EASE;缓解", "engine_type" : "public_engine", "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" } ] }