maxCountApplyInfos

URI

<keys_uri>/maxcountapplyinfos[.<format>]

支持的方法

GET、POST、DELETE、HEAD

父资源

keys

介绍

maxCountApplyInfos 资源是当前用户密钥配额信息的集合。支持获取我的密钥配额信息，支持创建密钥配额变更记录/申请，支持删除我的密钥配额变更记录/申请。

如果门户管理员未开启配额审核，当前用户可以自行设置密钥配额；门户管理员开启密钥审核后，当前用户需提交配额申请，经管理员审核通过后方可生效。

支持的方法：

支持的表述格式：RJSON、JSON、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。

http://supermapiportal:8190/web/mycontent/keys/maxcountapplyinfos.rjson

GET 请求

获取我的密钥配额的设置/申请信息。

请求参数

如果参数未设置，则返回所有的密钥配额设置/申请信息，设置参数后，会返回用户指定的密钥配额信息，请求参数必须包含在 URI 中。

名称 类型 含义
resourceType ResourceType 根据申请的的资源类型查询，密钥配额的枚举常量为"KEY_MAXCOUNT"。
resourceOwners String[] 根据资源所有者的名称查询。
resourceIds List<Integer> 根据密钥配额的 ID 列表查询。
applicants String[] 根据资源申请人名称查询。
applyStatuses ApplyStatus[] 根据密钥配额的申请状态查询。
checkUsers String[] 根据配额审核人的名称查询。
orderBy ApplyOrderBy 密钥配额信息查询的排序方式。
currentPage int 根据当前第几页查询。
pageSize int 根据每页大小查询。
currentUser String 当前用户。
keywords String[] 根据关键字查询。
orderType OrderType 排序结果升序/降序展示。

响应结构

对 maxCountApplyInfos 资源执行 GET 请求，根据请求参数返回当前登录用户设置/申请的密钥配额列表信息。由以下字段组成：

字段 类型 说明
content List<MaxCountApplyInfo> 页面内容。
currentPage

int

 当前第几页。
pageSize

int

 每页大小。
searchParameter ResourceApplySearchParameter 当前页搜索参数。
total int 总记录数。
totalPage int 总页数。

响应示例

对 maxCountApplyInfos 资源：http://localhost:8190/iportal/web/mycontent/keys/maxcountapplyinfos.rjson 执行 GET 请求，返回 rjson 格式的资源表述如下：

{

    "total": 2,

    "totalPage": 1,

    "pageSize": 9,

    "searchParameter": {

        "resourceOwners": null,

        "orderType": "ASC",

        "currentUser": null,

        "keywords": null,

        "applicants": [

            "user1"

        ],

        "orderBy": null,

        "pageSize": 9,

        "applyStatuses": null,

        "currentPage": 1,

        "checkUsers": null,

        "resourceType": "KEY_MAXCOUNT",

        "resourceIds": null

    },

    "currentPage": 1,

    "content": [

        {

            "resourceId": 3,

            "applicantNick": "wm",

            "applyReason": "",

            "resourceName": "test1",

            "checkInfo": null,

            "updateTime": 1600174651000,

            "maxCount": 100002,

            "applicant": "user1",

            "applyId": null,

            "checkUser": "admin",

            "checkUserNick": "admin",

            "maxCountType": "DAY",

            "id": 3,

            "applyTime": 1600174601625,

            "applyStatus": "PASS",

            "resourceType": "KEY_MAXCOUNT"

        },

        {

            "resourceId": 3,

            "applicantNick": "wm",

            "applyReason": "",

            "resourceName": "test1",

            "checkInfo": null,

            "updateTime": 1600224444000,

            "maxCount": 10001,

            "applicant": "user1",

            "applyId": null,

            "checkUser": "admin",

            "checkUserNick": "admin",

            "maxCountType": "DAY",

            "id": 6,

            "applyTime": 1600224321882,

            "applyStatus": "PASS",

            "resourceType": "KEY_MAXCOUNT"

        }

    ]

}

如果希望获取指定条件的密钥配额设置/申请信息，如根据申请状态对被拒绝的密钥配额申请进行过滤，则需要设置 applyStatuses=["REFUSE"]，即对 maxCountApplyInfos 资源：http://localhost:8190/iportal/web/mycontent/keys/maxcountapplyinfos.rjson?applyStatuses=["REFUSE"]执行 GET 请求，返回的 rjson 格式的资源表述如下：

{

    "total": 1,

    "totalPage": 1,

    "pageSize": 9,

    "searchParameter": {

        "resourceOwners": null,

        "orderType": "ASC",

        "currentUser": null,

        "keywords": null,

        "applicants": [

            "user1"

        ],

        "orderBy": null,

        "pageSize": 9,

        "applyStatuses": [

            "REFUSE"

        ],

        "currentPage": 1,

        "checkUsers": null,

        "resourceType": "KEY_MAXCOUNT",

        "resourceIds": null

    },

    "currentPage": 1,

    "content": [

        {

            "resourceId": 3,

            "applicantNick": "wm",

            "applyReason": "降低配额",

            "resourceName": "test1",

            "checkInfo": "不同意",

            "updateTime": 1600238123000,

            "maxCount": 8000,

            "applicant": "user1",

            "applyId": null,

            "checkUser": "admin",

            "checkUserNick": "admin",

            "maxCountType": "DAY",

            "id": 8,

            "applyTime": 1600238099706,

            "applyStatus": "REFUSE",

            "resourceType": "KEY_MAXCOUNT"

        }

    ]

}

POST 请求

创建我的密钥配额变更/变更申请。

请求参数

发送请求时，需要在请求体中传递如下参数：

名称 类型 含义

keyIds

List<Integer> 变更密钥的 id 列表。
maxCount

int

 设置/申请的最高配额。
maxCountType MaxCountType 设置/申请的最高配额的时间单位。
applyReason String 密钥配额的申请理由。

响应结构

返回的资源表述结构如下：

字段 类型 说明
succeed boolean 创建密钥配额变更/变更申请是否成功。
error Httperror 出错信息，如果创建成功，则没有本字段。

响应示例

对 maxCountApplyInfos 资源：http://localhost:8190/iportal/web/mycontent/keys/maxcountapplyinfos.rjson 执行 POST 请求，发送请求体如下：

{

    "keyIds": [

        1

    ],

    "maxCount": 100012,

    "maxCountType": "DAY",

    "applyReason": "123"

}

则返回的 rjson 格式响应结果如下：

{"succeed": true}

DELETE 请求

 删除密钥配额变更记录/申请，支持批量删除。url 中传递需要删除的记录/申请的 id 数组。

响应结构

返回的资源表述结构如下：

字段 类型 说明
succeed boolean 删除密钥配额变更记录/申请是否成功。
error Httperror 出错信息，如果删除成功，则没有本字段。

响应示例

对 maxCountApplyInfos 资源：http://localhost:8190/iportal/web/mycontent/keys/maxcountapplyinfos.rjsonids=[1,2] 执行 DELETE 请求，批量删除 id 为 1 和 2 的两个密钥配额变更记录/申请，返回的 rjson 格式响应结果如下：

{ "succeed": true}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头，但是没有响应实体。可以在不必传输整个响应内容的情况下，获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型，字符编码，压缩编码，实体内容长度等。

HEAD 请求可以用来判断 maxCountApplyInfos 资源是否存在，或者客户端是否有权限访问 maxCountApplyInfos 资源。通过对加.<format>的 URI 执行 HEAD 请求，还可以快速判断 maxCountApplyInfos  资源是否支持<format>格式的表述。

请参见