GetRedisAllSession - 擷取Redis執行個體當前會話 -

調用GetRedisAllSession介面，擷取Redis執行個體當前會話資料。

介面說明

本介面只適用於 Redis 引擎。
在使用 SDK 調用 DAS 服務時，需要將地區指定為 cn-shanghai。

說明

對於 Redis 叢集版資料庫執行個體，無法擷取使用直連模式產生的會話。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:GetRedisAllSession

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ConsoleContext	string	否	備用參數。	None
InstanceId	string	是	資料庫執行個體 ID。	r-2zemyfd1sh1u2i****

返回參數

名稱	類型	描述	樣本值
	object
Code	integer	返回的狀態代碼。	200
Message	string	請求返回的訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
Data	object	會話資料。
Timestamp	integer	擷取資料庫會話資料的時間，格式為 Unix 時間戳記，單位為毫秒（ms）。	1660100753556
Total	integer	會話總數。	2
Sessions	array<object>	會話資訊。
	object
Sub	integer	頻道訂閱數量。	0
Psub	integer	模式比對的訂閱數量。	0
Idle	integer	空閑時間長度，單位為秒（s）。	8
Flags	string	用戶端標誌，取值如下： A：儘快關閉串連。 b：用戶端正在等待阻塞事件。 c：寫入全部回複後將關閉串連。 d：受監視的鍵已被修改，`EXEC`命令將失敗。 i：用戶端正在等待虛擬機器 I/O 操作（已廢棄）。 M：用戶端是主節點。 N：未設定特點標誌。 O：處於監視模式的用戶端。 r：用戶端是唯讀模式的叢集節點。 S：用戶端是一般模式下的從節點。 u：用戶端未被阻塞。 U：通過 Unix 域通訊端串連的用戶端。 x：用戶端正在執行事務。	N
Oll	integer	輸出資料行表包含的對象數量。	0
QbufFree	integer	輸入緩衝區剩餘大小，單位為位元組（Byte）。	0
Multi	integer	`MULTI`/`EXEC`上下文中的命令數。	-1
Omem	integer	輸出緩衝區大小，單位為位元組（Byte）。	0
Qbuf	integer	輸入緩衝區大小，單位為位元組（Byte）。	0
Name	string	用戶端名稱。	test
Obl	integer	輸出固定緩衝區大小，單位為位元組（Byte）。	0
Client	string	用戶端的地址。	172.16.XX.XX
Cmd	string	最近一次執行的命令。	PING
Id	integer	用戶端識別碼。	9080586
Addr	string	用戶端的地址和連接埠。	172.16.XX.XX:53458
NodeId	string	節點 ID。	r-2zemyfd1sh1u2i**-proxy-14#1679**
Age	string	已串連時間長度，單位為秒（s）。	12
Db	integer	該用戶端正在使用的資料庫 ID。	0
Events	string	檔案描述符事件，取值為： r：用戶端通訊端在事件 Loop 中可讀。 w：用戶端通訊端在事件 Loop 中可寫。	r
Fd	integer	通訊端所使用的檔案描述符。	73
ClientDesc	string	用戶端別名。	prod ip
SourceStats	array<object>	訪問來源統計資料。
	object
Key	string	訪問來源。	172.16.XX.XX
Count	string	該訪問來源的會話總數。	1
Ids	array	用戶端識別碼資料。
	integer	用戶端識別碼。	9080586
RequestId	string	請求 ID。	40C6E9AF-6C23-5614-AA83-34344CC6****
Success	boolean	請求是否執行成功： true：執行成功。 false：執行失敗。	true

樣本

正常返回樣本

JSON格式

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Timestamp": 1660100753556,
    "Total": 2,
    "Sessions": [
      {
        "Sub": 0,
        "Psub": 0,
        "Idle": 8,
        "Flags": "N",
        "Oll": 0,
        "QbufFree": 0,
        "Multi": -1,
        "Omem": 0,
        "Qbuf": 0,
        "Name": "test",
        "Obl": 0,
        "Client": "172.16.XX.XX",
        "Cmd": "PING",
        "Id": 9080586,
        "Addr": "172.16.XX.XX:53458",
        "NodeId": "r-2zemyfd1sh1u2i****-proxy-14#1679****",
        "Age": "12",
        "Db": 0,
        "Events": "r",
        "Fd": 73,
        "ClientDesc": "prod ip"
      }
    ],
    "SourceStats": [
      {
        "Key": "172.16.XX.XX",
        "Count": "1",
        "Ids": [
          9080586
        ]
      }
    ]
  },
  "RequestId": "40C6E9AF-6C23-5614-AA83-34344CC6****",
  "Success": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

變更歷史

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