以下是要与此调用结合使用的 JSON 对象示例。

{
  "diskFileName": "string",
  "encryptionKey": "*********",
  "doNotEncrypt": false,
  "configExportType": "FULL_EXPORT",
  "deployedObjectsOnly": true,
  "entityIds": [
    "string"
  ],
  "jobName": "string",
  "type": "scheduleconfigexport"
}

属性包括：

• diskFileName -（可选。）导出 zip 文件的名称。如果不指定名称，系统会为您生成一个名称。即使指定名称，系统也可能在名称之后附加某些字符以确保唯一性。名称的最大长度为 60 个字符。

• encryptionKey -（可选。) zip 文件的加密密钥。如果不想加密文件，请忽略此字段并指定 "doNotEncrypt": true。如果指定密钥，则在将 zip 文件下载至工作站后，需要使用该密钥打开 zip 文件。请注意，导出的配置文件以明文形式公开密钥、密码和其他敏感数据（否则将无法导入），因此您可能希望应用加密密钥来保护敏感数据。系统使用 AES 256 加密。

• doNotEncrypt -（可选。）导出文件应该加密 (false) 还是不加密 (true)。默认值为 false，这意味着必须指定非空的 encryptionKey 属性。如果指定 true，则将忽略 encryptionKey 属性。

• configExportType - 以下枚举值之一：

  • FULL_EXPORT - 在导出文件中包括整个配置。这是默认值。

  • PARTIAL_EXPORT - 仅包含在 entityIds 列表中标识的对象及其后代对象。对于不可导出的对象，即使指定其身份，也无法将其包括在内。所有用户定义的对象均可导出。

  • PENDING_CHANGE_EXPORT - 仅包括尚未部署的对象，即待处理更改。

• deployedObjectsOnly -（可选。）是否仅在对象已部署时才将其包含在导出文件中。也就是说，不包括待处理更改。对于 PENDING_CHANGE_EXPORT 作业，忽略此属性，因为这些作业仅包括未部署对象。默认值为 false，表示导出中包含所有待处理更改。指定 true 以排除待处理更改。

• entityIds - 一组起始点对象的身份列表，其中对象以逗号分隔并括在 [方括号] 中。PARTIAL_EXPORT 作业需要此列表。此列表中的各项均可以是 UUID 值或与 "id=uuid-value"、"type=object-type" 或 "name=object-name" 等模式匹配的属性值对。例如，"type=networkobject"。

  type 可以是叶实体（例如 networkobject），也可以是一组叶类型的别名。一些典型的类型别名包括：network（NetworkObject 和 NetworkObjectGroup）、port（所有 TCP/UDP/ICMP 端口、协议和组类型）、url（URL 对象和组）、ikepolicy（IKE V1/V2 策略）、ikeproposal（Ike V1/V2 提议）、identitysource（所有身份源），certificate（所有证书类型）、object（将在“对象”(Objects) 页面上的 设备管理器 中列出的所有对象/组类型）、interface（所有网络接口）、s2svpn（所有站点间 VPN 相关类型）、ravpn（所有 RA VPN 相关类型）和 vpn（s2svpn 和 ravpn）。

  所有这些对象及其传出引用后代将包含在 PARTIAL_EXPORT 输出文件中。请注意，所有不可导出对象都将从输出中排除，即使您指定其身份。使用相应资源类型的 GET 方法获取目标对象的 UUID、类型或名称。

  例如，要导出所有网络对象以及名为 myaccessrule 的访问规则和由 UUID 标识的两个对象，可指定：

  
  "entityIds": [
     "type=networkobject", 
     "id=bab3e3cd-8c70-11e9-930a-1f12ee87d473", 
     "name=myaccessrule", 
     "acc2e3cd-8c70-11e9-930a-1f12ee87b286"
     ]",

• jobName -（可选。）导出作业的名称。在检索作业状态时，给出作业名称可以更轻松地进行查找。

• type - 作业类型，始终为 scheduleconfigexport。

例如，curl 命令会如下所示：

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "configExportType": "FULL_EXPORT", \ 
   "type": "scheduleconfigexport" \ 
 }' 'https://10.89.5.38/api/fdm/最新/action/configexport'

您应获得的响应代码为 200。如果发布了最小的 JSON 对象，则成功的响应正文将类似于以下内容。如果指定加密密钥，则会在响应中屏蔽该密钥。

