Adding a Custom Compliance Pack
Function
This API is used to add a custom compliance pack.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/compliance-packages
|
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 |
Yes |
String |
Compliance pack UUID. |
|
name |
Yes |
String |
Compliance pack name. |
|
version |
No |
String |
Compliance pack version. |
|
owner |
No |
String |
Compliance pack owner. |
|
spec_catalog_vo_list |
No |
Array of BaselineCatalogModel objects |
Compliance pack directory list. |
|
description |
Yes |
String |
Description of the compliance pack. |
|
classify |
No |
String |
Compliance pack category. |
|
areas |
No |
String |
Applicable domain of the compliance pack. |
|
region |
No |
String |
Region where the compliance pack applies. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
uuid |
Yes |
String |
Unique ID (UUID) of a directory. |
|
serial_number |
Yes |
Integer |
Directory location sequence. |
|
level_number |
Yes |
Integer |
Directory hierarchy. |
|
root |
Yes |
String |
UUID of the compliance pack where the directory is located. |
|
parent |
Yes |
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 |
No |
Integer |
Whether the directory is a leaf node. 0: No 1: Yes |
|
check_items |
No |
Array of CheckitemCatalogModel objects |
Check items associated with the directory. |
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 |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Response body for adding a custom compliance pack. |
|
400 |
Error response body for adding a custom compliance pack. |
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