Get a Service
get
/20160918/services/{service_id}
Get the specified Service object.
Request
Supported Media Types
- application/json
Path Parameters
-
serviceId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the service.
Response
Supported Media Types
- application/json
200 Response
The `Service` is being retrieved.
Headers
-
etag: string
For optimistic concurrency control. See `if-match`.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Service
Type:
object
An object that represents one or multiple Oracle services that you can enable for a ServiceGateway. The service CIDR label is to the string that represents the regional public IP address ranges of the Oracle service or services covered by a given Service object. That unique string is the value of the Service object's cidrBlock attribute.
Show Source
-
cidrBlock(required):
string
Minimum Length:
1
Maximum Length:255
A string that represents the regional public IP address ranges for the Oracle service or services covered by this Service object. Also known as the Service object's service CIDR label. When you set up a route rule to route traffic to the service gateway, use this value as the rule's destination. Also, when you set up a security list rule to cover traffic with the service gateway, use the cidrBlock value as the rule's destination (for an egress rule) or the source (for an ingress rule). Example: oci-phx-objectstorage -
description(required):
string
Minimum Length:
1
Maximum Length:255
Description of the Oracle service or services covered by this Service object. Example: OCI PHX Object Storage -
id(required):
string
Minimum Length:
1
Maximum Length:255
The Service object's OCID. -
name(required):
string
Minimum Length:
1
Maximum Length:127
Name of the Service object. This name can change and is not guaranteed to be unique. Example: OCI PHX Object Storage
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.