REST API for MySQL Cloud Service

Create and Assign Tags

post

/paas/api/v1.1/tags/{identityDomainId}/tags

This endpoint is not available on Oracle Cloud at Customer.

Creates instance tags and assigns them to existing resources in the same request. You can also create instance tags without creating assignments.

Note: This endpoint can be used to assign existing account non-metering tags to resources. The endpoint cannot be used to assign existing account metering tags, or create account tags of any type.

Request

Supported Media Types

application/json

Path Parameters

identityDomainId: string

Identity domain ID for the MySQL Cloud Service account.

Header Parameters

X-ID-TENANT-NAME: string

Identity domain ID for the MySQL Cloud Service account.

The request body defines the tags to create and the services to assign the tags to.

Root Schema : createassigntags-request

Type: object

Show Source

assignments(optional): object assignments

Groups the tag assignments to create.
tags(optional): array tags

Groups the instance tags to create.
For account non-metering tags, groups the tags to assign.
Each tag object is a key/value pair.

{
    "properties":{
        "assignments":{
            "type":"object",
            "description":"Groups the tag assignments to create.",
            "properties":{
                "services":{
                    "type":"array",
                    "description":"Groups the service resources to tag.<p>With instance tags, each new tag created is assigned to each service resource.<p>With account non-metering tags, each tag is assigned to each service resource.",
                    "items":{
                        "$ref":"#/definitions/assign-request"
                    }
                }
            }
        },
        "tags":{
            "type":"array",
            "description":"Groups the instance tags to create.<p>For account non-metering tags, groups the tags to assign.<p>Each tag object is a key/value pair.",
            "items":{
                "$ref":"#/definitions/tagscreate-request"
            }
        }
    }
}

Nested Schema : assignments

Type: object

Groups the tag assignments to create.

Show Source

services(optional): array services

Groups the service resources to tag.
With instance tags, each new tag created is assigned to each service resource.
With account non-metering tags, each tag is assigned to each service resource.

{
    "type":"object",
    "description":"Groups the tag assignments to create.",
    "properties":{
        "services":{
            "type":"array",
            "description":"Groups the service resources to tag.<p>With instance tags, each new tag created is assigned to each service resource.<p>With account non-metering tags, each tag is assigned to each service resource.",
            "items":{
                "$ref":"#/definitions/assign-request"
            }
        }
    }
}

Nested Schema : tags

Type: array

Groups the instance tags to create.

For account non-metering tags, groups the tags to assign.

Each tag object is a key/value pair.

Show Source

[0]: object tagscreate-request

Each tag is a key/value pair.
For account non-metering tags, specify the existing tag key and value for assignment.

{
    "type":"array",
    "description":"Groups the instance tags to create.<p>For account non-metering tags, groups the tags to assign.<p>Each tag object is a key/value pair.",
    "items":{
        "$ref":"#/definitions/tagscreate-request"
    }
}

Nested Schema : services

Type: array

Groups the service resources to tag.

With instance tags, each new tag created is assigned to each service resource.

With account non-metering tags, each tag is assigned to each service resource.

Show Source

[0]: object assign-request

{
    "type":"array",
    "description":"Groups the service resources to tag.<p>With instance tags, each new tag created is assigned to each service resource.<p>With account non-metering tags, each tag is assigned to each service resource.",
    "items":{
        "$ref":"#/definitions/assign-request"
    }
}

Nested Schema : assign-request

Type: object

Show Source

serviceName: string

Name of the service instance to tag (or untag).
serviceType(optional): string

Type of service.
For example, MySQL for a MySQL Cloud Service instance and DBaas for a Database Cloud Service deployment.

{
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"Name of the service instance to tag (or untag)."
        },
        "serviceType":{
            "type":"string",
            "description":"Type of service. <p>For example, <code>MySQL</code> for a MySQL Cloud Service instance and <code>DBaas</code> for a Database Cloud Service deployment."
        }
    },
    "required":[
        "serviceName"
    ]
}

Nested Schema : tagscreate-request

Type: object

Each tag is a key/value pair.

For account non-metering tags, specify the existing tag key and value for assignment.

Show Source

key: string

Specify the key for this instance tag to create. A tag key can contain letters, numbers, dashes (-), and underscores ( _ ), and it can contain up to 128 characters.
value(optional): string

Specify the value for this instance tag to create. A tag value can contain up to 256 characters and is case-sensitive.
Default value is an empty string (if you do not provide a specific value).

{
    "description":"Each tag is a key/value pair.<p>For account non-metering tags, specify the existing tag key and value for assignment.",
    "properties":{
        "key":{
            "type":"string",
            "description":"Specify the key for this instance tag to create. A tag key can contain letters, numbers, dashes (-), and underscores ( _ ), and it can contain up to 128 characters."
        },
        "value":{
            "type":"string",
            "description":"Specify the value for this instance tag to create. A tag value can contain up to 256 characters and is case-sensitive.<p>Default value is an empty string (if you do not provide a specific value)."
        }
    },
    "required":[
        "key"
    ]
}

Response

Supported Media Types

application/json

200 Response

OK.

The response body contains information about all tags and their assignments.

Root Schema : tagsassignments-response

Type: array

The response body contains information about all tags and their assignments.

Show Source

[0]: object tagsassignments-details

Each object describes a tag and its assignments.

{
    "description":"The response body contains information about all tags and their assignments.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/tagsassignments-details"
    }
}

Nested Schema : tagsassignments-details

Type: object

Each object describes a tag and its assignments.

Show Source

assignments(optional): object assignments

