ListComputeMetricsByInstance - MaxCompute - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries a list of computing resources used by a pay-as-you-go job.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
odps:ListComputeMetricsByInstance	list	All Resources ``	none	none

Request syntax

POST /api/v1/computeMetrics/listByInstance HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Request body parameters.
region	string	No	The region ID.	cn-hangzhou
projectNames	array	No	The name of MaxCompute project.
projectName	string	No	The name of MaxCompute project.	odps_porject
startDate	long	No	The start time for the period.	1715393576201
endDate	long	No	The end time for the period.	1718590596556
instanceId	string	No	The job(instance) ID.	20240730****ddlr
jobOwner	string	No	The Alibaba Cloud account that is used to run the MaxCompute job.	ALIYUN$7632***@aliyun.com
signature	string	No	The signature of the SQL job.	ghijkl789012
pageNumber	long	No	The page number.	1
pageSize	long	No	The number of entries per page.	10
types	array	No	Metering types.
type	string	No	Metering types. ComputationSql: the metering data of SQL jobs that involve internal tables. ComputationSqlOTS: the metering data of SQL jobs that involve Tablestore external tables. ComputationSqlOSS: the metering data of SQL jobs that involve OSS external tables. MapReduce: the metering data of MapReduce jobs. spark: the metering data of Spark jobs. mars: the metering data of Mars jobs.	SQL
specCodes	array	No	Specification types.
specCode	string	No	Specifications Type specifies the resource package that you select when you purchase the MaxCompute service. OdpsStandard: the pay-as-you-go resource package. OdpsSpot: the pay-as-you-go spot resource package.	OdpsStandard

Response parameters

Parameter	Type	Description	Example
	object	PopResult<ListResultDTO<InstanceComputeMetricDTO, DefaultPageInfo>>
requestId	string	The ID of the request.	0bc059b717363029839908920ea631
httpCode	integer	The HTTP status code. 1xx: informational response. The request is received and is being processed. 2xx: success. The request is successfully received, understood, and accepted by the server. 3xx: redirection. The request is redirected, and further actions are required to complete the request. 4xx: client error. The request contains invalid request parameters or syntaxes, or specific request conditions cannot be met. 5xx: server error. The server cannot meet requirements due to other reasons.	200
errorCode	string	The error code.	OBJECT_NOT_EXIST
errorMsg	string	The error message.	This object does not exist.
data	object	The data returned.
instanceComputeMetrics	array<object>	List of pay-as-you-go job compute usage.
instanceComputeMetrics	object
instanceId	string	The job(instance) ID.	20240730****ddlr
type	string	Metering types. ComputationSql: the metering data of SQL jobs that involve internal tables. ComputationSqlOTS: the metering data of SQL jobs that involve Tablestore external tables. ComputationSqlOSS: the metering data of SQL jobs that involve OSS external tables. MapReduce: the metering data of MapReduce jobs. spark: the metering data of Spark jobs. mars: the metering data of Mars jobs.	ComputationSql
specCode	string	Specifications Type, specifies the resource package that you select when you purchase the MaxCompute service. OdpsStandard: the pay-as-you-go resource package. OdpsSpot: the pay-as-you-go spot resource package.	OdpsStandard
jobOwner	string	The owner of the job.	ALIYUN$7632***@aliyun.com
projectName	string	The name of the project.	odps_porject
submitTime	long	The submission time of the job.	1610432000000
endTime	long	The end time of the job execution.	1710432000000
signature	string	The signature of the SQL job.	pqrs12345tuv
usage	double	The computing resource usage is calculated based on the following items: Amount of scanned data in the unit of GB. For the jobs whose metering types are ComputationSql, ComputationSqlOTS, or ComputationSqlOSS, they are billed based on the amount of scanned data. The computing resource usage of such a job is calculated by using the following formula: Amount of scanned data × Complexity. The complexity is fixed at 1 for the jobs whose metering types are ComputationSqlOTS or ComputationSqlOSS. CU-hours. For the jobs whose metering types are MapReduce, spark, or mars, they are billed based on CU-hours.	1024
unit	string	The unit of computing resource usage	GB
totalCount	long	The total number of results returned.	64
pageNumber	long	The current page number.	1
pageSize	long	The number of entries per page.	10

Examples

Sample success responses

JSONformat

{
  "requestId": "0bc059b717363029839908920ea631",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "This object does not exist.",
  "data": {
    "instanceComputeMetrics": [
      {
        "instanceId": "20240730****ddlr",
        "type": "ComputationSql",
        "specCode": "OdpsStandard",
        "jobOwner": "ALIYUN$7632***@aliyun.com",
        "projectName": "odps_porject",
        "submitTime": 1610432000000,
        "endTime": 1710432000000,
        "signature": "pqrs12345tuv",
        "usage": 1024,
        "unit": "GB"
      }
    ],
    "totalCount": 64,
    "pageNumber": 1,
    "pageSize": 10
  }
}

Error codes

For a list of error codes, visit the Service error codes.