返回结构

参数 描述 说明

指令名称

API 返回的指令名称 ( action ),例如 HpcJobListJobsResponse

API 返回的指令名称一般以 "API 请求指令名称" + "Response" 来表示。

返回码

返回码 ( ret_code ) 用来表示 API 请求的返回值。ret_code = 0 表示 API 请求正常;ret_code != 0 表示 API 请求错误。

-

返回统计

返回统计(total_count/total)用来表示 API 请求的数据统计,total_count = 1 表示当前获取到 1 条数据;
查询类接口有此返回参数;
修改、删除、增加类 API 没有数据统计。

-

返回参数

返回参数响应消息。

-

返回示例

API 的返回结果为 JSON 结构,则 FileSystemsList 的 API 请求返回:

  "action": "EpfsFileSystemsFileSystemsListResponse",
  "fs_list": [
    {
      "console_id": "nscccloud",
      "create_time": "2022-08-29T02:48:07Z",
      "fs_id": "qfs-9vzh015i",
      "id": "qfs-9vzh015i",
      "owner": "usr-OPUpGVB3",
      "quota": null,
      "root_user_id": "usr-OPUpGVB3",
      "status": "active",
      "update_time": "2022-08-29T02:48:07Z",
      "user_id": "usr-OPUpGVB3"
    }
  ],
  "ret_code": 0,
  "total": 1,
  "total_count": 1