Home PageResource Orchestration ServiceDeveloper ReferenceResource TypesPAIALIYUN::PAIPlugin::Group
Search for Help Content

ALIYUN::PAIPlugin::Group

Updated at: 2025-02-14 09:34
Product
Community

ALIYUN::PAIPlugin::Group is used to create a user group.

Syntax

{
  "Type": "ALIYUN::PAIPlugin::Group",
  "Properties": {
    "Name": String,
    "Source": Integer,
    "Algorithm": String,
    "Column": String,
    "Filter": String,
    "InferenceJobId": String,
    "Project": String,
    "PhoneNumber": String,
    "Remark": String,
    "Table": String,
    "Text": String,
    "Uri": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Property

Type

Required

Editable

Description

Constraint

Name

String

Yes

No

The name of the user group.

None.

Source

Integer

Yes

No

The source of the user group.

Valid values:

  • 0: text. A phone number resides in each row. A maximum of 100 phone numbers is supported.

  • 1: text file. A phone number resides in each row. To use a text file, you can upload the file in the console or specify a custom Object Storage Service (OSS) address. Before you specify a custom OSS address, make sure that authorization is complete in the console.

  • 2: CSV file. You must specify the column names of phone numbers. To use a CSV file, you can upload the file in the console or specify a custom OSS address. Before you specify a custom OSS address, make sure that authorization is complete in the console.

  • 3: MaxCompute table. You must specify the column names of phone numbers.

  • 4: algorithm.

Algorithm

String

No

No

The associated algorithm.

This property must be specified when Source is set to 4.

Column

String

No

No

The column name of the phone number.

This property must be specified when Source is set to 2 or 3 and phone numbers are included.

Filter

String

No

No

The filter condition.

This property must be specified when Source is set to 3.

InferenceJobId

String

No

No

The ID of the prediction job.

This property must be specified when Source is set to 4.

Project

String

No

No

The name of the MaxCompute project.

This property must be specified when Source is set to 3.

PhoneNumber

String

No

No

Specifies whether to include phone numbers.

If the phone numbers of a user group are included, the user group can be used for reach plans.

Remark

String

No

No

The remarks on the user group.

None.

Table

String

No

No

The name of the MaxCompute table.

This property must be specified when Source is set to 3.

Text

String

No

No

The text.

This property must be specified when Source is set to 1.

Uri

String

No

No

The file address.

This property must be specified when Source is set to 1 or 2.

Return values

Fn::GetAtt

  • CreatedTime: the creation time. The time is displayed in UTC+8.

  • Amount: the number of users in the user group.

  • Id: the ID of the user group.

  • Name: the name of the user group.

Examples

YAML
JSON
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PhoneNumber:
    Type: String
    Description:
      en: Whether to include mobile phone numbers. People with mobile phone numbers can be used for reach plans.
    Required: false
  Text:
    Type: String
    Description:
      en: The text of the phone number. This must be specified when Source is 0(Enter phone numbers).
    Required: false
  Source:
    Type: Number
    Description:
      en: |-
        Crowd source. Valid values:
        0: Enter phone numbers.
        1: Single-column CSV File (Phone Numbers).
        2: Multi-column CSV File.
        3: MaxCompute Table.
        4: Algorithm.
    AllowedValues:
      - 0
      - 1
      - 2
      - 3
      - 4
    Required: true
  Name:
    Type: String
    Description:
      en: The name of the user group.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::PAIPlugin::Group
    Properties:
      PhoneNumber:
        Ref: PhoneNumber
      Text:
        Ref: Text
      Source:
        Ref: Source
      Name:
        Ref: Name
Outputs:
  CreatedTime:
    Description: The creation time of the user group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreatedTime
  Amount:
    Description: The number of the user group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Amount
  Id:
    Description: The ID of the user group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Id
  Name:
    Description: The name of the user group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Name

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PhoneNumber": {
      "Type": "String",
      "Description": {
        "en": "Whether to include mobile phone numbers. People with mobile phone numbers can be used for reach plans."
      },
      "Required": false
    },
    "Text": {
      "Type": "String",
      "Description": {
        "en": "The text of the phone number. This must be specified when Source is 0(Enter phone numbers)."
      },
      "Required": false
    },
    "Source": {
      "Type": "Number",
      "Description": {
        "en": "Crowd source. Valid values:\n0: Enter phone numbers.\n1: Single-column CSV File (Phone Numbers).\n2: Multi-column CSV File.\n3: MaxCompute Table.\n4: Algorithm."
      },
      "AllowedValues": [
        0,
        1,
        2,
        3,
        4
      ],
      "Required": true
    },
    "Name": {
      "Type": "String",
      "Description": {
        "en": "The name of the user group."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::PAIPlugin::Group",
      "Properties": {
        "PhoneNumber": {
          "Ref": "PhoneNumber"
        },
        "Text": {
          "Ref": "Text"
        },
        "Source": {
          "Ref": "Source"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "CreatedTime": {
      "Description": "The creation time of the user group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreatedTime"
        ]
      }
    },
    "Amount": {
      "Description": "The number of the user group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Amount"
        ]
      }
    },
    "Id": {
      "Description": "The ID of the user group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Id"
        ]
      }
    },
    "Name": {
      "Description": "The name of the user group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Name"
        ]
      }
    }
  }
}
Previous: ALIYUN::PAIPlugin::CampaignNext: ALIYUN::PAIPlugin::InferenceJob
  • On this page （1, T）
  • Syntax
  • Properties
  • Return values
  • Examples
Feedback