- HTTP 请求
- 路径参数
- 请求正文
- 响应正文
- 授权范围
- 命令
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- 状态
- StopLostModeStatus
- 状态
- 试试看!
向设备发出命令。返回的 Operation
资源的 metadata
字段中包含 Command
。使用获取操作方法获取命令的状态。
HTTP 请求
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
name |
设备的名称,格式为 |
请求正文
请求正文包含一个 Command
实例。
响应正文
如果成功,则响应正文包含一个 Operation
实例。
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/androidmanagement
如需了解详情,请参阅 OAuth 2.0 概览。
命令
一个命令。
JSON 表示法 |
---|
{ "type": enum ( |
字段 | |
---|---|
type |
命令的类型。 |
create |
创建命令时的时间戳。时间戳由服务器自动生成。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
duration |
命令有效的时长。如果设备在此期间未执行该命令,该命令将过期。如果未指定,默认时长为 10 分钟。没有时长上限。 该时长以秒为单位,最多包含九个小数位,以“ |
user |
设备所有者用户的资源名称,格式为 |
error |
如果命令失败,则包含一个错误代码来说明失败原因。当调用方取消命令时,系统不会设置此值。 |
new |
对于类型为 |
reset |
对于类型为 |
联合字段 如果已设置此值,则不得设置 |
|
clear |
用于从设备中清除指定应用数据的 |
start |
用于将设备置于丢失模式的 |
stop |
用于让设备退出丢失模式的 |
联合字段 status 。特定于命令的状态。请注意,某些命令不使用此参数,尤其是 、 、 和 。将来,这些命令也可能会使用此变量。status 只能是下列其中一项: |
|
clear |
仅限输出。用于从设备中清除指定应用数据的 |
start |
仅限输出。用于将设备置于丢失模式的 |
stop |
仅限输出。用于让设备退出丢失模式的 |
CommandType
命令类型。
枚举 | |
---|---|
COMMAND_TYPE_UNSPECIFIED |
不允许使用此值。 |
LOCK |
锁定设备,就像锁屏超时已过一样。 |
RESET_PASSWORD |
重置用户的密码。 |
REBOOT |
重新启动设备。仅适用于搭载 Android 7.0(API 级别 24)或更高版本的全托管式设备。 |
RELINQUISH_OWNERSHIP |
从公司自有的 Android 8.0 及更高版本设备中移除工作资料和所有政策,将设备交还给个人使用。系统会保留与个人资料关联的应用和数据。设备确认该命令后,系统会将其从服务器中删除。 |
CLEAR_APP_DATA |
清除指定应用的应用数据。Android 9 及更高版本支持此功能。请注意,应用可以将数据存储在其应用数据之外,例如存储在外部存储设备中或用户字典中。另请参阅 。 |
START_LOST_MODE |
使设备进入丢失模式。仅适用于全托管式设备或具有受管理资料的组织自有设备。另请参阅 。 |
STOP_LOST_MODE |
让设备退出丢失模式。仅适用于全托管式设备或具有受管理资料的组织自有设备。另请参阅 。 |
CommandErrorCode
命令错误代码。此字段是由服务器填充的只读字段。
枚举 | |
---|---|
COMMAND_ERROR_CODE_UNSPECIFIED |
没有错误。 |
UNKNOWN |
发生未知错误。 |
API_LEVEL |
设备的 API 级别不支持此命令。 |
MANAGEMENT_MODE |
管理模式(资料所有者、设备所有者等)不支持该命令。 |
INVALID_VALUE |
命令的参数值无效。 |
UNSUPPORTED |
设备不支持该命令。将 Android Device Policy 更新到最新版本或许可以解决此问题。 |
ResetPasswordFlag
可用于 RESET_PASSWORD
命令类型的标志。
枚举 | |
---|---|
RESET_PASSWORD_FLAG_UNSPECIFIED |
系统会忽略此值。 |
REQUIRE_ENTRY |
在用户输入密码之前,不允许其他管理员再次更改密码。 |
DO_NOT_ASK_CREDENTIALS_ON_BOOT |
请勿在设备启动时请求用户凭据。 |
LOCK_NOW |
重置密码后锁定设备。 |
ClearAppsDataParams
与
命令相关联的参数,用于清除设备中指定应用的数据。CLEAR_APP_DATA
JSON 表示法 |
---|
{ "packageNames": [ string ] } |
字段 | |
---|---|
package |
执行该命令时将清除其数据的应用的软件包名称。 |
StartLostModeParams
与
命令关联的参数,用于将设备置于丢失模式。必须提供至少一个参数(不包括组织名称),才能将设备置于丢失模式。START_LOST_MODE
JSON 表示法 |
---|
{ "lostMessage": { object ( |
字段 | |
---|---|
lost |
设备处于丢失模式时向用户显示的消息。 |
lost |
当设备处于丢失模式且用户点按“致电所有者”按钮时,系统会拨打此电话号码。 |
lost |
设备处于丢失模式时向用户显示的电子邮件地址。 |
lost |
设备处于丢失模式时向用户显示的街道地址。 |
lost |
设备处于丢失模式时系统向用户显示的组织名称。 |
StopLostModeParams
此类型没有字段。
与
命令关联的参数,用于让设备退出丢失模式。STOP_LOST_MODE
ClearAppsDataStatus
用于从设备中清除指定应用数据的
命令的状态。CLEAR_APP_DATA
JSON 表示法 |
---|
{
"results": {
string: {
object ( |
字段 | |
---|---|
results |
各应用的结果,即从软件包名称到相应清除结果的映射。 包含一系列 |
PerAppResult
尝试清除单个应用数据的结果。
JSON 表示法 |
---|
{
"clearingResult": enum ( |
字段 | |
---|---|
clearing |
尝试清除单个应用数据的结果。 |
ClearingResult
尝试清除单个应用数据的结果。
枚举 | |
---|---|
CLEARING_RESULT_UNSPECIFIED |
未指定结果。 |
SUCCESS |
此应用的数据已成功清除。 |
APP_NOT_FOUND |
系统找不到此应用,因此无法清除其数据。 |
APP_PROTECTED |
由于此应用受保护,因此无法清除其数据。例如,这可能适用于对设备正常运行至关重要的应用,例如 Google Play 商店。 |
API_LEVEL |
设备 API 级别不支持此命令,因此无法清除此应用的数据。 |
StartLostModeStatus
用于将设备置于丢失模式的
命令的状态。START_LOST_MODE
JSON 表示法 |
---|
{
"status": enum ( |
字段 | |
---|---|
status |
状态。请参阅 |
状态
状态。请参阅
。StartLostModeStatus
枚举 | |
---|---|
STATUS_UNSPECIFIED |
未指定。此值未使用。 |
SUCCESS |
设备已进入丢失模式。 |
RESET_PASSWORD_RECENTLY |
由于管理员最近重置了设备的密码,因此无法将设备置于丢失模式。 |
USER_EXIT_LOST_MODE_RECENTLY |
由于用户最近退出了丢失模式,因此无法将设备置于丢失模式。 |
ALREADY_IN_LOST_MODE |
设备已处于丢失模式。 |
StopLostModeStatus
用于让设备退出丢失模式的
命令的状态。STOP_LOST_MODE
JSON 表示法 |
---|
{
"status": enum ( |
字段 | |
---|---|
status |
状态。请参阅 |
状态
状态。请参阅
。StopLostModeStatus
枚举 | |
---|---|
STATUS_UNSPECIFIED |
未指定。此值未使用。 |
SUCCESS |
设备已退出丢失模式。 |
NOT_IN_LOST_MODE |
设备未处于丢失模式。 |