{
  "version": null,
  "scheduleType": "IMMEDIATE",
  "user": "admin",
  "forceOperation": false,
  "jobHistoryUuid": "c7a8ba61-629a-11e9-8b8d-0fcc3c9d6d0b",
  "ipAddress": "10.24.5.177",
  "diskFileName": "export-config-1",
  "encryptionKey": null,
  "doNotEncrypt": true
  "configExportType": "FULL_EXPORT",
  "deployedObjectsOnly": false,
  "entityIds": null,
  "jobName": "Config Export",
  "id": "c79be920-629a-11e9-8b8d-85231be77de0",
  "type": "scheduleconfigexport",
  "links": {
    "self": "https://10.89.5.38/api/fdm/最新
/action/configexport/c79be920-629a-11e9-8b8d-85231be77de0"
  }
}

配置文件列表包括导出文件和上传用于导入的任何文件。

curl 命令类似于下文：

curl -X GET --header 'Accept: application/json' 
'https://10.89.5.38/api/fdm/最新/action/configfiles'

响应将显示项目列表，每个项目都是一个配置文件。例如，以下列表显示 2 个文件。请注意，所有文件的 id 均是默认值。忽略 ID，并用 diskFileName 代替它。

{
  "items": [
    {
      "diskFileName": "export-config-2.zip",
      "dateModified": "2019-04-19 13:32:28Z",
      "sizeBytes": 10182,
      "id": "default",
      "type": "configimportexportfileinfo",
      "links": {
        "self": "https://10.89.5.38/api/fdm/最新/action/configfiles/default"
      }
    },
    {
      "diskFileName": "export-config-1.zip",
      "dateModified": "2019-04-19 13:14:56Z",
      "sizeBytes": 10083,
      "id": "default",
      "type": "configimportexportfileinfo",
      "links": {
        "self": "https://10.89.5.38/api/fdm/最新/action/configfiles/default"
      }
    }
  ],

curl 命令类似于下文：

curl -X GET --header 'Accept: application/octet-stream' 
'https://10.89.5.38/api/fdm/最新/action/downloadconfigfile/export-config-2.zip'

文件将下载至默认下载文件夹。如果是从 API Explorer 发出 GET 方法，且浏览器配置为提示下载位置，系统会提示您保存文件。

下载成功后会出现 200 返回代码，但无响应正文。

以下是要与此调用结合使用的 JSON 对象示例。

{
  "diskFileName": "string",
  "encryptionKey": "*********",
  "preserveConfigFile": true,
  "autoDeploy": true,
  "allowPendingChange": true,
  "excludeEntities": [
     "string" 
     ]",
  "inputEntities": [
    {
      "action": "CREATE",
      "oldName": "string",
      "parentId": "string",
      "parentName": "string",
      "index": 0,
      "data": {
        "version": "string",
        "id": "string",
        "type": "identity"
      },
      "id": "string",
      "type": "IdEntityWrapper"
    }
  ],
  "jobName": "string",
  "type": "scheduleconfigimport"
}

属性包括：

• diskFileName - 要导入的配置 zip 或 txt 文件的名称。

• encryptionKey - 用于加密 zip 文件的密钥（如有）。如果配置文件未加密，请勿指定密钥。

• preserveConfigFile -（可选。）在成功导入作业后，是否在 威胁防御 磁盘上保留导入的配置文件的副本。指定 true 以保留文件，指定 false 以使文件从 威胁防御 磁盘中删除。默认值为 false。

• autoDeploy -（可选。）导入成功时是否自动开始部署作业。导入的对象是待处理更改，在成功部署更改前，这些对象处于非活动状态。指定 true 以自动开始部署作业。如果指定 false，则必须手动部署更改。默认值为 false。

• allowPendingChange -（可选。）如有现有待处理更改，是否允许开始导入作业。如果将此属性设置为 true，并将 autoDeploy 设置为 true，则自动部署作业将包括已预先存在和已导入的所有更改。如果将此属性设置为 false，则如果存在待处理更改，导入作业将不会运行。默认值为 false。

• excludeEntities -（可选。）标识不应导入的对象的对象匹配字符串列表。仅当导入文件包含您不想导入的项目（即，您决定不从上传文件中删除这些项目）时，才需指定此属性。此列表中的各项目模式如下："id=uuid-value"、"type=object-type" 或 "name=object-name"。系统将从导入中删除与其中一个模式匹配的输入对象。

  type 可以是叶实体（例如 networkobject），也可以是一组叶类型的别名。一些典型的类型别名包括：network（NetworkObject 和 NetworkObjectGroup）、port（所有 TCP/UDP/ICMP 端口、协议和组类型）、url（URL 对象和组）、ikepolicy（IKE V1/V2 策略）、ikeproposal（Ike V1/V2 提议）、identitysource（所有身份源），certificate（所有证书类型）、object（将在“对象”(Objects) 页面上的 设备管理器 中列出的所有对象/组类型）、interface（所有网络接口）、s2svpn（所有站点间 VPN 相关类型）、ravpn（所有 RA VPN 相关类型）和 vpn（s2svpn 和 ravpn）。

  例如，要排除导入所有网络对象以及由名称 myobj 和 UUID 标识的其他两个对象，请指定以下定义：

  
  "excludeEntities": [
     "type=networkobject", 
     "name=myobj", 
     "id=acc2e3cd-8c70-11e9-930a-1f12ee87b286"
     ]",

• inputEntities - 如果要导入的对象数量很少，则可以在 inputEntities 对象列表中而不是配置文件中对其进行定义。要使用此属性，则不能包含 diskFileName 属性，否则必须将该属性设置为 null。

• jobName -（可选。）导出作业的名称。在检索作业状态时，给出作业名称可以更轻松地进行查找。

• type - 作业类型，始终为 scheduleconfigimport。

例如，curl 命令会如下所示：

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "diskFileName": "import-2.txt", \ 
   "preserveConfigFile": true, \ 
   "autoDeploy": true, \ 
   "allowPendingChange": true, \ 
   "type": "scheduleconfigimport" \ 
 }' 'https://10.89.5.38/api/fdm/最新/action/configimport'

