All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::EDAS::Applications

Last Updated:Nov 26, 2024

DATASOURCE::EDAS::Applications is used to query applications.

Syntax

{
  "Type": "DATASOURCE::EDAS::Applications",
  "Properties": {
    "LogicalRegionId": String,
    "ResourceGroupId": String,
    "ClusterId": String,
    "AppName": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

LogicalRegionId

String

No

Yes

The ID of the microservices namespace by which you want to query applications.

None.

ResourceGroupId

String

No

Yes

The ID of the resource group by which you want to query applications.

None.

ClusterId

String

No

Yes

The ID of the cluster by which you want to query applications.

None.

AppName

String

No

Yes

The name of the application by which you want to query applications.

None.

RefreshOptions

String

No

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

  • Never (default): does not refresh data source resources when the stack is updated.

  • Always: refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

  • AppIds: the IDs of the applications.

  • Applications: details of the applications.

Property

Type

Description

Constraint

AppIds

List

The IDs of the applications.

None.

Applications

List

Details of the applications.

None.

AppId

String

The application ID.

None.

ResourceGroupId

String

The ID of the resource group.

None.

ClusterId

String

The cluster ID.

None.

RegionId

String

The region ID.

None.

ClusterType

Number

The cluster type.

Valid values:

  • 2: Elastic Compute Service (ECS) cluster

  • 3: self-managed Kubernetes cluster in Enterprise Distributed Application Service (EDAS)

  • 5: Container Service for Kubernetes (ACK) cluster

RunningInstanceCount

Number

The number of running application instances.

None.

Name

String

The application name.

None.

BuildPackageId

Number

The build package number of EDAS Container.

None.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AppName:
    Type: String
    Description: The application name keyword.
Resources:
  Applications:
    Type: DATASOURCE::EDAS::Applications
    Properties:
      AppName:
        Ref: AppName
Outputs:
  Applications:
    Description: The list of applications.
    Value:
      Fn::GetAtt:
        - Applications
        - Applications
  AppIds:
    Description: The list of application IDs.
    Value:
      Fn::GetAtt:
        - Applications
        - AppIds
                    
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AppName": {
      "Type": "String",
      "Description": "The application name keyword."
    }
  },
  "Resources": {
    "Applications": {
      "Type": "DATASOURCE::EDAS::Applications",
      "Properties": {
        "AppName": {
          "Ref": "AppName"
        }
      }
    }
  },
  "Outputs": {
    "Applications": {
      "Description": "The list of applications.",
      "Value": {
        "Fn::GetAtt": [
          "Applications",
          "Applications"
        ]
      }
    },
    "AppIds": {
      "Description": "The list of application IDs.",
      "Value": {
        "Fn::GetAtt": [
          "Applications",
          "AppIds"
        ]
      }
    }
  }
}