RegistryService

A set of methods for managing registry.

Call Description
Get Returns the specified registry.
List Retrieves the list of registries in the specified folder.
Create Creates a registry in the specified folder.
Update Updates the specified registry.
Delete Deletes the specified registry.
ListCertificates Retrieves the list of registry certificates for the specified registry.
AddCertificate Adds a certificate.
DeleteCertificate Deletes the specified registry certificate.
ListPasswords Retrieves the list of passwords for the specified registry.
AddPassword Adds password for the specified registry.
DeletePassword Deletes the specified password.
ListDeviceTopicAliases Retrieves the list of device topic aliases for the specified registry.
ListOperations Lists operations for the specified registry.

Calls RegistryService

Get

Returns the specified registry.
To get the list of available registries, make a List request.

rpc Get (GetRegistryRequest) returns (Registry)

GetRegistryRequest

Field Description
registry_id string
Required. ID of the registry to return.
To get a registry ID make a RegistryService.List request. The maximum string length in characters is 50.

Registry

Field Description
id string
ID of the registry.
folder_id string
ID of the folder that the registry belongs to.
created_at google.protobuf.Timestamp
Creation timestamp.
name string
Name of the registry. The name is unique within the folder.
description string
Description of the registry. 0-256 characters long.
labels map<string,string>
Resource labels as key:value pairs. Мaximum of 64 per resource.
status enum Status
Status of the registry.
  • CREATING: Registry is being created.
  • ACTIVE: Registry is ready to use.
  • DELETING: Registry is being deleted.
    log_group_id string
    ID of the logs group for the specified registry.

    List

    Retrieves the list of registries in the specified folder.

    rpc List (ListRegistriesRequest) returns (ListRegistriesResponse)

    ListRegistriesRequest

    Field Description
    folder_id string
    Required. ID of the folder to list registries in.
    To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
    page_size int64
    The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListRegistriesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
    page_token string
    Page token. To get the next page of results, set page_token to the ListRegistriesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

    ListRegistriesResponse

    Field Description
    registries[] Registry
    List of registries.
    next_page_token string
    Token for getting the next page of the list. If the number of results is greater than the specified ListRegistriesRequest.page_size, use next_page_token as the value for the ListRegistriesRequest.page_token parameter in the next list request.
    Each subsequent page will have its own next_page_token to continue paging through the results.

    Registry

    Field Description
    id string
    ID of the registry.
    folder_id string
    ID of the folder that the registry belongs to.
    created_at google.protobuf.Timestamp
    Creation timestamp.
    name string
    Name of the registry. The name is unique within the folder.
    description string
    Description of the registry. 0-256 characters long.
    labels map<string,string>
    Resource labels as key:value pairs. Мaximum of 64 per resource.
    status enum Status
    Status of the registry.
    • CREATING: Registry is being created.
    • ACTIVE: Registry is ready to use.
    • DELETING: Registry is being deleted.
      log_group_id string
      ID of the logs group for the specified registry.

      Create

      Creates a registry in the specified folder.

      rpc Create (CreateRegistryRequest) returns (operation.Operation)

      Metadata and response of Operation:
          Operation.metadata:CreateRegistryMetadata
          Operation.response:Registry

      CreateRegistryRequest

      Field Description
      folder_id string
      Required. ID of the folder to create a registry in.
      To get a folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
      name string
      Required. Name of the registry. The name must be unique within the folder. The maximum string length in characters is 50. Value must match the regular expression [a-zA-Z0-9_-]*.
      description string
      Description of the registry. The maximum string length in characters is 256.
      labels map<string,string>
      Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
      certificates[] Certificate
      Registry certificates.
      password string
      Registry passwords.
      The password must contain at least three character categories among the following: upper case latin, lower case latin, numbers and special symbols.

      Certificate

      Field Description
      certificate_data string
      Public part of the registry certificate.

      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<CreateRegistryMetadata>
      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.
      result oneof: error or 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.
        error google.rpc.Status
      The error result of the operation in case of failure or cancellation.
        response google.protobuf.Any<Registry>
      if operation finished successfully.

      CreateRegistryMetadata

      Field Description
      registry_id string
      ID of the registry that is being created.

      Registry

      Field Description
      id string
      ID of the registry.
      folder_id string
      ID of the folder that the registry belongs to.
      created_at google.protobuf.Timestamp
      Creation timestamp.
      name string
      Name of the registry. The name is unique within the folder.
      description string
      Description of the registry. 0-256 characters long.
      labels map<string,string>
      Resource labels as key:value pairs. Мaximum of 64 per resource.
      status enum Status
      Status of the registry.
      • CREATING: Registry is being created.
      • ACTIVE: Registry is ready to use.
      • DELETING: Registry is being deleted.
        log_group_id string
        ID of the logs group for the specified registry.

        Update

        Updates the specified registry.

        rpc Update (UpdateRegistryRequest) returns (operation.Operation)

        Metadata and response of Operation:
            Operation.metadata:UpdateRegistryMetadata
            Operation.response:Registry

        UpdateRegistryRequest

        Field Description
        registry_id string
        Required. ID of the registry to update.
        To get a registry ID make a RegistryService.List request. The maximum string length in characters is 50.
        update_mask google.protobuf.FieldMask
        Field mask that specifies which fields of the registry are going to be updated.
        name string
        Name of the registry. The name must be unique within the folder. The maximum string length in characters is 50. Value must match the regular expression [a-zA-Z0-9_-]*.
        description string
        Description of the registry. The maximum string length in characters is 256.
        labels map<string,string>
        Resource labels as key:value pairs.
        Existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.

        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<UpdateRegistryMetadata>
        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.
        result oneof: error or 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.
          error google.rpc.Status
        The error result of the operation in case of failure or cancellation.
          response google.protobuf.Any<Registry>
        if operation finished successfully.

        UpdateRegistryMetadata

        Field Description
        registry_id string
        ID of the registry that is being updated.

        Registry

        Field Description
        id string
        ID of the registry.
        folder_id string
        ID of the folder that the registry belongs to.
        created_at google.protobuf.Timestamp
        Creation timestamp.
        name string
        Name of the registry. The name is unique within the folder.
        description string
        Description of the registry. 0-256 characters long.
        labels map<string,string>
        Resource labels as key:value pairs. Мaximum of 64 per resource.
        status enum Status
        Status of the registry.
        • CREATING: Registry is being created.
        • ACTIVE: Registry is ready to use.
        • DELETING: Registry is being deleted.
          log_group_id string
          ID of the logs group for the specified registry.

          Delete

          Deletes the specified registry.

          rpc Delete (DeleteRegistryRequest) returns (operation.Operation)

          Metadata and response of Operation:
              Operation.metadata:DeleteRegistryMetadata
              Operation.response:google.protobuf.Empty

          DeleteRegistryRequest

          Field Description
          registry_id string
          Required. ID of the registry to delete.
          To get a registry ID make a RegistryService.List request. The maximum string length in characters is 50.

          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<DeleteRegistryMetadata>
          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.
          result oneof: error or 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.
            error google.rpc.Status
          The error result of the operation in case of failure or cancellation.
            response google.protobuf.Any<google.protobuf.Empty>
          if operation finished successfully.

          DeleteRegistryMetadata

          Field Description
          registry_id string
          ID of the registry that is being deleted.

          ListCertificates

          Retrieves the list of registry certificates for the specified registry.

          rpc ListCertificates (ListRegistryCertificatesRequest) returns (ListRegistryCertificatesResponse)

          ListRegistryCertificatesRequest

          Field Description
          registry_id string
          Required. ID of the registry to list certificates for. The maximum string length in characters is 50.

          ListRegistryCertificatesResponse

          Field Description
          certificates[] RegistryCertificate
          List of certificates for the specified registry.

          RegistryCertificate

          Field Description
          registry_id string
          ID of the registry that the certificate belongs to.
          fingerprint string
          SHA256 hash of the certificates.
          certificate_data string
          Public part of the certificate.
          created_at google.protobuf.Timestamp
          Creation timestamp.

          AddCertificate

          Adds a certificate.

          rpc AddCertificate (AddRegistryCertificateRequest) returns (operation.Operation)

          Metadata and response of Operation:
              Operation.metadata:AddRegistryCertificateMetadata
              Operation.response:RegistryCertificate

          AddRegistryCertificateRequest

          Field Description
          registry_id string
          Required. ID of the registry for which the certificate is being added.
          To get a registry ID make a RegistryService.List request. The maximum string length in characters is 50.
          certificate_data string
          Public part of the certificate that is being added.

          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<AddRegistryCertificateMetadata>
          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.
          result oneof: error or 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.
            error google.rpc.Status
          The error result of the operation in case of failure or cancellation.
            response google.protobuf.Any<RegistryCertificate>
          if operation finished successfully.

          AddRegistryCertificateMetadata

          Field Description
          registry_id string
          ID of the registry certificate that is being added.
          fingerprint string
          Fingerprint of the certificate that is being added.

          RegistryCertificate

          Field Description
          registry_id string
          ID of the registry that the certificate belongs to.
          fingerprint string
          SHA256 hash of the certificates.
          certificate_data string
          Public part of the certificate.
          created_at google.protobuf.Timestamp
          Creation timestamp.

          DeleteCertificate

          Deletes the specified registry certificate.

          rpc DeleteCertificate (DeleteRegistryCertificateRequest) returns (operation.Operation)

          Metadata and response of Operation:
              Operation.metadata:DeleteRegistryCertificateMetadata
              Operation.response:google.protobuf.Empty

          DeleteRegistryCertificateRequest

          Field Description
          registry_id string
          Required. ID of the registry to delete a certificate for.
          To get a registry ID make a RegistryService.List request. The maximum string length in characters is 50.
          fingerprint string
          Required. Fingerprint of the certificate that is being deleted. The maximum string length in characters is 50.

          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<DeleteRegistryCertificateMetadata>
          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.
          result oneof: error or 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.
            error google.rpc.Status
          The error result of the operation in case of failure or cancellation.
            response google.protobuf.Any<google.protobuf.Empty>
          if operation finished successfully.

          DeleteRegistryCertificateMetadata

          Field Description
          registry_id string
          Required. ID of a registry for which the certificate is being delete. The maximum string length in characters is 50.
          fingerprint string
          Required. Fingerprint of the certificate to deleted. The maximum string length in characters is 50.

          ListPasswords

          Retrieves the list of passwords for the specified registry.

          rpc ListPasswords (ListRegistryPasswordsRequest) returns (ListRegistryPasswordsResponse)

          ListRegistryPasswordsRequest

          Field Description
          registry_id string
          Required. ID of the registry to list passwords in.
          To get a registry ID make a RegistryService.List request. The maximum string length in characters is 50.

          ListRegistryPasswordsResponse

          Field Description
          passwords[] RegistryPassword
          List of passwords for the specified registry.

          RegistryPassword

          Field Description
          registry_id string
          ID of the registry that the password belongs to.
          id string
          ID of the password.
          created_at google.protobuf.Timestamp
          Creation timestamp.

          AddPassword

          Adds password for the specified registry.

          rpc AddPassword (AddRegistryPasswordRequest) returns (operation.Operation)

          Metadata and response of Operation:
              Operation.metadata:AddRegistryPasswordMetadata
              Operation.response:RegistryPassword

          AddRegistryPasswordRequest

          Field Description
          registry_id string
          Required. ID of the registry to add a password for.
          To get a registry ID make a RegistryService.List request. The maximum string length in characters is 50.
          password string
          Passwords for the registry.
          The password must contain at least three character categories among the following: upper case latin, lower case latin, numbers and special symbols. The minimum string length in characters is 14.

          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<AddRegistryPasswordMetadata>
          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.
          result oneof: error or 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.
            error google.rpc.Status
          The error result of the operation in case of failure or cancellation.
            response google.protobuf.Any<RegistryPassword>
          if operation finished successfully.

          AddRegistryPasswordMetadata

          Field Description
          registry_id string
          ID of the registry for which the password is being added.
          password_id string
          ID of a password that is being added.

          RegistryPassword

          Field Description
          registry_id string
          ID of the registry that the password belongs to.
          id string
          ID of the password.
          created_at google.protobuf.Timestamp
          Creation timestamp.

          DeletePassword

          Deletes the specified password.

          rpc DeletePassword (DeleteRegistryPasswordRequest) returns (operation.Operation)

          Metadata and response of Operation:
              Operation.metadata:DeleteRegistryPasswordMetadata
              Operation.response:google.protobuf.Empty

          DeleteRegistryPasswordRequest

          Field Description
          registry_id string
          Required. ID of the registry to delete a password for.
          To get a registry ID make a DeviceService.List request. The maximum string length in characters is 50.
          password_id string
          Required. ID of the password to delete.
          To get a password ID make a RegistryService.ListPasswords request. The maximum string length in characters is 50.

          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<DeleteRegistryPasswordMetadata>
          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.
          result oneof: error or 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.
            error google.rpc.Status
          The error result of the operation in case of failure or cancellation.
            response google.protobuf.Any<google.protobuf.Empty>
          if operation finished successfully.

          DeleteRegistryPasswordMetadata

          Field Description
          registry_id string
          Required. ID of a registry for which the password is being delete. The maximum string length in characters is 50.
          password_id string
          Required. ID of the password to delete.
          To get a password ID make a RegistryService.ListPasswords request. The maximum string length in characters is 50.

          ListDeviceTopicAliases

          Retrieves the list of device topic aliases for the specified registry.

          rpc ListDeviceTopicAliases (ListDeviceTopicAliasesRequest) returns (ListDeviceTopicAliasesResponse)

          ListDeviceTopicAliasesRequest

          Field Description
          registry_id string
          Required. ID of the registry to list aliases for device topic.
          To get a registry ID make a RegistryService.List request. The maximum string length in characters is 50.
          page_size int64
          The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListDeviceTopicAliasesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
          page_token string
          Page token. To get the next page of results, set page_token to the ListDeviceTopicAliasesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

          ListDeviceTopicAliasesResponse

          Field Description
          aliases[] DeviceAlias
          List of device aliases for the specified registry.
          next_page_token string
          Token for getting the next page of the list. If the number of results is greater than the specified ListDeviceTopicAliasesRequest.page_size, use next_page_token as the value for the ListDeviceTopicAliasesRequest.page_token parameter in the next list request.
          Each subsequent page will have its own next_page_token to continue paging through the results.

          DeviceAlias

          Field Description
          device_id string
          ID of the device that the alias belongs to.
          topic_prefix string
          Prefix of a canonical topic name to be aliased, e.g. $devices/abcdef.
          alias string
          Alias of a device topic.

          ListOperations

          Lists operations for the specified registry.

          rpc ListOperations (ListRegistryOperationsRequest) returns (ListRegistryOperationsResponse)

          ListRegistryOperationsRequest

          Field Description
          registry_id string
          Required. ID of the registry to list operations for.
          page_size int64
          The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListRegistryOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
          page_token string
          Page token. To get the next page of results, set page_token to the ListRegistryOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
          filter string
          A filter expression that filters resources listed in the response. Currently you can use filtering only on Registry.name field. The maximum string length in characters is 1000.

          ListRegistryOperationsResponse

          Field Description
          operations[] operation.Operation
          List of operations for the specified registry.
          next_page_token string
          Token for getting the next page of the list. If the number of results is greater than the specified ListRegistryOperationsRequest.page_size, use next_page_token as the value for the ListRegistryOperationsRequest.page_token parameter in the next list request.
          Each subsequent page will have its own next_page_token to continue paging through the results.

          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.
          result oneof: error or 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.
            error google.rpc.Status
          The error result of the operation in case of failure or cancellation.
            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.