Function

This API is used to collect summary statistics on users' jobs and prices.

URI

• URI format

  GET /v1.0/{project_id}/overview

• Parameter description

  Table 1 URI parameter description

  Parameter	Mandatory	Description
  project_id	Yes	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

None

Response

• Example response

  {
  "message_id": "CS.10001",
  "message": "Message content",
    "payload": {
    "total_cost": 100,
      "job_overview": {
      "total_jobs": 100,
      "running_jobs_count": 100,
      "finished_job_count": 100,
      "exception_job_count": 100,
      "running_job_charge": 100,
      "running_job_price": 100,
      "running_job_total_spu": 100,
      "running_job_total_time": 1.5,
      "billing_unit": "CNY",
      "time_unit": "HOUR"
    },
  "cluster_overview": {
        "total_clusters": 100,
        "running_cluster_count": 100,
        "exception_cluster_count": 100,
        "other_cluster_count": 100,
        "running_cluster_charge": 100,
        "running_cluster_price": 100,
        "running_cluster_total_spu": 100,
        "running_cluster_total_time": 100,
        "billing_unit": "CNY",
        "time_unit": "HOUR"
      }
    },
    "current_time": 1533686888000
  }

• Parameter description

  Table 2 Response parameters

  Parameter	Mandatory	Type	Description
  message_id	No	String	Message type ID.
  message	No	String	Message content.
  payload	No	None	Information about summary statistics.
  total_cost	No	Double	Total price.
  job_overview	No	None	Entity for collecting summary statistics of jobs.
  total_jobs	No	Int	Total number of jobs.
  running_jobs_count	No	Int	Number of running jobs.
  finished_job_count	No	Int	Number of completed jobs.
  exception_job_count	No	Int	Number of jobs experiencing exceptions.
  running_job_charge	No	Double	Total price charged for running jobs.
  running_job_price	No	Double	Sum of prices per hour charged for all running jobs.
  running_job_total_spu	No	Int	Total number of SPUs consumed by running jobs.
  running_job_total_time	No	Double	Total running duration of running jobs.
  billing_unit	No	String	Settlement currency.
  time_unit	No	String	Time unit.
  cluster_overview	No	None	Entity for collecting summary statistics of clusters.
  running_cluster_price	No	Double	Sum of prices per hour charged for all running clusters.
  running_cluster_count	No	Int	Total number of running clusters.
  running_cluster_total_time	No	Double	Total running duration of running clusters.
  total_clusters	No	Int	Total number of clusters
  running_cluster_total_spu	No	Int	Total number of SPUs consumed by running clusters.
  running_cluster_charge	No	Double	Total price charged for running clusters.
  exception_cluster_count	No	Int	Number of completed clusters.
  other_cluster_count	No	Int	Number of abnormal clusters.
  current_time	No	Int	Current time, expressed by milliseconds.

Status Code

Table 3 describes the status code.

Error Code

For details, see Error Codes.