操作安全报告 - ExecuteReportAction
功能介绍
操作安全报告
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/sa/reports/{report_id}/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
report_id |
是 |
String |
报告ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
report_content |
否 |
String |
报告的base64编码 |
|
email_title |
否 |
String |
邮件标题 |
|
email_to |
否 |
String |
收件人邮箱 |
|
email_cc |
否 |
String |
抄送人邮箱 |
|
email_content |
否 |
String |
邮件内容 |
|
report_file_type |
否 |
String |
附件类型 |
|
action |
是 |
String |
API的动作支持send和download |
|
report_page |
否 |
String |
安全报告Base64编码的内容 |
|
page_config |
否 |
PageConfigPx object |
安全报告的页边距 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
width |
否 |
Integer |
安全报告的宽度 |
|
height |
否 |
Integer |
安全报告的高度 |
|
margin |
否 |
MarginInfo object |
安全报告的页边距 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
|
file |
Object |
导出文件 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
发送报告请求体
{
"email_to" : "xx@xxx.com",
"report_page" : "WyI8ZGl2PjxkaXYgZGF0YS13LWUtdHlwZT1cInRleHQtYm94XCIgY29udGVudD1cIuaXpeW/l+WuoeiuoeaKpeWRilwiIHBvc2l0aW9uPVwiYWJzb2x1dGVcIiBsZWZ0PVwiMTgyLjI5OTk4Nzc5Mjk2ODc1cHhcIiB0b3A9XCIxNjEuMTc0OTg3NzkyOTY4NzVweFwiIHdpZHRoPVwiNjMwcHhcIiBoZWlnaHQ9XCIxNDlweFwiICBpbnNldD1cIjAsMCwwLDBcIiBjb2xvcj1cIiMwMDAwMDBcIiBpcy1ib2xkPVwiZmFsc2VcIiBpcy1pdGFsaWM9XCJmYWxzZVwiIGZvbnQtc2l6ZT1cIjEwMHB4XCIgZm9udC1mYW1pbHk9XCJIZWx2ZXRpY2EsIEFyaWFsLCBQaW5nRmFuZ1NDLVJlZ3VsYXIsIFwiSGlyYWdpbm8gU2FucyBHQlwiLCBcIk1pY3Jvc29mdCBZYUhlaVwiLCDlvq7ova/pm4Xpu5EsIFwiTWljcm9zb2Z0IEpoZW5nSGVpXCJcIiBsaW5lLWhlaWdodD1cIjEuM1wiPiA8L2Rpdj48ZGl2IGRhdGEtdy1lLXR5cGU9XCJ0ZXh0LWJveFwiIGNvbnRlbnQ9XCIyMDI1XCIgcG9zaXRpb249XCJhYnNvbHV0ZVwiIGxlZnQ9XCIxODIuMjk5OTg3NzkyOTY4NzVweFwiIHRvcD1cIjMzOC42MjQ5Njk0ODI0MjE5cHhcIiB3aWR0aD1cIjEyOHB4XCIgaGVpZ2h0PVwiNDlweFwiICBpbnNldD1cIjAsMCwwLDBcIiBjb2xvcj1cIiMwMDAwMDBcIiBpcy1ib2xkPVwiZmFsc2VcIiBpcy1pdGFsaWM9XCJmYWxzZVwiIGZvbnQtc2l6ZT1cIjMycHhcIiBmb250LWZhbWlseT1cIkhlbHZldGljYSwgQXJpYWwsIFBpbmdGYW5nU0MtUmVndWxhciwgXCJIaXJhZ2lubyBTYW5zIEdCXCIsIFwiTWljcm9zb2Z0IFlhSGVpXCIsIOW+rui9r+mbhem7kSwgXCJNaWNyb3NvZnQgSmhlbmdIZWlcIlwiIGxpbmUtaGVpZ2h0PVwiMS4zXCI+IDwvZGl2PjxkaXYgZGF0YS13LWUtdHlwZT1cInRleHQtYm94XCIgY29udGVudD1cIjExLjE5IDAwOjAwOjAwXCIgcG9zaXRpb249XCJhYnNvbHV0ZVwiIGxlZnQ9XCIyOTAuNDQ5OTUxMTcxODc1cHhcIiB0b3A9XCIzMzAuMjI1MDA2MTAzNTE1NnB4XCIgd2lkdGg9XCIyNTJweFwiIGhlaWdodD1cIjMzcHhcIiAgaW5zZXQ9XCIwLDAsMCwwXCIgY29sb3I9XCIjMDAwMDAwXCIgaXMtYm9sZD1cImZhbHNlXCIgaXMtaXRhbGljPVwiZmFsc2VcIiBmb250LXNpemU9XCIxOHB4XCIgZm9udC1mYW1pbHk9XCJIZWx2ZXRpY2EsIEFyaWFsLCBQaW5nRmFuZ1NDLVJlZ3VsYXIsIFwiSGlyYWdpbm8gU2FucyBHQlwiLCBcIk1pY3Jvc29mdCBZYUhlaVwiLCDlvq7ova/pm4Xpu5EsIFwiTWljcm9zb2Z0IEpoZW5nSGVpXCJcIiBsaW5lLWhlaWdodD1cIjEuM1wiPiA8L2Rpdj48ZGl2IGRhdGEtdy1lLXR5cGU9XCJ0ZXh0LWJveFwiIGNvbnRlbnQ9XCIxMS4xOSAyMzo1OTo1OVwiIHBvc2l0aW9uPVwiYWJzb2x1dGVcIiBsZWZ0PVwiMjkwLjQ0OTk1MTE3MTg3NXB4XCIgdG9wPVwiMzY0Ljg3NDk2OTQ4MjQyMTlweFwiIHdpZHRoPVwiMjUycHhcIiBoZWlnaHQ9XCIzM3B4XCIgIGluc2V0PVwiMCwwLDAsMFwiIGNvbG9yPVwiIzAwMDAwMFwiIGlzLWJvbGQ9XCJmYWxzZVwiIGlzLWl0YWxpYz1cImZhbHNlXCIgZm9udC1zaXplPVwiMThweFwiIGZvbnQtZmFtaWx5PVwiSGVsdmV0aWNhLCBBcmlhbCwgUGluZ0ZhbmdTQy1SZWd1bGFyLCBcIkhpcmFnaW5vIFNhbnMgR0JcIiwgXCJNaWNyb3NvZnQgWWFIZWlcIiwg5b6u6L2v6ZuF6buRLCBcIk1pY3Jvc29mdCBKaGVuZ0hlaVwiXCIgbGluZS1oZWlnaHQ9XCIxLjNcIj4gPC9kaXY+PGRpdiBkYXRhLXctZS10eXBlPVwidGV4dC1ib3hcIiBjb250ZW50PVwi55Sf5oiQ5pe26Ze077yaMjAyNS8xMS8yMCAxMDo1MzozOFwiIHBvc2l0aW9uPVwiYWJzb2x1dGVcIiBsZWZ0PVwiMTgyLjI5OTk4Nzc5Mjk2ODc1cHhcIiB0b3A9XCI0ODEuOTQ5OTIwNjU0Mjk2OXB4XCIgd2lkdGg9XCIyODhweFwiIGhlaWdodD1cIjI3cHhcIiAgaW5zZXQ9XCIwLDAsMCwwXCIgY29sb3I9XCIjOGM4YzhjXCIgaXMtYm9sZD1cImZhbHNlXCIgaXMtaXRhbGljPVwiZmFsc2VcIiBmb250LXNpemU9XCIxMnB4XCIgZm9udC1mYW1pbHk9XCJIZWx2ZXRpY2EsIEFyaWFsLCBQaW5nRmFuZ1NDLVJlZ3VsYXIsIFwiSGlyYWdpbm8gU2FucyBHQlwiLCBcIk1pY3Jvc29mdCBZYUhlaVwiLCDlvq7ova/pm4Xpu5EsIFwiTWljcm9zb2Z0IEpoZW5nSGVpXCJcIiBsaW5lLWhlaWdodD1cIjEuM1wiPiA8L2Rpdj48L2Rpdj4iXQ==",
"page_config" : {
"margin" : {
"top" : 0,
"left" : 50,
"bottom" : 0,
"right" : 50
},
"width" : 1612,
"height" : 730
},
"report_file_type" : "word",
"email_content" : "content",
"action" : "download",
"report_content" : "123",
"email_cc" : "xx@xxx.com",
"email_title" : "tittle"
}
响应示例
状态码:200
下载文件
{
"code" : "00000000",
"message" : "成功"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
下载文件 |
|
400 |
错误响应 |
错误码
请参见错误码。