IoT Core Service, REST: Registry.Create
Creates a registry in the specified folder.
HTTP request
POST https://iot-devices.api.cloud.yandex.net/iot-devices/v1/registries
Body parameters
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"certificates": [
{
"certificateData": "string"
}
],
"password": "string",
"logOptions": {
"disabled": "boolean",
// Includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields
"minLevel": "string"
}
}
|
Field |
Description |
|
folderId |
string Required field. ID of the folder to create a registry in. To get a folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. |
|
name |
string Required field. Name of the registry. The name must be unique within the folder. |
|
description |
string Description of the registry. |
|
labels |
object (map<string, string>) Resource labels as |
|
certificates[] |
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. |
|
logOptions |
Options for logging registry events |
Certificate
Specification of a registry certificate.
|
Field |
Description |
|
certificateData |
string Public part of the registry certificate. |
LogOptions
|
Field |
Description |
|
disabled |
boolean Is logging from registry disabled. |
|
logGroupId |
string Entry should be written to log group resolved by ID. Includes only one of the fields Log entries destination. |
|
folderId |
string Entry should be written to default log group for specified folder. Includes only one of the fields Log entries destination. |
|
minLevel |
enum (Level) Minimum log entry level. See LogLevel.Level for details.
|
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",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"logGroupId": "string",
"logOptions": {
"disabled": "boolean",
// Includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields
"minLevel": "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 To work with values in this field, use the APIs described in the |
|
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 To work with values in this field, use the APIs described in the |
|
done |
boolean If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
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. For more information, see Registry.
|
Field |
Description |
|
id |
string ID of the registry. |
|
folderId |
string ID of the folder that the registry belongs to. |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
name |
string Name of the registry. The name is unique within the folder. |
|
description |
string Description of the registry. 0-256 characters long. |
|
labels |
object (map<string, string>) Resource labels as |
|
status |
enum (Status) Status of the registry.
|
|
logGroupId |
string ID of the logs group for the specified registry. |
|
logOptions |
Options for logging registry events |
LogOptions
|
Field |
Description |
|
disabled |
boolean Is logging from registry disabled. |
|
logGroupId |
string Entry should be written to log group resolved by ID. Includes only one of the fields Log entries destination. |
|
folderId |
string Entry should be written to default log group for specified folder. Includes only one of the fields Log entries destination. |
|
minLevel |
enum (Level) Minimum log entry level. See LogLevel.Level for details.
|