GetUserConfig-阿里云帮助中心

You can call GetUserConfig to query user information.

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

paidsw:GetUserConfig

get

*All Resource

*

None

Request syntax

GET /api/v2/userconfig HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The user configuration.
AccountSufficient	boolean	Indicates whether the account has a sufficient balance.	false
FreeTierSpecAvailable	boolean	Indicates whether free tier instances are available for purchase.	true
FreeTier	object	The properties of the free tier.
IsFreeTierUser	boolean	Indicates whether the user has a free tier.	true
StartTime	string	The start time of the free tier.	2020-11-08T15:00:00Z
EndTime	string	The end time of the free tier.	2020-11-08T15:00:00Z
Status	string	The status of the free tier. The value can be `valid` or `invalid`.	valid
InitBaseValue	number	The initial value of the free tier resource.	5000
InitShowValue	string	The initial display value of the free tier resource.	5000
InitBaseUnit	string	The unit of the initial value for the free tier resource.	个
InitShowUnit	string	The display unit of the initial value for the free tier resource.	个
PeriodBaseValue	number	The current value of the free tier resource.	3000
PeriodShowValue	string	The current display value of the free tier resource.	3000
PeriodBaseUnit	string	The unit of the current value for the free tier resource.	个
PeriodShowUnit	string	The display unit of the current value for the free tier resource.	个
EnableEciDisk	boolean	Indicates whether eciDisk is enabled.	true
RequestId	string	The request ID.	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	Indicates whether the request was successful. Possible values: true false	true
Message	string	The message returned.	"Access denied"
Code	string	The status code. Possible values: InternalError: An internal error occurred. Errors other than parameter validation errors are classified as internal errors. ValidationError: A parameter validation error occurred.	null
HttpStatusCode	integer	The HTTP status code. Possible values: 400 404	null

Examples

Success response

JSON format

{
  "AccountSufficient": false,
  "FreeTierSpecAvailable": true,
  "FreeTier": {
    "IsFreeTierUser": true,
    "StartTime": "2020-11-08T15:00:00Z",
    "EndTime": "2020-11-08T15:00:00Z",
    "Status": "valid",
    "InitBaseValue": 5000,
    "InitShowValue": "5000",
    "InitBaseUnit": "个",
    "InitShowUnit": "个",
    "PeriodBaseValue": 3000,
    "PeriodShowValue": "3000",
    "PeriodBaseUnit": "个",
    "PeriodShowUnit": "个"
  },
  "EnableEciDisk": true,
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"Access denied\"",
  "Code": "null",
  "HttpStatusCode": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.