公共參數指調用任何API時必須攜帶的參數,其中簽名的方法請參見簽名方法
注意 如果使用SDK開發,公共參數可以由SDK自動生成,因此推薦使用SDK調用API。
公共請求參數
名稱 | 類型 | 是否必須 | 描述 |
Action | String | 是 | API的名稱。取值請參見API概覽 |
Version | String | 是 | API版本號,取值:2018-06-19 |
AccessKeyId | String | 是 | 用戶AccessKeyId |
Signature | String | 是 | 簽名結果串。 |
SignatureMethod | string | 是 | 簽名方式。取值:HMAC-SHA1 |
Timestamp | String | 是 | 請求的時間戳。日期格式按照ISO8601標準表示,并需要使用UTC時間。格式為:YYYY-MM-DDThh:mm:ssZ。例如,2020-10-01T12:00:00Z,表示北京時間2020年10月01日20點0分0秒。 |
SignatureVersion | String | 是 | 簽名算法版本。取值:1.0 |
SignatureNonce | String | 是 | 唯一隨機數,用于防止網絡重放攻擊。用戶在不同請求間要使用不同的隨機數值。 |
Format | String | 是 | 返回參數的類型,取值:json |
請求示例
以下示例查詢杭州區虛擬集群
MyCluster
下,ID為MySparkId的作業的狀態: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
公共返回參數
名稱 | 類型 | 描述 |
---|---|---|
RequestId | String | 本次請求的唯一ID,可以用來記錄調用詳情以及追蹤問題。 |