GetUserCommand - 获取用户自定义命令

获取用户自定义命令。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paidsw:GetUserCommandget
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
UserCommandIdstring

用户自定义命令的 ID。可通过 GetInstance 等接口获取。

1900
InstanceIdstring

DSW 实例 ID,填写此项用于查找与该实例绑定的 UserCommand。传入该选项会覆盖 UserCommandId 的设置。

dsw-dlsd0fskn193213xxx
Tokenstring

使用 GetToken 接口签发的 Token 访问 UserCommand。

eyJhbGci......

返回参数

名称类型描述示例值
object

Schema of Response

UserCommandIdstring

用户自定义命令的 ID。

1900
OnStartobject

自定义启动命令,每次实例启动时会执行。

Contentstring

具体的自定义启动命令内容。

apt update
Messagestring

返回结果说明。

null
Codestring

状态码,可能值:

  • null: 请求成功。
  • ValidationError:参数验证错误。
  • InternalError:系统内部错误。
ValidationError
RequestIdstring

请求 ID。

BEBDF2EE-642E-5992-8907-D2011A7ACEFE
Successboolean

成功标志,可能值:

  • true
  • false
true
accessDeniedDetailobject

访问拒绝详细信息,在因 RAM 无权限拒绝用户访问的场景返回。

"AccessDeniedDetail": { "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "AQIBIAAAA....bwhg==", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "ram:GetUserCommand" }

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。