# 创建SQL校验 - CreateSqlValidation #### 功能介绍 创建SQL校验 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI POST /v2/{project_id}/workspaces/{workspace_id}/siem/sql/validation 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | workspace_id | 是 | String | **参数解释**： 工作空间ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | script | 是 | String | Job Script 作业脚本 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sources | Array of [TableItem] objects | 源表 | | modes | Array of strings | 模式 | 表5TableItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | project_id | String | 项目ID | | workspace_id | String | 工作空间ID | | table_id | String | UUID | | table_name | String | Table name 表名 | | table_alias | String | 表别名 | | directory | String | directory 目录分组 | | description | String | 表描述 | | category | String | **参数解释**： 表类别 - STREAMING 流式传输 - INDEX 索引 - APPLICATION 应用 - TENANT_OBS 租户对象存储 - LAKE 数据湖 **约束限制**： 不涉及 **取值范围**： - STREAMING - INDEX - APPLICATION - TENANT_OBS - LAKE **默认取值**： 不涉及 | | lock_status | String | **参数解释**： 表锁状态 - LOCKED 已锁 - UNLOCKED 未锁 **约束限制**： 不涉及 **取值范围**： - LOCKED - UNLOCKED **默认取值**： 不涉及 | | process_status | String | **参数解释**： 表处理状态 - COMPLETED 处理完成 - CREATING 创建中 - UPDATING 更新中 - DELETING 删除中 - TRUNCATING 清空中 - CREATE_FAILED 创建失败 - UPDATING_FAILED 更新失败 - DELETING_FAILED 删除失败 - TRUNCATE_FAILED 清空失败 **约束限制**： 不涉及 **取值范围**： - COMPLETED - CREATING - UPDATING - DELETING - TRUNCATING - CREATE_FAILED - UPDATING_FAILED - DELETING_FAILED - TRUNCATE_FAILED **默认取值**： 不涉及 | | process_error | String | **参数解释**： 表处理错误 - NONE 无 **约束限制**： 不涉及 **取值范围**： - NONE **默认取值**： 不涉及 | | edit_type | String | **参数解释**： 表编辑类型 - MODIFIABLE 可任意修改态 - APPENDED 追加态 (原来的内容锁定，只可追加) - LOCKED 锁定态 (完全锁定，不可修改) **约束限制**： 不涉及 **取值范围**： - MODIFIABLE - APPENDED - LOCKED **默认取值**： 不涉及 | | format | String | **参数解释**： 表格式 - JSON Json格式 - DEBEZIUM_JSON Debezium JSON 格式 - CSV CSV格式 - PARQUET PARQUET格式 - ORC ORC格式 **约束限制**： 不涉及 **取值范围**： - JSON - DEBEZIUM_JSON - CSV - PARQUET - ORC **默认取值**： 不涉及 | | rw_type | String | **参数解释**： 表读写类型 - READ_ONLY 只读 - READ_WRITE 读写 - WRITE_ONLY 只写 **约束限制**： 不涉及 **取值范围**： - READ_ONLY - READ_WRITE - WRITE_ONLY **默认取值**： 不涉及 | | owner_type | String | **参数解释**： 拥有者类型 - SYSTEM 系统 - USER 用户 - SYSTEM_ALLOWED_DELETE 系统可删除 - USER_ALLOWED_DELETE 用户可删除 **约束限制**： 不涉及 **取值范围**： - SYSTEM - USER - SYSTEM_ALLOWED_DELETE - USER_ALLOWED_DELETE **默认取值**： 不涉及 | | data_layering | String | **参数解释**： 数据分层 - ODS 操作数据存储层 - DWS 数据汇总层 - ADS 应用数据服务层 **约束限制**： 不涉及 **取值范围**： - ODS - DWS - ADS **默认取值**： 不涉及 | | data_classification | String | **参数解释**： 数据分类 - FACTUAL_DATA 事实数据 - DIMENSION_DATA 维度数据 **约束限制**： 不涉及 **取值范围**： - FACTUAL_DATA - DIMENSION_DATA **默认取值**： 不涉及 | | create_time | Integer | 毫秒时间戳 | | update_time | Integer | 毫秒时间戳 | | delete_time | Integer | 毫秒时间戳 | | store_size_in_bytes | Long | 已使用存储容量 | #### 请求示例 ``` { "script" : "select * from a" } ``` #### 响应示例 **状态码：200** 成功 ``` { } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 CreateSqlValidationSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("")) .build(); CreateSqlValidationRequest request = new CreateSqlValidationRequest(); request.withWorkspaceId("{workspace_id}"); CreateSqlValidationRequestBody body = new CreateSqlValidationRequestBody(); body.withScript("select * from a"); request.withBody(body); try { CreateSqlValidationResponse response = client.createSqlValidation(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] ``` # coding: utf-8 import os 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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("")) \ .build() try: request = CreateSqlValidationRequest() request.workspace_id = "{workspace_id}" request.body = CreateSqlValidationRequestBody( script="select * from a" ) response = client.create_sql_validation(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] ``` 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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.CreateSqlValidationRequest{} request.WorkspaceId = "{workspace_id}" request.Body = &model.CreateSqlValidationRequestBody{ Script: "select * from a", } response, err := client.CreateSqlValidation(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=CreateSqlValidation&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。