导出基线 - ExportBaseline
功能介绍
导出基线
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/export
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| content-type | 是 | String | 参数解释: 内容类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| X-Language | 是 | String | 参数解释: 语言,参考值:zh-cn、en-us 约束限制: 不涉及 取值范围: zh-cn:中文环境 en-us:英文环境 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| exportType | 否 | String | 参数解释: 需要导出的类型 约束限制: 不涉及 取值范围: baseline_result:基线检查结果 baseline_template:基线检查结果模板 checkitem:检查项 checkitem_template:检查项模板 compliance:遵从包 compliance_template:遵从包模板 默认取值: baseline_result |
| data_object_filters_form | 否 | DataobjectSearch object | 参数解释: 搜索列表条件 约束限制: 不涉及 |
| title | 否 | Array of strings | 参数解释: 导出字段列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ids | 否 | Array of strings | 参数解释: 导出的基线id列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 分页查询参数,用于指定一次查询最多的结果数,从1开始。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 分页查询参数。用于指定查询结果的起始位置,从0开始 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| sort_by | 否 | String | 参数解释: 排序字段:create_time | update_time 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| order | 否 | String | 参数解释: 排序方式:升序/降序 约束限制: 不涉及 取值范围: DESC: 降序 ASC: 升序 默认取值: 不涉及 |
| from_date | 否 | String | 参数解释: 搜索起始时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| to_date | 否 | String | 参数解释: 搜索结束时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| condition | 否 | condition object | 参数解释: 搜索条件表达式 约束限制: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| conditions | 否 | Array of conditions objects | 参数解释: 表达式列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| logics | 否 | Array of strings | 参数解释: 表达式名称列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| - | File | 参数解释: 基线结果/遵从包/检查项文件 约束限制: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| message | String | 参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
导出遵从包模板
https://{endpoint}/v2/{project_id}/workspaces/{workspace_id}/sa/baseline/export
{
"exportType" : "compliance_template"
} 响应示例
状态码:200
请求成功
"baseline.xlsx"
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 响应错误返回对象 |
错误码
请参见错误码。