开关访问控制
功能介绍
典型场景
开启或关闭URL鉴权时调用此接口。
接口功能
URL鉴权
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v2/apps/{app_id}/authentication
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
app_id |
是 |
String |
应用id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
内容类型。 |
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable |
是 |
Boolean |
开启或关闭URL鉴权 |
expire |
否 |
Integer |
有效期,当开启鉴权时必填。 取值范围:[60,2592000],缺省为300。 单位:秒。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-Id |
String |
此字段携带请求ID号,以便任务跟踪。 |
参数 |
参数类型 |
描述 |
---|---|---|
app_id |
String |
应用id |
authentication |
AppAuth object |
鉴权配置 |
参数 |
参数类型 |
描述 |
---|---|---|
enable |
Boolean |
开启或关闭URL鉴权 |
expire |
Integer |
接入RTC建链认证时的signature的有效期。单位:秒。默认300秒。signature由app_key生成 |
app_key |
String |
APP鉴权密钥 |
update_time |
String |
app鉴权的更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-Id |
String |
此字段携带请求ID号,以便任务跟踪。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
X-request-Id |
String |
此字段携带请求ID号,以便任务跟踪。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
X-request-Id |
String |
此字段携带请求ID号,以便任务跟踪。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
开启指定应用id的URL鉴权
PUT https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/authentication { "enable" : true, "expire" : 300 }
响应示例
状态码: 200
鉴权密钥
{ "app_id" : "123456789abcdefghijklmno", "authentication" : { "app_key" : "ACTIVATION", "enable" : true, "expire" : 300, "update_time" : "2020-07-26T07:03:05.075Z" } }
状态码: 400
语义有误,当前请求无法被服务器理解,或参数有误
{ "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" }
状态码: 404
app编号不存在
{ "error_code" : "RTC.00001015", "error_msg" : "AppNotExist" }
状态码: 500
设置失败,服务器端错误
{ "error_code" : "RTC.00002xxx", "error_msg" : "InternalError" }
状态码
状态码 |
描述 |
---|---|
200 |
鉴权密钥 |
400 |
语义有误,当前请求无法被服务器理解,或参数有误 |
404 |
app编号不存在 |
500 |
设置失败,服务器端错误 |
错误码
请参见错误码。