DATASOURCE::PAI::Service - Resource Orchestration Service

DATASOURCE::PAI::Service is used to query the information about a service in Elastic Algorithm Service (EAS).

Syntax

{
  "Type": "DATASOURCE::PAI::Service",
  "Properties": {
    "ServiceName": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ServiceName

String

Yes

The name of the EAS service.

None.

RefreshOptions

String

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

ServiceGroup: the group to which the service belongs.
Message: the summary of the service.
Memory: the memory that you applied for each instance.
CurrentVersion: the current version of the model.
RunningInstance: the number of instances for the running service.
Cpu: the CPU that you applied for each instance.
Image: the data image of the service.
Gpu: the GPU that you applied for each instance.
CallerUid: the user ID of the account that is used to create the service.
Reason: the reason why the service is in the current state.
TotalInstance: the total number of instances of the service.
ServiceConfig: the configurations of the service.
AccessToken: the request token of the service.
InternetEndpoint: the public endpoint of the service.
ResourceAlias: the alias of the resource group to which the service belongs.
CreateTime: the time when the service was created.
Resource: the resource group to which the service belongs.
Labels: the tags of the service.
ExtraData: the additional information about the service.
Namespace: the namespace to which the service belongs.
Weight: the weight of the canary release for the service.
Role: the role of the service.
PendingInstance: the number of instances for the suspended service.
LatestVersion: the latest version of the service.
ServiceName: the name of the service.
SafetyLock: the security lock of the service.
UpdateTime: the time when the service was updated.
ServiceUid: the ID of the service. The value of this property is the same as the value of the ServiceId property.
RoleAttrs: the additional attributes of the service role.
ParentUid: the user ID of the Alibaba Cloud account that is used to create the service.
IntranetEndpoint: the internal endpoint of the service.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ServiceName:
    Type: String
    Description:
      en: The name of the service.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PAI::Service
    Properties:
      ServiceName:
        Ref: ServiceName
Outputs:
  ServiceGroup:
    Description: The group to which the service belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceGroup
  Message:
    Description: The summary of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Message
  Memory:
    Description: The memory that you applied for each instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Memory
  CurrentVersion:
    Description: The current version of the model.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CurrentVersion
  RunningInstance:
    Description: The number of instances for the running service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RunningInstance
  Cpu:
    Description: The CPU that you applied for each instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Cpu
  Image:
    Description: The data image of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Image
  Gpu:
    Description: The GPU that you applied for each instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Gpu
  CallerUid:
    Description: The user ID of the account that is used to create the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CallerUid
  Reason:
    Description: The reason why the service is in the current state.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Reason
  TotalInstance:
    Description: The total number of instances of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TotalInstance
  ServiceConfig:
    Description: The configurations of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceConfig
  AccessToken:
    Description: The request token of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AccessToken
  InternetEndpoint:
    Description: The public endpoint of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InternetEndpoint
  ResourceAlias:
    Description: The alias of the resource group to which the service belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceAlias
  CreateTime:
    Description: The time when the service was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  Resource:
    Description: The resource group to which the service belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Resource
  Labels:
    Description: The tags of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Labels
  ExtraData:
    Description: The additional information about the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExtraData
  Namespace:
    Description: The namespace of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Namespace
  Weight:
    Description: The weight of the canary release for the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Weight
  Role:
    Description: The role of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Role
  PendingInstance:
    Description: The number of instances for the suspended service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PendingInstance
  LatestVersion:
    Description: The latest version of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LatestVersion
  ServiceName:
    Description: The name of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceName
  SafetyLock:
    Description: The security lock of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SafetyLock
  UpdateTime:
    Description: The time when the service was updated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdateTime
  ServiceUid:
    Description: The ID of the service. The value of this property is the same as the value of ServiceId.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceUid
  RoleAttrs:
    Description: The additional attributes of the service role.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RoleAttrs
  ParentUid:
    Description: The user ID of the Alibaba Cloud account that is used to create the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParentUid
  IntranetEndpoint:
    Description: The private endpoint of the service.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IntranetEndpoint

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ServiceName": {
      "Type": "String",
      "Description": {
        "en": "The name of the service."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PAI::Service",
      "Properties": {
        "ServiceName": {
          "Ref": "ServiceName"
        }
      }
    }
  },
  "Outputs": {
    "ServiceGroup": {
      "Description": "The group to which the service belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceGroup"
        ]
      }
    },
    "Message": {
      "Description": "The summary of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Message"
        ]
      }
    },
    "Memory": {
      "Description": "The memory that you applied for each instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Memory"
        ]
      }
    },
    "CurrentVersion": {
      "Description": "The current version of the model.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CurrentVersion"
        ]
      }
    },
    "RunningInstance": {
      "Description": "The number of instances for the running service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RunningInstance"
        ]
      }
    },
    "Cpu": {
      "Description": "The CPU that you applied for each instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Cpu"
        ]
      }
    },
    "Image": {
      "Description": "The data image of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Image"
        ]
      }
    },
    "Gpu": {
      "Description": "The GPU that you applied for each instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Gpu"
        ]
      }
    },
    "CallerUid": {
      "Description": "The user ID of the account that is used to create the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CallerUid"
        ]
      }
    },
    "Reason": {
      "Description": "The reason why the service is in the current state.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Reason"
        ]
      }
    },
    "TotalInstance": {
      "Description": "The total number of instances of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TotalInstance"
        ]
      }
    },
    "ServiceConfig": {
      "Description": "The configurations of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceConfig"
        ]
      }
    },
    "AccessToken": {
      "Description": "The request token of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AccessToken"
        ]
      }
    },
    "InternetEndpoint": {
      "Description": "The public endpoint of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InternetEndpoint"
        ]
      }
    },
    "ResourceAlias": {
      "Description": "The alias of the resource group to which the service belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceAlias"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the service was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "Resource": {
      "Description": "The resource group to which the service belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Resource"
        ]
      }
    },
    "Labels": {
      "Description": "The tags of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Labels"
        ]
      }
    },
    "ExtraData": {
      "Description": "The additional information about the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExtraData"
        ]
      }
    },
    "Namespace": {
      "Description": "The namespace of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Namespace"
        ]
      }
    },
    "Weight": {
      "Description": "The weight of the canary release for the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Weight"
        ]
      }
    },
    "Role": {
      "Description": "The role of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Role"
        ]
      }
    },
    "PendingInstance": {
      "Description": "The number of instances for the suspended service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PendingInstance"
        ]
      }
    },
    "LatestVersion": {
      "Description": "The latest version of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LatestVersion"
        ]
      }
    },
    "ServiceName": {
      "Description": "The name of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceName"
        ]
      }
    },
    "SafetyLock": {
      "Description": "The security lock of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SafetyLock"
        ]
      }
    },
    "UpdateTime": {
      "Description": "The time when the service was updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdateTime"
        ]
      }
    },
    "ServiceUid": {
      "Description": "The ID of the service. The value of this property is the same as the value of ServiceId.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceUid"
        ]
      }
    },
    "RoleAttrs": {
      "Description": "The additional attributes of the service role.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RoleAttrs"
        ]
      }
    },
    "ParentUid": {
      "Description": "The user ID of the Alibaba Cloud account that is used to create the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParentUid"
        ]
      }
    },
    "IntranetEndpoint": {
      "Description": "The private endpoint of the service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IntranetEndpoint"
        ]
      }
    }
  }
}