Jump to

• Request
• Response
• Examples

View Tags for a Service Instance

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/tags

Returns tagging information for the specified MySQL Cloud Service instance.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the MySQL Cloud Service account.
• serviceId: string
  Name of the MySQL Cloud Service instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the MySQL Cloud Service account.

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

The response body contains tagging information.

Root Schema : gettags-responsem

Type: object

The response body contains tagging information.

Show Source

• items(optional): array items
  Groups tags.

{
    "description":"The response body contains tagging information.",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Groups tags.",
            "items":{
                "$ref":"#/definitions/gettags-details"
            }
        }
    }
}

Nested Schema : items

Type: array

Groups tags.

Show Source

• [0]: object gettags-details
  Each object is a tag.

{
    "type":"array",
    "description":"Groups tags.",
    "items":{
        "$ref":"#/definitions/gettags-details"
    }
}

Nested Schema : gettags-details

Type: object

Each object is a tag.

Show Source

• assignments(optional): object assignments
  Groups assignment details for this tag.
• isExternalTag(optional): boolean
  Flag that identifies this tag as an account tag.

  This property is only shown if the value is true.

• isMeteringTag(optional): boolean
  Flag that identifies this tag as an account tag that is used for metering.

  This property is only shown if the value is true.

• isPlacementTag(optional): boolean
  Flag that identifies this tag as a service instance placement tag.
• key(optional): string
  Tag key.
• state(optional): string
  Whether a tag has been created or is in the process of being deleted. Possible values: Ready, Deleting
• value(optional): string
  Tag value.

{
    "description":"Each object is a tag.",
    "properties":{
        "isPlacementTag":{
            "type":"boolean",
            "description":"Flag that identifies this tag as a service instance placement tag."
        },
        "isExternalTag":{
            "type":"boolean",
            "description":"Flag that identifies this tag as an account tag.<p>This property is only shown if the value is <code>true</code>."
        },
        "isMeteringTag":{
            "type":"boolean",
            "description":"Flag that identifies this tag as an account tag that is used for metering.<p>This property is only shown if the value is <code>true</code>."
        },
        "key":{
            "type":"string",
            "description":"Tag key."
        },
        "value":{
            "type":"string",
            "description":"Tag value."
        },
        "state":{
            "type":"string",
            "description":"Whether a tag has been created or is in the process of being deleted. Possible values: <code>Ready</code>, <code>Deleting</code>"
        },
        "assignments":{
            "type":"object",
            "description":"Groups assignment details for this tag.",
            "properties":{
                "services":{
                    "type":"array",
                    "description":"Groups service details.",
                    "items":{
                        "$ref":"#/definitions/gettagsservice-details"
                    }
                }
            }
        }
    }
}

Nested Schema : assignments

Type: object

Groups assignment details for this tag.

Show Source

• services(optional): array services
  Groups service details.

{
    "type":"object",
    "description":"Groups assignment details for this tag.",
    "properties":{
        "services":{
            "type":"array",
            "description":"Groups service details.",
            "items":{
                "$ref":"#/definitions/gettagsservice-details"
            }
        }
    }
}

Nested Schema : services

Type: array

Groups service details.

Show Source

• [0]: object gettagsservice-details

{
    "type":"array",
    "description":"Groups service details.",
    "items":{
        "$ref":"#/definitions/gettagsservice-details"
    }
}

Nested Schema : gettagsservice-details

Type: object

Show Source

• assignmentState(optional): string
  Whether tag assignment or unassignment is in progress. Possible values: Assigning, Unassigning, Assigned
• serviceName(optional): string
  Name of the service instance.
• serviceType(optional): string
  Type of service.

  For example, MySQLCS for a MySQLCS Service instance and DBaas for a Database Cloud Service deployment.

{
    "properties":{
        "assignmentState":{
            "type":"string",
            "description":"Whether tag assignment or unassignment is in progress. Possible values: <code>Assigning</code>, <code>Unassigning</code>, <code>Assigned</code>"
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the service instance."
        },
        "serviceType":{
            "type":"string",
            "description":"Type of service. <p>For example, <code>MySQLCS</code> for a MySQLCS Service instance and <code>DBaas</code> for a Database Cloud Service deployment."
        }
    }
}

Examples

The following example shows how to retrieve tags for a MySQL Cloud Service instance by submitting a GET request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/ExampleInstance/tags

Example of Response Header

The following shows an example of the response header.

HTTP/1.0 200 Connection established

HTTP/2 200
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
content-language: en
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005Q45AAuAB3z015Rvl3id0007SK0002DM
x-oracle-dms-ecid: 005Q45AAuAB3z015Rvl3id0007SK0002DM
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Sun, 25 Mar 2018 19:02:51 GMT
content-length: 2485

Example of Response Body

The following is an example of the response returned.

{
    "items": [
        {
            "key": "environment",
            "value": "",
            "readOnly": false,
            "assignments": {
                "services": [
                    {
                        "serviceType": "MySQLCS",
                        "serviceName": "ExampleInstance",
                        "assignmentState": "Assigned"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href":"https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/ExampleInstance/tags/environment/"
                }
            ],
            "state": "Ready"
        },
        {
            "key": "department",
            "value": "dev",
            "readOnly": false,
            "assignments": {
                "services": [
                    {
                        "serviceType": "MySQLCS",
                        "serviceName": "ExampleInstance",
                        "assignmentState": "Assigned"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/ExampleInstance/tags/department/dev"
                }
            ],
            "state": "Ready"
        },
        {
            "key": "application",
            "value": "mysql",
            "readOnly": true,
            "isMeteringTag": true,
            "isExternalTag": true,
            "assignments": {
                "services": [
                    {
                        "serviceType": "MySQLCS",
                        "serviceName": "ExampleInstance",
                        "assignmentState": "Assigned"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/ExampleInstance/tags/application/mysql"
                }
            ],
            "state": "Ready"
        }
    ],
    "limit": 200,
    "hasMore": false,
    "offset": 0,
    "links": [
        {
            "rel": "first",
            "href": "https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/ExampleInstance/tags?offset=0"
        },
        {
            "rel": "last",
            "href": "https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/ExampleInstance/tags?offset=0"
        },
        {
            "rel": "canonical",
            "href": "https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags/"
        },
        {
            "rel": "self",
            "href": "https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/ExampleInstance/tags"
        }
    ]
}