创建后台报备
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PolicyType |
string |
是 |
报备策略类型。取值：
|
PrivateAccessBlock |
| Targets |
array<object> |
是 |
报备用户列表，使用 Flat 序列化格式。支持 1~100 个用户；仅支持当前阿里云账号下的具体 SASE 用户。去重后的用户数与报备对象数的乘积不能大于 100。 |
|
|
object |
否 |
|||
| UserId |
string |
是 |
SASE 用户 ID。可通过 ListUsers 查询。 |
su_8548af20c3b30e931e75cd847a4c**** |
| ReportObjects |
array<object> |
是 |
报备对象列表，使用 Flat 序列化格式。支持 1~100 个同一策略类型的报备对象；对象字段必须与 PolicyType 匹配。 |
|
|
object |
否 |
|||
| ApplicationId |
string |
否 |
内网应用 ID。当 PolicyType 取值为 PrivateAccessBlock 时必填。可通过 ListPrivateAccessApplications 查询。 |
pa-app-****************1234 |
| DevType |
string |
否 |
终端操作系统。当 PolicyType 取值为 PeripheralBlock 时必填。取值：
|
windows |
| DeviceType |
string |
否 |
外设渠道。当 PolicyType 取值为 PeripheralBlock 时必填。Windows 支持 usbStorage、printer、mobile、cardReader、cdrom、bluetooth；macOS 支持 usbStorage、airDrop、mobile、bluetooth。 |
usbStorage |
| FileMd5 |
string |
否 |
文件 MD5。当 PolicyType 取值为 DlpSend 时必填。取值必须为 32 位十六进制字符串，不区分大小写。 |
c936226c4745125b5786527d205a**** |
| ReportDomain |
string |
否 |
报备域名。当 PolicyType 取值为 DomainWhitelist 或 DomainBlacklist 时必填。支持普通域名或以 *. 开头的泛域名，不支持协议、端口和路径。 |
*.example.com |
| Scope |
string |
否 |
外设报备粒度。当 PolicyType 取值为 PeripheralBlock 时必填，当前仅支持 Channel，表示按外设渠道报备。 |
Channel |
| SoftwareId |
string |
否 |
禁用软件 ID。当 PolicyType 取值为 SoftwareBlock 时必填。 |
swb-c717ee516145**** |
| ValidityType |
string |
否 |
生效时长类型。不传时默认为 FixedTime。取值：
|
FixedTime |
| EndTimestamp |
integer |
否 |
报备截止时间，Unix 时间戳，单位为秒。当 ValidityType 取值为 FixedTime 或未传入 ValidityType 时必填，且必须晚于当前时间；当 ValidityType 取值为 Permanent 时请勿传入，或传入 0。 |
1788192000 |
| Reason |
string |
是 |
报备原因，1 至 1024 个字符 |
项目临时访问 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| FailedCount |
integer |
integer 创建失败的组合数量。 |
0 |
| Items |
array<object> |
各“用户 × 报备对象”组合的处理结果。部分组合失败时，接口仍返回全部组合的结果。 |
|
|
array<object> |
|||
| ApprovalId |
string |
创建成功后生成的审批实例 ID。创建失败时不返回。 |
approval-6b5188a28634**** |
| Code |
string |
当前组合创建失败时返回的错误码；成功时不返回。 |
TargetNotFound |
| EffectStatus |
string |
报备生效状态。创建成功时返回 Enabled，表示有效。 |
Enabled |
| Message |
string |
string 当前组合创建失败时返回的错误信息；成功时不返回。 |
target user is not found |
| ReportObject |
any |
当前组合对应的报备对象，字段随 PolicyType 变化。 |
[{"ApplicationId":"pa-application-92b60359213a****"}] |
| ReportType |
string |
报备类型。创建成功时固定返回 BackendReport，表示后台报备。 |
BackendReport |
| Status |
string |
审批状态。创建成功时返回 Approved，表示已通过。 |
Approved |
| Success |
boolean |
当前组合是否创建成功。 |
true |
| Target |
object |
当前组合对应的报备用户。 |
|
| UserId |
string |
SASE 用户 ID。 |
su_1b91e674235a25e4117faf5c36a8ad4e69a14303247fb7d9f2046ce8b372**** |
| ObjectCount |
integer |
去重后的报备对象数量。 |
1 |
| RequestId |
string |
Id of the request |
D6707286-A50E-57B1-B2CF-EFAC59E8**** |
| SuccessCount |
integer |
创建成功的组合数量。 |
1 |
| TargetCount |
integer |
去重后的报备用户数量。 |
1 |
| TotalCount |
integer |
展开后的“用户 × 报备对象”组合总数。 |
1 |
示例
正常返回示例
JSON格式
{
"FailedCount": 0,
"Items": [
{
"ApprovalId": "approval-6b5188a28634****",
"Code": "TargetNotFound",
"EffectStatus": "Enabled",
"Message": "target user is not found",
"ReportObject": "[{\"ApplicationId\":\"pa-application-92b60359213a****\"}]",
"ReportType": "BackendReport",
"Status": "Approved",
"Success": true,
"Target": {
"UserId": "su_1b91e674235a25e4117faf5c36a8ad4e69a14303247fb7d9f2046ce8b372****"
}
}
],
"ObjectCount": 1,
"RequestId": "D6707286-A50E-57B1-B2CF-EFAC59E8****",
"SuccessCount": 1,
"TargetCount": 1,
"TotalCount": 1
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。