Querying Compliance Pack Details
Function
This API is used to query compliance pack details.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/compliance-packages/{compliance_packages_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
compliance_packages_id |
Yes |
String |
Compliance pack UUID. |
|
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 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
uuid |
String |
Compliance pack UUID. |
|
name |
String |
Compliance pack name. |
|
version |
String |
Compliance pack version. |
|
owner |
String |
Compliance pack owner. |
|
spec_catalog_vo_list |
Array of BaselineCatalogModel objects |
Compliance pack directory list. |
|
description |
String |
Description of the compliance pack. |
|
classify |
String |
Compliance pack category. |
|
areas |
String |
Applicable domain of the compliance pack. |
|
region |
String |
Region where the compliance pack applies. |
|
state |
Integer |
Compliance pack status. 0: disabled. 1: enabled |
|
type |
Integer |
Compliance pack type. 0: built-in 1: custom |
|
check_items_num |
Integer |
Number of check items in the compliance pack. |
|
has_auto_check_items |
Boolean |
Whether the compliance pack contains automatic check items. |
|
Parameter |
Type |
Description |
|---|---|---|
|
uuid |
String |
Unique ID (UUID) of a directory. |
|
serial_number |
Integer |
Directory location sequence. |
|
level_number |
Integer |
Directory hierarchy. |
|
root |
String |
UUID of the compliance pack where the directory is located. |
|
parent |
String |
UUID of the parent directory of the directory. If the directory is at the first layer, the value is the UUID of the compliance pack. |
|
is_leaf |
Boolean |
Whether the directory is a leaf node. 0: No 1: Yes |
|
check_items |
Array of CheckitemCatalogModel objects |
Check items associated with the directory. |
|
Parameter |
Type |
Description |
|---|---|---|
|
uuid |
String |
Check item UUID. |
|
name |
String |
Check item name. |
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
None
Example Responses
Status code: 200
Response body for querying compliance pack details.
{
"uuid" : "102c8876-f111-4ee9-b499-80450711df6f",
"name" : "testForApie",
"version" : "1.0",
"owner" : "l123",
"spec_catalog_vo_list" : [ {
"uuid" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"serial_number" : 2,
"level_number" : 0,
"root" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"parent" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"is_leaf" : true,
"check_items" : [ {
"uuid" : "3f9d8c0e-2a1b-4d3c-9a7b-1f2e3d4c5b6a",
"name" : "test spec"
} ]
} ],
"description" : "test spec",
"classify" : "test",
"areas" : "test",
"region" : "test",
"state" : 0,
"type" : 0,
"check_items_num" : 0,
"has_auto_check_items" : true
}
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.
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 |
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 ShowCompliancePackageDetailSolution { 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(); ShowCompliancePackageDetailRequest request = new ShowCompliancePackageDetailRequest(); request.withCompliancePackagesId("{compliance_packages_id}"); request.withWorkspaceId("{workspace_id}"); try { ShowCompliancePackageDetailResponse response = client.showCompliancePackageDetail(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 32 33 |
# 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 = ShowCompliancePackageDetailRequest() request.compliance_packages_id = "{compliance_packages_id}" request.workspace_id = "{workspace_id}" response = client.show_compliance_package_detail(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 38 39 |
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.ShowCompliancePackageDetailRequest{} request.CompliancePackagesId = "{compliance_packages_id}" request.WorkspaceId = "{workspace_id}" response, err := client.ShowCompliancePackageDetail(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 querying compliance pack details. |
|
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