GetUserCommand-阿里云帮助中心

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:GetUserCommand

get

*All Resource

*

None

Request syntax

GET /api/v2/usercommands/{UserCommandId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
UserCommandId	string	No	The ID of the user-defined command. You can get this ID by calling API operations such as GetInstance.	1900

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the Data Science Workshop (DSW) instance. Specify this parameter to find the user command that is attached to the instance. This parameter overwrites the UserCommandId setting.	dsw-dlsd0fskn193213xxx
Token	string	No	The token used to access the user command. The token is issued by the GetToken API operation.	eyJhbGci......

Response elements

Element	Type	Description	Example
	object	Response schema
UserCommandId	string	The ID of the user-defined command.	1900
OnStart	object	The custom startup command. This command is executed each time the instance starts.
Content	string	The content of the custom startup command.	apt update
Message	string	A description of the result.	null
Code	string	The status code. Valid values: null: The request was successful. ValidationError: A parameter is invalid. InternalError: An internal error occurred.	ValidationError
RequestId	string	The request ID.	BEBDF2EE-642E-5992-8907-D2011A7ACEFE
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
accessDeniedDetail	object	Details about the access denial. This parameter is returned if access is denied because the user does not have the required RAM permissions.	"AccessDeniedDetail": { "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "AQIBIAAAA....bwhg==", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "ram:GetUserCommand" }

Examples

Success response

JSON format

{
  "UserCommandId": "1900",
  "OnStart": {
    "Content": "apt update"
  },
  "Message": "null",
  "Code": "ValidationError",
  "RequestId": "BEBDF2EE-642E-5992-8907-D2011A7ACEFE",
  "Success": true,
  "accessDeniedDetail": {
    "test": "test",
    "test2": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.