All Products
Search
Document Center

Resource Orchestration Service:ALB resources

Last Updated:Apr 02, 2026

AssociationProperty Values

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ALB::ACL::ACLId

An Application Load Balancer (ALB) access control list (ACL).

RegionId: The region ID. This defaults to the region of the stack.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "RegionId"
        },
        "AlbACLId":{
          "AssociationProperty":"ALIYUN::ALB::ACL::ACLId",
          "AssociationPropertyMetadata": {
             "RegionId": "${RegionId}"
          },
          "Type":"String"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: RegionId
      AlbACLId:
        AssociationProperty: ALIYUN::ALB::ACL::ACLId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
        Type: String
  • Example description

    To retrieve the ID of an ALB access control list (ACL), set the AssociationProperty attribute of the AlbACLId parameter to ALIYUN::ALB::ACL::ACLId.

ALIYUN::ALB::Instance::InstanceId

An ALB instance.

  • RegionId: The region ID. This defaults to the region of the stack.

  • VpcId: The virtual private cloud (VPC) ID.

  • AddressType: The network type.

  • ZoneId: The zone ID.

  • PayType: The billing method for the instance.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "AlbInstanceId":{
          "AssociationProperty":"ALIYUN::ALB::Instance::InstanceId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      AlbInstanceId:
        AssociationProperty: ALIYUN::ALB::Instance::InstanceId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    To retrieve the ID of an ALB instance, set the AssociationProperty attribute of the AlbInstanceId parameter to ALIYUN::ALB::Instance::InstanceId.

ALIYUN::ALB::LoadBalancer::LoadBalancerId

The ID of an ALB instance.

  • RegionId: The region ID. This defaults to the region of the stack.

  • VpcId: The virtual private cloud (VPC) ID.

  • AddressType: The network type.

  • ZoneId: The zone ID.

  • PayType: The billing method for the instance.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "AlbLoadBalancerId":{
          "AssociationProperty":"ALIYUN::ALB::LoadBalancer::LoadBalancerId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      AlbLoadBalancerId:
        AssociationProperty: ALIYUN::ALB::LoadBalancer::LoadBalancerId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    To retrieve the ID of an ALB instance, set the AssociationProperty attribute of the AlbLoadBalancerId parameter to ALIYUN::ALB::LoadBalancer::LoadBalancerId.

ALIYUN::Resource::Data::API

The ID of an ALB server group.

  • Parameters.ServerGroupType: The server type.

    • Instance: The server type, which includes ECS, ENI, and ECI instances.

    • Ip: The IP address type.

    • Fc: The Function Compute type.

    • If this parameter is left empty, all server types are queried.

  • Parameters.ResourceGroupId: The resource group ID.

  • Parameters.VpcId: The virtual private cloud (VPC) ID.

  • Parameters.ServerGroupIds: A list of server group IDs. You can query up to 20 server group IDs at a time.

  • Parameters.ServerGroupNames: A list of server group names. You can query up to 10 server group names at a time.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ServerGroup": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::Resource::Data::API",
          "AssociationPropertyMetadata": {
            "APIAction": "alb/ListServerGroups",
            "ValueGetter": "ServerGroupId",
            "LabelGetter": "ServerGroupName",
            "OptionsGetter": "ServerGroups",
            "Pagination": "NextToken",
            "Parameters.ServerGroupType": "Instance",
            "Parameters.ServerGroupNames.1": "Group3"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ServerGroup:
        Type: String
        AssociationProperty: ALIYUN::Resource::Data::API
        AssociationPropertyMetadata:
          APIAction: alb/ListServerGroups
          ValueGetter: ServerGroupId
          LabelGetter: ServerGroupName
          OptionsGetter: ServerGroups
          Pagination: NextToken
          Parameters.ServerGroupType: Instance
          Parameters.ServerGroupNames.1: Group3
  • Example description

    This example demonstrates how to call the QueryServerGroups API operation for Application Load Balancer (ALB). The AssociationProperty attribute of the ServerGroup parameter is set to ALIYUN::Resource::Data::API. The AssociationPropertyMetadata attributes, Parameters.ServerGroupType and Parameters.ServerGroupNames.1, are used to filter the results. By setting ServerGroupType to Instance and ServerGroupNames to Group3, the query retrieves the corresponding server group ID (ServerGroupId) and displays the server group name. For more information, see the QueryServerGroups document.

    Important

    The values of the APIAction, ValueGetter, LabelGetter, OptionsGetter, and Pagination attributes are fixed and cannot be changed. You can customize the values of Parameters.XXXX attributes as required.