Common request parameters must be included in all DLA API requests. For more information
about the signature method, see Signature method.
Notice If you use an SDK for your development, common request parameters can be automatically
generated by the SDK. We recommend that you use an SDK to call API operations.
Common request parameters
Parameter | Type | Required | Description |
Action | String | Yes | The operation that you want to perform. For more information, see List of operations by function. |
Version | String | Yes | The version number of the API. Set the value to 2018-06-19. |
AccessKeyId | String | Yes | The AccessKey ID provided to you by Alibaba Cloud. |
Signature | String | Yes | The signature string of the current request. |
SignatureMethod | string | Yes | The encryption method of the signature string. Set the value to HMAC-SHA1. |
Timestamp | String | Yes | 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. For example, 2020-10-01T12:00:00Z indicates 20:00:00 on October 1, 2020 (UTC+8). |
SignatureVersion | String | Yes | The version of the signature encryption algorithm. Set the value to 1.0. |
SignatureNonce | String | Yes | A unique, random number used to prevent replay attacks. You must use different numbers for different requests. |
Format | String | Yes | The format in which to return the response. Set the value to json. |
Sample requests
The following example demonstrates how to query the status of the job with ID MySparkId
in the
MyCluster
virtual cluster deployed in the China (Hangzhou) region.http://openanalytics-open.cn-hangzhou.aliyuncs.com/?Action=GetJobStatus
&Format=JSON
&AccessKeyId=XXX
&SignatureNonce=YYY
&Signature=ZZZ
&SignatureMethod=HMAC-SHA1
&SignatureVersion=1.0
&Version=2018-06-19
&Timestamp=2020-10-27T00:00:00Z
&JobId=MySparkJobId
&VcName=MyCluster
Common response parameters
Parameter | Type | Description |
---|---|---|
RequestId | String | The unique ID of the request. This parameter is used to record call details and track problems. |