Yandex Cloud Registry API, REST: Registry.Create

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

Yandex Cloud

Улучшена

Tania L.

Обновлена 21 февраля 2025 г.

HTTP request
Body parameters
Response
CreateRegistryMetadata
Status
Registry

Creates a registry in the specified folder.

HTTP request

POST https://registry.api.yandexcloud.kz/cloud-registry/v1/registries

Body parameters

{
  "folderId": "string",
  "name": "string",
  "labels": "object",
  "kind": "string",
  "type": "string",
  "description": "string",
  "properties": "object"
}

Field	Description
folderId	string Required field. ID of the folder to create a registry in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.
name	string Name of the registry. There may be only one registry per folder.
labels	object (map<string, string>) Resource labels as `key:value` pairs.
kind	enum (Kind) Required field. Kind of the registry. `KIND_UNSPECIFIED` `MAVEN`: Registry kind is maven. `NPM`: Registry kind is npm. `DOCKER`: Registry kind is docker. `NUGET`: Registry kind is nuget.
type	enum (Type) Required field. Type of the registry. `TYPE_UNSPECIFIED` `LOCAL`: Registry type is local. `REMOTE` `VIRTUAL`
description	string Description of the registry. 0-1024 characters long.
properties	object (map<string, string>) Property names and values.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "registryId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "name": "string",
    "kind": "string",
    "type": "string",
    "status": "string",
    "description": "string",
    "labels": "object",
    "properties": "object",
    "createdAt": "string",
    "modifiedAt": "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	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.
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	Registry 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.

CreateRegistryMetadata

Field

Description

registryId

string

ID of the registry that is being created.

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.

Registry

A Registry resource.

Field	Description
id	string Output only. ID of the registry.
folderId	string ID of the folder that the registry belongs to.
name	string Name of the registry.
kind	enum (Kind) Kind of the registry. `KIND_UNSPECIFIED` `MAVEN`: Registry kind is maven. `NPM`: Registry kind is npm. `DOCKER`: Registry kind is docker. `NUGET`: Registry kind is nuget.
type	enum (Type) Type of the registry. `TYPE_UNSPECIFIED` `LOCAL`: Registry type is local. `REMOTE` `VIRTUAL`
status	enum (Status) Output only. Status of the registry. `STATUS_UNSPECIFIED` `CREATING`: Registry is being created. `ACTIVE`: Registry is ready to use. `DELETING`: Registry is being deleted.
description	string Description of the registry.
labels	object (map<string, string>) Resource labels as `key:value` pairs. Maximum of 64 per resource.
properties	object (map<string, string>) Resource properties as `key:value` pairs. Maximum of 64 per resource.
createdAt	string (date-time) Output only. Creation timestamp in RFC3339 text format. 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).
modifiedAt	string (date-time) Output only. Modification timestamp in RFC3339 text format. 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).