DescribeApplicationPrompts - PolarDB - Alibaba Cloud Documentation Center

Lists the Application Prompts for a specific Application.

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

polardb:DescribeApplicationPrompts

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The Application ID.	pa-**************
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100 Default value: 30.	50
PageNumber	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The Request ID.	6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
TotalRecordCount	string	The total number of matching entries.	10
PageRecordCount	string	The number of entries on the current page.	1
PageNumber	string	The page number.	1
Items	array<object>	A list of Application Prompts.
	object	An Application Prompt.
PromptId	string	The Prompt ID.	papt-58z96zl691otf356o4
PromptType	string	The Prompt Type.	DELETE_RELATIONS_SYSTEM_PROMPT
PromptName	string	The Prompt Name.	prompt name
PromptValue	string	The Prompt Value.	prompt value
PromptEnabled	integer	Specifies whether the Prompt is enabled. A value of 1 indicates enabled, and 0 indicates disabled.	prompt if enabled

Examples

Success response

JSON format

{
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******",
  "TotalRecordCount": "10",
  "PageRecordCount": "1",
  "PageNumber": "1",
  "Items": [
    {
      "PromptId": "papt-58z96zl691otf356o4",
      "PromptType": "DELETE_RELATIONS_SYSTEM_PROMPT",
      "PromptName": "prompt name",
      "PromptValue": "prompt value",
      "PromptEnabled": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.