{ "version_module": true, "documentationLink": "https://cloud.google.com/docs/quotas", "batchPath": "batch", "protocol": "rest", "mtlsRootUrl": "https://cloudquotas.mtls.googleapis.com/", "ownerName": "Google", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "discoveryVersion": "v1", "rootUrl": "https://cloudquotas.googleapis.com/", "ownerDomain": "google.com", "revision": "20260604", "title": "Cloud Quotas API", "version": "v1", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "canonicalName": "Cloud Quotas", "resources": { "projects": { "resources": { "locations": { "resources": { "services": { "resources": { "quotaInfos": { "methods": { "list": { "id": "cloudquotas.projects.locations.services.quotaInfos.list", "path": "v1/{+parent}/quotaInfos", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/quotaInfos", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Identifier. Parent value of QuotaInfo resources. Listing across different resource containers (such as 'projects/-') is not allowed. Example names: `projects/123/locations/global/services/compute.googleapis.com` `folders/234/locations/global/services/compute.googleapis.com` `organizations/345/locations/global/services/compute.googleapis.com`", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListQuotaInfosResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists QuotaInfos of all quotas for a given project, folder or organization." }, "get": { "id": "cloudquotas.projects.locations.services.quotaInfos.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/quotaInfos/{quotaInfosId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Identifier. The resource name of the quota info. An example name: `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/quotaInfos/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "QuotaInfo" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Retrieve the QuotaInfo of a quota for a project, folder or organization." } } } } }, "quotaPreferences": { "methods": { "list": { "id": "cloudquotas.projects.locations.quotaPreferences.list", "path": "v1/{+parent}/quotaPreferences", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/quotaPreferences", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Identifier. Parent value of QuotaPreference resources. Listing across different resource containers (such as 'projects/-') is not allowed. When the value starts with 'folders' or 'organizations', it lists the QuotaPreferences for org quotas in the container. It does not list the QuotaPreferences in the descendant projects of the container. Example parents: `projects/123/locations/global`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filter result QuotaPreferences by their state, type, create/update time range. Example filters: `reconciling=true AND request_type=CLOUD_CONSOLE`, `reconciling=true OR creation_time\u003e2022-12-03T10:30:00`", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. How to order of the results. By default, the results are ordered by create time. Example orders: `quota_id`, `service, create_time`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListQuotaPreferencesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists QuotaPreferences in a given project, folder or organization." }, "get": { "id": "cloudquotas.projects.locations.quotaPreferences.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/quotaPreferences/{quotaPreferencesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Identifier. Name of the resource Example name: `projects/123/locations/global/quota_preferences/my-config-for-us-east1`", "pattern": "^projects/[^/]+/locations/[^/]+/quotaPreferences/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "QuotaPreference" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single QuotaPreference." }, "create": { "id": "cloudquotas.projects.locations.quotaPreferences.create", "path": "v1/{+parent}/quotaPreferences", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/quotaPreferences", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Identifier. Value for parent. Example: `projects/123/locations/global`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "quotaPreferenceId": { "description": "Optional. Id of the requesting object, must be unique under its parent. If client does not set this field, the service will generate one.", "location": "query", "type": "string" }, "ignoreSafetyChecks": { "description": "The list of quota safety checks to be ignored.", "location": "query", "repeated": true, "type": "string", "enumDescriptions": [ "Unspecified quota safety check.", "Validates that a quota mutation would not cause the consumer's effective limit to be lower than the consumer's quota usage.", "Validates that a quota mutation would not cause the consumer's effective limit to decrease by more than 10 percent." ], "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH" ] } }, "parameterOrder": [ "parent" ], "request": { "$ref": "QuotaPreference" }, "response": { "$ref": "QuotaPreference" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new QuotaPreference that declares the desired value for a quota." }, "patch": { "id": "cloudquotas.projects.locations.quotaPreferences.patch", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/quotaPreferences/{quotaPreferencesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required except in the CREATE requests. The resource name of the quota preference. The path that follows `/locations` must be `/global`. For example: `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`", "pattern": "^projects/[^/]+/locations/[^/]+/quotaPreferences/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the QuotaPreference resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "allowMissing": { "description": "Optional. If set to true, and the quota preference is not found, a new one will be created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" }, "validateOnly": { "description": "Optional. If set to true, validate the request, but do not actually update. Note that a request being valid does not mean that the request is guaranteed to be fulfilled.", "location": "query", "type": "boolean" }, "ignoreSafetyChecks": { "description": "The list of quota safety checks to be ignored.", "location": "query", "repeated": true, "type": "string", "enumDescriptions": [ "Unspecified quota safety check.", "Validates that a quota mutation would not cause the consumer's effective limit to be lower than the consumer's quota usage.", "Validates that a quota mutation would not cause the consumer's effective limit to decrease by more than 10 percent." ], "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH" ] } }, "parameterOrder": [ "name" ], "request": { "$ref": "QuotaPreference" }, "response": { "$ref": "QuotaPreference" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval." } } }, "gdcZones": { "resources": { "gdcServices": { "resources": { "gdcQuotaInfos": { "methods": { "list": { "id": "cloudquotas.projects.locations.gdcZones.gdcServices.gdcQuotaInfos.list", "path": "v1/{+parent}/gdcQuotaInfos", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gdcZones/{gdcZonesId}/gdcServices/{gdcServicesId}/gdcQuotaInfos", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent value of GdcQuotaInfo resources. Listing across different resource containers (such as 'projects/-') is not allowed. Example parents: `projects/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com` `organizations/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com`", "pattern": "^projects/[^/]+/locations/[^/]+/gdcZones/[^/]+/gdcServices/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGdcQuotaInfosResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists GdcQuotaInfos in a given project and location." }, "get": { "id": "cloudquotas.projects.locations.gdcZones.gdcServices.gdcQuotaInfos.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gdcZones/{gdcZonesId}/gdcServices/{gdcServicesId}/gdcQuotaInfos/{gdcQuotaInfosId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the GdcQuotaInfo. An example name: `projects/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com/gdcQuotaInfos/gdc-quota-1` `organizations/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com/gdcQuotaInfos/gdc-quota-1`", "pattern": "^projects/[^/]+/locations/[^/]+/gdcZones/[^/]+/gdcServices/[^/]+/gdcQuotaInfos/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GdcQuotaInfo" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single GdcQuotaInfo." } } } } } } } } } } }, "organizations": { "resources": { "locations": { "resources": { "services": { "resources": { "quotaInfos": { "methods": { "list": { "id": "cloudquotas.organizations.locations.services.quotaInfos.list", "path": "v1/{+parent}/quotaInfos", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/services/{servicesId}/quotaInfos", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Identifier. Parent value of QuotaInfo resources. Listing across different resource containers (such as 'projects/-') is not allowed. Example names: `projects/123/locations/global/services/compute.googleapis.com` `folders/234/locations/global/services/compute.googleapis.com` `organizations/345/locations/global/services/compute.googleapis.com`", "pattern": "^organizations/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListQuotaInfosResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists QuotaInfos of all quotas for a given project, folder or organization." }, "get": { "id": "cloudquotas.organizations.locations.services.quotaInfos.get", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/services/{servicesId}/quotaInfos/{quotaInfosId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Identifier. The resource name of the quota info. An example name: `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`", "pattern": "^organizations/[^/]+/locations/[^/]+/services/[^/]+/quotaInfos/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "QuotaInfo" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Retrieve the QuotaInfo of a quota for a project, folder or organization." } } } } }, "quotaPreferences": { "methods": { "list": { "id": "cloudquotas.organizations.locations.quotaPreferences.list", "path": "v1/{+parent}/quotaPreferences", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/quotaPreferences", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Identifier. Parent value of QuotaPreference resources. Listing across different resource containers (such as 'projects/-') is not allowed. When the value starts with 'folders' or 'organizations', it lists the QuotaPreferences for org quotas in the container. It does not list the QuotaPreferences in the descendant projects of the container. Example parents: `projects/123/locations/global`", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filter result QuotaPreferences by their state, type, create/update time range. Example filters: `reconciling=true AND request_type=CLOUD_CONSOLE`, `reconciling=true OR creation_time\u003e2022-12-03T10:30:00`", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. How to order of the results. By default, the results are ordered by create time. Example orders: `quota_id`, `service, create_time`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListQuotaPreferencesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists QuotaPreferences in a given project, folder or organization." }, "get": { "id": "cloudquotas.organizations.locations.quotaPreferences.get", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/quotaPreferences/{quotaPreferencesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Identifier. Name of the resource Example name: `projects/123/locations/global/quota_preferences/my-config-for-us-east1`", "pattern": "^organizations/[^/]+/locations/[^/]+/quotaPreferences/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "QuotaPreference" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single QuotaPreference." }, "create": { "id": "cloudquotas.organizations.locations.quotaPreferences.create", "path": "v1/{+parent}/quotaPreferences", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/quotaPreferences", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Identifier. Value for parent. Example: `projects/123/locations/global`", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "quotaPreferenceId": { "description": "Optional. Id of the requesting object, must be unique under its parent. If client does not set this field, the service will generate one.", "location": "query", "type": "string" }, "ignoreSafetyChecks": { "description": "The list of quota safety checks to be ignored.", "location": "query", "repeated": true, "type": "string", "enumDescriptions": [ "Unspecified quota safety check.", "Validates that a quota mutation would not cause the consumer's effective limit to be lower than the consumer's quota usage.", "Validates that a quota mutation would not cause the consumer's effective limit to decrease by more than 10 percent." ], "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH" ] } }, "parameterOrder": [ "parent" ], "request": { "$ref": "QuotaPreference" }, "response": { "$ref": "QuotaPreference" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new QuotaPreference that declares the desired value for a quota." }, "patch": { "id": "cloudquotas.organizations.locations.quotaPreferences.patch", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/quotaPreferences/{quotaPreferencesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required except in the CREATE requests. The resource name of the quota preference. The path that follows `/locations` must be `/global`. For example: `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`", "pattern": "^organizations/[^/]+/locations/[^/]+/quotaPreferences/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the QuotaPreference resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "allowMissing": { "description": "Optional. If set to true, and the quota preference is not found, a new one will be created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" }, "validateOnly": { "description": "Optional. If set to true, validate the request, but do not actually update. Note that a request being valid does not mean that the request is guaranteed to be fulfilled.", "location": "query", "type": "boolean" }, "ignoreSafetyChecks": { "description": "The list of quota safety checks to be ignored.", "location": "query", "repeated": true, "type": "string", "enumDescriptions": [ "Unspecified quota safety check.", "Validates that a quota mutation would not cause the consumer's effective limit to be lower than the consumer's quota usage.", "Validates that a quota mutation would not cause the consumer's effective limit to decrease by more than 10 percent." ], "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH" ] } }, "parameterOrder": [ "name" ], "request": { "$ref": "QuotaPreference" }, "response": { "$ref": "QuotaPreference" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval." } } }, "gdcZones": { "resources": { "gdcServices": { "resources": { "gdcQuotaInfos": { "methods": { "list": { "id": "cloudquotas.organizations.locations.gdcZones.gdcServices.gdcQuotaInfos.list", "path": "v1/{+parent}/gdcQuotaInfos", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/gdcZones/{gdcZonesId}/gdcServices/{gdcServicesId}/gdcQuotaInfos", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent value of GdcQuotaInfo resources. Listing across different resource containers (such as 'projects/-') is not allowed. Example parents: `projects/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com` `organizations/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com`", "pattern": "^organizations/[^/]+/locations/[^/]+/gdcZones/[^/]+/gdcServices/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGdcQuotaInfosResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists GdcQuotaInfos in a given project and location." }, "get": { "id": "cloudquotas.organizations.locations.gdcZones.gdcServices.gdcQuotaInfos.get", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/gdcZones/{gdcZonesId}/gdcServices/{gdcServicesId}/gdcQuotaInfos/{gdcQuotaInfosId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the GdcQuotaInfo. An example name: `projects/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com/gdcQuotaInfos/gdc-quota-1` `organizations/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com/gdcQuotaInfos/gdc-quota-1`", "pattern": "^organizations/[^/]+/locations/[^/]+/gdcZones/[^/]+/gdcServices/[^/]+/gdcQuotaInfos/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GdcQuotaInfo" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single GdcQuotaInfo." } } } } } } } } } } }, "folders": { "resources": { "locations": { "resources": { "services": { "resources": { "quotaInfos": { "methods": { "list": { "id": "cloudquotas.folders.locations.services.quotaInfos.list", "path": "v1/{+parent}/quotaInfos", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/services/{servicesId}/quotaInfos", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Identifier. Parent value of QuotaInfo resources. Listing across different resource containers (such as 'projects/-') is not allowed. Example names: `projects/123/locations/global/services/compute.googleapis.com` `folders/234/locations/global/services/compute.googleapis.com` `organizations/345/locations/global/services/compute.googleapis.com`", "pattern": "^folders/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListQuotaInfosResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists QuotaInfos of all quotas for a given project, folder or organization." }, "get": { "id": "cloudquotas.folders.locations.services.quotaInfos.get", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/services/{servicesId}/quotaInfos/{quotaInfosId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Identifier. The resource name of the quota info. An example name: `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`", "pattern": "^folders/[^/]+/locations/[^/]+/services/[^/]+/quotaInfos/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "QuotaInfo" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Retrieve the QuotaInfo of a quota for a project, folder or organization." } } } } }, "quotaPreferences": { "methods": { "list": { "id": "cloudquotas.folders.locations.quotaPreferences.list", "path": "v1/{+parent}/quotaPreferences", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/quotaPreferences", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Identifier. Parent value of QuotaPreference resources. Listing across different resource containers (such as 'projects/-') is not allowed. When the value starts with 'folders' or 'organizations', it lists the QuotaPreferences for org quotas in the container. It does not list the QuotaPreferences in the descendant projects of the container. Example parents: `projects/123/locations/global`", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filter result QuotaPreferences by their state, type, create/update time range. Example filters: `reconciling=true AND request_type=CLOUD_CONSOLE`, `reconciling=true OR creation_time\u003e2022-12-03T10:30:00`", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. How to order of the results. By default, the results are ordered by create time. Example orders: `quota_id`, `service, create_time`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListQuotaPreferencesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists QuotaPreferences in a given project, folder or organization." }, "get": { "id": "cloudquotas.folders.locations.quotaPreferences.get", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/quotaPreferences/{quotaPreferencesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Identifier. Name of the resource Example name: `projects/123/locations/global/quota_preferences/my-config-for-us-east1`", "pattern": "^folders/[^/]+/locations/[^/]+/quotaPreferences/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "QuotaPreference" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single QuotaPreference." }, "create": { "id": "cloudquotas.folders.locations.quotaPreferences.create", "path": "v1/{+parent}/quotaPreferences", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/quotaPreferences", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Identifier. Value for parent. Example: `projects/123/locations/global`", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "quotaPreferenceId": { "description": "Optional. Id of the requesting object, must be unique under its parent. If client does not set this field, the service will generate one.", "location": "query", "type": "string" }, "ignoreSafetyChecks": { "description": "The list of quota safety checks to be ignored.", "location": "query", "repeated": true, "type": "string", "enumDescriptions": [ "Unspecified quota safety check.", "Validates that a quota mutation would not cause the consumer's effective limit to be lower than the consumer's quota usage.", "Validates that a quota mutation would not cause the consumer's effective limit to decrease by more than 10 percent." ], "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH" ] } }, "parameterOrder": [ "parent" ], "request": { "$ref": "QuotaPreference" }, "response": { "$ref": "QuotaPreference" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new QuotaPreference that declares the desired value for a quota." }, "patch": { "id": "cloudquotas.folders.locations.quotaPreferences.patch", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/quotaPreferences/{quotaPreferencesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required except in the CREATE requests. The resource name of the quota preference. The path that follows `/locations` must be `/global`. For example: `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`", "pattern": "^folders/[^/]+/locations/[^/]+/quotaPreferences/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the QuotaPreference resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "allowMissing": { "description": "Optional. If set to true, and the quota preference is not found, a new one will be created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" }, "validateOnly": { "description": "Optional. If set to true, validate the request, but do not actually update. Note that a request being valid does not mean that the request is guaranteed to be fulfilled.", "location": "query", "type": "boolean" }, "ignoreSafetyChecks": { "description": "The list of quota safety checks to be ignored.", "location": "query", "repeated": true, "type": "string", "enumDescriptions": [ "Unspecified quota safety check.", "Validates that a quota mutation would not cause the consumer's effective limit to be lower than the consumer's quota usage.", "Validates that a quota mutation would not cause the consumer's effective limit to decrease by more than 10 percent." ], "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH" ] } }, "parameterOrder": [ "name" ], "request": { "$ref": "QuotaPreference" }, "response": { "$ref": "QuotaPreference" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval." } } } } } } } }, "servicePath": "", "baseUrl": "https://cloudquotas.googleapis.com/", "id": "cloudquotas:v1", "description": "Cloud Quotas API provides Google Cloud service consumers with management and observability for resource usage, quotas, and restrictions of the services they consume.", "fullyEncodeReservedExpansion": true, "basePath": "", "schemas": { "ListQuotaInfosResponse": { "id": "ListQuotaInfosResponse", "description": "Message for response to listing QuotaInfos", "type": "object", "properties": { "quotaInfos": { "description": "The list of QuotaInfo", "type": "array", "items": { "$ref": "QuotaInfo" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "QuotaInfo": { "id": "QuotaInfo", "description": "QuotaInfo represents information about a particular quota for a given project, folder or organization.", "type": "object", "properties": { "name": { "description": "Resource name of this QuotaInfo. The ID component following \"locations/\" must be \"global\". For example, `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`", "type": "string" }, "quotaId": { "description": "The id of the quota, which is unique within the service. For example, `CpusPerProjectPerRegion`", "type": "string" }, "metric": { "description": "The metric of the quota. It specifies the resources consumption the quota is defined for. For example, `compute.googleapis.com/cpus`", "type": "string" }, "service": { "description": "The name of the service in which the quota is defined. For example, `compute.googleapis.com`", "type": "string" }, "isPrecise": { "description": "Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.", "type": "boolean" }, "refreshInterval": { "description": "The reset time interval for the quota. Refresh interval applies to rate quota only. For example, \"minute\" for per minute, \"day\" for per day, or \"10 seconds\" for every 10 seconds.", "type": "string" }, "containerType": { "description": "The container type of the QuotaInfo.", "type": "string", "enumDescriptions": [ "Unspecified container type.", "consumer project", "folder", "organization" ], "enum": [ "CONTAINER_TYPE_UNSPECIFIED", "PROJECT", "FOLDER", "ORGANIZATION" ] }, "dimensions": { "description": "The dimensions the quota is defined on.", "type": "array", "items": { "type": "string" } }, "metricDisplayName": { "description": "The display name of the quota metric", "type": "string" }, "quotaDisplayName": { "description": "The display name of the quota.", "type": "string" }, "metricUnit": { "description": "The unit in which the metric value is reported, e.g., \"MByte\".", "type": "string" }, "quotaIncreaseEligibility": { "description": "Whether it is eligible to request a higher quota value for this quota.", "$ref": "QuotaIncreaseEligibility" }, "isFixed": { "description": "Whether the quota value is fixed or adjustable", "type": "boolean" }, "dimensionsInfos": { "description": "The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.", "type": "array", "items": { "$ref": "DimensionsInfo" } }, "isConcurrent": { "description": "Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.", "type": "boolean" }, "serviceRequestQuotaUri": { "description": "URI to the page where users can request more quota for the cloud service—for example, https://console.cloud.google.com/iam-admin/quotas.", "type": "string" } } }, "QuotaIncreaseEligibility": { "id": "QuotaIncreaseEligibility", "description": "Eligibility information regarding requesting increase adjustment of a quota.", "type": "object", "properties": { "isEligible": { "description": "Whether a higher quota value can be requested for the quota.", "type": "boolean" }, "ineligibilityReason": { "description": "The reason of why it is ineligible to request increased value of the quota. If the is_eligible field is true, it defaults to INELIGIBILITY_REASON_UNSPECIFIED.", "type": "string", "enumDescriptions": [ "Default value when is_eligible is true.", "The container is not linked with a valid billing account.", "Quota increase is not supported for the quota.", "There is not enough usage history to determine the eligibility.", "Other reasons." ], "enum": [ "INELIGIBILITY_REASON_UNSPECIFIED", "NO_VALID_BILLING_ACCOUNT", "NOT_SUPPORTED", "NOT_ENOUGH_USAGE_HISTORY", "OTHER" ] } } }, "DimensionsInfo": { "id": "DimensionsInfo", "description": "The detailed quota information such as effective quota value for a combination of dimensions.", "type": "object", "properties": { "dimensions": { "description": "The map of dimensions in key-value pairs. The key of a map entry is \"region\", \"zone\", or the name of a service-specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimensionInfo instance configured for the specific value. For example: `{\"provider\" : \"Example Organization\"}` where `provider` is a service-specific quota dimension and `Example Organization` is the provider name.", "type": "object", "additionalProperties": { "type": "string" } }, "details": { "description": "Quota details for the specified dimensions.", "$ref": "QuotaDetails" }, "applicableLocations": { "description": "The applicable regions or zones of this dimension. The field is set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.", "type": "array", "items": { "type": "string" } } } }, "QuotaDetails": { "id": "QuotaDetails", "description": "The quota details for a map of dimensions.", "type": "object", "properties": { "value": { "description": "The value currently in effect and being enforced.", "type": "string", "format": "int64" }, "rolloutInfo": { "description": "Rollout information of this quota. This field is present only if the effective limit will change due to the ongoing rollout of the service config.", "$ref": "RolloutInfo" } } }, "RolloutInfo": { "id": "RolloutInfo", "description": "[Output only] Rollout information of a quota.", "type": "object", "properties": { "ongoingRollout": { "description": "Whether there is an ongoing rollout for a quota or not.", "type": "boolean" } } }, "ListQuotaPreferencesResponse": { "id": "ListQuotaPreferencesResponse", "description": "Message for response to listing QuotaPreferences", "type": "object", "properties": { "quotaPreferences": { "description": "The list of QuotaPreference", "type": "array", "items": { "$ref": "QuotaPreference" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "QuotaPreference": { "id": "QuotaPreference", "description": "QuotaPreference represents the preferred quota configuration specified for a project, folder or organization. There is only one QuotaPreference resource for a quota value targeting a unique set of dimensions.", "type": "object", "properties": { "name": { "description": "Required except in the CREATE requests. The resource name of the quota preference. The path that follows `/locations` must be `/global`. For example: `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`", "type": "string" }, "dimensions": { "description": "Immutable. The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as `region`, `zone`, `network_id`, and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. Note: QuotaPreferences can only be applied across all values of `user` and `resource` dimension. Do not set values for `user` or `resource` in the dimension map. For example: `{\"provider\" : \"Example Organization\"}` where `provider` is a service-specific quota dimension and `Example Organization` is the provider name.", "type": "object", "additionalProperties": { "type": "string" } }, "quotaConfig": { "description": "Required. Preferred quota configuration.", "$ref": "QuotaConfig" }, "etag": { "description": "Optional. The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.", "type": "string" }, "createTime": { "description": "Output only. Create time stamp", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Update time stamp", "readOnly": true, "type": "string", "format": "google-datetime" }, "service": { "description": "Required. The name of the service to which the quota preference is applied.", "type": "string" }, "quotaId": { "description": "Required. The id of the quota to which the quota preference is applied. A quota name is unique in the service. For example, `CpusPerProjectPerRegion`", "type": "string" }, "reconciling": { "description": "Output only. Is the quota preference pending Google Cloud approval and fulfillment.", "readOnly": true, "type": "boolean" }, "justification": { "description": "The reason / justification for this quota preference.", "type": "string" }, "contactEmail": { "description": "Input only. An email address that can be used to contact the user, in case Google Cloud needs more information to make a decision before additional quota can be granted. When requesting a quota increase, the email address is required. When requesting a quota decrease, the email address is optional. For example, the email address is optional when the `QuotaConfig.preferred_value` is smaller than the `QuotaDetails.reset_value`.", "type": "string" } } }, "QuotaConfig": { "id": "QuotaConfig", "description": "The preferred quota configuration.", "type": "object", "properties": { "preferredValue": { "description": "Required. The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is \"unlimited\".", "type": "string", "format": "int64" }, "stateDetail": { "description": "Output only. Optional details about the state of this quota preference.", "readOnly": true, "type": "string" }, "grantedValue": { "description": "Output only. Granted quota value.", "readOnly": true, "type": "string", "format": "int64" }, "traceId": { "description": "Output only. The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.", "readOnly": true, "type": "string" }, "annotations": { "description": "Optional. The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations", "type": "object", "additionalProperties": { "type": "string" } }, "requestOrigin": { "description": "Output only. The origin of the quota preference request.", "readOnly": true, "type": "string", "enumDescriptions": [ "The unspecified value.", "Created through Cloud Console.", "Generated by automatic quota adjustment." ], "enum": [ "ORIGIN_UNSPECIFIED", "CLOUD_CONSOLE", "AUTO_ADJUSTER" ] } } }, "ListGdcQuotaInfosResponse": { "id": "ListGdcQuotaInfosResponse", "description": "Message for response to listing GdcQuotaInfos", "type": "object", "properties": { "gdcQuotaInfos": { "description": "The list of GdcQuotaInfo", "type": "array", "items": { "$ref": "GdcQuotaInfo" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "GdcQuotaInfo": { "id": "GdcQuotaInfo", "description": "GdcQuotaInfo represents information about a particular quota for a given project, folder or organization in GDC.", "type": "object", "properties": { "name": { "description": "Output only. Identifier. Resource name of this GdcQuotaInfo. For example, `projects/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com/gdcQuotaInfos/gdc-quota-1` `organizations/123/locations/us-west2/gdcZones/us-west2-edge-lga1/gdcServices/edgecontainer.googleapis.com/gdcQuotaInfos/gdc-quota-1`", "readOnly": true, "type": "string" }, "quotaId": { "description": "Output only. The id of the quota, which is unique within the service. For example, `CpusPerProjectPerRegion`", "readOnly": true, "type": "string" }, "metric": { "description": "Output only. The metric of the quota. It specifies the resources consumption the quota is defined for. For example, `compute.googleapis.com/cpus`", "readOnly": true, "type": "string" }, "service": { "description": "Output only. The name of the service in which the quota is defined. For example, `compute.googleapis.com`", "readOnly": true, "type": "string" }, "precise": { "description": "Output only. Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.", "readOnly": true, "type": "boolean" }, "refreshInterval": { "description": "Output only. The reset time interval for the quota. Refresh interval applies to rate quota only. For example, \"minute\" for per minute, \"day\" for per day, or \"10 seconds\" for every 10 seconds.", "readOnly": true, "type": "string" }, "containerType": { "description": "Output only. The type of a cloud resource container that the quota is defined for.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified container type.", "consumer project", "organization" ], "enum": [ "GDC_CONTAINER_TYPE_UNSPECIFIED", "GDC_PROJECT", "GDC_ORGANIZATION" ] }, "dimensions": { "description": "Output only. The dimensions the quota is defined on.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "gdcDimensionsInfos": { "description": "Output only. The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.", "readOnly": true, "type": "array", "items": { "$ref": "GdcDimensionsInfo" } } } }, "GdcDimensionsInfo": { "id": "GdcDimensionsInfo", "description": "The detailed quota information such as effective quota value for a combination of dimensions.", "type": "object", "properties": { "dimensions": { "description": "The map of dimensions in key-value pairs. The key of a map entry is \"region\", \"zone\", or the name of a service-specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimensionInfo instance configured for the specific value. For example: `{\"provider\" : \"Example Organization\"}` where `provider` is a service-specific quota dimension and `Example Organization` is the provider name.", "type": "object", "additionalProperties": { "type": "string" } }, "details": { "description": "Quota details for the specified dimensions.", "$ref": "GdcQuotaDetails" } } }, "GdcQuotaDetails": { "id": "GdcQuotaDetails", "description": "The quota details for a map of dimensions.", "type": "object", "properties": { "value": { "description": "The value currently in effect and being enforced.", "type": "string", "format": "int64" }, "resetValue": { "description": "The Google Cloud defined quota value that the quota will be reset to if a quota decrease preference is deleted", "type": "string", "format": "int64" } } } }, "name": "cloudquotas", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "kind": "discovery#restDescription" }