文档

通过AccessKey执行工作流

更新时间:

使用AccessKey鉴权方式执行工作流,可以通过SDK调用执行,为您提供更安全的服务。

逻辑编排自定义请求触发器目前提供了两种客户端调用方式,如果无需鉴权,可以直接调用对应触发器的Endpoint执行工作流;如果选择的是AccessKey鉴权方式,需要配合SDK调用执行,可以通过以下步骤执行。

步骤

  1. 获取 Path。单击工作流图形化设计中对应的自定义请求触发器节点当收到 HTTP 请求时展开触发器详情。单击 Path 后面的复制按钮复制该触发器的调用 Path。

2. 通过RAM授权

如果是使用AccessKey进行访问,请提前给AccessKey对应的RAM用户赋予权限,具体操作可参见 使用RAM授权

3. 使用SDK调用

重要
  • 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。

  • 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。

  • 本示例通过将AccessKey保存在环境变量中来实现身份验证为例。关于如何配置环境变量,请参见身份验证配置

  • 本示例中使用的环境变量名分别为ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET

Java

  • 安装依赖

将 Maven 依赖项添加到 pom.xml 中

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <version>4.0.3</version>
</dependency>
  • 代码示例

import com.aliyuncs.CommonRequest;
import com.aliyuncs.CommonResponse;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.http.FormatType;
import com.aliyuncs.http.MethodType;
import com.aliyuncs.profile.DefaultProfile;
public class TestJavaSDK {
    public static void main(String[] args) {
        // RegionID使用default,后面通过setDomain指定具体的Endpoint
        // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下资源的安全
        DefaultProfile profile = DefaultProfile.getProfile("default", System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        IAcsClient client = new DefaultAcsClient(profile);
        CommonRequest request = new CommonRequest();
        request.setProtocol(ProtocolType.HTTPS);
        request.setMethod(MethodType.POST);
        request.setDomain("lc.<regionId>.aliyuncs.com");
        request.setVersion("2019-09-25");
        // 注意下面的 <Path> 替换为第1步复制的 Path
        request.setUriPattern("<Path>");
        // 这里根据工作流需求设置参数
        request.putQueryParameter("RegionId", "us-east-1");
        request.putHeadParameter("Content-Type", "application/json");
        // 这里根据工作流需求设置正文,注意是 JSON 字符串
        String requestBody = "";
        request.setHttpContent(requestBody.getBytes(), "utf-8", FormatType.JSON);
        try {
            CommonResponse response = client.getCommonResponse(request);
            System.out.println(response.getData());
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            e.printStackTrace();
        }
    }
}

GO

  • 代码示例

package main
import (
	"fmt"
  "os"
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk"
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
)
func main() {
  // RegionID使用default,后面通过request.Domain指定具体的Endpoint
  // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下资源的安全
	client, err := sdk.NewClientWithAccessKey("default", os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
	if err != nil {
		panic(err)
	}
	request := requests.NewCommonRequest()
	request.Method = "POST"
	request.Scheme = "https" // https | http
	request.Domain = "lc.<regionId>.aliyuncs.com"
	request.Version = "2019-09-25"
  // 注意下面的 <Path> 替换为第1步复制的 Path
	request.PathPattern = "<Path>"
  request.Headers["Content-Type"] = "application/json"
  // 这里根据工作流需求设置参数
  request.QueryParams["RegionId"] = "us-east-1"
  // 这里根据工作流需求设置正文,注意是 JSON 字符串
	body := ``
	request.Content = []byte(body)
	response, err := client.ProcessCommonRequest(request)
	if err != nil {
		panic(err)
	}
	fmt.Print(response.GetHttpContentString())
}

Python

  • 代码示例

#!/usr/bin/env python
#coding=utf-8
import os
from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.request import CommonRequest
# RegionID使用default,后面通过request.set_domain指定具体的Endpoint
# 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下资源的安全
client = AcsClient(os.getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'), os.getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'), 'default')
request = CommonRequest()
request.set_accept_format('json')
request.set_method('POST')
request.set_protocol_type('https') # https | http
request.set_domain('lc.<regionId>.aliyuncs.com')
request.set_version('2019-09-25')
# 注意下面的 <Path> 替换为第1步复制的 Path
request.set_uri_pattern('<Path>')
# 这里根据工作流需求设置参数
request.add_query_param('RegionId', "us-east-1")
request.add_header('Content-Type', 'application/json')
# 这里根据工作流需求设置正文,注意是 JSON 字符串
body = ''''''
request.set_content(body.encode('utf-8'))
response = client.do_action_with_exception(request)
# python2:  print response
print(str(response, encoding = 'utf-8'))

Ruby

# gem install aliyunsdkcore
require 'aliyunsdkcore'
# 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下资源的安全
client = ROAClient.new(
  access_key_id: ENV['ALIBABA_CLOUD_ACCESS_KEY_ID'],
  access_key_secret: ENV['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
  endpoint: 'https://lc.<regionId>.aliyuncs.com',
  api_version: '2019-09-25'
)
response = client.request(
  method: 'POST',
  # 注意下面的 <Path> 替换为第1步复制的 Path
  uri: '<Path>',
  # 这里根据工作流需求设置参数
  queries: {
    "RegionId": "cn-hangzhou",
  },
  headers: {
    "Content-Type": "application/json"
  },
  # 这里根据工作流需求设置正文,注意是 JSON 字符串
  body: ``,
  options: {}
)
print response

Node.js

  • 安装依赖

npm install @alicloud/pop-core

  • 代码示例

var ROAClient = require('@alicloud/pop-core').ROAClient;
// 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下资源的安全
var client = new ROAClient({
  accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,
  accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET,
  endpoint: 'https://lc.<regionId>.aliyuncs.com',
  apiVersion: '2019-09-25',
});
async function test() {
  try {
    var res = await client.request(
      'POST',
      '<Path>', // 注意这里的 <Path> 替换为第1步复制的 Path
      {}, // 这里根据工作流需求设置参数
      '<request body>', // 这里根据工作流需求设置正文,注意是 JSON 字符串
      {
        'content-type': 'application/json',
      }
    );
    console.log('invoke workflow: ', res);
  } catch (err) {
    console.error(err);
  }
}
test().then();

接口详细入参可以查看SDK 源码

支持的地域

该功能目前支持以下地域。需要注意该功能的Endpoint和逻辑编排管控类API的Endpoint不同,请使用如下表格中对应地域的Endpoint。

Region

RegionId

Endpoint

华东2(上海)

cn-shanghai

https://lc.cn-shanghai.aliyuncs.com

美国(弗吉尼亚)

us-east-1

https://lc.us-east-1.aliyuncs.com

新加坡

ap-southeast-1

https://lc.ap-southeast-1.aliyuncs.com