文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 配额管理/ 查询资源的锁定状态 - ListLockedStatus
更新时间:2025-10-31 GMT+08:00
分享

查询资源的锁定状态 - ListLockedStatus

功能介绍

按需计费的防护配额转包年/包月过程中,会将防护配额锁定,已锁定的防护配额不支持转包年/包月,通过该接口可查询主机安全防护配额的锁定状态。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/resources/{resource_id}/locked-status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

resource_id

String

参数解释:

主机安全防护配额的资源ID

约束限制:

仅支持查询项目ID与企业项目ID下防护配额资源的锁定状态

取值范围:

字符长度1-64位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

locked_status

Boolean

参数解释:

主机安全防护配额资源的锁定状态。

取值范围:

  • true:已锁定,不可将按需计费的防护配额转为包年/包月。

  • false:未锁定,可将按需计费的防护配额转为包年/包月。

请求示例

响应示例

状态码:200

请求已成功

{
  "locked_status" : true
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档