DescribeApplicationPrompts - - 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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.