查看租户资源列表 - ListTenantResources
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/tenants/resources
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方法请参考获取项目ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 每页显示的条目数量。 取值范围: 1~100 默认取值: 10 |
| offset | 否 | Integer | 偏移量,表示从此偏移量开始查询。 取值范围: 0~2147483647 默认取值: 0 |
| resource | 否 | String | 资源类型。可填多个,用","分隔。详见资源类型。 |
| business | 否 | String | 业务类型。可填多个,用","分隔。 |
| resource_source | 是 | String | 资源来源,可填多个 例如:PURCHASED,ADMIN_ALLOCATED,将返回商用资源与管理员分配资源。 |
| resource_id | 否 | String | 资源id。 |
| order_id | 否 | String | 订单id。 |
| charging_mode | 否 | String | 计费类型。 |
| resource_expire_start_time | 否 | String | 资源过期时间段 开始时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z" |
| resource_expire_end_time | 否 | String | 资源过期时间段 结束时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z" |
| sub_resource | 否 | String | 子资源类型。当前只有flexus套餐包存在该字段 |
| status | 否 | Integer | 资源状态。 取值范围: 0~1 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
| Authorization | 否 | String | 使用AK/SK方式认证时必选,携带的鉴权信息。 |
| X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
| X-Project-Id | 否 | String | 使用AK/SK方式认证时必选,携带项目ID信息。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Request-Id | String | 请求ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resources | Array of ResourceItemInfo objects | 资源用量列表 |
| count | Number | 资源总数。 取值范围: 0~2147483647 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_id | String | 资源ID。 |
| order_id | String | cloudServiceId的订单id。 云服务购买清单等场景必填(purchaseMode取值为3、4),每个CloudService生成一个订单;此场景如果为空,则报错。 其他场景,为空。 |
| bound_asset | BoundAssetInfo object | 绑定的资产。 |
| resource_expire_time | String | 资源截止时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z" |
| resource_type | String | 资源类型。详见资源类型。 |
| business_type | String | 业务类型。 |
| sub_resource_type | String | 子资源类型。当前只有flexus套餐包存在该字段 |
| is_sub_resource | Boolean | 是否子资源。子资源描述的是子资源的数量和单位 默认取值: false |
| charging_mode | String | 计费类型。 |
| resource_source | String | 资源来源。 |
| amount | Float | 总量 取值范围: 0~1000000 |
| usage | Float | 使用量 取值范围: 0~1000000 |
| status | Integer | 资源状态 0:正常 1:冻结 取值范围: 0~1 |
| unit | String | 单位。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
GET https://{endpoint}/v1/f488337c31c8e4622f1590735b134c65/tenants/resources 响应示例
状态码:200
查看租户信息
{
"resources" : [ {
"resource_id" : "f488337c31c8e4622f1590735b134c65",
"resource_type" : "Interaction.basic.channel",
"business_type" : "LIVE_2D",
"order_id" : "ed4553db2cf949fca7eeb327a276bdbd",
"resource_expire_time" : "2021-01-10T08:43:17Z",
"charging_mode" : "ONE_TIME",
"amount" : 1,
"unit" : "CHANNEL"
} ],
"count" : 1
} 状态码:400
请求传参异常,包含错误码及对应描述。
{
"error_code" : "MSS.00000003",
"error_msg" : "Invalid parameter"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查看租户信息 |
| 400 | 请求传参异常,包含错误码及对应描述。 |
错误码
请参见错误码。
