云服务器内容精选
-
AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。
-
响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述 状态码：500 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述
-
Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。
-
请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-request-id 是 String 消息跟踪唯一id X-Auth-Token 是 String 租户级Token 表2 请求Body参数 参数 是否必选 参数类型 描述 instance_ids 是 Array of strings 实例列表，单个实例最大长度32，列表最大长度100 instance_settings 是 Array of InstanceSetting objects 视频设置内容 表3 InstanceSetting 参数 是否必选 参数类型 描述 network_type 是 String 网络类型，枚举：MOBILE_NETWORK/WIFI/WIRED，注意这三个参数都必须有，配合encoding_type必填的2种参数共6种组合，详细先看请求示例 encoding_type 是 String 编码类型，H264/H265，注意这两个参数都必须有，配合network_type必填的3种参数共6种组合，详细先看请求示例 video_spec_groups 是 Array of VideoSpecGroup objects 视频规格组 表4 VideoSpecGroup 参数 是否必选 参数类型 描述 definition_540P 是 VideoSpec object 标清参数设置，540P definition_720P 是 VideoSpec object 高清参数设置，720P definition_1080P 是 VideoSpec object 超清参数设置，1080P 表5 VideoSpec 参数 是否必选 参数类型 描述 code_rate 是 Integer 码率，单位kbps，值范围100-10000，需要是100的倍数 fps 是 Integer 帧率，单位fps，可选30，60
-
请求示例 /v1/instances/video-setting{ "instance_ids" : [ "iRJEVP96" ], "instance_settings" : [ { "network_type" : "MOBILE_NETWORK", "encoding_type" : "H264", "video_spec_groups" : [ { "definition_540P" : { "code_rate" : 6000, "fps" : 30 }, "definition_720P" : { "code_rate" : 6000, "fps" : 30 }, "definition_1080P" : { "code_rate" : 8000, "fps" : 30 } } ] }, { "network_type" : "MOBILE_NETWORK", "encoding_type" : "H265", "video_spec_groups" : [ { "definition_540P" : { "code_rate" : 6000, "fps" : 30 }, "definition_720P" : { "code_rate" : 6000, "fps" : 30 }, "definition_1080P" : { "code_rate" : 8000, "fps" : 30 } } ] }, { "network_type" : "WIFI", "encoding_type" : "H264", "video_spec_groups" : [ { "definition_540P" : { "code_rate" : 6000, "fps" : 30 }, "definition_720P" : { "code_rate" : 6000, "fps" : 30 }, "definition_1080P" : { "code_rate" : 8000, "fps" : 30 } } ] }, { "network_type" : "WIFI", "encoding_type" : "H265", "video_spec_groups" : [ { "definition_540P" : { "code_rate" : 6000, "fps" : 30 }, "definition_720P" : { "code_rate" : 6000, "fps" : 30 }, "definition_1080P" : { "code_rate" : 8000, "fps" : 30 } } ] }, { "network_type" : "WIRED", "encoding_type" : "H264", "video_spec_groups" : [ { "definition_540P" : { "code_rate" : 6000, "fps" : 30 }, "definition_720P" : { "code_rate" : 6000, "fps" : 30 }, "definition_1080P" : { "code_rate" : 8000, "fps" : 30 } } ] }, { "network_type" : "WIRED", "encoding_type" : "H265", "video_spec_groups" : [ { "definition_540P" : { "code_rate" : 6000, "fps" : 30 }, "definition_720P" : { "code_rate" : 6000, "fps" : 30 }, "definition_1080P" : { "code_rate" : 8000, "fps" : 30 } } ] } ]}
-
响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述
-
响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 error_code String 响应码，错误码规范KooPhone.API.1001，数字递增 error_msg String 响应描述 data InstanceAsyncCommandsInfo object 响应内容 表4 InstanceAsyncCommandsInfo 参数 参数类型 描述 task_id String 任务id cmd_jobs Array of CmdJob objects 响应任务列表 表5 CmdJob 参数 参数类型 描述 instance_id String 实例列表 job_id String 异步命令任务id 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述
-
请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-request-id 是 String 消息跟踪唯一id X-Auth-Token 是 String 租户级Token 表2 请求Body参数 参数 是否必选 参数类型 描述 command 是 String 命令，最大长度为1024字节，只支持大小写字母、数字、下划线（_）、点（.）、斜线（/）、冒号（:）、中划线（-）。 instance_ids 是 Array of strings 实例列表
-
响应示例 状态码：200 正常响应 { "data" : { "task_id" : "6837531fd3f54550927b930180a706bf", "cmd_jobs" : [ { "instance_id" : "a44uhlf7", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "instance_id" : "efjy72gs", "job_id" : "1564567b8bab40f34711234cb80d0456" } ] }, "error_code" : "0", "error_msg" : "ok"}
-
响应示例 状态码：200 实例鉴权接口返回设备信息 { "data" : { "resource" : { "sdk" : { "internal" : { "address" : null, "aport" : null, "atype" : null, "address_ipv6" : null }, "external" : { "address" : "10.83.71.187", "aport" : 10030, "atype" : 1, "address_ipv6" : null } }, "rtc" : { "ice_signaling" : { "signaling_url" : "http://100.93.2.248:18082", "expired_time" : null, "ice_servers" : [ ] } }, "device_id" : "7b0cd026df8d495b8a65d628d7bec433", "kp_id" : "Q39YyZvI" }, "device_token" : "dee5081f40c83ddea3ded91c387351e9" }, "error_code" : "0", "error_msg" : "ok"} 状态码：400 请求错误 { "error_code" : "string", "error_msg" : "string"} 状态码：500 内部错误 { "error_code" : "string", "error_msg" : "string"}
-
响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data data object 反参全部信息 error_code String 错误码 error_msg String 错误信息 表4 data 参数 参数类型 描述 resource resource object 资源集合 device_token String 设备鉴权token 表5 resource 参数 参数类型 描述 sdk sdk object sdk信息 rtc rtc object rtc信息 device_id String 设备id kp_id String 云机实例Id，如whklpuo1 表6 sdk 参数 参数类型 描述 internal internal object 内网信息 external external object 外网信息 表7 internal 参数 参数类型 描述 address String 内网ip地址 aport String 音频端口 atype String 音频类型 address_ipv6 String ipv6地址 表8 external 参数 参数类型 描述 address String 外网eip地址 aport Integer 音频端口 atype Integer 音频类型 address_ipv6 String 外网ipv6地址 表9 rtc 参数 参数类型 描述 ice_signaling ice_signaling object ice信令信息 表10 ice_signaling 参数 参数类型 描述 signaling_url String 信令服务访问地址 expired_time String streaming时长。单位秒 ice_servers Array of strings ICE 服务器 状态码：400 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述
-
响应示例 状态码：200 正常响应 { "data" : { "jobs" : [ { "job_id" : "1564567b8bab40f34711234cb80d0123", "status" : -1, "error_code" : "CPS0005", "error_msg" : "Phone not found.", "execute_msg" : null }, { "job_id" : "1564567b8bab40f34711234cb80d0456", "status" : 2, "error_code" : "", "error_msg" : "", "execute_msg" : "xxxxxx" } ] }, "error_code" : "0", "error_msg" : "ok"}
-
响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 error_code String 响应码，错误码规范KooPhone.API.1001，数字递增 error_msg String 响应描述 data JobDetailWrapper object 根据task_id查询出的任务列表 表4 JobDetailWrapper 参数 参数类型 描述 jobs Array of JobDetail objects 根据task_id查询出的任务列表 表5 JobDetail 参数 参数类型 描述 job_id String 任务唯一标识 status Integer 任务状态。1 表示运行中，2表示成功，-1表示失败 error_code String 任务错误码 error_msg String 任务错误码说明 execute_msg String 任务执行返回内容，最长1024字节。命令执行成功和失败均将命令的输出返回 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码，KOOPHONE.API.xxxx或者common.00000xxx error_msg String 响应描述
-
状态码 常用状态码请参见表1。 表1 请求状态返回码 状态码 描述 说明 200 OK 资源获取成功。 201 Created 资源创建成功。 202 Accepted 已经接受处理。 204 No Content 操作成功，但无数据。 400 Bad Request 请求内容缺失或无效的请求内容。 401 Unauthorized 权限无效。 403 Forbidden 不允许执行当前请求。 404 Not Found 请求的资源没有找到。 405 Method Not Allowed 对资源的操作不允许。 406 Not Acceptable 请求的资源的内容特性无法满足请求头中的条件，因而无法生成响应实体。 409 Conflict 由于和被请求的资源的当前状态之间存在冲突，请求无法完成。 411 Missing Content-Length 请求的报文中缺少http content-length头域。 413 Request Entity Too Large 服务器拒绝处理当前请求，因为该请求提交的实体数据大小超过了服务器愿意或者能够处理的范围。 416 Requested range not satisfiable 如果请求中包含了Range请求头，并且 Range中指定的任何数据范围都与当前资源的可用范围不重合，同时请求中又没有定义 If-Range 请求头，那么服务器就应当返回416状态码。 429 Too Many Requests 服务器会对接口进行流控，超过了接口限流要求，服务器将无法处理。 500 Internal Server Error 服务器遇到了一个未曾预料的状况，导致了它无法完成对请求的处理。 501 Not Implemented 请求中所涉及到的操作和元数据，系统未实现，不能处理。 503 Service Unavailable 用户发起太频繁请求，系统暂时不能为该用户提供服务。 父主题： 附录
-
请求消息体 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 91011121314151617181920212223242526 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } }} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
更多精彩内容
CDN加速
GaussDB
文字转换成语音
免费的服务器
如何创建网站
域名网站购买
私有云桌面
云主机哪个好
域名怎么备案
手机云电脑
SSL证书申请
云点播服务器
免费OCR是什么
电脑云桌面
域名备案怎么弄
语音转文字
文字图片识别
云桌面是什么
网址安全检测
网站建设搭建
国外CDN加速
SSL免费证书申请
短信批量发送
图片OCR识别
云数据库MySQL
个人域名购买
录音转文字
扫描图片识别文字
OCR图片识别
行驶证识别
虚拟电话号码
电话呼叫中心软件
怎么制作一个网站
Email注册网站
华为VNC
图像文字识别
企业网站制作
个人网站搭建
华为云计算
免费租用云托管
云桌面云服务器
ocr文字识别免费版
HTTPS证书申请
图片文字识别转换
国外域名注册商
使用免费虚拟主机
云电脑主机多少钱
鲲鹏云手机
短信验证码平台
OCR图片文字识别
SSL证书是什么
申请企业邮箱步骤
免费的企业用邮箱
云免流搭建教程
域名价格
