googleapis.com – servicecontrol
Provides admission control and telemetry reporting for services integrated with Service Infrastructure.
- Homepage
- https://api.apis.guru/v2/specs/googleapis.com:servicecontrol/v1.json
- Provider
- googleapis.com:servicecontrol / servicecontrol
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/googleapis.com/servicecontrol/v1/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/googleapis.com/servicecontrol/v1/openapi.yaml
Tools (5)
Extracted live via the executor SDK.
-
services.servicecontrolServicesAllocateQuotaAttempts to allocate quota for the specified consumer. It should be called before the operation is executed. This method requires the
servicemanagement.services.quotapermission on the specified service. For more information, see . NOTE: The client must fail-open on server errorsINTERNAL,UNKNOWN,DEADLINE_EXCEEDED, andUNAVAILABLE. To ensure system reliability, the server may inject these errors to prohibit any hard dependency on the quota functionality. -
services.servicecontrolServicesCheckChecks whether an operation on a service should be allowed to proceed based on the configuration of the service and related policies. It must be called before the operation is executed. If feasible, the client should cache the check results and reuse them for 60 seconds. In case of any server errors, the client should rely on the cached results for much longer time to avoid outage. WARNING: There is general 60s delay for the configuration and policy propagation, therefore callers MUST NOT depend on the
Checkmethod having the latest policy information. NOTE: the CheckRequest has the size limit (wire-format byte size) of 1MB. This method requires theservicemanagement.services.checkpermission on the specified service. For more information, see . -
services.servicecontrolServicesReportReports operation results to Google Service Control, such as logs and metrics. It should be called after an operation is completed. If feasible, the client should aggregate reporting data for up to 5 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to reduce data loss during client crashes. Clients should carefully choose the aggregation time window to avoid data loss risk more than 0.01% for business and compliance reasons. NOTE: the ReportRequest has the size limit (wire-format byte size) of 1MB. This method requires the
servicemanagement.services.reportpermission on the specified service. For more information, see . -
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools