CloudFlow API operations use the RPC protocol. You can call CloudFlow API operations by sending HTTP GET or HTTP POST requests. This topic describes how to call CloudFlow API operations. Each API request must contain parameters and be signed and authenticated.
Request syntax
This section describes the syntax of an API request sent over HTTP or HTTPS.
Use the following URL format for a GET request. The URL must be encoded in UTF-8.
http(s)://Endpoint/?Action=xx&ParametersEndpoint: the endpoint of the CloudFlow API.
Action: the name of the operation being performed. For example, to execute a workflow, you must set the Action parameter to StartExecution.
Parameters: the request parameters for the operation. Separate multiple parameters with ampersands (&). Request parameters include both common parameters and operation-specific parameters.
The following example demonstrates how to call the StartExecution operation in CloudFlow:
https://[Endpoint]/?Action=StartExecution
&FlowName=Flow
&<Common request parameters>We recommend that you send API requests over HTTPS to enhance security.
Endpoint
The endpoint of CloudFlow API is XXX.aliyuncs.com.
Network type | Region | Public endpoint | Internal endpoint |
Internet-facing services | China (Hangzhou) | cn-hangzhou.fnf.aliyuncs.com | cn-hangzhou-internal.fnf.aliyuncs.com |
China (Shanghai) | cn-shanghai.fnf.aliyuncs.com | cn-shanghai-internal.fnf.aliyuncs.com | |
China (Beijing) | cn-beijing.fnf.aliyuncs.com | cn-beijing-internal.fnf.aliyuncs.com | |
China (Qingdao) | cn-qingdao.fnf.aliyuncs.com | cn-qingdao-internal.fnf.aliyuncs.com | |
China (Shenzhen) | cn-shenzhen.fnf.aliyuncs.com | cn-shenzhen-internal.fnf.aliyuncs.com | |
Singapore | ap-southeast-1.fnf.aliyuncs.com | ap-southeast-1-internal.fnf.aliyuncs.com | |
US (Silicon Valley) | us-west-1.fnf.aliyuncs.com | us-west-1-internal.fnf.aliyuncs.com |
Common parameters
The following table describes common request parameters that can be used when you call CloudFlow API operations by sending GET requests over URLs.
Parameter | Type | Required | Example | Description |
Action | String | Yes | StartExecution | The operation that you want to perform. |
AccessKeyId | String | Yes | LTAIp4********fjx | The AccessKey ID provided to you by Alibaba Cloud. For more information, see Obtain an AccessKey pair. |
Signature | String | Yes | OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D | The signature string of the current request. For more information, see Request syntax and signature method V2 for RPC APIs. |
SignatureMethod | String | Yes | HMAC-SHA1 | The encryption algorithm of the signature string. Default value: HMAC-SHA1. |
SignatureVersion | String | Yes | 1.0 | The version of the signature encryption algorithm. Default value: 1.0. |
SignatureNonce | String | Yes | 3ee8c1b8-****-44af-****-4e0ad82fd6cf | A unique and random number that is used to prevent replay attacks. You must use different numbers for different requests. |
Timestamp | String | Yes | 2024-01-01T12:00:00Z | The timestamp of the request. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
Version | String | Yes | 2019-03-15 | The version number of the API. The value must be in the YYYY-MM-DD format. Default value: 2019-03-15. |
Format | String | No | json | The format of the response parameters. Valid values: JSON and XML. Default value: JSON. |