StopApp - 停止应用

更新时间:
复制 MD 格式

停止指定应用。

接口说明

凭据获取

如果需要通过 GetLoginToken 获取 LoginToken 和 SessionId,请调用 appstream-center 2021-02-20 版本的 GetLoginToken;2021-09-03 版本不提供该接口。LoginToken 也可以通过 RefreshLoginToken 更新获取。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

AppInstanceGroupId

string

否

交付组 ID。 通过接口 ListRunningApps 获取,参数:AppInstanceGroupId 此参数为必填项,未提供或对应的交付组不存在时服务返回 400 错误,错误码为 InvalidAppInstanceGroup.NotFound。

aig-89ibriac2wudyph38

AppInstanceId

string

否

实例 ID。 通过接口 ListRunningApps 获取,参数:AppInstanceId

ai-d297eyf83g5niwnjl

AppId

string

否

应用 ID。 通过接口 ListRunningApps 获取,参数:AppId

ca-fxwp4koywsglzvvex

ProductType

string

否

产品类型,取值仅可为CloudApp,表示无影云应用。 此参数为必填项,未提供或取值不合法时服务返回 400 错误,错误码为 ProductTypeInvalid。

枚举值:

  • CloudApp :

    云应用

CloudApp

ForceStop

boolean

否

是否强制停止

枚举值:

  • false :

    不强制停止

  • true :

    强制停止

false

ApiType

string

否

接口类型。取值仅可为 AnonymousUserAPI,表示客户端调用接口。

枚举值:

  • AnonymousUserAPI :

    AnonymousUserAPI

AnonymousUserAPI

ClientId

string

否

客户端生成的唯一 ID。

91b79184-51d0-42ad-8475-78cae95b0aa6

LoginToken

string

否

登录凭证。 通过 GetLoginToken 接口登录获取,或登录后通过更新接口 RefreshLoginToken 获取。返回参数:LoginToken。 此参数为必填项,未提供时服务返回 400 错误,错误码为 InvalidParameter.loginToken。

v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d330e

EndUserId

string

否

便捷账号用户名。

test.test

SessionId

string

否

会话 ID。 通过登录接口 GetLoginToken 获取,返回参数:SessionId。 此参数为必填项,未提供时服务返回 400 错误,错误码为 InvalidParameter.sessionId。

597e869d-ea14-4b83-9490-714f68bfe935

ClientOS

string

否

客户端操作系统。

windows_"Windows 10 Enterprise" 10.0 (Build 19042)

ClientVersion

string

否

客户端版本。

3.1.1-R-20211022.144255

ClientIp

string

否

客户端 IP。

22.21.2.79

BizRegionId

string

否

交付组所属的地域 ID。 通过接口 ListRunningApps 获取,参数:RegionId

cn-hangzhou

LoginRegionId

string

否

登录的 regionId。 用户登录时所选的工作区 regionId。

cn-hangzhou

ClientChannel

string

否

app 客户端标识,用于区分不同应用。

枚举值:

  • pc :

    pc

  • web :

    web

  • mobile :

    mobile

pc

Uuid

string

否

设备 UUID

2943802884B27030B6759F9132B26903

WyId

string

否

无影用户 ID。 通过登录接口 GetLoginToken 获取,返回参数:WyId。

ac3cb49059261898

IdpId

string

否

登录认证服务 ID 通过接口 FindIdpListByLoginName 获取

idp-9ie5smicnct2xodn2

AliUid

integer

否

租户 ID。 通过登录接口 GetLoginToken 获取,返回参数:TenantId。

1924794279035094

RegionId

string

否

交付组所属的地域 ID。 通过接口 ListRunningApps 获取,参数:RegionId

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

BaseResult

RequestId

string

请求 ID。

83A9075B-C646-59A9-8232-CAE41AF4B9E3

示例

正常返回示例

JSON格式

{
  "RequestId": "83A9075B-C646-59A9-8232-CAE41AF4B9E3"
}

错误码

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

变更历史

更多信息,参考变更详情。