Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Identity and Access Management
  • Secure use of Yandex Cloud
  • Access management
  • Pricing policy
  • Role reference
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Enable
        • Disable
        • ResolveAgent
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • HTTP request
  • Path parameters
  • Query parameters
  • Resource
  • Response
  • Resource
  1. API reference
  2. REST
  3. ServiceControl
  4. Get

Identity and Access Management API, REST: ServiceControl.Get

Written by
Yandex Cloud
Updated at November 26, 2024
  • HTTP request
  • Path parameters
  • Query parameters
  • Resource
  • Response
  • Resource

Returns the Service information in the specified resource container.

To get the list of available Services, make a List request.

HTTP requestHTTP request

GET https://iam.api.cloud.yandex.net/iam/v1/services/{serviceId}

Path parametersPath parameters

Field

Description

serviceId

string

Required field. ID of the Service.

Query parametersQuery parameters

Field

Description

resource

Resource

Required field. Resource container to get a service information in.

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

ResourceResource

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.

ResponseResponse

HTTP Code: 200 - OK

{
  "serviceId": "string",
  "resource": {
    "id": "string",
    "type": "string"
  },
  "updatedAt": "string",
  "status": "string"
}

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.

ResourceResource

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.

Was the article helpful?

Previous
Overview
Next
List
Yandex project
© 2025 Yandex.Cloud LLC