Common request parameters

Updated at:

The Alibaba Cloud Visual Intelligence API provides RPC-style API operations, which require that each API request includes a set of common request parameters.

Request example

http://imageseg.cn-shanghai.aliyuncs.com/?Signature=NAxwl1W9ROkidJfGeZrsKUXw%2BQ****
&AccessKeyId=testId
&Action=SegmentCommonImage
&Format=JSON
&RegionId=cn-shanghai
&SignatureMethod=HMAC-SHA1
&SignatureNonce=313ef0fb-0393-464f-a6e2-59d9ca2585b1
&SignatureVersion=1.0
&Timestamp=2019-10-12T08%3A18%3A18Z
&Version=2019-12-30

Request parameters

Name

Type

Required

Description

Signature

String

Yes

The request signature, which is the final generated signature string. For more information, see Request signature.

AccessKeyId

String

Yes

The AccessKey ID used to access the service. For more information, see Create an AccessKey.

Action

String

Yes

The name of the API operation.

Format

String

No

The format of the response.

Valid values: JSON (default) or XML.

RegionId

String

No

The ID of the region supported by the API operation.

For example, cn-shanghai.

SignatureMethod

String

Yes

The signature method.

The value is HMAC-SHA1.

SignatureNonce

String

Yes

A unique random number for the signature. This number is used to prevent replay attacks. Use a different random number for each request. In Java, use java.util.UUID.randomUUID() to generate the number.

SignatureVersion

String

Yes

The version of the signature algorithm.

The value is 1.0.

Timestamp

String

Yes

The timestamp of the request. The time must be in UTC and formatted in compliance with the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ.

For example, 2019-10-13T10:00:00Z represents 18:00:00 on October 13, 2019 in the UTC+8 time zone.

Version

String

Yes

The version of the API operation. The format is YYYY-MM-DD.

The value is 2019-12-30.