admin 管理员组

文章数量: 1184232


2024年3月19日发(作者:中方回应拜登撕毁对华承诺)

目录

概述

注意事项

思科 ASA REST API 快速入门指南

首次发布:2014 年 12 月 24 日

第 1 页上的概述

第 2 页上的 ASA REST API 请求和响应

第 3 页上的安装和配置 ASA REST API 代理和客户端

第 5 页上的文档控制台和导出 API 脚本

第 6 页上的在 ASA 上启用 REST API 调试

第 6 页上的 ASA REST API 相关的系统日志消息

第 7 页上的相关文档

有若干选项可用于配置和管理单个 Cisco ASA:

命令行界面 (CLI) - 您可通过连接控制台将控制命令直接发送到 ASA。

自适应安全设备管理器 (ASDM) - “内置”管理应用,其图形用户界面可供您配置、管理和监

控 ASA。

思科安全管理器 – 虽然此图形应用旨在用于由许多安全设备构成的大中型网络,但它也可用

来配置、管理和监控单个 ASA。

思科 ASA REST API 的推出为您提供了另一款轻型、易用的选件。这是基于“RESTful”原则的

应用编程接口 (API),可以在运行 API 的任何 ASA 上快速下载和启用这些原则。

在浏览器上安装 REST 客户端之后,您可以联系特定 ASA 的 REST 代理和使用标准 HTTP 方法访

问当前配置信息,并发出其他配置参数。

在 ASA 上启用 REST API 后,不会阻止其他安全管理协议的连接。这意味着在您修改 ASA 配置

时,使用 CLI、ASDM 或安全管理器的其他用户也可能正在执行相同的操作。

Cisco Systems, Inc.

ASA REST API 请求和响应

ASA REST API 请求和响应

借助于 ASA REST API,您可以通过具象状态传输 (REST) API 进行编程访问,以管理单个 ASA。

该 API 基于 HTTPS 协议和 REST 方法,允许外部客户端对 ASA 资源执行 CRUD(创建、读取、

更新、删除)操作。

所有 API 请求均通过 HTTPS 发送到 ASA,并由系统返回响应。

本节概述如何构建请求以及预期响应。

请求结构

可用的请求方法如下:

GET – 从指定对象检索数据。

PUT – 将提供的信息添加到指定对象(如果存在);否则,使用提供的信息创建对象。

POST – 将提供的信息添加到现有对象。

DELETE – 删除指定对象。

PATCH – 将部分修改应用于指定对象。

响应结构

每个请求均从 ASA 生成一个带有标准报头、响应内容和状态代码的 HTTPS 响应。

响应结构可以是:

LOCATION – 新创建的资源 ID;仅适用于 POST - 保留新的资源 ID(作为 URI 表达)。

CONTENT-TYPE – 描述响应消息正文的介质类型;描述响应消息正文的表达和语法。

20x

- 二百系列代码表示操作成功,包括:

–200 OK

– 成功请求的标准响应。

–201 Created

– 已完成请求;已创建新资源。

–202 Accepted

– 已接受请求,但是未完成处理。

–204 No Content

– 服务器已成功处理请求;未返回内容。

每个响应均包括 HTTP 状态或错误代码。可用的代码属于以下类别:

•4xx

- 四百系列代码表示客户端错误,包括:

–400 Bad Request

– 无效的查询参数,包括无法识别的参数、缺失的参数或无效值。

–404 Not Found

– 提供的 URL 与现有资源不匹配。例如,因为资源不可用,HTTP

DELETE 可能失败。

–405 Method not Allowed

– 提出资源上不允许的 HTTP 请求;例如,只读资源上的 POST。

•5xx

- 五百系列代码表示服务器端错误。

一旦出现错误,除了错误代码以外,返回响应还可能包括错误对象(包含有关错误的更多详

情)。JSON 错误/警告响应模式如下:

[

{ “code” : “string”,

“details”: “string”,

“context”: attribute name,

思科 ASA REST API 快速入门指南

2

最后更新日期:2014 年 10 月 30 日


本文标签: 响应 请求 错误 对象 管理