This topic describes the common parameters that are relevant to API operations of Optimization Solver.
Common request parameters
The following table describes the common request parameters that are used when you call Optimization Solver 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. For more information, see Obtain an AccessKey pair. |
Signature | String | Yes | OLeaidS1JvxuMvnyHOwuJ%2BuX5q**** | The signature string. |
SignatureMethod | String | Yes | HMAC-SHA1 | The encryption method of the signature string. Default value: HMAC-SHA1. |
SignatureVersion | String | Yes | 1.0 | The version number of the signature encryption algorithm. Default value: 1.0. |
SignatureNonce | String | Yes | 3ee8c1b8-****-44af-****-4e0ad82fd6cf | A unique, random number used to prevent network replay attacks. You must use different numbers for different requests. |
Timestamp | String | Yes | 2018-01-01T12:00:00Z | The timestamp of a request. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0. |
Version | String | Yes | 2021-07-30 | The version number of the API. The value must be in the YYYY-MM-DD format. Default value: 2021-07-30. |
Format | String | No | JSON | The format of the response parameters. Valid values: JSON and XML. Default value: JSON. |
Examples
https://opt.cn-beijing.aliyuncs.com/?Action=XXXXXX
&Format=JSON
&Version=2021-07-30
&Signature=Pc5W****************************
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=LTAI****************
&Timestamp=2018-01-01T12:00:00Z
…Common response parameters
Parameter | Type | Description |
RequestId | String | The unique identifier of a request. The request ID is returned regardless of whether the call is successful. |