通過GetGatewayAuthConsumerDetail擷取網關鑒權消費者細節-微服務引擎-阿里雲

擷取網關鑒權消費者細節。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:GetGatewayAuthConsumerDetail

get

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

無

請求參數

名稱	類型	必填	描述	樣本值
GatewayUniqueId	string	是	網關唯一標識 ID。	gw-1a4ab101d5924b6f92c5ec98a84*****
Id	integer	是	鑒權消費者 ID。	120
AcceptLanguage	string	否	返回資訊的語言類型： zh：中文 en：英文	zh

返回參數

名稱	類型	描述	樣本值
	object	RestResult<List>
RequestId	string	請求 ID。	316F5F64-F73D-42DC-8632-01E308B6****
Success	boolean	請求結果，取值如下： `true`：請求成功。 `false`：請求失敗。	true
Code	integer	code 僅僅用來和 success 同步。	200
ErrorCode	string	錯誤碼。	mse-100-000
HttpStatusCode	integer	HTTP 狀態代碼。	200
Message	string	返回資訊。	請求處理成功
DynamicCode	string	動態錯誤資訊中的預留位置。	code
DynamicMessage	string	動態錯誤資訊，用於替換返回參數 ErrMessage 錯誤資訊中的%s。說明如果 ErrMessage 返回The Value of Input Parameter %s is not valid，且 DynamicMessage 返回 DtsJobId，則代表所傳入的請求參數 DtsJobId 不合法。	The specified parameter is invalid.
Data	object	資料結構。
Id	integer	鑒權消費者 ID。	12
Name	string	鑒權消費者名稱。	test
ConsumerStatus	boolean	鑒權消費者狀態： true：啟用 false：停用	true
PrimaryUser	string	建立人。	123
GatewayUniqueId	string	網關唯一標識 ID。	gw-7ea3da97b96543e19f6c597cd4a9****
Type	string	鑒權類型： JWT	JWT
GmtCreate	string	建立時間。	2023-02-01 14:17:57
GmtModified	string	更新時間。	2023-03-01 14:17:57
Description	string	描述。	描述
EncodeType	string	加密類型： RSA OCT	RSA
Jwks	string	JWT 公開金鑰，支援 JSON 格式。	{ "keys": [ { "e": "AQAB", "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ", "kty": "RSA", "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ" } ] }
TokenName	string	要校正的 Token 參數資訊的名稱，預設是以 Bearer 為首碼放在 Authorization header 中，例如：`Authorization: Bearer token`。	Authorization
TokenPass	boolean	是否透傳。	true
TokenPosition	string	要校正的 Token 參數資訊的位置，預設是以 Bearer 為首碼放在 Authorization header 中，例如：`Authorization: Bearer token`。	HEADER
TokenPrefix	string	要校正的 Token 參數資訊的首碼，預設是以 Bearer 為首碼放在 Authorization header 中，例如：`Authorization: Bearer token`。	Bearer
KeyName	string	JWT 內身份標識 KeyName。	iss
KeyValue	string	JWT 內身份標識 KeyValue。	abcd
ResourceList	array<object>	資源清單
	object	資源清單
Id	integer	鑒權消費者授權 ID。	16
ConsumerId	integer	網關鑒權消費者 ID。	123
RouteId	integer	路由 ID。	3458
RouteName	string	路由名稱。	test
ResourceStatus	boolean	資源授權狀態： true：啟用 false：停用	true
GatewayUniqueId	string	網關唯一標識 ID。	gw-4822033a8513496fa10f05c934f*****
GmtCreate	string	建立時間。	2022-12-06 01:38:03
GmtModified	string	修改時間。	2022-12-06 01:38:03

樣本

正常返回樣本

JSON格式

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "請求處理成功",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "Id": 12,
    "Name": "test",
    "ConsumerStatus": true,
    "PrimaryUser": "123",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597cd4a9****",
    "Type": "JWT",
    "GmtCreate": "2023-02-01 14:17:57",
    "GmtModified": "2023-03-01 14:17:57",
    "Description": "描述",
    "EncodeType": "RSA",
    "Jwks": "{\n      \"keys\": [\n            {\n                  \"e\": \"AQAB\",\n                  \"kid\": \"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\",\n                  \"kty\": \"RSA\",\n                  \"n\": \"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\"\n            }\n      ]\n}",
    "TokenName": "Authorization",
    "TokenPass": true,
    "TokenPosition": "HEADER",
    "TokenPrefix": "Bearer ",
    "KeyName": "iss",
    "KeyValue": "abcd",
    "ResourceList": [
      {
        "Id": 16,
        "ConsumerId": 123,
        "RouteId": 3458,
        "RouteName": "test",
        "ResourceStatus": true,
        "GatewayUniqueId": "gw-4822033a8513496fa10f05c934f*****",
        "GmtCreate": "2022-12-06 01:38:03",
        "GmtModified": "2022-12-06 01:38:03"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalRequest	Invalid request:%s	非法請求： %s
400	InvalidParameter	Parameter error:%s	請求參數錯誤：%s
500	InternalError	Console error. Try again later:%s	控制台錯誤.稍後重試：%s
403	NoPermission	You are not authorized to perform this operation:%s	沒有許可權使用此介面：%s
404	NotFound	Not found:%s	資源不存在：%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。