GetSmsOcrOssInfo-阿里云帮助中心

Retrieves the Object Storage Service (OSS) information for Optical Character Recognition (OCR).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dysms:GetSmsOcrOssInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskType	string	No	The type of the OCR task. Valid value: ICP_DOMAIN: A screenshot of the Internet Content Provider (ICP) filing for a domain name. Valid values: ICP_DOMAIN : A screenshot of the ICP filing for a domain name.	ICP_DOMAIN

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details of the access denial. This field is returned only when RAM authentication fails.	None
RequestId	string	The ID of the request. This unique identifier is generated by Alibaba Cloud and can be used for troubleshooting.	25D5AFDE-xxxx-132E-8909-1FDC071DA
Message	string	The description of the status code.	OK
Model	object	The OSS configuration information.
Policy	string	The signature policy.	eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********
StartPath	string	The policy path.	1000********001
Bucket	string	The name of the bucket.	示例值
AccessKeyId	string	The AccessKey ID used for the signature.	bypFNbG******
Signature	string	The signature calculated from the AccessKey secret and the policy. OSS uses this signature to authenticate the request when you call an OSS API operation.	QvNTGC9DSLTeByP+ZWW******
Host	string	The host address.	http://***.oss-cn-zhangjiakou.aliyuncs.com
ExpireTime	string	The expiration timestamp. Unit: seconds.	1741521339
Code	string	The request status code. A value of OK indicates that the request was successful. For other error codes, see API error codes.	OK
Success	boolean	Indicates whether the API call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "RequestId": "25D5AFDE-xxxx-132E-8909-1FDC071DA",
  "Message": "OK",
  "Model": {
    "Policy": "eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********",
    "StartPath": "1000********001",
    "Bucket": "示例值",
    "AccessKeyId": "bypFNbG******",
    "Signature": "QvNTGC9DSLTeByP+ZWW******",
    "Host": "http://***.oss-cn-zhangjiakou.aliyuncs.com",
    "ExpireTime": "1741521339"
  },
  "Code": "OK",
  "Success": true
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.