This topic describes how to modify a tag value of multiple resources at a time by using an Operation Orchestration Service (OOS) custom template.

Prerequisites

A tag is bound to resources. For more information, see Create or bind a tag.

Background information

In this topic, a custom template is created in OOS. This template can be used to modify a tag value of hundreds of ECS instances at a time. In this example, a tag value of the ECS instances is changed from OldTagValue to NewTagValue. The corresponding tag key-value pair is changed from TagKey:OldTagValue to TagKey:NewTagValue.
Note
  • You can use the OOS custom template to modify a tag value for up to 1,000 resources at a time. If the number of resources is greater than 1,000, you must execute the template multiple times.
  • You can use the OOS custom template to modify the tag values of any resources that support tagging in the same region. You can modify the API operations in the template to make it applicable to various resources. For more information about resources that support tagging, see Overview. For information about the resources that OOS supports, see List of supported cloud services.

Step 1: Create a custom template

You can perform the following steps to create an OOS custom template to modify a tag value of multiple resources.

  1. Log on to the OOS console.
  2. In the top navigation bar, select a region.
  3. In the left-side navigation pane, click My Templates.
  4. Click Create Template.
  5. In the Create Template dialog box, click the Empty Templates tab, select Empty Templates, and then click OK.
  6. In the Basic Information section on the right of the Create Template page, enter a template name in the Template Name field and add tags.
  7. Click the JSON tab and write code in the code editor. Sample code:
    {
        "Description": "Modify a tag value of multiple resources at a time",
        "FormatVersion": "OOS-2019-06-01",
        "Parameters": {
            "operateId": {
                "Description": "Define the operation ID",
                "Type": "String",
                "MinLength": 1,
                "MaxLength": 64
            },
            "tagKey": {
                "Description": "Current tag key",
                "Type": "String",
                "MinLength": 1,
                "MaxLength": 64
            },
            "tagValue": {
                "Description": "Current tag value",
                "Type": "String",
                "MinLength": 1,
                "MaxLength": 64
            },
            "newTagValue": {
                "Description": "New tag value",
                "Type": "String",
                "MinLength": 1,
                "MaxLength": 64
            }
        },
        "Tasks": [
            {
                "Name": "DescribeInstances_ECS",
                "Action": "ACS::ExecuteAPI",
                "Description": {
                    "en": "Filter ECS instances by tag"
                },
                "Properties": {
                    "Service": "ECS",
                    "API": "DescribeInstances",
                    "AutoPaging": true,
                    "Parameters": {
                        "Tags": [
                            {
                                "Key": "{{ tagKey }}",
                                "Value": "{{ tagValue }}"
                            }
                        ]
                    }
                },
                "Outputs": {
                    "Instances": {
                        "Type": "List",
                        "ValueSelector": "Instances.Instance[].InstanceId"
                    }
                }
            },
            {
                "Name": "TagResources_ECS_Instances",
                "Action": "ACS::ExecuteAPI",
                "Description": {
                    "en": "Update the tag of ECS instances"
                },
                "Properties": {
                    "Service": "ECS",
                    "API": "TagResources",
                    "Parameters": {
                        "Tags": [
                            {
                                "Key": "{{ tagKey }}",
                                "Value": "{{ newTagValue }}"
                            }
                        ],
                        "ResourceType": "Instance",
                        "ResourceIds": [
                            "{{ACS::TaskLoopItem}}"
                        ]
                    }
                },
                "Loop": {
                    "MaxErrors": "100%",
                    "Concurrency": 20,
                    "Items": "{{DescribeInstances_ECS.Instances}}"
                }
            }
        ],
        "Outputs": {}
    }
  8. Click Create Template.

Step 2: Execute the custom template

You can perform the following steps to execute the template created in Step 1 to modify a tag value of multiple resources.

  1. In the left-side navigation pane, click My Templates.
  2. Find the template created in Step 1 and click Create Execution in the Actions column.
  3. On the Create page, enter an execution description and select an execution mode in the Basic Information step. Then, click Next: Parameter Settings.
  4. In the Parameter Settings step, configure parameters and click Next: OK.

    You must configure the following parameters in this step:

    • operateId: the operation ID, which is used to identify an operation. You can enter an operation ID.
    • tagKey: the current tag key. In this example, the current tag key is TagKey.
    • tagValue: the current tag value. In this example, the current tag value is OldTagValue.
    • newTagValue: the new tag value. In this example, the new tag value is NewTagValue.
  5. Click Create. The execution details page appears. You can view the execution results.
    Note If the execution fails, you can check the logs for the cause of the failure and make adjustments accordingly.