关闭应用资源。
接口说明
前置条件
调用本接口前,需先完成用户登录认证,取得 LoginToken 和 SessionId。本接口 StopAppResources 使用 appstream-center 的 2021-09-03 版本;前置登录接口使用 2021-02-20 版本的 GetLoginToken 。请分别使用各自的 API 版本。
1. 准备企业标识符与账号信息
以下流程适用于使用企业标识符登录的便捷账号或 AD 域账号账密认证。
| 参数 | 填写说明 |
ClientId | 客户端生成的唯一 ID,调用 GetLoginToken 时必填。以下调用序列复用同一个客户端 ID。 |
LoginIdentifier | 填写待登录的企业标识符,即 TenantAlias。登录请求的参数名是 LoginIdentifier,不是 TenantAlias。如需查询该标识符的登录配置,可调用 FindIdpListByLoginIdentifier(2021-02-20),其响应中的 TenantAliasInfo.TenantAlias 表示企业标识符。 |
CurrentStage | 账密认证时填写 ADPassword。该值适用于便捷账号和 AD 域账号,不只适用于 AD 域账号。 |
EndUserId | 便捷账号或 AD 域账号的用户名;当 CurrentStage=ADPassword 时必填。 |
Password | 对应账号的密码;当 CurrentStage=ADPassword 时必填。 |
2. 按返回的认证阶段继续登录
首次调用 GetLoginToken 后,保存返回的 SessionId。该值仅在同一登录会话第一次调用时返回;需要继续认证时,后续请求携带已保存的 SessionId,不要因后续响应未返回该字段而将其清空。
根据响应中的 NextStage 判断是否还需认证,并将要求的下一认证阶段作为后续请求的 CurrentStage。例如:
| 下一认证阶段 | 后续操作 |
MFAVerify | 携带 SessionId 和虚拟 MFA 设备生成的 AuthenticationCode 继续调用 GetLoginToken。 |
TokenVerify | 携带 SessionId 和客户端二次认证验证码 TokenCode 继续认证。 |
ChangePassword | 按要求填写 OldPassword 和 NewPassword,完成修改密码阶段。 |
MFABind 或其他认证阶段 | 按实际返回的阶段及 GetLoginToken 文档完成对应操作;不要直接套用 MFAVerify 的请求参数。 |
认证阶段由账号配置及本次登录结果决定,并非每次登录都必须依次经过上述所有阶段。仅在登录认证完成并取得 LoginToken 后调用 StopAppResources;认证失败或尚有待完成的认证阶段时,不继续关闭资源。
3. 调用序列示例
以下为参数传递伪代码,不是可直接执行的 SDK 示例。clientId、tenantAlias、endUserId、password 和 authenticationCode 均为调用方运行时变量;resourceIds、productType、appInstanceGroupId 为本次操作的业务参数。请勿在示例或日志中写入真实密码、验证码或登录凭证。
login1 = GetLoginToken(version="2021-02-20",
ClientId=clientId, LoginIdentifier=tenantAlias,
CurrentStage="ADPassword", EndUserId=endUserId, Password=password)
sessionId = login1.SessionId
loginResult = login1
if loginResult.NextStage == "MFAVerify":
loginResult = GetLoginToken(version="2021-02-20",
ClientId=clientId, LoginIdentifier=tenantAlias,
SessionId=sessionId, CurrentStage="MFAVerify",
AuthenticationCode=authenticationCode)
如仍要求其他认证阶段,继续按 NextStage 处理;不要把上述一次 MFA 调用视为固定终点。登录完成后,使用本次登录取得的 LoginToken 和已保存的 SessionId 调用本接口:
StopAppResources(version="2021-09-03",
ClientId=clientId, LoginToken=loginResult.LoginToken, SessionId=sessionId,
ProductType=productType, AppInstanceGroupId=appInstanceGroupId,
ResourceIds=resourceIds)
Password、LoginIdentifier 和 CurrentStage 属于前置登录请求,不是 StopAppResources 的请求参数。本接口其他参数及资源 ID 的填写规则见下方请求参数表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| BizRegionId |
string |
否 |
业务地域 ID。 |
cn-hangzhou |
| LoginToken |
string |
是 |
登录 Token。 |
v12369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70**** |
| EndUserId |
string |
否 |
用户名。 |
testUser |
| SessionId |
string |
是 |
会话 ID。 |
597e869d-ea14-4b83-9490-714f68bfe935 |
| LoginRegionId |
string |
否 |
办公网络 ID 登录时候的地域 ID。 |
cn-hangzhou |
| Uuid |
string |
否 |
客户端 Uuid。 |
C50973691A6D2BE23F2CDD73B85B**** |
| ClientId |
string |
是 |
客户端 ID。 |
eac19bef-1e45-4190-a03a-4ea74b699ca7 |
| ClientOS |
string |
否 |
客户端操作系统。 |
windows_"Windows 10 Enterprise" 10.0 (Build 19042) |
| ClientVersion |
string |
否 |
客户端版本。 |
7.2.0-R-20241008.110000 |
| ClientIp |
string |
否 |
客户端 IP。 |
1.2.3.4 |
| ProductType |
string |
是 |
产品类型。 枚举值:
|
AndroidCloud |
| AppInstanceGroupId |
string |
是 |
资源组 ID。 |
aig-9ciijz60n4xsv**** |
| ResourceIds |
array |
是 |
资源 ID 列表。 |
|
|
string |
是 |
资源 ID。云手机请传入持久会话 ID。 |
p-00001 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应。 |
||
| RequestId |
string |
请求 ID。 |
829444D6-9FD3-5C65-A570-065975537647 |
| Code |
string |
错误码。 |
InvalidAppInstanceGroup.NotFound |
| Message |
string |
错误信息。 |
The app instance group is not found. |
| Success |
string |
请求成功与否,成功返回为 true,失败为 false |
true |
示例
正常返回示例
JSON格式
{
"RequestId": "829444D6-9FD3-5C65-A570-065975537647",
"Code": "InvalidAppInstanceGroup.NotFound",
"Message": "The app instance group is not found.",
"Success": "true"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。