Jump to

• Request
• Response

GetService

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.

Back to Top

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. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

{
    "description":"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.",
    "properties":{
        "cidrBlock":{
            "description":"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 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "description":{
            "description":"Description of the Oracle service or services covered by this Service object. Example: OCI PHX Object Storage ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "id":{
            "description":"The Service object's OCID.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "name":{
            "description":"Name of the Service object. This name can change and is not guaranteed to be unique. Example: OCI PHX Object Storage ",
            "maxLength":"127",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "id",
        "name",
        "cidrBlock",
        "description"
    ],
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top