GetApp-阿里云帮助中心

Retrieves the details of a specified 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
ClusterId	string	Yes	The cluster ID.	xxljob-d6a5243b6fa
AppName	string	Yes	The application name.	test-app

Response elements

Element	Type	Description	Example
	object	The response object.
Code	integer	The response code.	200
Message	string	The error message.	Not found: appName not found.
RequestId	string	The unique ID of the request, generated by Alibaba Cloud. Use this ID to troubleshoot issues.	D0DE9C33-992A-580B-89C4-B609A292748D
Success	boolean	Indicates whether the request was successful.	true
Data	object	The details of the application.
Id	integer	The primary key ID.	3402
AppName	string	The application name.	test-app
AccessToken	string	The access token.	2f4ddeab8e344ed68e0402cf9b8502ffv3
Title	string	The title of the application.	测试应用
Creator	string	The creator of the application.	18582193685027xx
Updater	string	The last user to update the application.	18582193685027xx
Leader	string	The leader address.	http://28.*.*.3:80
MaxJobs	integer	The maximum number of jobs.	1000
MaxConcurrency	integer	The maximum concurrency.	100
JobNum	integer	The number of jobs.	100
ExecutorNum	integer	The number of executors.	2
EnableLog	boolean	Indicates whether logging is enabled. `true`: Enabled. `false`: Disabled.	true
LabelRouteStrategy	integer
AppType	integer	The application type.	1

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Not found: appName not found.",
  "RequestId": "D0DE9C33-992A-580B-89C4-B609A292748D",
  "Success": true,
  "Data": {
    "Id": 3402,
    "AppName": "test-app",
    "AccessToken": "2f4ddeab8e344ed68e0402cf9b8502ffv3",
    "Title": "测试应用",
    "Creator": "18582193685027xx",
    "Updater": "18582193685027xx",
    "Leader": "http://28.***.***.3:80\n",
    "MaxJobs": 1000,
    "MaxConcurrency": 100,
    "JobNum": 100,
    "ExecutorNum": 2,
    "EnableLog": true,
    "LabelRouteStrategy": 0,
    "AppType": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Parameter error: %s.	Parameter error: %s
401	IllegalRequest	IllegalRequest: %s.	Illegal request:%s
500	InternalError	InternalError: %s.	System Internal Error: %s
403	NoPermission	No permission to perform this operation: %s.	No permission to perform this operation: %s
404	NotFound	Not found: %s.	The resource does not exist: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.