取得應用角色權限
更新時間:2025-07-17 14:55:09
介面描述
1、获取应用角色权限
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/user/webapp-role/get
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁保存在客戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| roleId | true | Integer | 角色ID |
範例
http://api.polyv.net/live/v4/user/webapp-role/get?roleId=1&appId=frlr1zazn3&sign=4D418459FA42A9F88475022E33945955×tamp=1659056102639
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與http狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求產生的唯一UUID,僅可用於排查、除錯,不應該和業務掛鉤 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位描述】 |
| data | Object | 角色權限資訊【詳見Data參數描述】 |
Error參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與error.code對應 |
Data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| role | Object | 角色資訊【詳見Role參數描述】 |
| permissions | Array | 權限列表【詳見Permissions參數描述】 |
Role參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| id | Integer | 角色ID |
| name | String | 角色名稱 |
| userId | String | 使用者ID |
| description | String | 角色描述 |
| status | String | 角色狀態 |
| createdTime | Long | 建立時間(13位毫秒級時間戳記) |
| lastModified | Long | 最後修改時間(13位毫秒級時間戳記) |
| permissionName | String | 權限名稱 |
| isOldRole | Boolean | 是否為舊角色 |
| type | String | 角色類型(root:僅主帳號可見, child:主帳號和子帳號都可見) |
Permissions參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| id | Integer | 權限ID |
| type | String | 權限類型 |
| name | String | 權限名稱 |
| code | String | 權限代碼 |
| parentId | Integer | 父權限ID |
| lft | Integer | 左節點值(用於樹狀結構) |
| rgt | Integer | 右節點值(用於樹狀結構) |
| createdTime | Long | 建立時間(13位毫秒級時間戳記) |
| lastModified | Long | 最後修改時間(13位毫秒級時間戳記) |
| depth | Integer | 權限層級深度 |
| owned | Boolean | 是否擁有該權限 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、例外處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 获取应用角色权限
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getRoleTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/user/webapp-role/get";
String roleId = "1";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("roleId", roleId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试获取应用角色权限成功:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "8352399b-d440-4e21-affa-2ea10e734c52",
"data": {
"role": {
"id": 3521,
"name": "测试角色",
"userId": "2b3ccac944",
"description": "这是一个测试角色",
"status": null,
"createdTime": 1752731090000,
"lastModified": 1752731090000,
"permissionName": null,
"isOldRole": null,
"type": "root"
},
"permissions": [
{
"id": 102,
"type": "LIVE_V2",
"name": "直播权限",
"code": "live_v2",
"parentId": 0,
"lft": 1,
"rgt": 310,
"createdTime": 1619769766000,
"lastModified": 1619769766000,
"depth": 0,
"owned": false
},
{
"id": 103,
"type": "LIVE_V2",
"name": "新建直播",
"code": "live-create-channel-center",
"parentId": 1,
"lft": 2,
"rgt": 7,
"createdTime": 1619769799000,
"lastModified": 1678786231000,
"depth": 1,
"owned": false
}
]
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "角色不存在"
},
"success": false
}
