Obtaining a Report Template
Function
Obtaining a Report Template
URI
GET /v2/{project_id}/audit/{instance_id}/reports/templates
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
** Parameter description**: Specifies the project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user. ** Restrictions**: N/A ** Value range**: The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters. ** Default value**: N/A |
instance_id |
Yes |
String |
Definition: Instance ID. The value can be obtained from the ID field of the API for querying the instance list. ** Restrictions**: N/A Range: The value is subject to the value of the API for querying the instance list. The value contains 32 to 64 characters. ** Default value**: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. The token can be queried by calling the IAM API. (The token is the value of X-Subject-Token in the response header.) ** Restrictions**: N/A Range: Used by the IAM service to query the user token. ** Default value**: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
os_type |
String |
OS type |
templates |
Array of TemplateInfo objects |
Obtaining the Template List |
Parameter |
Type |
Description |
---|---|---|
db_ids |
String |
Database ID. |
db_names |
String |
Database name |
desc |
String |
Description |
frequency |
String |
Period |
group |
String |
Type
|
id |
String |
Template ID |
name |
String |
Report template name. |
status |
String |
Status.
|
type |
String |
Report type.
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
details |
Array of DbssErrorDetail objects |
PDP5 authentication exception information |
encoded_authorization_message |
String |
PDP5 authentication exception information |
error_code |
String |
Error Codes |
error_msg |
String |
Error message. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
PDP5 error information |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
details |
Array of DbssErrorDetail objects |
PDP5 authentication exception information |
encoded_authorization_message |
String |
PDP5 authentication exception information |
error_code |
String |
Error Codes |
error_msg |
String |
Error message. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
PDP5 error information |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
details |
Array of DbssErrorDetail objects |
PDP5 authentication exception information |
encoded_authorization_message |
String |
PDP5 authentication exception information |
error_code |
String |
Error Codes |
error_msg |
String |
Error message. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
PDP5 error information |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
details |
Array of DbssErrorDetail objects |
PDP5 authentication exception information |
encoded_authorization_message |
String |
PDP5 authentication exception information |
error_code |
String |
Error Codes |
error_msg |
String |
Error message. |
Example Requests
/v2/{project_id}/audit/{instance_id}/reports/templates
Example Responses
Status code: 200
OK
{ "templates" : [ { "template" : { "id" : "t8g7LJgBTpKZyZbbeTgS", "name" : "Database Security General Report", "type" : "COMPREHENSIVE", "group" : "COMPREHENSIVE", "frequency" : "AUDIT_REPORT_WEEK", "status" : "ON", "desc" : "Database Security General Report", "db_ids" : "", "db_names" : "" } } ], "os_type" : "amd64" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Invalid request parameter. |
401 |
Authorization failed. |
403 |
Unauthorized |
500 |
Server error. |
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