Adding a Custom Check Item
Function
This API is used to add a custom check item.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/checkitems
|
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 |
|
X-Language |
Yes |
String |
Definition Language. Reference value: zh-cn or en-us. Constraints N/A Range zh-cn: Chinese environment en-us: English environment Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
uuid |
No |
String |
Check item ID. |
|
aggregation_handle_status |
No |
String |
Check item result aggregation status. |
|
audit_procedure |
No |
String |
Check process of the check item. |
|
impact |
No |
String |
Impact of the check item. |
|
cloud_server |
Yes |
String |
Cloud service to which the check item belongs. |
|
description |
Yes |
String |
Check item description. |
|
level |
Yes |
String |
Check item severity. informational: informational low: low risk medium: medium risk high: high risk fatal: fatal |
|
method |
Yes |
Integer |
Check method of the check item. 0: automatic 3: playbook workflows. |
|
name |
Yes |
String |
Check item name. |
|
source |
No |
Integer |
Source of the check item. 0: default 2: workflows and playbooks |
|
workflow_id |
No |
String |
Definition Workflow ID. Constraints N/A |
|
spec_checkitem_list |
No |
Array of SpecCheckitemModel objects |
Information about the compliance pack to which the check item belongs. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
checkitem_uuid |
No |
String |
Check item UUID. |
|
create_time |
No |
String |
Compliance pack creation timestamp. |
|
language |
No |
String |
Compliance pack language environment. |
|
name |
No |
String |
Compliance pack name. |
|
remove_time |
No |
String |
Compliance pack deletion timestamp. |
|
specification_uuid |
No |
String |
Compliance pack UUID. |
|
uuid |
No |
String |
uuid |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
message |
String |
Error message. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Add a custom check item.
https://{endpoint}/v2/{project_id}/workspaces/{workspace_id}/sa/baseline/checkitems
{
"name" : "testt1",
"description" : "eee",
"level" : "medium",
"cloud_server" : "IAM",
"method" : 0
}
Example Responses
Status code: 200
Response body for adding a custom check item.
{
"code" : "SecMaster.00000000",
"message" : "Success."
}
Status code: 400
Request failed.
{
"error_code" : "SecMaster.00040006",
"error_msg" : "Invalid request parameters"
}
Status code: 401
No required permissions.
{
"error_code" : "SecMaster.90010015",
"error_msg" : "Unauthorized request"
}
Status code: 500
Request failed.
{
"error_code" : "SecMaster.00040011",
"error_msg" : "Internal system error"
}
SDK Sample Code
The SDK sample code is as follows.
Add a custom check item.
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 |
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 CreateCustomizedCheckitemSolution { 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(); CreateCustomizedCheckitemRequest request = new CreateCustomizedCheckitemRequest(); request.withWorkspaceId("{workspace_id}"); CheckitemModel body = new CheckitemModel(); body.withName("testt1"); body.withMethod(0); body.withLevel("medium"); body.withDescription("eee"); body.withCloudServer("IAM"); request.withBody(body); try { CreateCustomizedCheckitemResponse response = client.createCustomizedCheckitem(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()); } } } |
Add a custom check item.
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 |
# 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("<YOUR REGION>")) \ .build() try: request = CreateCustomizedCheckitemRequest() request.workspace_id = "{workspace_id}" request.body = CheckitemModel( name="testt1", method=0, level="medium", description="eee", cloud_server="IAM" ) response = client.create_customized_checkitem(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Add a custom check item.
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 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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateCustomizedCheckitemRequest{} request.WorkspaceId = "{workspace_id}" request.Body = &model.CheckitemModel{ Name: "testt1", Method: int32(0), Level: "medium", Description: "eee", CloudServer: "IAM", } response, err := client.CreateCustomizedCheckitem(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 |
Response body for adding a custom check item. |
|
400 |
Request failed. |
|
401 |
No required permissions. |
|
500 |
Request failed. |
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