Querying Check Item Details
Function
This API is used to query check item details.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/checkitems/{checkitem_id}
|
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 |
|
checkitem_id |
Yes |
String |
Check item UUID. |
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 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
cloud_server |
String |
Cloud service to which the check item belongs. |
|
description |
String |
Check item description. |
|
level |
String |
Check item severity. informational: informational low: low risk medium: medium risk high: high risk fatal: fatal |
|
method |
Integer |
Check method of the check item. 0: automatic 3: playbook workflows. |
|
name |
String |
Check item name. |
|
source |
Integer |
Source of the check item. 0: default 2: workflows and playbooks |
|
workflow_id |
String |
Definition Workflow ID. Constraints N/A |
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 querying check item details. |
|
400 |
Error response body for querying check item details. |
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