获取license详情 - ShowResourceDetailLicense
功能介绍
获取所监控或者统计的license详情。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/dew/cpcs/resource/license
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cluster_id | 否 | String | 参数解释: 集群id,默认空字符串,默认查询所有集群 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| service_type | 否 | String | 参数解释: 密码服务类型,默认空字符串,默认查询所有密码服务类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| license_type | 否 | String | 参数解释: license类型,默认空字符串,0:包周期证书,1:临时证书 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 页面大小,不超过1500 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 页数,默认1 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| from | 否 | Long | 参数解释: 查询起始时间戳,毫秒级时间戳,默认为0,默认从三天前查询 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| to | 否 | Long | 参数解释: 查询终止时间戳,毫秒级时间戳,默认为0,默认查询到当前时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释: license总数 取值范围: 不涉及 |
| used_count | Integer | 参数解释: license使用量 取值范围: 不涉及 |
| license_list | Array of LicenseInfo objects | 参数解释: license列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| license_type | Integer | 参数解释: license 类型 -0 包周期license, -1 临时license -2 永久license 取值范围: 不涉及 |
| instance_id | String | 参数解释: 所绑定实例id 取值范围: 不涉及 |
| instance_name | String | 参数解释: 所绑定实例名称 取值范围: 不涉及 |
| cluster_id | String | 参数解释: 所绑定集群id 取值范围: 不涉及 |
| cluster_name | String | 参数解释: 所绑定集群名称 取值范围: 不涉及 |
| active_time | String | 参数解释: license激活时间 取值范围: 不涉及 |
| expried_time | String | 参数解释: license过期时间 取值范围: 不涉及 |
| status | String | 参数解释: license状态 取值范围: 不涉及 |
请求示例
-
GET https://cpcs.com/v1/{project_id}/dew/cpcs/resource/license?license_type=&cluster_id=&service_type=&limit=10&offset=1 -
获取特定类型的license详情,服务为协同签名,类型为一年周期license,第一页,一页10个
GET https://cpcs.com/v1/{project_id}/dew/cpcs/resource/license?license_type=0&cluster_id=&service_type=COLLA_SIGN&limit=10&offset=1 -
GET https://cpcs.com/v1/{project_id}/dew/cpcs/resource/license?license_type=&cluster_id=&service_type=&limit=10&offset=1
响应示例
状态码:200
正常返回
{
"total_count" : 256,
"used_count" : 236,
"license_list" : [ {
"license_type" : 0,
"instance_name" : "xxxx",
"cluster_name" : "xxxx",
"instance_id" : "xxxx",
"cluster_id" : "xxxx",
"active_time" : "2026-03-05 14:00:00",
"expried_time" : "2026-03-06 15:00:00",
"status" : "expiring"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 正常返回 |
错误码
请参见错误码。