导出资产指纹信息 - DownloadAssetFile
功能介绍
导出资产指纹信息
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/asset/export
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
asset_type |
是 |
String |
参数解释: 资产指纹类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
category |
是 |
String |
参数解释: 类别 约束限制: 不涉及 取值范围:
默认取值: host |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
search_param |
否 |
String |
参数解释: 查询条件,json格式字符串,如{"port_string": "8080"} 约束限制: 如下接口的请求参数的json格式
取值范围: 字符长度0-128 默认取值: 不涉及 |
|
export_headers |
是 |
Array of ExportHead objects |
参数解释: 导出数据表头信息详情 约束限制: 表头信息应为如下格式[[字段1,表头1显示名称],[字段2,表头2显示名称],[字段3,表头3显示名称]] 取值范围: 可从如下取值中选取部分或全部组成表头信息 所有资产都有如下字段:
其他资产类别特有字段: 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
[数组元素] |
否 |
Array of strings |
参数解释: 导出数据表头信息详情 约束限制: 表头信息应为如下格式[[字段1,表头1显示名称],[字段2,表头2显示名称],[字段3,表头3显示名称]] 取值范围: 可从如下取值中选取部分或全部组成表头信息 所有资产都有如下字段:
其他资产类别特有字段: 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
导出任务ID |
请求示例
导出资产指纹的相关数据。
POST https://{endpoint}/v5/{project_id}/asset/export?asset_type=web_service&category=host&enterprise_project_id=all_granted_eps
{
"export_headers" : [ [ "host_name", "服务器名称" ], [ "host_id", "服务器ID" ] ]
}
响应示例
状态码:200
请求已成功
{
"task_id" : "513d9747-6059-495f-be82-2db216e643ae"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。