Cloud DevOps-Kochbuch Teil 4 - Entdecken Sie DevOps DirectMail in Python mit der REST-API

Dieses Mal werden wir ** Direct Mail ** von ** Alibaba Cloud DevOps ** mit ** REST API ** mit ** Python ** untersuchen.

• Dieser Blog ist eine Übersetzung aus der englischen Version. Sie können das Original von [hier] überprüfen (https://www.alibabacloud.com/blog/cloud-devops-cookbook-part-4-api-gateway-and-directmail-with-python-3-0_593732). Einige maschinelle Übersetzungen werden verwendet. Wir würden uns freuen, wenn Sie auf Übersetzungsfehler hinweisen könnten. * *

Alibaba Cloud Tech Share, Autor John Hanley. Tech Share fördert den Austausch von technischem Wissen und Best Practices innerhalb der Cloud-Community. Incentive-Programm.

Meine Lieblingssprache zum Erlernen von Rapid Prototyping und neuen Cloud-Diensten ist Python. Mit Python sind die meisten Aufgaben so einfach, dass Sie Ihre neue API in wenigen Minuten testen können. Auf diese Weise können Sie sich auf das Lernen konzentrieren, ohne sich Gedanken über die Funktionsweise der API in einer bestimmten Sprache machen zu müssen. Aber ich verwende C ++ für Code auf Unternehmensebene, der Millionen von Dollar kosten kann, wenn ich einen Fehler mache.

Alibabas DirectMail (https://www.alibabacloud.com/product/directmail?spm=a2c65.11461447.0.0.38ad725bFhEjCQ) unterstützt Python nicht. PHP, Java und C # werden unterstützt. Ein sehr häufiger Anwendungsfall für DirectMail ist das E-Mailen von dynamischen und statischen Websites. Ist zu liefern. Für dynamische Websites ist PHP die beste Wahl. Für statische Websites DirectMail und Function Compute Die Integration von Produkt- / Funktionsberechnung (Spm = a2c65.11461447.0.0.38ad725bFhEjCQ) ist perfekt. Function Compute unterstützt jedoch kein PHP. Dies bedeutet, dass Sie in einer Sprache auf dem Desktop und in einer anderen in der Cloud entwickeln.

Daher kam mir die Idee, die REST-API von DirectMail zu verwenden. Das heißt, Sie können Python verwenden, um zu lernen, wie Sie die REST-API verwenden und insbesondere weniger dokumentierte Signaturen erstellen.

DirectMail unterstützt drei verschiedene Schnittstellen (nicht alle Sprachen werden unterstützt).

1、Alibaba REST API 2、Alibaba Cloud SDK 3、Alibaba SMTP Interface Im vorherigen Artikel habe ich ein Beispiel für die Verwendung von SDK (Function Compute) in Python vorgestellt. Dieses Mal werde ich mich auf die DirectMail-REST-API konzentrieren und ein Beispiel für die Funktionsweise in Python zeigen.

Alibaba Cloud DirectMail REST-API

Es gibt mehrere Gründe, die REST-API zu verwenden.

1. Grundlegendes zu APIs, Parametern und Fehlern auf niedriger Ebene. In 2 ist der Codebereich klein. 3, verkürzte Lade- und Ausführungszeit. 4 gibt es wenige Abhängigkeiten. In 5 muss die SDK-Bibliothek nicht auf dem Zielsystem installiert werden. 6, SDK ist nicht in der Zielsprache verfügbar.

REST-API-Anforderungen

1. Verstehen Sie HTTPS, HTTP-Header und HTTP-Körper.
2. Verstehen Sie den Unterschied zwischen den Methoden HTTP HEAD, DELETE, GET, POST und PUT.
3. Verstehen Sie, wie Sie Daten für jede HTTP-Methode senden.
4. Verstehen Sie die API-Parameter, die in jeder HTTP-Methode enthalten sein müssen.
5. Verstehen, wie HTTP-Anforderungen signiert werden.

Öffentliche Parameter der Alibaba Cloud

Dies ist ein Link zu Alibabas Dokumentation zu öffentlichen DirectMail-Parametern.

Kommentare zu den oben genannten Parametern:

** SignatureNonce **: Dieser Parameter ist seit einiger Zeit ärgerlich. Zuerst dachte ich, dies sei der Salzwert, der beim Signieren von HMAC_SHA1 verwendet wird. Es stellt sich jedoch heraus, dass dies eine Zeichenfolge ist, die von uuid.uuid4 () generiert und im Header enthalten ist. Wenn Sie den Wert dieser Zeichenfolge in einem nachfolgenden Befehl wiederholen, wird der Befehl abgelehnt.

** AccessKeyId **: Erstellt einen neuen RAM-Benutzer mit Nur-DirectMail-Berechtigungen. In diesem Fall benötigen Sie sowohl einen Zugriffsschlüssel als auch ein Zugriffsschlüsselgeheimnis für die REST-API.

** Zeitstempel **: Es ist wichtig, dass Datum und Uhrzeit des Systems korrekt sind. Wenn diese Zeit vom Service von Alibaba abweicht, wird die Anfrage abgelehnt. Verwenden Sie nach Möglichkeit einen Zeitdienst wie NTP für Ihr System.

Alibaba Cloud DirectMail-Anforderungsparameter

Ein Link zur Alibaba-Dokumentation zu DirectMail-Anforderungsparametern (https://www.alibabacloud.com/help/doc-detail/29444.htm?spm=a2c65.11461447.0.0.38ad725bFhEjCQ).

Berechnen Sie das richtige Datum

# Correctly formatted date and time
now = datetime.datetime.utcnow()

# Date used by the HTTP "Date" header
date = now.strftime("%a, %d %b %Y %H:%M:%S GMT")

# Date used by the API parameter "Timestamp"
utc = now.isoformat(timespec='seconds') + 'Z'

Host und Endpunkt in diesem Beispiel (Singapur-> ap-Südost-1)

# HTTP Host header
host = "dm.ap-southeast-1.aliyuncs.com"

# URL for POST
url = "https://dm.ap-southeast-1.aliyuncs.com/"

Erstellen einer Parameterliste mit öffentlichen Parametern

parameters = {}

# Add the DirectMail public request parameters
parameters["Format"] = "json"
parameters["AccessKeyId"] = credentials['AccessKey']
parameters["SignatureMethod"] = "HMAC-SHA1"
parameters["SignatureType"] = ""
parameters["SignatureVersion"] = "1.0"
parameters["SignatureNonce"] = get_uuid()
parameters["Timestamp"] = utc
parameters["Version"] = "2017-06-22"
parameters["RegionId"] = "ap-southeast-1"

Erstellen einer Parameterliste mit Anforderungsparametern

# Add parameters that are always set
parameters["Action"] = "SingleSendMail"
parameters["AddressType"] = "1"
parameters["ReplyToAddress"] = "true"

# Add the DirectMail API parameters
parameters["AccountName"] = dm_account
parameters["FromAlias"] = dm_alias
parameters["ToAddress"] = to_list
parameters["Subject"] = subject
parameters["HtmlBody"] = body
parameters["textBody"] = body_text

Erstellen Sie eine Anforderungszeichenfolge zum Signieren

def build_request_string(table):
    """ Build canonical list """
    items = sorted(iter(table.items()), key=lambda d: d[0])
    enc = my_urlencode(items)
    return enc

Vorsichtsmaßnahmen bezüglich Anforderungszeichenfolgen

Anforderungszeichenfolgenparameter müssen zuerst sortiert werden. Die Zeichenfolge wird dann url-codiert. Dies bedeutet, dass jedes Schlüssel / Wert-Paar ein & -Zeichen hat.

Das Endergebnis sieht wie im folgenden Beispiel aus, jedoch mit einer längeren Länge.

AccessKeyId=LTAIQlgy6erobert&AccountName=test%40test.com&Action=SingleSendMail …

Erstellen Sie eine Signatur aus der Anforderungszeichenfolge

Dies ist ein Link zu Alibabas Dokumentation zur DirectMail-Signatur.

# Build the request string for the signing process
params = build_request_string(parameters)

# Create the actual string to sign (method = "POST")
stringToSign = method + "&%2F&" + percentEncode(params)

Signature = sign(stringToSign, credentials['AccessKeySecret'])

Ein Programm, das die DirectMail-REST-API aufruft, um E-Mails zu senden

Laden Sie [sendEmail.zip] herunter (https://alicloud-common.oss-ap-southeast-1.aliyuncs.com/sendEmail.zip?spm=a2c65.11461447.0.0.38ad725bFhEjCQ&file=sendEmail.zip).

############################################################
# Version 1.00
# Date Created: 2018-05-26
# Last Update:  2018-05-27
# https://www.neoprime.io
# Copyright (c) 2018, NeoPrime, LLC
############################################################

""" Alibaba Cloud DirectMail REST API With Signing """

import base64
import datetime
import hmac
import hashlib
import urllib
import uuid
import json
import requests

# My library for processing Alibaba Cloud Services (ACS) credentials
import mycred_acs

# From the DirectMail Console
dm_account = "<enter your value here>"
dm_alias = "<enter your value here>"

debug = 0

def set_connection_logging():
    """ Enable HTTP connection logging """
    if debug is 0:
        return

    import logging
    import http.client as http_client

    http_client.HTTPConnection.debuglevel = 1

    # You must initialize logging, otherwise you'll not see debug output.
    logging.basicConfig()
    logging.getLogger().setLevel(logging.DEBUG)
    requests_log = logging.getLogger("requests.packages.urllib3")
    requests_log.setLevel(logging.DEBUG)
    requests_log.propagate = True
    return

def get_uuid():
    """ return a uuid as a signing nonce """
    return str(uuid.uuid4())

def percentEncode(path):
    """ Encode a URL """
    res = urllib.parse.quote(path)
    res = res.replace('+', '%20')
    res = res.replace('*', '%2A')
    res = res.replace('%7E', '~')
    return res

def my_urlencode(query):
    """ Encode a Query """
    res = urllib.parse.urlencode(query)
    res = res.replace('+', '%20')
    res = res.replace('*', '%2A')
    res = res.replace('%7E', '~')
    return res

def build_request_string(table):
    """ Build canonical list """
    items = sorted(iter(table.items()), key=lambda d: d[0])
    enc = my_urlencode(items)
    return enc

def sign(string, secret):
    """ Sign REST API Request """
    nsecret = secret + '&'

    h = hmac.new(
        bytes(nsecret, "utf-8"),
        bytes(string, "utf-8"),
        hashlib.sha1)

    #sig = base64.b64encode(h.digest())
    sig = str(base64.encodebytes(h.digest()).strip(), "utf-8")
    return sig

def sendEmail(credentials, subject, body, body_text, to_list):
    """ Send an email using Alibaba DirectMail """
    # HTTP Method
    method = "POST"

    # Correctly formatted date and time
    now = datetime.datetime.utcnow()
    date = now.strftime("%a, %d %b %Y %H:%M:%S GMT")
    utc = now.isoformat(timespec='seconds') + 'Z'

    # HTTP Host header
    host = "dm.ap-southeast-1.aliyuncs.com"

    # URL for POST
    url = "https://dm.ap-southeast-1.aliyuncs.com/"

    parameters = {}

    # Add the DirectMail public request parameters
    parameters["Format"] = "json"
    parameters["AccessKeyId"] = credentials['AccessKey']
    parameters["SignatureMethod"] = "HMAC-SHA1"
    parameters["SignatureType"] = ""
    parameters["SignatureVersion"] = "1.0"
    parameters["SignatureNonce"] = get_uuid()
    parameters["Timestamp"] = utc
    #parameters["Version"] = "2015-11-23"
    parameters["Version"] = "2017-06-22"
    parameters["RegionId"] = "ap-southeast-1"

    # Add parameters that are always set
    parameters["Action"] = "SingleSendMail"
    parameters["AddressType"] = "1"
    parameters["ReplyToAddress"] = "true"

    # Add the DirectMail API parameters
    parameters["AccountName"] = dm_account
    parameters["FromAlias"] = dm_alias
    parameters["ToAddress"] = to_list
    parameters["Subject"] = subject
    parameters["HtmlBody"] = body
    parameters["textBody"] = body_text

    # Build the request string for the signing process
    params = build_request_string(parameters)

    # Create the actual string to sign
    stringToSign = method + "&%2F&" + percentEncode(params)

    #print("String to Sign")
    #print(stringToSign)

    Signature = sign(stringToSign, credentials['AccessKeySecret'])
    #print("Signature", Signature)

    parameters["Signature"] = Signature

    headers = {
        'Date': date,
        'Host': host
    }

    set_connection_logging()

    print("Sending Email to", parameters["ToAddress"])
    r = requests.post(url, data=parameters, headers=headers)

    if r.status_code != 200:
        print("Error: Email Send Failed:", r.status_code)
        print(r.text)
        return 1

    #print(r.text)

    result = json.loads(r.text)
    print("Success: Request ID:", result['RequestId'])

    return 0

# Load the Alibaba Cloud Credentials (AccessKey)
cred = mycred_acs.LoadCredentials()

dm_subject = "Welcome to Alibaba Cloud DirectMail"

dm_body = "<h2>Welcome to Alibaba Cloud DirectMail<h2>You are receiving this email as part of a test program.<br /><br />Click for <a href='https://www.neoprime.io/info/alibaba/'>more information<a>.<br /><br /><a href='https://www.alibabacloud.com/'><img src='https://www.neoprime.io/info/alibaba/img/alibaba-600x263.png' alt='Alibaba' width='700'><a>"

dm_body_text = "Welcome to Alibaba Cloud DirectMail\nYou are receiving this email as part of a test program."

dm_to_list = "[email protected], [email protected]

sendEmail(cred, dm_subject, dm_body, dm_body_text, dm_to_list)

Führen Sie Python 3.x aus: python sendEmail.py

Alibaba-Dokument

Alibaba DirectMail Product Page Alibaba DirectMail Documentation Alibaba DirectMail Public parameters Alibaba DirectMail Request parameters Alibaba DirectMail Signature

• Alibaba Cloud ist der Cloud-Infrastrukturbetreiber Nr. 1 (2019 Gartner) im asiatisch-pazifischen Raum mit zwei Rechenzentren in Japan und mehr als 60 Verfügbarkeitszonen weltweit. Klicken Sie hier, um weitere Informationen zu Alibaba Cloud zu erhalten. Offizielle Seite von Alibaba Cloud Japan *