您应获得的响应代码为 200。如果发布了最小的 JSON 对象，则成功的响应正文将类似于以下内容。如果指定加密密钥，则会在响应中屏蔽该密钥。

{
  "version": null,
  "scheduleType": "IMMEDIATE",
  "user": "admin",
  "forceOperation": false,
  "jobHistoryUuid": "7e360139-6725-11e9-abb5-078014531401",
  "ipAddress": "10.24.127.37",
  "diskFileName": "import-2.txt",
  "encryptionKey": null,
  "preserveConfigFile": true,
  "autoDeploy": true,
  "allowPendingChange": true,
  "jobName": "Config Import",
  "id": "7e2b52d8-6725-11e9-abb5-5dec35337506",
  "type": "scheduleconfigimport",
  "links": {
    "self": "https://10.89.5.38/api/fdm/最新
/action/configimport/7e2b52d8-6725-11e9-abb5-5dec35337506"
  }
}

或者，也可以使用 GET/jobs/configimportstatus/{objId} 获取导入作业的状态。对于 objId，请使用对 POST /action/configimport 调用的响应正文中的 jobHistoryUuid 值。

curl 命令会如下所示：

curl -X GET --header 'Accept: application/json' 
'https://10.89.5.38/api/fdm/最新/jobs/configimportstatus'

成功导入的响应正文可能如下所示。如果导入失败，可能需要编辑文件以更正格式或内容错误，然后重试。

{
      "version": "pcgccfnk4hmiz",
      "jobName": "Config Import",
      "jobDescription": null,
      "user": "admin",
      "startDateTime": "2019-04-25 06:43:54Z",
      "endDateTime": "2019-04-25 06:44:01Z",
      "status": "SUCCESS",
      "statusMessage": "The configuration was imported successfully",
      "scheduleUuid": "7e2b52d8-6725-11e9-abb5-5dec35337506",
      "diskFileName": "import-2.txt",
      "messages": [],
      "preserveConfigFile": true,
      "autoDeploy": true,
      "allowPendingChange": true,
      "id": "7e360139-6725-11e9-abb5-078014531401",
      "type": "configimportjobstatus",
      "links": {
        "self": "https://10.89.5.38/api/fdm/最新
/jobs/configimportstatus/7e360139-6725-11e9-abb5-078014531401"
  }
}