Identity and Access Management API, REST: ServiceControl.Enable
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 |
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 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 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. |
EnableServiceMetadata
Field |
Description |
serviceId |
string ID of the Service. |
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 that the service belongs to. |
updatedAt |
string (date-time) Time of the last status update of the service. String in RFC3339 To work with values in this field, use the APIs described in the |
status |
enum (Status) Current status of the service.
|