Creating a Module
Function
This API is used to create a module.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/modules
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A |
|
workspace_id |
Yes |
String |
Definition Workspace ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A |
|
content-type |
Yes |
String |
Definition Content type. Constraints N/A Range Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
String |
Module ID. |
|
name |
Yes |
String |
Name. |
|
description |
No |
String |
Description. |
|
project_id |
No |
String |
Tenant ID. |
|
workspace_id |
No |
String |
Workspace ID. |
|
module_json |
No |
String |
Module information. |
|
module_type |
No |
String |
Module type, which can be tab or section. |
|
metric_ids |
No |
String |
ID of the metric associated with the section module. |
|
thumbnail |
No |
String |
Module thumbnail. |
|
data_query |
No |
String |
Data query mode. |
|
boa_version |
No |
String |
BOA base version. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
message |
String |
Error message. |
|
request_id |
String |
Request ID. |
|
success |
Boolean |
Request result. |
|
data |
ModuleDetailInfo object |
Module details. |
|
Parameter |
Type |
Description |
|---|---|---|
|
cloud_pack_id |
String |
Subscription package ID. |
|
cloud_pack_name |
String |
Subscription package name. |
|
cloud_pack_version |
String |
Subscription package version. |
|
create_time |
String |
Creation time. |
|
creator_id |
String |
Creator ID. |
|
description |
String |
Description. |
|
en_description |
String |
English description. |
|
id |
String |
Module ID. |
|
module_json |
String |
Module information. When the module is an indicator card, the id field in items is also the indicator ID. |
|
name |
String |
Name. |
|
en_name |
String |
Name in English. |
|
project_id |
String |
Tenant ID. |
|
workspace_id |
String |
Workspace ID. |
|
update_time |
String |
Update time. |
|
thumbnail |
String |
Module thumbnail. |
|
module_type |
String |
Module type, which can be tab or section. |
|
tag |
String |
Module tag. |
|
is_built_in |
Boolean |
Whether the module is a system module. |
|
data_query |
String |
Data query mode. |
|
boa_version |
String |
BOA base version. |
|
version |
String |
SecMaster edition. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Request body for creating a module.
{
"workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620",
"thumbnail" : "xxxxxx",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"module_type" : "tab",
"name" : "MyModule4",
"description" : "This is my module",
"metric_ids" : "123",
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"module_json" : "{\"items\":[{\"dataclass_name\":\"metric\",\"case_sensitived\":false,\"cloud_pack_id\":\"\",\"cloud_pack_name\":\"\",\"cloud_pack_version\":\"\",\"is_built_in\":false,\"creatable\":null,\"create_time\":\"2022-03-15T10:39:09Z+0800\",\"creator_id\":\"\",\"creator_name\":\"\",\"default_value\":\"XXXXXXXXXXXX\",\"en_default_value\":\"\",\"description\":\"\",\"en_description\":\"\",\"display_type\":\"pie\",\"editable\":null,\"extra_json\":\"{\"x-label\":\"time\",\"y-label\":\"value\",\"api\":\"/xxxx/\"}\",\"field_key\":\"XXXXXXX\",\"name\":\"XXXXXX\",\"en_name\":\"\",\"field_tooltip\":\"\",\"field_type\":\"pie\",\"id\":\"21d729b8-2fa4-4e61-82ef-c7fa4bff02ef\",\"iu_type\":null,\"json_schema\":\"\",\"maintainable\":null,\"modifier_id\":\"\",\"modifier_name\":\"\",\"readonly\":false,\"required\":false,\"searchable\":false,\"update_time\":\"2022-03-15T10:39:09Z+0800\",\"used_by\":\"securityreport\",\"visible\":true}]}"
}
Example Responses
Status code: 200
Return information about creating a module.
{
"code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"message" : "Error message",
"success" : true,
"data" : {
"boa_version" : "v3",
"cloud_pack_id" : "cloud",
"cloud_pack_name" : "cloud",
"cloud_pack_version" : "v1",
"data_query" : null,
"description" : "This is my module",
"en_description" : "This is my module",
"en_name" : "test",
"id" : "a2a6a89e-07cf-413c-a823-94a073239b2d",
"is_built_in" : null,
"module_json" : "eyJpdGVtcyI6W3siZGF0YWNsYXNzX25hbWUiOiLmjIfmoIciLCJjYXNlX3NlbnNpdGl2ZWQiOmZhbHNlLCJjbG91ZF9wYWNrX2lkIjoiIiwiY2xvdWRfcGFja19uYW1lIjoiIiwiY2xvdWRfcGFja192ZXJzaW9uIjoiIiwiaXNfYnVpbHRfaW4iOmZhbHNlLCJjcmVhdGFibGUiOm51bGwsImNyZWF0ZV90aW1lIjoiMjAyMi0wMy0xNVQxMDozOTowOVorMDgwMCIsImNyZWF0b3JfaWQiOiIiLCJjcmVhdG9yX25hbWUiOiIiLCJkZWZhdWx0X3ZhbHVlIjoiWFhYWFhYWFhYWFhYIiwiZW5fZGVmYXVsdF92YWx1ZSI6IiIsImRlc2NyaXB0aW9uIjoiIiwiZW5fZGVzY3JpcHRpb24iOiIiLCJkaXNwbGF5X3R5cGUiOiJwaWUiLCJlZGl0YWJsZSI6bnVsbCwiZXh0cmFfanNvbiI6InsieC1sYWJlbCI6InRpbWUiLCJ5LWxhYmVsIjoidmFsdWUiLCJhcGkiOiIveHh4eC8ifSIsImZpZWxkX2tleSI6IlhYWFhYWFgiLCJuYW1lIjoiWFhYWFhYIiwiZW5fbmFtZSI6IiIsImZpZWxkX3Rvb2x0aXAiOiIiLCJmaWVsZF90eXBlIjoicGllIiwiaWQiOiIyMWQ3MjliOC0yZmE0LTRlNjEtODJlZi1jN2ZhNGJmZjAyZWYiLCJpdV90eXBlIjpudWxsLCJqc29uX3NjaGVtYSI6IiIsIm1haW50YWluYWJsZSI6bnVsbCwibW9kaWZpZXJfaWQiOiIiLCJtb2RpZmllcl9uYW1lIjoiIiwicmVhZG9ubHkiOmZhbHNlLCJyZXF1aXJlZCI6ZmFsc2UsInNlYXJjaGFibGUiOmZhbHNlLCJ1cGRhdGVfdGltZSI6IjIwMjItMDMtMTVUMTA6Mzk6MDlaKzA4MDAiLCJ1c2VkX2J5Ijoic2VjdXJpdHlyZXBvcnQiLCJ2aXNpYmxlIjp0cnVlfV19",
"module_type" : "tab",
"name" : "MyModule4",
"project_id" : "81fee81ab75a48a7b38e6586868688e7",
"tag" : "test",
"thumbnail" : "xxxxxx",
"version" : "25.2.0",
"workspace_id" : "8ace3994-5fab-429b-ae44-9b4307c5b694"
}
}
SDK Sample Code
The SDK sample code is as follows.
Request body for creating a module.
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 55 56 57 58 59 |
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.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; public class CreateModuleSolution { 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("<YOUR REGION>")) .build(); CreateModuleRequest request = new CreateModuleRequest(); request.withWorkspaceId("{workspace_id}"); ModuleCreateRequestPojo body = new ModuleCreateRequestPojo(); body.withThumbnail("xxxxxx"); body.withMetricIds("123"); body.withModuleType("tab"); body.withModuleJson("{"items":[{"dataclass_name":"metric","case_sensitived":false,"cloud_pack_id":"","cloud_pack_name":"","cloud_pack_version":"","is_built_in":false,"creatable":null,"create_time":"2022-03-15T10:39:09Z+0800","creator_id":"","creator_name":"","default_value":"XXXXXXXXXXXX","en_default_value":"","description":"","en_description":"","display_type":"pie","editable":null,"extra_json":"{"x-label":"time","y-label":"value","api":"/xxxx/"}","field_key":"XXXXXXX","name":"XXXXXX","en_name":"","field_tooltip":"","field_type":"pie","id":"21d729b8-2fa4-4e61-82ef-c7fa4bff02ef","iu_type":null,"json_schema":"","maintainable":null,"modifier_id":"","modifier_name":"","readonly":false,"required":false,"searchable":false,"update_time":"2022-03-15T10:39:09Z+0800","used_by":"securityreport","visible":true}]}"); body.withWorkspaceId("909494e3-558e-46b6-a9eb-07a8e18ca620"); body.withProjectId("909494e3-558e-46b6-a9eb-07a8e18ca62f"); body.withDescription("This my XXXX"); body.withName("MyModule4"); body.withId("909494e3-558e-46b6-a9eb-07a8e18ca62f"); request.withBody(body); try { CreateModuleResponse response = client.createModule(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()); } } } |
Request body for creating a module.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateModuleRequest() request.workspace_id = "{workspace_id}" request.body = ModuleCreateRequestPojo( thumbnail="xxxxxx", metric_ids="123", module_type="tab", module_json="{"items":[{"dataclass_name":"metric","case_sensitived":false,"cloud_pack_id":"","cloud_pack_name":"","cloud_pack_version":"","is_built_in":false,"creatable":null,"create_time":"2022-03-15T10:39:09Z+0800","creator_id":"","creator_name":"","default_value":"XXXXXXXXXXXX","en_default_value":"","description":"","en_description":"","display_type":"pie","editable":null,"extra_json":"{"x-label":"time","y-label":"value","api":"/xxxx/"}","field_key":"XXXXXXX","name":"XXXXXX","en_name":"","field_tooltip":"","field_type":"pie","id":"21d729b8-2fa4-4e61-82ef-c7fa4bff02ef","iu_type":null,"json_schema":"","maintainable":null,"modifier_id":"","modifier_name":"","readonly":false,"required":false,"searchable":false,"update_time":"2022-03-15T10:39:09Z+0800","used_by":"securityreport","visible":true}]}", workspace_id="909494e3-558e-46b6-a9eb-07a8e18ca620", project_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", description="This my XXXX", name="MyModule4", id="909494e3-558e-46b6-a9eb-07a8e18ca62f" ) response = client.create_module(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Request body for creating a module.
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 55 56 57 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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 := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateModuleRequest{} request.WorkspaceId = "{workspace_id}" thumbnailModuleCreateRequestPojo:= "xxxxxx" metricIdsModuleCreateRequestPojo:= "123" moduleTypeModuleCreateRequestPojo:= "tab" moduleJsonModuleCreateRequestPojo:= "{"items":[{"dataclass_name":"metric","case_sensitived":false,"cloud_pack_id":"","cloud_pack_name":"","cloud_pack_version":"","is_built_in":false,"creatable":null,"create_time":"2022-03-15T10:39:09Z+0800","creator_id":"","creator_name":"","default_value":"XXXXXXXXXXXX","en_default_value":"","description":"","en_description":"","display_type":"pie","editable":null,"extra_json":"{"x-label":"time","y-label":"value","api":"/xxxx/"}","field_key":"XXXXXXX","name":"XXXXXX","en_name":"","field_tooltip":"","field_type":"pie","id":"21d729b8-2fa4-4e61-82ef-c7fa4bff02ef","iu_type":null,"json_schema":"","maintainable":null,"modifier_id":"","modifier_name":"","readonly":false,"required":false,"searchable":false,"update_time":"2022-03-15T10:39:09Z+0800","used_by":"securityreport","visible":true}]}" workspaceIdModuleCreateRequestPojo:= "909494e3-558e-46b6-a9eb-07a8e18ca620" projectIdModuleCreateRequestPojo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f" descriptionModuleCreateRequestPojo:= "This my XXXX" idModuleCreateRequestPojo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f" request.Body = &model.ModuleCreateRequestPojo{ Thumbnail: &thumbnailModuleCreateRequestPojo, MetricIds: &metricIdsModuleCreateRequestPojo, ModuleType: &moduleTypeModuleCreateRequestPojo, ModuleJson: &moduleJsonModuleCreateRequestPojo, WorkspaceId: &workspaceIdModuleCreateRequestPojo, ProjectId: &projectIdModuleCreateRequestPojo, Description: &descriptionModuleCreateRequestPojo, Name: "MyModule4", Id: &idModuleCreateRequestPojo, } response, err := client.CreateModule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Return information about creating a module. |
|
400 |
Error response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot