查询BMS容量

功能

查询BMS裸金属服务器即已发放不同型号规格的BMS服务器已分配量台数、剩余可用量台数等。

注意事项

无

调用方法

GET

URI

/rest/dataapi/homs/open-api/v1/CloudService/capacity

路径参数

无

查询参数

无

请求

• 请求header参数

  参数	是否必选	类型	值域	说明
  X-APIG-Appcode	是	string	无	由SRE分配的AppCode。
  x-auth-token	是	string	无	调用方APIG的IAM认证token。
  x-hcso-domainid	是（HCSO场景） 否（其他场景）	string	无	接入的租户ID。
  x-hcso-appcode	是	string	无	由SRE分配的AppCode

• 查询参数

  参数	是否必选	类型	值域	说明
  begin_time	是	int	无	查询开始时间（毫秒时间戳）。
  end_time	是	int	无	查询结束时间（毫秒时间戳）。
  service_type	否	string	BMS	服务类型。
  zone_type	否	string	BMS_POD	BMS专属区。
  page_size	是	int	0~1000	页大小。
  offset_value	是	int	无	查询起始值。

• 请求body参数

  无

• 请求示例

  GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=BMS HTTP/1.1 
  Host: example.com
  Content-Type: application/json 
  Accept: application/json
  X-APIG-Appcode: xxx 
  x-auth-token: xxx 
  x-hcso-domainid：xxx 
  x-hcso-appcode：xxx

响应

• 响应参数

  参数	是否必选	类型	值域	说明
  code	是	String	无	返回码。
  msg	是	String	无	返回消息。
  total	是	Integer	无	数据条数。
  service_type	否	String	无	云服务名，标识资源所属的云服务。BMS裸金属服务。
  timestamp	是	Long	无	时间戳。
  region	是	String	无	资源所属region 中文名。
  zone_type	否	String	无	资源所属区域类型：MANAGE管理区，POD或KVM_POD租户区。
  allocated	是	String	无	已分配量，xx台（单位）。
  available	是	String	无	剩余量，xx台（单位）。
  total(list内)	是	String	无	裸金属服务器可用总量，xx台（单位）。
  metric_type	否	String	无	裸金属服务器规格型号指标：如physical.kd1ne.2xlarge型号。

• 响应示例

  HTTP/1.1 200  OK 
  Date:Tue,18 Jul 2023 09:58:01 GMT
  Server: example.com
  Content-Type: application/json;charset=UTF8 
  { 
      "total": 1, 
      "list": [ 
               { 
               "service_type": "BMS", 
               "total": "4", 
               "available": "4", 
               "metric_type": "physical.kd1ne.2xlarge", 
               "zone_type": "POD", 
               "used": "0", 
               "free": "0", 
               "used_ratio": "0", 
               "region": "cn-east-264", 
               "resource_count": "0", 
               "allocated": "0", 
               "timestamp": "1650211200000" 
                } 
               ] 
  }

状态码