系统管理

使用此 REST API 来管理系统资源。

限制: 某些 REST API 不适用于 Cloud Pak System System W3500 ,并且不会返回值。
生成 HTTP 请求时,需要某些头以进行认证、授权和内容协商。 有关更多信息,请参阅 HTTP 头请求

常用参数

以下参数提供有关整体系统功能的常规状态。 这些字段通常在所有 REST API 调用中使用。
created_time
对象的创建时间。
updated_time
对象的最近一次更新时间。
对象的一般可用性。 如果值为 pending,那么对象已创建但未激活。 如果值为 available,那么对象在系统中处于活动状态。
标识
对象在系统中的唯一标识。
要列示字段的多个实例,请指定同一个参数的多个项目,例如:
?id=<id1>&id=<id2>

REST API 方法描述中的 响应 部分仅显示部分响应,以提供该类型的一个对象的示例。 某些描述包括用于检索所讨论对象的单个实例的语法。 未提供响应和参数的示例,这是因为详细信息与完整响应的一部分完全相同。

GET 调用的可选参数

使用以下可选参数来修改来自 GET 调用的响应:
  • 对于单个资源或多个资源的 GET 调用:
    resolvechildren=<n>
    对于包含一个或多个 URI 模式的任何字段,向下显示一个或多个级别的子表条目,其中 <n> 是要解析的级别数。 示例如下所示:
    /resources/{resource}/{id}?resolvechildren=3
    resolveparents=<n>
    对于包含一个或多个 URI 模式的任何字段,向上显示一个或多个级别的父表条目,其中 <n> 是要解析的级别数。 示例如下所示:
    /resources/{resource}/{id}?resolveparents=3
  • 对于仅针对多个资源的 GET 调用:
    <field>=<value>
    您可以指定过滤器以减少返回的资源数。 此过滤器仅返回其指定字段包含指定过滤器值的记录。 示例如下所示:
    /resources/{resource}/<field>=<value>
    fuzzy=[true | false]
    您可以指定此属性以及字段过滤器来进一步优化返回的记录数。 如果 fuzzy 属性指定为 true(缺省值),那么搜索匹配位于字段中任何位置的指定值。 如果 fuzzy 指定为 false,那么执行指定值的精确匹配。 示例如下所示:
    /resources/{resource}/<field>=<value>&fuzzy=true
    compare=[gt | gte | lt | lte]
    您可以指定此属性以及字段过滤器来进一步优化返回的记录数。 此字段的值必须是数字。
    • gt 返回其指定字段的值大于指定值的资源。
    • gte 返回其指定字段的值大于或等于指定值的资源。
    • lt 返回其指定字段的值小于指定值的资源。
    • lte 返回其指定字段的值小于或等于指定值的资源。
    示例如下所示:
    /resources/{resource}/<field>=<value>&compare=gt
    计数 =<n>
    page 参数配合使用,针对每个页面返回指定数目的资源。 如果未指定此参数,那么针对每个页面返回 500 返回码。
    页面 =<m>
    count 参数配合使用,返回指定数目的页面。 如果未指定此参数,那么仅返回第一个页面,其中包含 count 参数指定的资源数。 示例如下所示:
    /resources/{resource}?count=<n>&page=<m>
    totalcount=[true | false]
    返回资源计数。 示例如下所示:
    /resources/{resource}?totalcount=true
    order=[+ | -]
    与字段过滤器配合使用,此参数按指定字段的值对返回的资源进行升序或降序排序。 示例如下所示:
    /resources/{resource}?order=+<field>