Связаться с намиПодключиться

Managed Service for Greenplum® API, REST: ResourceGroup.Create

Статья создана
Обновлена 23 января 2025 г.

Creates resource group

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/{clusterId}/resource_groups

Path parameters

Field

Description

clusterId

string

Required field.

Body parameters

{
  "resourceGroup": {
    "name": "string",
    "isUserDefined": "boolean",
    "concurrency": "string",
    "cpuRateLimit": "string",
    "memoryLimit": "string",
    "memorySharedQuota": "string",
    "memorySpillRatio": "string"
  }
}

Field

Description

resourceGroup

ResourceGroup

ResourceGroup

Field

Description

name

string

Required field.

isUserDefined

boolean

concurrency

string (int64)

References to CONCURRENCY from gp resource group parameter

cpuRateLimit

string (int64)

References to CPU_RATE_LIMIT from gp resource group parameter

memoryLimit

string (int64)

References to MEMORY_LIMIT from gp resource group parameter

memorySharedQuota

string (int64)

References to MEMORY_SHARED_QUOTA from gp resource group parameter

memorySpillRatio

string (int64)

References to MEMORY_SPILL_RATIO from gp resource group parameter

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string",
    "resourceGroupName": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "name": "string",
    "isUserDefined": "boolean",
    "concurrency": "string",
    "cpuRateLimit": "string",
    "memoryLimit": "string",
    "memorySharedQuota": "string",
    "memorySpillRatio": "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

CreateResourceGroupMetadata

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

ResourceGroup

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.

CreateResourceGroupMetadata

Field

Description

clusterId

string

Required field.

resourceGroupName

string

Required field.

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.

ResourceGroup

Field

Description

name

string

Required field.

isUserDefined

boolean

concurrency

string (int64)

References to CONCURRENCY from gp resource group parameter

cpuRateLimit

string (int64)

References to CPU_RATE_LIMIT from gp resource group parameter

memoryLimit

string (int64)

References to MEMORY_LIMIT from gp resource group parameter

memorySharedQuota

string (int64)

References to MEMORY_SHARED_QUOTA from gp resource group parameter

memorySpillRatio

string (int64)

References to MEMORY_SPILL_RATIO from gp resource group parameter
Предыдущая
GetAtRevision
Следующая
Update