Groups assignment details for this tag.
isExternalTag(optional): boolean

Flag to identify an account tag.
This property is only shown if the value is true.
isMeteringTag(optional): boolean

Flag to identify an account tag that is used for metering.
This property is only shown if the value is true.
isPlacementTag(optional): boolean

Flag for internal use only.
key(optional): string

Tag key.
state(optional): string

Whether a tag is created or is in the process of being deleted. Possible values: Ready, Deleting
This property is not shown when you use the Create and Assign Tags endpoint or Create and Delete Assignments endpoint.
value(optional): string

Tag value.

{
    "description":"Each object describes a tag and its assignments.",
    "properties":{
        "isPlacementTag":{
            "type":"boolean",
            "description":"Flag for internal use only."
        },
        "isExternalTag":{
            "type":"boolean",
            "description":"Flag to identify an account tag.<p>This property is only shown if the value is <code>true</code>."
        },
        "isMeteringTag":{
            "type":"boolean",
            "description":"Flag to identify 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 is created or is in the process of being deleted. Possible values: <code>Ready</code>, <code>Deleting</code><p>This property is not shown when you use the Create and Assign Tags endpoint or Create and Delete Assignments endpoint."
        },
        "assignments":{
            "type":"object",
            "description":"Groups assignment details for this tag.",
            "properties":{
                "services":{
                    "type":"array",
                    "description":"Groups the service resources assigned with this tag.",
                    "items":{
                        "$ref":"#/definitions/serviceassignment-details"
                    }
                }
            }
        }
    }
}

Nested Schema : assignments

Type: object

Groups assignment details for this tag.

Show Source

services(optional): array services

Groups the service resources assigned with this tag.

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

Nested Schema : services

Type: array

Groups the service resources assigned with this tag.

Show Source

[0]: object serviceassignment-details

Each object describes a service resource.

{
    "type":"array",
    "description":"Groups the service resources assigned with this tag.",
    "items":{
        "$ref":"#/definitions/serviceassignment-details"
    }
}

Nested Schema : serviceassignment-details

Type: object

Each object describes a service resource.

Show Source

assignmentState(optional): string

Whether tag assignment or unassignment is in progress. Possible values: Assigning, Unassigning, Assigned
This property is not shown when you use the Create and Assign Tags endpoint or Create and Delete Assignments endpoint.
serviceName(optional): string

Name of the service instance.
serviceType(optional): string

Type of service.
For example, MySQL for a MySQL Cloud Service instance and DBaas for a Database Cloud Service deployment.

{
    "description":"Each object describes a service resource.",
    "properties":{
        "assignmentState":{
            "type":"string",
            "description":"Whether tag assignment or unassignment is in progress. Possible values: <code>Assigning</code>, <code>Unassigning</code>, <code>Assigned</code><p>This property is not shown when you use the Create and Assign Tags endpoint or Create and Delete Assignments endpoint."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the service instance."
        },
        "serviceType":{
            "type":"string",
            "description":"Type of service. <p>For example, <code>MySQL</code> for a MySQL Cloud Service instance and <code>DBaas</code> for a Database Cloud Service deployment."
        }
    }
}

400 Response

Bad request.

Root Schema : failed-response

Type: object

Show Source

details(optional): object details

Groups details of a bad request, not found response, or conflict response.

{
    "properties":{
        "details":{
            "type":"object",
            "description":"Groups details of a bad request, not found response, or conflict response.",
            "properties":{
                "issues":{
                    "type":"array",
                    "description":"List of operation issues found.",
                    "items":{
                        "type":"string"
                    }
                },
                "message":{
                    "type":"string",
                    "description":"Operation message."
                }
            }
        }
    }
}

Nested Schema : details

Type: object

Groups details of a bad request, not found response, or conflict response.

Show Source

issues(optional): array issues

List of operation issues found.
message(optional): string

Operation message.

{
    "type":"object",
    "description":"Groups details of a bad request, not found response, or conflict response.",
    "properties":{
        "issues":{
            "type":"array",
            "description":"List of operation issues found.",
            "items":{
                "type":"string"
            }
        },
        "message":{
            "type":"string",
            "description":"Operation message."
        }
    }
}

Nested Schema : issues

Type: array

List of operation issues found.

Show Source

[0]: string

{
    "type":"array",
    "description":"List of operation issues found.",
    "items":{
        "type":"string"
    }
}

Examples

The following example shows how to create tags and assign them in the same POST request 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 POST -u username:password -d @createassigntags.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags"

Example of Request Body

The following example shows the contents of the request body in JSON format.

At least one tag key/value pair must be specified. The request may contain a list of existing resources to which the new tag will be assigned.

{
  "tags": [
    {
      "key": "environment",
      "value": "qa"
    }
  ],
  "assignments": {
    "services": [
      {
        "serviceType": "MySQLCS",
        "serviceName": "MyExample"
      }
    ]
  }
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Fri, 05 Jan 2018 19:02:23 GMT
Content-Length: 142
Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json
X-ORACLE-DMS-ECID: 1bcaf164-c5b5-4c70-b7d8-5a24c1e19493-00000a8a
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
Access-Control-Allow-Origin: *l/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/1450657
Content-Type: application/json

Example of Response Body

The following shows an example of the response body in JSON format.

One tag is created. The new tag is assigned to one service resource.

[
   {
      "key":"environment",
      "value":"qa",
      "assignments":{
         "services":[
            {
               "serviceType":"MySQLCS",
               "serviceName":"MyExample"
            }
         ]
      }
   }
]