CreateConsumer-阿里云帮助中心

Creates a consumer.

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

apig:CreateConsumer

create

*All Resource

*

None

Request syntax

POST /v1/consumers HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
name	string	No	The consumer name.	test
description	string	No	The consumer description.	consumer for test
jwtIdentityConfig	JwtIdentityConfig	No	The JWT identity configuration.
akSkIdentityConfigs	array	No	A list of AK/SK identity configurations.
	AkSkIdentityConfig	No	An AK/SK identity configuration.
apikeyIdentityConfig	ApiKeyIdentityConfig	No	The identity configuration for API key authentication.
enable	boolean	No	Specifies whether to enable the consumer.	false
gatewayType	string	No	The gateway type. Valid values: API: For a cloud-native API gateway. AI: For an AI gateway.	API

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	479AE38F-A574-52F7-87EA-E91199999F9E
code	string	The response status code.	Ok
message	string	The response message.	success
data	object	The response data.
consumerId	string	The consumer ID.	cs-cvnjramm1hks1r3fmmug

Examples

Success response

JSON format

{
  "requestId": "479AE38F-A574-52F7-87EA-E91199999F9E",
  "code": "Ok",
  "message": "success",
  "data": {
    "consumerId": "cs-cvnjramm1hks1r3fmmug"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.