All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::ARMS::XTraceApp

Last Updated:Feb 25, 2025

ALIYUN::ARMS::XTraceApp is used to create an application monitoring task.

Syntax

{
  "Type": "ALIYUN::ARMS::XTraceApp",
  "Properties": {
    "XTraceAppName": String,
    "ResourceGroupId": String,
    "Tags": List
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

XTraceAppName

String

Yes

No

The name of the application.

None.

ResourceGroupId

String

No

Yes

The ID of the resource group.

None.

Tags

List

No

Yes

The tags that you want to add to the application.

You can add up to 20 tags.

For more information, see Tags properties.

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Property

Type

Required

Editable

Description

Constraint

Key

String

Yes

No

The tag key.

None.

Value

String

No

No

The tag value.

None.

Return values

Fn::GetAtt

  • ResourceGroupId: the ID of the resource group.

  • CreateTime: the timestamp that indicates when the task was created.

  • Pid: the ID of the application.

  • Tags: the tags that are added to the application.

  • XTraceAppName: the name of the application.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  XTraceAppName:
    Type: String
    Description:
      en: The name of the resource.
    Required: true
    Default: arms-k8s-demo
Resources:
  ExtensionResource:
    Type: ALIYUN::ARMS::XTraceApp
    Properties:
      XTraceAppName:
        Ref: XTraceAppName
Outputs:
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceGroupId
  CreateTime:
    Description: The creation time of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  Pid:
    Description: the identify of application.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Pid
  Tags:
    Description: The tags of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags
  XTraceAppName:
    Description: The name of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - XTraceAppName
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "XTraceAppName": {
      "Type": "String",
      "Description": {
        "en": "The name of the resource."
      },
      "Required": true,
      "Default": "arms-k8s-demo"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ARMS::XTraceApp",
      "Properties": {
        "XTraceAppName": {
          "Ref": "XTraceAppName"
        }
      }
    }
  },
  "Outputs": {
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "Pid": {
      "Description": "the identify of application.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Pid"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    },
    "XTraceAppName": {
      "Description": "The name of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "XTraceAppName"
        ]
      }
    }
  }
}