Identity and Access Management API, gRPC: ServiceControlService
A set of methods for managing Service resources.
Call | Description |
---|---|
Get | Returns the Service information in the specified resource container. |
List | Retrieves the list of Service in the specified resource container. |
Enable | Enable a service in the specified resource container. |
Resume | Resume a service in the specified resource container. |
Pause | Pause a service in the specified resource container. |
Disable | Disable a service in the specified resource container. |
Calls ServiceControlService
Get
Returns the Service information in the specified resource container.
To get the list of available Services, make a List request.
rpc Get (GetServiceRequest) returns (Service)
GetServiceRequest
Field | Description |
---|---|
service_id | string Required. ID of the Service. The maximum string length in characters is 50. |
resource | Resource Required. Resource container to get a service information in. It is supported only resource-manager.cloud resource container now. |
Resource
Field | Description |
---|---|
id | string Required. ID of the resource. The maximum string length in characters is 50. |
type | string Required. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc. The maximum string length in characters is 64. |
Service
Field | Description |
---|---|
service_id | string ID of the service. |
resource | Resource Resource that the service belongs to. |
updated_at | google.protobuf.Timestamp Time of the last status update of the service. |
status | enum Status Current status of the service.
|
List
Retrieves the list of Service in the specified resource container.
rpc List (ListServicesRequest) returns (ListServicesResponse)
ListServicesRequest
Field | Description |
---|---|
resource | Resource Required. Resource container to list a services. It is supported only resource-manager.cloud resource container now. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListServicesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100 Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListServicesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 2000. |
Resource
Field | Description |
---|---|
id | string Required. ID of the resource. The maximum string length in characters is 50. |
type | string Required. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc. The maximum string length in characters is 64. |
ListServicesResponse
Field | Description |
---|---|
services[] | Service List of Services. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListServicesRequest.page_size, use the next_page_token as the value for the ListServicesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Service
Field | Description |
---|---|
service_id | string ID of the service. |
resource | Resource Resource that the service belongs to. |
updated_at | google.protobuf.Timestamp Time of the last status update of the service. |
status | enum Status Current status of the service.
|
Enable
Enable a service in the specified resource container.
rpc Enable (EnableServiceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:EnableServiceMetadata
Operation.response:Service
EnableServiceRequest
Field | Description |
---|---|
service_id | string Required. ID of the Service. The maximum string length in characters is 50. |
resource | Resource Required. Resource container to enable a service in. It is supported only resource-manager.cloud resource container now. |
Resource
Field | Description |
---|---|
id | string Required. ID of the resource. The maximum string length in characters is 50. |
type | string Required. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc. The maximum string length in characters is 64. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
EnableServiceMetadata
Field | Description |
---|---|
service_id | string ID of the Service. |
resource | Resource Resource container. |
Service
Field | Description |
---|---|
service_id | string ID of the service. |
resource | Resource Resource that the service belongs to. |
updated_at | google.protobuf.Timestamp Time of the last status update of the service. |
status | enum Status Current status of the service.
|
Resume
Resume a service in the specified resource container.
rpc Resume (ResumeServiceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:ResumeServiceMetadata
Operation.response:Service
ResumeServiceRequest
Field | Description |
---|---|
service_id | string Required. ID of the Service. The maximum string length in characters is 50. |
resource | Resource Required. Resource container to resume a service in. It is supported only resource-manager.cloud resource container now. |
Resource
Field | Description |
---|---|
id | string Required. ID of the resource. The maximum string length in characters is 50. |
type | string Required. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc. The maximum string length in characters is 64. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
ResumeServiceMetadata
Field | Description |
---|---|
service_id | string ID of the Service. |
resource | Resource Resource container. |
Service
Field | Description |
---|---|
service_id | string ID of the service. |
resource | Resource Resource that the service belongs to. |
updated_at | google.protobuf.Timestamp Time of the last status update of the service. |
status | enum Status Current status of the service.
|
Pause
Pause a service in the specified resource container.
rpc Pause (PauseServiceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:PauseServiceMetadata
Operation.response:Service
PauseServiceRequest
Field | Description |
---|---|
service_id | string Required. ID of the Service. The maximum string length in characters is 50. |
resource | Resource Required. Resource container to pause a service in. It is supported only resource-manager.cloud resource container now. |
force | bool Force pause. It will pause service even if there is service resources that will be broke. |
Resource
Field | Description |
---|---|
id | string Required. ID of the resource. The maximum string length in characters is 50. |
type | string Required. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc. The maximum string length in characters is 64. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
PauseServiceMetadata
Field | Description |
---|---|
service_id | string ID of the Service. |
resource | Resource Resource container. |
Service
Field | Description |
---|---|
service_id | string ID of the service. |
resource | Resource Resource that the service belongs to. |
updated_at | google.protobuf.Timestamp Time of the last status update of the service. |
status | enum Status Current status of the service.
|
Disable
Disable a service in the specified resource container.
rpc Disable (DisableServiceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DisableServiceMetadata
Operation.response:Service
DisableServiceRequest
Field | Description |
---|---|
service_id | string Required. ID of the Service. The maximum string length in characters is 50. |
resource | Resource Required. Resource container to disable a service in. It is supported only resource-manager.cloud resource container now. |
Resource
Field | Description |
---|---|
id | string Required. ID of the resource. The maximum string length in characters is 50. |
type | string Required. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc. The maximum string length in characters is 64. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DisableServiceMetadata
Field | Description |
---|---|
service_id | string ID of the Service. |
resource | Resource Resource container. |
Service
Field | Description |
---|---|
service_id | string ID of the service. |
resource | Resource Resource that the service belongs to. |
updated_at | google.protobuf.Timestamp Time of the last status update of the service. |
status | enum Status Current status of the service.
|