检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。
Unauthorized 权限无效。 403 Forbidden 不允许执行当前请求。 404 Not Found 请求的资源没有找到。 405 Method Not Allowed 对资源的操作不允许。 406 Not Acceptable 请求的资源的内容特性无法满足请求头中的条件,因而无法生成响应实体。
状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响
KOOPHONE.API.1000 请求参数错误 请求参数错误 检查请求参数类型及范围 400 KOOPHONE.API.1002 实例非同一个大区 实例非同一个大区 修改请求实例为同一个大区 401 KOOPHONE.API.1001 无实例权限 无实例权限 检查请求传入的实例id是否正确 500
选择“成员管理 > 创建成员”。参考表1填写成员信息,填写完成后,单击“下一步”。 表1 创建成员参数说明 参数名称 参数说明 成员姓名 成员的姓名。最多可输入20个任意字符,不支持输入空格。 成员账号 管理员为成员设置的账号。输入账号前半部分,后面默认带组织域名后缀。 例如:zhangsan01@abc
获取项目ID 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。项目ID获取步骤如下: 登录华为云管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。 图1 查看项目ID 父主题: 附录
如何调用API 构造请求 认证鉴权 返回结果
12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。
由于KooPhone在运行中对计算、存储等各类云服务资源存在依赖关系,因此首次登录KooPhone控制台时,KooPhone将自动请求获取当前区域下的云资源权限,从而更好地为提供服务。 KooPhone自动请求获取的服务权限包括: 访问计算类服务 为KooPhone云手机实例提供虚拟化管理,因此需要获取访问CPH云手机服务的权限。
/v1/instances/batch-query-status 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-request-id 是 String 消息跟踪唯一id X-Auth-Token 是 String 租户级Token 表2 请求Body参数 参数 是否必选 参数类型
resentational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 终端节点 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同。KooPhone的终端节点为“koophone.myhuaweicloud
包年/包月转按需 创建一个包年/包月云手机实例后,您可以将该实例的计费模式转为按需计费,回收部分成本,同时更加灵活地按需使用云手机实例。 包年/包月立即转按需 包年/包月立即转按需会退还当前周期的剩余费用,订单完成后,按需的计费模式立即生效。 登录KooPhone管理控制台,进入KooPhone云手机页面。
/v1/instances/async-command 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-request-id 是 String 消息跟踪唯一id X-Auth-Token 是 String 租户级Token 表2 请求Body参数 参数 是否必选 参数类型
调用该接口后,当前实例会被初始化。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v1/instances/batch-reset 请求参数 表1 请求Header参数
/v1/instances/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 异步请求返回的任务id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-request-id 是 String 消息跟踪唯一id X-Auth-Token
默认情况下,新建的IAM用户没有任何权限,您需要将其加入用户组,并给用户组授予策略或角色,才能使得用户组中的用户获得对应的权限,这一过程称为授权。授权后,用户就可以基于被授予的权限对云服务进行操作。 KooPhone部署时通过物理区域划分,为项目级服务。授权时,“作用范围”需要选择 “区域级
/v1/instances/sync-command 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-request-id 是 String 消息跟踪唯一id X-Auth-Token 是 String 租户级Token 表2 请求Body参数 参数 是否必选 参数类型
/v1/instances/video-setting 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-request-id 是 String 消息跟踪唯一id X-Auth-Token 是 String 租户级Token 表2 请求Body参数 参数 是否必选 参数类型
/v1/instances/{instance_id}/auth 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 租户的iam token信息 响应参数