CreateAccessWarrant-Smart Science and Education Content Platform(SSECP)-阿里云帮助中心

Creates an access warrant.

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

aicontent:CreateAccessWarrant

create

*All Resource

*

None

Request syntax

POST /api/v1/aliyunConsole/createAccessWarrant HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	WarrantCreateCmd
appId	string	No	The merchant's application ID.	a123
timestamp	string	No	The 10-digit request timestamp in seconds.	1701000000
userId	string	No	The merchant's user ID.	sn123
userClientIp	string	No	The public IP address of the client device.	110.25.23.12
requestSign	string	No	The signature for the request parameters.	e32fac43df0b0b0be32fac43df0b0b0b
warrantAvailable	integer	No	The duration, in seconds, for which the access warrant is valid.	7200

Response elements

Element	Type	Description	Example
	object	SingleResponse	{ "success": true, "data":{ "appId": "a123", "userId": "u456", "accessToken": "abc123def456ghi789jkl012mno345pqr678stu901vwx2yz345fgh67i", "warrantId": "warrant_123456", "expireTime": "2024-01-01T12:00:00Z" }, "requestId": "592A27EF-26D3-1434-98C1-97AD63337852" }
requestId	string	The unique request ID.	xxxx-xxxx-xxxx-xxxxxxxx
success	boolean	Indicates whether the request was successful.	true
errCode	string	The error code returned if the request fails.	UNKNOWN_ERROR
errMessage	string	The error message returned if the request fails.	未知错误
httpStatusCode	integer	The HTTP status code.	200
data	object	The returned data object.	[]
ApplicationAccessId	string	The merchant's application ID.	1234567890
UserId	string	The merchant's user ID.	1234567890
AccessToken	string	The access token.	1234567890
AccessWarrantId	string	The access warrant ID.	ex2xxxxxxxx
ExpireTime	string	The expiration time of the access warrant.	1672531200
CreateTime	string	The creation time of the access warrant.	1672531200

Examples

Success response

JSON format

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "success": true,
  "errCode": "UNKNOWN_ERROR",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": {
    "ApplicationAccessId": "1234567890",
    "UserId": "1234567890",
    "AccessToken": "1234567890",
    "AccessWarrantId": "ex2xxxxxxxx",
    "ExpireTime": "1672531200",
    "CreateTime": "1672531200"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.