Связаться с намиПодключиться

Quota Manager API, REST: QuotaRequest.Cancel

Статья создана
Обновлена 8 августа 2025 г.

Cancels quotas in the specified quota request.

HTTP request

POST https://quota-manager.api.cloud.yandex.net/quota-manager/v1/quotaRequests/{quotaRequestId}/cancel

Path parameters

Field

Description

quotaRequestId

string

Required field. ID of the quota request to update.

Body parameters

{
  "quotaIds": [
    "string"
  ]
}

Field

Description

quotaIds[]

string

Quota IDs that is being canceled.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "quotaRequestId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "resource": {
      "id": "string",
      "type": "string"
    },
    "createdAt": "string",
    "status": "string",
    "quotaLimits": [
      {
        "quotaId": "string",
        "desiredLimit": "string",
        "approvedLimit": "string",
        "unit": "string",
        "status": "string",
        "message": "string",
        "modifiedBy": "string"
      }
    ],
    "createdBy": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CancelQuotaRequestMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

QuotaRequest

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CancelQuotaRequestMetadata

Field

Description

quotaRequestId

string

ID of the quota request that is being updated.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

QuotaRequest

Field

Description

id

string

ID of the quota request.

resource

Resource

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

status

enum (Status)

Status of current quota request.

  • STATUS_UNSPECIFIED
  • PENDING: The request is pending and is waiting to be processed.
  • PROCESSING: The request is processing.
  • PROCESSED: The request was processed.
  • CANCELED: The request was canceled.
  • DELETING: The request is deleting.

quotaLimits[]

QuotaLimit

Quota limits

createdBy

string

ID of the subject who created quota request.

Resource

Field

Description

id

string

Required field. The id if the resource.

type

string

Required field. The type of the resource, e.g. resource-manager.cloud, billing.account.

QuotaLimit

Field

Description

quotaId

string

ID of the quota.

desiredLimit

string

Desired limit.

approvedLimit

string

Approved limit.

unit

string

Unit of quota.

status

enum (Status)

Status of current quota limit.

  • STATUS_UNSPECIFIED
  • PENDING: The request is pending and is waiting to be processed.
  • PROCESSING: The request is processing.
  • PARTIAL_APPROVED: The request was partially approved.
  • APPROVED: The request was approved.
  • REJECTED: The request was rejected.
  • CANCELED: The request was canceled.

message

string

modifiedBy

string

ID of the subject who modified quota limit.
Предыдущая
Create
Следующая
List