Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1339132165.3 KB
projects

Creates a new UtilizationReport.

post/v1/{+parent}/utilizationReports

Path parameters

parentstring required

Required. The Utilization Report's parent.

Query parameters

requestIdstring

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

utilizationReportIdstring

Required. The ID to use for the report, which will become the final component of the reports's resource name. This value maximum length is 63 characters, and valid characters are /a-z-/. It must start with an english letter and must not end with a hyphen.

Request body

namestring

Output only. The report unique name.

createTimestring google-datetime

Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).

displayNamestring

The report display name, as assigned by the user.

state'STATE_UNSPECIFIED' | 'CREATING' | 'SUCCEEDED' | 'FAILED'

Output only. Current state of the report.

timeFrame'TIME_FRAME_UNSPECIFIED' | 'WEEK' | 'MONTH' | 'YEAR'

Time frame of the report.

frameEndTimestring google-datetime

Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.

vmCountinteger

Output only. Total number of VMs included in the report.

stateTimestring google-datetime

Output only. The time the state was last set.

Response

Successful response