GetMongoDBCurrentOp - Database Autonomy Service - Alibaba Cloud Documentation Center

Queries the current sessions of an ApsaraDB for MongoDB (MongoDB) instance.

Operation description

This operation is applicable only to MongoDB instances.
If you use an Alibaba Cloud SDK or Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call API operations of DAS, you must set the region to cn-shanghai.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:GetMongoDBCurrentOp		All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	dds-uf608087********
NodeId	string	No	The node ID. Note If you do not specify a node ID, the sessions of the primary node are queried by default.	23302531
Role	string	No	A reserved parameter. You do not need to specify the parameter.	None
FilterDoc	string	No	The `db.currentOp()` command that is used to filter sessions. For more information, see db.currentOp() of MongoDB Documentation.	{ "active" : true }

Response parameters

Parameter	Type	Description	Example
	object
Code	long	The response code.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. Otherwise, an error message such as an error code is returned.	Successful
Data	object	The details of the sessions.
Timestamp	long	The time when the database sessions were returned. The value is in the UNIX timestamp format. Unit: milliseconds.	1692029584428
SessionList	object []	The sessions.
OpId	string	The operation ID.	14508
Active	boolean	Indicates whether the operation is active. Valid values: true false	true
Command	string	The document that contains the complete command object associated with the operation.	"command" : { "find" : "items", "filter" : { "sku" : 1403978 }, ... "$db" : "test" }
Op	string	The type of the operation.	update
SecsRunning	long	The duration of the operation. Unit: seconds.	5
PlanSummary	string	The description of the execution plan.	None
Host	string	The host.	a79******.cloud.et15:3328
Client	string	The IP address of the client.	219.143.177.4:52324
Desc	string	The description of the connection.	conn1013858
Ns	string	The namespace.	admin.cmd
ConnectionId	long	The connection ID.	66378736
Driver	string	The driver for MongoDB.	mongo-java-driver\|legacy@3.11.2
OsType	string	The type of the operating system.	Linux
OsName	string	The name of the operating system.	Linux
OsArch	string	The architecture of the operating system.	amd64
Platform	string	The platform.	Java/Alibaba/1.8.0_152-b5
KillPending	boolean	Indicates whether the operation is marked as terminated. true false	true
Shard	string	The ID of the data shard. Note This parameter is returned for sharded cluster instances.	d-bp1689995b78****
SessionStat	object	The statistics on the sessions.
ActiveCount	long	The number of active sessions.	0
TotalCount	long	The total number of sessions.	55
LongestSecsRunning	long	The longest duration of a session. Unit: seconds.	0
ClientStats	object	The statistics on the IP addresses of the clients.
	object	The details of the IP addresses of the clients.
ActiveCount	long	The number of clients whose IP addresses are active.	0
TotalCount	long	The total number of IP addresses of clients.	11
DbStats	object	The statistics on the namespaces.
	object	The details of the namespaces.
ActiveCount	long	The number of active namespaces.	0
TotalCount	long	The total number of namespaces.	11
RequestId	string	The request ID.	FC6C0929-29E1-59FD-8DFE-70D9D41E****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

For more information, see the data returned by running the currentOp command of MongoDB.

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Timestamp": 1692029584428,
    "SessionList": [
      {
        "OpId": "14508",
        "Active": true,
        "Command": "\"command\" : {\n  \"find\" : \"items\",\n  \"filter\" : {\n    \"sku\" : 1403978\n  },\n  ...\n  \"$db\" : \"test\"\n}",
        "Op": "update",
        "SecsRunning": 5,
        "PlanSummary": "None",
        "Host": "a79******.cloud.et15:3328",
        "Client": "219.143.177.4:52324",
        "Desc": "conn1013858",
        "Ns": "admin.cmd",
        "ConnectionId": 66378736,
        "Driver": "mongo-java-driver|legacy@3.11.2",
        "OsType": "Linux",
        "OsName": "Linux",
        "OsArch": "amd64",
        "Platform": "Java/Alibaba/1.8.0_152-b5",
        "KillPending": true,
        "Shard": "d-bp1689995b78****"
      }
    ],
    "SessionStat": {
      "ActiveCount": 0,
      "TotalCount": 55,
      "LongestSecsRunning": 0,
      "ClientStats": {
        "key": {
          "ActiveCount": 0,
          "TotalCount": 11
        }
      },
      "DbStats": {
        "key": {
          "ActiveCount": 0,
          "TotalCount": 11
        }
      }
    }
  },
  "RequestId": "FC6C0929-29E1-59FD-8DFE-70D9D41E****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

For a list of error codes, visit the Service error codes.