CMCI REST API 参考

CICS 管理客户机接口 (CMCI) 为系统管理客户机 (例如 IBM® CICS Explorer®) 提供 REST 应用程序编程接口 (API)。通过利用 Ansible® IBM z/OS CICS 集合，还可以在自动化过程中使用 CMCI REST API。

客户向CMCI发起 HTTP。如果接口确定请求有效，则将构建 CICSPlex SM API 命令，如果是独立的 CICS ，则将构建 CICS。运行命令后，CMCI将创建HTTP。如果请求成功，则会采用 HTTP 200（OK）响应和包含结果集的 XML 提要的形式，并将其传回给客户端。如果请求失败，响应将包含一个非OK HTTP 响应代码，并附带失败详情。

CMCI HTTP 请求和响应的格式基于 HTTP/1.1。有关此协议的更多信息，请参阅 HTTP。

CMCI 请求中的元素

CMCI请求采用 HTTP形式，后跟URI（通用资源标识符），必要时还包含XML正文，其中包含CICS 或CICSPlex SM资源所做的任何更改的详细信息。

HTTP 头

标题包含HTTP 方法之一：

HTTP 方法	描述
DELETE	从 CICSPlex SM 数据存储库中除去资源，从 CSD 中除去资源或废弃已安装的资源。
GET	检索有关 CICSPlex SM 数据存储库上的资源的信息，检索有关 CSD 上的资源的信息，或检索有关已安装资源的信息。
POST	在 CICSPlex SM 数据存储库上创建资源或在 CSD 中创建资源。
PUT	更新 CICSPlex SM 数据存储库中的现有资源，更新 CSD 中的现有资源，或者设置属性并对已安装的资源执行操作。还对 CICSPlex SM 和 CSD 资源执行操作。

URI

URI 包含 CICS 或 CICSPlex SM 资源的名称，并指定一系列参数，这些参数用于优化查询的作用域和性质，以标识指定资源的一个或多个实例。在 GET 请求中， URI 还指定 API 是保留还是废弃一组结果。如果 API 保留结果，那么新请求可以对保留的结果执行操作，而不必重复检索操作。您还可以使用后续请求在一次选择一个或多个记录的保留结果中翻页。有关保留结果集的更多信息，请参阅使用保留结果集来提高 GET 请求的性能。

XML 主体

POST 和 PUT 请求包含 XML 主体。在 PUT 请求中，主体包含要对资源属性进行的更改的详细信息，或者包含要对目标资源执行的操作。在 POST 请求中，主体包含要提供给新资源实例的属性值。

GET 和 DELETE 请求不需要 XML 主体。如果 DELETE 请求需要其他参数，那么这些参数必须包含在 URI 中，并且可以选择添加到 XML 主体中。例如，如果要删除 CSD 资源定义，那么必须在 URI 中包含 PARAMETER=CSDGROUP(csdgrp) ，并且可以选择将 <parameter name="CSD"/> 添加到 XML 主体。