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

Identity and Access Management API, REST: ServiceControl.Enable

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

Enable a service in the specified resource container.

HTTP request

POST https://iam.api.cloud.yandex.net/iam/v1/service/{serviceId}:enable

Path parameters

Field

Description

serviceId

string

Required field. ID of the Service.

Body parameters

{
  "resource": {
    "id": "string",
    "type": "string"
  }
}

Field

Description

resource

Resource

Required field. Resource container to enable a service in.

It is supported only resource-manager.cloud resource container now.

Resource

A Resource. For more information, see Resource.

Field

Description

id

string

Required field. ID of the resource.

type

string

Required field. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "serviceId": "string",
    "resource": {
      "id": "string",
      "type": "string"
    }
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "serviceId": "string",
    "resource": {
      "id": "string",
      "type": "string"
    },
    "updatedAt": "string",
    "status": "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

EnableServiceMetadata

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

Service

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.

EnableServiceMetadata

Field

Description

serviceId

string

ID of the Service.

resource

Resource

Resource container.

Resource

A Resource. For more information, see Resource.

Field

Description

id

string

Required field. ID of the resource.

type

string

Required field. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc.

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.

Service

A Service.

Field

Description

serviceId

string

ID of the service.

resource

Resource

Resource that the service belongs to.

updatedAt

string (date-time)

Time of the last status update of the service.

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).

status

enum (Status)

Current status of the service.

  • STATUS_UNSPECIFIED
  • ENABLED: The service is enabled.
  • PAUSED: The service is paused.
  • DISABLED: The service is disabled.
  • ENABLING: The service is being enabled.
  • RESUMING: The service is being resumed.
  • PAUSING: The service is being paused.
  • DISABLING: The service is being disabled.
  • ERROR: The service is in error state.
  • DEFAULT: The service could be auto enabled.
Предыдущая
List
Следующая
Disable