获取用户自定义命令。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v2/usercommands/{UserCommandId} HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| UserCommandId |
string |
否 |
用户自定义命令的 ID。可通过 GetInstance 等接口获取。 |
1900 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
否 |
DSW 实例 ID，填写此项用于查找与该实例绑定的 UserCommand。传入该选项会覆盖 UserCommandId 的设置。 |
dsw-dlsd0fskn193213xxx |
| Token |
string |
否 |
使用 GetToken 接口签发的 Token 访问 UserCommand。 |
eyJhbGci...... |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| UserCommandId |
string |
用户自定义命令的 ID。 |
1900 |
| OnStart |
object |
自定义启动命令，每次实例启动时会执行。 |
|
| Content |
string |
具体的自定义启动命令内容。 |
apt update |
| Message |
string |
返回结果说明。 |
null |
| Code |
string |
状态码，可能值：
|
ValidationError |
| RequestId |
string |
请求 ID。 |
BEBDF2EE-642E-5992-8907-D2011A7ACEFE |
| Success |
boolean |
成功标志，可能值：
|
true |
| accessDeniedDetail |
object |
访问拒绝详细信息，在因 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
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。