CreateApiExport - 创建API安全数据导出任务

创建API安全数据导出任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-waf:CreateApiExportcreate
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

WAF 实例的 ID。

说明 您可以调用 DescribeInstance 获取当前 WAF 实例的 ID。
waf-cn-zxu3***
Regionstring

语言类型。取值:

  • cn(默认):中文。
  • en:英文。
cn
ZoneIdstring

时区 ID。

Asia/Shanghai
Typestring

导出任务类型。取值:

  • apisec_api(默认):表示 API 资产任务。

  • apisec_abnormal:表示 API 风险任务。

  • apisec_event:表示 API 安全事件任务。

apisec_api
Paramstring

导出任务的扩展参数,支持通过条件匹配过滤导出的内容,以一系列参数构造的 JSON 格式转化成字符串。

说明 根据所指定的导出任务类型Type)不同,具体涉及的参数有所不同。详细信息,请参见导出任务参数描述
{ "startTime": 1741449600, "endTime": 1744079820, "sensitiveLevel": "L1" }
ClusterIdstring

混合云集群 ID。

说明 只针对混合云场景,您可以调用 DescribeHybridCloudClusters 获取混合云集群信息。
993
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q

导出任务参数描述

API 资产任务(apisec_api

参数描述

参数的详细取值可以参考接口 DescribeApisecApiResources 的同名参数。

名称类型示例值描述
startTimeInteger1741449600查询的开始时间,格式为 Unix 时间戳(UTC 时间),单位为秒。
EndTimeInteger1744097760查询的结束时间,格式为 Unix 时间戳(UTC 时间),单位为秒。
MatchedHostStringa.aliyun.comAPI 接口所属的域名或 IP。
ApiFormatString/auth/loginAPI 接口。
SensitiveTypeString1004响应敏感数据类型。
ApiStatusStringOfflineInterfaceAPI 的状态。
FollowLong0是否关注。
ApiTypeStringinnerAPI服务对象。
ApiTagStringSendMailAPI 的业务用途。
SensitiveLevelStringL3接口敏感等级。
ApiMethodStringPOSTAPI 的请求方法。
RequestSensitiveTypeString1004,1005请求敏感信息类型。
AuthFlagString0是否有鉴权字段。

API 风险任务(apisec_abnormal

参数描述

参数的详细取值可以参考接口 DescribeApisecAbnormals 的同名参数。

名称类型示例值描述
startTimeInteger1741449600查询的开始时间,格式为 Unix 时间戳(UTC 时间),单位为秒。
EndTimeInteger1744097760查询的结束时间,格式为 Unix 时间戳(UTC 时间),单位为秒。
MatchedHostStringa.aliyun.comAPI 接口所属的域名或 IP。
ApiFormatString/api/users/loginAPI 接口。
AbnormalLevelStringmedium风险等级。
AbnormalTagStringLackOfSpeedLimit风险类型。
UserStatusStringConfirmed风险状态。
OriginStringcustom风险类型的来源。
ApiTagStringSendMailAPI 的业务用途。

API 事件任务(apisec_event

参数描述

参数的详细取值可以参考接口 DescribeApisecEvents 的同名参数。

名称类型示例值描述
StartTsInteger1741449600查询的开始时间,格式为 Unix 时间戳(UTC 时间),单位为秒。
EndTsInteger1744097760查询的结束时间,格式为 Unix 时间戳(UTC 时间),单位为秒。
MatchedHostStringa.aliyun.comAPI 接口所属的域名或 IP。
ApiFormatString/api/users/loginAPI 接口。
EventLevelStringmedium事件等级。
EventTagStringObtainSensitiveUnauthorized事件类型。
UserStatusStringConfirmed事件状态。
OriginStringcustom事件类型的来源。
ApiTagStringSendMailAPI 的业务用途。

返回参数

名称类型描述示例值
object

请求结果。

RequestIdstring

请求 ID。

62382992-F9AA-52B2-9147-66B3B9E51D74

示例

正常返回示例

JSON格式

{
  "RequestId": "62382992-F9AA-52B2-9147-66B3B9E51D74"
}

错误码

访问错误中心查看更多错误码。