Yandex Cloud Registry API, gRPC: ScanPolicyService.Update

Статья создана

Yandex Cloud

Обновлена 3 июня 2026 г.

gRPC request
UpdateScanPolicyRequest
ScanRules
PushRule
ScheduledRule
operation.Operation

Updates the specified scan policy.

gRPC request

rpc Update (UpdateScanPolicyRequest) returns (operation.Operation)

UpdateScanPolicyRequest

{
  "scan_policy_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "scan_lang_packages": "bool",
  "rules": {
    "push_rule": {
      "paths": [
        "string"
      ],
      "disabled": "bool"
    },
    "schedule_rules": [
      {
        "amount": "int64",
        "interval_unit": "IntervalUnit",
        "paths": [
          "string"
        ],
        "disabled": "bool"
      }
    ]
  },
  "disabled": "bool"
}

Field	Description
scan_policy_id	string Required field. ID of the scan policy. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the scan policy resource are going to be updated.
name	string Name of the scan policy. Value must match the regular expression `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
description	string Description of the scan policy. The maximum string length in characters is 256.
scan_lang_packages	bool Flag indicating whether language packages should be scanned.
rules	ScanRules Rules of the scan policy.
disabled	bool Turns off scan policy.

ScanRules

Field

Description

push_rule

PushRule

Description of on-push scan rule.

schedule_rules[]

ScheduledRule

Description of time based rescan rule.

PushRule

Field

Description

paths[]

string

List of paths that are scanned with rule. Child paths are included into parent node. "*" - means all artifacts in registry

Each value must match the regular expression \*|[a-z0-9]+(?:[._-][a-z0-9]+)*(/([a-z0-9]+(?:[._-][a-z0-9]+)*))*. The number of elements must be greater than 0.

disabled

bool

Turns off scan rule.

ScheduledRule

Field	Description
amount	int64 Amount of time units for the scan interval. Value must be greater than 0.
interval_unit	enum IntervalUnit Unit for the scan interval. `DAYS`: Time unit is days.
paths[]	string List of paths that are scanned with rule. Child paths are included into parent node. "" - means all artifacts in registry Each value must match the regular expression `\\|[a-z0-9]+(?:[._-][a-z0-9]+)(/([a-z0-9]+(?:[._-][a-z0-9]+)))*`. The number of elements must be in the range 1-1000.
disabled	bool Turns off scan rule.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any 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	google.rpc.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	google.protobuf.Any 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.

Yandex Cloud Registry API, gRPC: ScanPolicyService.Update

gRPC requestgRPC request

UpdateScanPolicyRequestUpdateScanPolicyRequest

ScanRulesScanRules

PushRulePushRule

ScheduledRuleScheduledRule

operation.Operationoperation.Operation