Help Center/ Data Lake Insight/ User Guide/ Submitting a Flink Job Using DLI/ Adding Tags to a Flink Job
Updated on 2024-11-08 GMT+08:00
View PDF
Share

Adding Tags to a Flink Job

A tag is a key-value pair customized by users and used to identify cloud resources. It helps users to classify and search for cloud resources. A tag consists of a tag key and a tag value.

DLI allows you to add tags to Flink jobs. You can add tags to Flink jobs to identify information such as the project name, service type, and background. If you use tags in other cloud services, you are advised to create the same tag key-value pairs for cloud resources used by the same business to keep consistency.

DLI supports the following two types of tags:

  • Resource tags: indicate non-global tags created on DLI.

If your organization has configured tag policies for DLI, add tags to resources based on the policies. If a tag does not comply with the tag policies, resource creation may fail. Contact your organization administrator to learn more about tag policies.

This section includes the following content:

Managing a Job Tag

DLI allows you to add, modify, or delete tags for jobs.

  1. In the left navigation pane of the DLI management console, choose Job Management > Flink Jobs. The Flink Jobs page is displayed.
  2. Click the name of the job to be viewed. The Job Details page is displayed.
  3. Click Tags to display the tag information about the current job.

    Figure 1 Managing a job tag

  4. Click Add/Edit Tag to open to the Add/Edit Tag dialog box.
  5. Configure the tag parameters in the Add/Edit Tag dialog box.

    Figure 2 Adding a tag
    Table 1 Tag parameters

    Parameter

    Description

    Tag key

    You can perform the following operations:

    • Click the text box and select a predefined tag key from the drop-down list.

      To add a predefined tag, you need to create one on TMS and then select it from the Tag key drop-down list. You can click View predefined tags to go to the Predefined Tags page of the TMS console. Then, click Create Tag in the upper corner of the page to create a predefined tag.

      For details, see Creating Predefined Tags in Tag Management Service User Guide.

    • Enter a tag key in the text box.
      NOTE:

      A tag key can contain a maximum of 128 characters. Only letters, numbers, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

    Tag value

    You can perform the following operations:

    • Click the text box and select a predefined tag value from the drop-down list.
    • Enter a tag value in the text box.
      NOTE:

      A tag value can contain a maximum of 255 characters. Only letters, numbers, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.
    • A maximum of 20 tags can be added.
    • Only one tag value can be added to a tag key.
    • The key name in each resource must be unique.

  6. Click OK.
  7. (Optional) In the tag list, locate the row where the tag you want to delete resides, click Delete in the Operation column to delete the tag.

Searching for a Job by Tag

If tags have been added to a job, you can search for the job by setting tag filtering conditions to quickly find it.

  1. In the left navigation pane of the DLI management console, choose Job Management > Flink Jobs. The Flink Jobs page is displayed.
  2. In the upper right corner of the page, click the search box and select Tags.

    Figure 3 Searching for jobs by tag

  3. Choose a tag key and value as prompted. If no tag key or value is available, create a tag for the job. For details, see Managing a Job Tag.
  4. Choose other tags to generate a tag combination for job search.
  5. Click search icon. The target job will be displayed in the job list.