Oracle Metadata API

openapi: 3.2.0
info:
  description: Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see [Oracle Multicloud Hub](/iaas/Content/multicloud-hub/home.htm).
  title: Oracle Multicloud Metadata API
  version: '20180828'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/45dc72ed7644fee2cdc2862dbdb9940c0392e2742c304d5e7b7bac5fe9b75485.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Oracle Multicloud API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/45dc72ed7644fee2cdc2862dbdb9940c0392e2742c304d5e7b7bac5fe9b75485.yaml
    what: the harvested document for Oracle Multicloud API
servers:
- url: http://127.0.0.1/20180828
- url: https://127.0.0.1/20180828
tags:
- name: metadata
paths:
  /externalLocationMappingMetadata:
    get:
      description: 'List mapped partner cloud regions and zones across cloud service providers

        for the specified Multicloud base compartment and subscription service name.

        Each mapping includes the OCI region, logical availability domain, and physical availability domain,

        along with mapped partner cloud details that depend on the partner cloud.

        For example, Azure includes a logical zone while AWS doesn''t.

        For more information, see

        [Cross-Cloud Region-Zone Mapping](/iaas/Content/multicloud-hub/view-cloud-mapping.htm).

        '
      operationId: ListExternalLocationMappingMetadata
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdQueryParam'
      - $ref: '#/components/parameters/RequiredSubscriptionServiceNameListQueryParam'
      - $ref: '#/components/parameters/RequiredBaseCompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of externalLocationMetadata objects.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

                important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalLocationMappingMetadatumSummaryCollection'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: List externalLocation metadata from OCI to CSP for regions, Physical AZs.
      tags:
      - metadata
      x-example: 'Request for an Azure subscription:


        POST /20180828/ExternalLocationMappingMetadatumSummaryCollection/ListExternalLocationMappingMetadata?subscriptionServiceName=ORACLEDBATAZURE&compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: multicloud.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /externalLocationSummariesMetadata:
    get:
      description: 'List externalLocationSummary metadata from OCI Region to the Cloud Service Provider region across all regions.

        '
      operationId: ListExternalLocationSummariesMetadata
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdQueryParam'
      - $ref: '#/components/parameters/RequiredSubscriptionServiceNameQueryParam'
      - $ref: '#/components/parameters/EntityTypeQueryParam'
      - $ref: '#/components/parameters/RequiredBaseCompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of externalLocationSummaryMetadata objects.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

                important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalLocationSummariesMetadatumSummaryCollection'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: List externalLocationSummary metadata from OCI Region to the CSP region across all regions.
      tags:
      - metadata
  /externalLocationsMetadata:
    get:
      description: 'List externalLocationDetail metadata from OCI to Cloud  Service Provider for regions, Availability Zones, and Cluster Placement Group ID.

        '
      operationId: ListExternalLocationDetailsMetadata
      parameters:
      - $ref: '#/components/parameters/RequiredSubscriptionIdQueryParam'
      - $ref: '#/components/parameters/EntityTypeQueryParam'
      - $ref: '#/components/parameters/BaseCompartmentIdQueryParam'
      - $ref: '#/components/parameters/LinkedCompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequiredSubscriptionServiceNameQueryParam'
      - $ref: '#/components/parameters/ExternalLocationNameQueryParam'
      - $ref: '#/components/parameters/LogicalZoneQueryParam'
      - $ref: '#/components/parameters/ClusterPlacementGroupIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of externalLocationDetailMetadata objects.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

                important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalLocationsMetadatumCollection'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: List externalLocationDetail metadata from OCI to CSP for regions, AZs, and CPG-ID.
      tags:
      - metadata
