ALIYUN::Aligreen::Callback_资源编排(ROS)-阿里云帮助中心

ALIYUN::Aligreen::Callback类型用于创建回调。

语法

{
  "Type": "ALIYUN::Aligreen::Callback",
  "Properties": {
    "CallbackUrl": String,
    "CallbackName": String,
    "CallbackTypes": List,
    "CallbackSuggestions": List,
    "CryptType": Integer
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
CallbackUrl	String	是	是	检测结果回调地址。	无
CallbackName	String	是	是	回调名称。	无
CallbackTypes	List	是	是	回调类型列表。	取值： machineScan：机器审计结果通知 selfAudit：自助审计通知最多支持配置2组类型。
CallbackSuggestions	List	是	是	阿里云人工审核的结果列表。	取值： block：阿里云人工审核结果为违规。 review：疑似违规。 pass：通过。最多支持配置3组类型。
CryptType	Integer	否	否	加密算法方式。	取值： 0：使用HMAC-SHA256加密算法。 1：使用国密SM3加密算法。

返回值

Fn::GetAtt

CallbackUrl：检测结果回调地址。
CryptType：加密算法方式。
CallbackId：回调ID。
CallbackName：回调名称。
CallbackTypes：回调类型列表。
CallbackSuggestions：阿里云人工审核的结果列表。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CallbackUrl:
    Type: String
    Description:
      en: The detection result will be called back to the url.
    Required: true
  CallbackName:
    Type: String
    Description:
      en: The Callback name defined by the customer. It can contain no more than 20 characters in Chinese, English, underscore (_), and digits.
    Required: true
  CallbackTypes:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: 'Represents the resource attribute field for the notification type. Value: self-service audit result (selfAudit) and machine audit result (machineScan).'
        AllowedValues:
          - selfAudit
          - machineScan
        Required: true
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: 'A list of Callback types. Value: machineScan: Machine audit result notification, selfAudit: self-service audit notification.'
    Required: true
    MinLength: 1
    MaxLength: 2
  CallbackSuggestions:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: 'Resource attribute fields that represent the results of the audit. Values: block, review and pass.'
        AllowedValues:
          - block
          - review
          - pass
        Required: true
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: 'List of audit results supported by message notification. Value: block: confirmed violation, review: Suspected violation, pass: normal.'
    Required: true
    MinLength: 1
    MaxLength: 3
Resources:
  ExtensionResource:
    Type: ALIYUN::Aligreen::Callback
    Properties:
      CallbackUrl:
        Ref: CallbackUrl
      CallbackName:
        Ref: CallbackName
      CallbackTypes:
        Ref: CallbackTypes
      CallbackSuggestions:
        Ref: CallbackSuggestions
Outputs:
  CallbackUrl:
    Description: The detection result will be called back to the url.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackUrl
  CryptType:
    Description: The encryption algorithm is used to verify that the callback request is sent by the Aliyun Green Service to your business service.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CryptType
  CallbackId:
    Description: The ID of the primary key of the Callback.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackId
  CallbackName:
    Description: The Callback name defined by the customer.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackName
  CallbackTypes:
    Description: The list of Callback types.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackTypes
  CallbackSuggestions:
    Description: List of audit results supported by message notification.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackSuggestions

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CallbackUrl": {
      "Type": "String",
      "Description": {
        "en": "The detection result will be called back to the url."
      },
      "Required": true
    },
    "CallbackName": {
      "Type": "String",
      "Description": {
        "en": "The Callback name defined by the customer. It can contain no more than 20 characters in Chinese, English, underscore (_), and digits."
      },
      "Required": true
    },
    "CallbackTypes": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "Represents the resource attribute field for the notification type. Value: self-service audit result (selfAudit) and machine audit result (machineScan)."
          },
          "AllowedValues": [
            "selfAudit",
            "machineScan"
          ],
          "Required": true
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "A list of Callback types. Value: machineScan: Machine audit result notification, selfAudit: self-service audit notification."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 2
    },
    "CallbackSuggestions": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "Resource attribute fields that represent the results of the audit. Values: block, review and pass."
          },
          "AllowedValues": [
            "block",
            "review",
            "pass"
          ],
          "Required": true
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "List of audit results supported by message notification. Value: block: confirmed violation, review: Suspected violation, pass: normal."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 3
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::Aligreen::Callback",
      "Properties": {
        "CallbackUrl": {
          "Ref": "CallbackUrl"
        },
        "CallbackName": {
          "Ref": "CallbackName"
        },
        "CallbackTypes": {
          "Ref": "CallbackTypes"
        },
        "CallbackSuggestions": {
          "Ref": "CallbackSuggestions"
        }
      }
    }
  },
  "Outputs": {
    "CallbackUrl": {
      "Description": "The detection result will be called back to the url.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackUrl"
        ]
      }
    },
    "CryptType": {
      "Description": "The encryption algorithm is used to verify that the callback request is sent by the Aliyun Green Service to your business service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CryptType"
        ]
      }
    },
    "CallbackId": {
      "Description": "The ID of the primary key of the Callback.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackId"
        ]
      }
    },
    "CallbackName": {
      "Description": "The Callback name defined by the customer.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackName"
        ]
      }
    },
    "CallbackTypes": {
      "Description": "The list of Callback types.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackTypes"
        ]
      }
    },
    "CallbackSuggestions": {
      "Description": "List of audit results supported by message notification.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackSuggestions"
        ]
      }
    }
  }
}