components:
  parameters:
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the opc-next-page response header from the previous

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated`

        is descending. Default order for `displayName` is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    ExternalLocationNameQueryParam:
      description: The cloud service provider region.
      in: query
      name: externalLocation
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ClusterPlacementGroupIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group.
      in: query
      name: clusterPlacementGroupId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    BaseCompartmentIdQueryParam:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud base compartment in which to list resources.

        A Multicloud base compartment is an OCI compartment that maps to a subscription in a cloud service provider (such as Azure or AWS).

        '
      in: query
      name: compartmentId
      required: false
      schema:
        type: string
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a

        paginated "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    LogicalZoneQueryParam:
      description: OCI logical availability domain (AD) to filter the response.
      in: query
      name: logicalZone
      required: false
      x-default-description: 'null'
      schema:
        type: string
    RequiredSubscriptionServiceNameQueryParam:
      description: The cloud service provider.
      in: query
      name: subscriptionServiceName
      required: true
      x-obmcs-top-level-enum: '#/definitions/SubscriptionType'
      schema:
        type: string
        enum:
        - ORACLEDBATAZURE
        - ORACLEDBATGOOGLE
        - ORACLEDBATAWS
    RequiredBaseCompartmentIdQueryParam:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud base compartment in which to list resources.

        A Multicloud base compartment is an OCI compartment that maps to a subscription in a cloud service provider (such as Azure or AWS).

        '
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    RequiredSubscriptionIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud subscription in which to list resources.
      in: query
      name: subscriptionId
      required: true
      schema:
        type: string
    SubscriptionIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud subscription in which to list resources.
      in: query
      name: subscriptionId
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`).

        In general, the sort order is `DESC` when sorting by time and `ASC` otherwise.

        '
      in: query
      name: sortOrder
      x-default-description: 'The default value depends on `sortBy`.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    LinkedCompartmentIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment linked to the resource.
      in: query
      name: linkedCompartmentId
      schema:
        type: string
    RequiredSubscriptionServiceNameListQueryParam:
      description: The cloud service provider.
      in: query
      name: subscriptionServiceName
      required: true
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ORACLEDBATAZURE
          - ORACLEDBATGOOGLE
          - ORACLEDBATAWS
          type: string
          x-obmcs-top-level-enum: '#/definitions/SubscriptionType'
    EntityTypeQueryParam:
      description: The resource type query (for example, dbsystem or instance).
      in: query
      name: entityType
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - dbsystem
        - goldengatedeployment
        - goldengateconnection
        - cloudexadatainfrastructure
        - cloudvmcluster
        - cloudautonomousvmcluster
        - exadbvmcluster
        - autonomousdatabase
    RequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        The only valid characters for request IDs are letters, numbers,

        underscore, and dash.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
  schemas:
    ExternalLocationSummariesMetadatumSummary:
      description: Flat Map of CSP Region to OCI Region
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        externalLocation:
          $ref: '#/components/schemas/ExternalLocationSummary'
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        ociRegion:
          description: OCI region identifier https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
          example: us-ashburn-1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
      required:
      - ociRegion
      - definedTags
      - freeformTags
      type: object
    Error:
      description: Error response information.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    ExternalLocationSummariesMetadatumSummaryCollection:
      description: 'External location summary information from OCI primitives to any CSP across all regions

        '
      properties:
        items:
          description: List of ExternalLocationSummariesMetadatumSummary
          items:
            $ref: '#/components/schemas/ExternalLocationSummariesMetadatumSummary'
          type: array
      required:
      - items
      type: object
    CspZoneKeyReferenceId:
      description: This is CSP zone key reference
      properties:
        keyName:
          description: KeyName for Azure=AzureSubscriptionId Aws=AwsAccountId GCP=GcpProjectName
          example: AzureSubscriptionId
          type: string
        keyValue:
          description: "Value of keyName\n   GcpProjectName: A human-readable name for your project. The project name isn't used by any Google APIs. You can edit the project name at any time during or after project creation. Project names do not need to be unique.\n   AzureSubscriptionId: A unique alphanumeric string that identifies your Azure subscription.\n   AwsAccountId: a unique 12-digit number that identifies an Amazon Web Services (AWS) account\n"
          example: 1234
          type: string
      required:
      - keyValue
      - keyName
      type: object
    ExternalLocationDetail:
      description: External location for CSP Region, CSP-Physical-AZ, CSP-Logical-AZ
      properties:
        cspLogicalAz:
          description: A mapping of CSP physical availability zone to CSP logical availability zone.
          example: logical-az-1
          type: string
        cspLogicalAzContext:
          description: AWS Account Id, Azure Subscription Id or GCP Entitlement Id
          example: 4aa7be2d-ffd6-4657-828b-31ca25e39985
          type: string
        cspLogicalAzDisplayName:
          description: User friendly display name for cspLogicalAZ
          example: Availability Zone 1
          type: string
        cspPhysicalAz:
          description: A mapping of OCI site group name to CSP physical availability zone name
          example: eastus-az1
          type: string
        cspPhysicalAzDisplayName:
          description: User friendly display name for cspPhysicalAZ
          example: South Central US 3
          type: string
        cspRegion:
          description: CSP region corresponding to the given OCI region
          example: germanywestcentral
          type: string
        cspRegionDisplayName:
          description: CSP region display Name corresponding to the given OCI region
          example: Germany West Central
          type: string
        cspZoneKeyReferenceId:
          $ref: '#/components/schemas/CspZoneKeyReferenceId'
        serviceName:
          description: The serviceName that externalLocation map object belongs to.
          enum:
          - ORACLEDBATAZURE
          - ORACLEDBATGOOGLE
          - ORACLEDBATAWS
          example: ORACLEDBATAZURE
          type: string
          x-obmcs-top-level-enum: '#/definitions/SubscriptionType'
      required:
      - cspRegion
      - cspRegionDisplayName
      - cspPhysicalAz
      - cspPhysicalAzDisplayName
      type: object
    ExternalLocationMappingMetadatumSummaryCollection:
      description: 'External location information from OCI primitives to a CSP

        '
      properties:
        items:
          description: List of ExternalLocationMappingMetadatumSummary
          items:
            $ref: '#/components/schemas/ExternalLocationMappingMetadatumSummary'
          type: array
      required:
      - items
      type: object
    ExternalLocationsMetadatumCollection:
      description: 'External location information from OCI primitives to any CSP

        '
      properties:
        items:
          description: List of ExternalLocationsMetadatumSummary
          items:
            $ref: '#/components/schemas/ExternalLocationsMetadatumSummary'
          type: array
      required:
      - items
      type: object
    ExternalLocationSummary:
      description: External location for CSP Region
      properties:
        cspRegion:
          description: CSP region corresponding to the given OCI region
          example: germanywestcentral
          type: string
        cspRegionDisplayName:
          description: CSP region display Name corresponding to the given OCI region
          example: Germany West Central
          type: string
      required:
      - cspRegion
      - cspRegionDisplayName
      type: object
    ExternalLocation:
      description: External location for CSP Region, CSP-Physical-AZ
      properties:
        cspPhysicalAz:
          description: A mapping of OCI site group name to CSP physical availability zone name
          example: eastus-az1
          type: string
        cspPhysicalAzDisplayName:
          description: User friendly display name for cspPhysicalAZ
          example: South Central US 3
          type: string
        cspRegion:
          description: CSP region corresponding to the given OCI region
          example: germanywestcentral
          type: string
        cspRegionDisplayName:
          description: CSP region display Name corresponding to the given OCI region
          example: Germany West Central
          type: string
        serviceName:
          description: The serviceName that externalLocation map object belongs to
          enum:
          - ORACLEDBATAZURE
          - ORACLEDBATGOOGLE
          - ORACLEDBATAWS
          example: ORACLEDBATAZURE
          type: string
          x-obmcs-top-level-enum: '#/definitions/SubscriptionType'
      required:
      - cspRegion
      - cspRegionDisplayName
      - cspPhysicalAz
      - cspPhysicalAzDisplayName
      type: object
    ExternalLocationMappingMetadatumSummary:
      description: 'Flat Map of CSP Region -> CSP-Physical-AZ -> OCI Site Group.

        '
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        externalLocation:
          $ref: '#/components/schemas/ExternalLocation'
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        ociLogicalAd:
          description: OCI logical ad name
          example: EU-ZURICH-1-AD-1
          type: string
        ociPhysicalAd:
          description: OCI physical ad name
          example: GWjz:EU-ZURICH-1-AD-1
          type: string
        ociRegion:
          description: OCI region identifier https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
          example: us-ashburn-1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
      required:
      - externalLocation
      - ociRegion
      - ociPhysicalAd
      - ociLogicalAd
      - freeformTags
      - definedTags
      type: object
    ExternalLocationsMetadatumSummary:
      description: Flat Map of CSP Region -> CSP-Physical-AZ -> CSP-Logical-AZ -> OCI Site Group -> CPG-ID
      properties:
        clusterPlacementGroupId:
          description: Cluster Placement Group OCID
          example: ocid.abc.123
          type: string
        cpgId:
          description: Cluster Placement Group OCID (deprecated representation)
          example: ocid.abc.123
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        externalLocation:
          $ref: '#/components/schemas/ExternalLocationDetail'
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        ociLogicalAd:
          description: OCI logical ad name
          example: EU-ZURICH-1-AD-1
          type: string
        ociPhysicalAd:
          description: OCI physical ad name
          example: GWjz:EU-ZURICH-1-AD-1
          type: string
        ociRegion:
          description: OCI region identifier https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
          example: us-ashburn-1
          type: string
        partnerCloudAccountName:
          description: User friendly name of account name for customer's subscription
          type: string
        partnerCloudAccountUrl:
          description: Direct URL to partner cloud for customer's account
          type: string
        partnerCloudName:
          description: Partner Cloud Name based on service name
          example: Azure
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
      required:
      - externalLocation
      - ociRegion
      - ociPhysicalAd
      - cpgId
      - clusterPlacementGroupId
      - definedTags
      - freeformTags
      type: object
  responses:
    DefaultError:
      description: An error has occurred.
      headers:
        opc-request-id:
          description: Unique identifier for the request
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  definedTags:
    additionalProperties:
      additionalProperties:
        description: 'The value of the tag. Only the String type is supported.

          '
        type: object
      description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


        Example: `{"CostCenter": "42"}`

        '
      type: object
    description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

      For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


      Example: `{"Operations": {"CostCenter": "42"}}`

      '
    type: object
  etag:
    description: 'For optimistic concurrency control. See `if-match`.

      '
    type: string
  freeformTags:
    additionalProperties:
      type: string
    description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

      For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


      Example: `{"Department": "Finance"}`

      '
    type: object
  opc-next-page:
    description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

      important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

      '
    type: string
  opc-request-id:
    description: 'Unique Oracle-assigned identifier for the request. If you need to contact

      Oracle about a particular request, please provide the request ID.

      '
    type: string
  opc-work-request-id:
    description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

      Use GetWorkRequest with this ID to track the status of the request.

      '
    type: string
  retry-after:
    description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
    type: integer
  systemTags:
    additionalProperties:
      additionalProperties:
        description: 'The value of the tag. Only the String type is supported.

          '
        type: object
      description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


        Example: `{"free-tier-retained": "true"}`

        '
      type: object
    description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


      Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

      '
    type: object
  x-headers: null
  x-properties: null
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.omhub.cp