Cluster Log Packaging - BackupUMongoDBLog
Overview
Log Packaging
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is BackupUMongoDBLog. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See Region and Availability Zone List | Yes |
| Zone | string | Availability Zone. See Availability Zone List | Yes |
| ProjectId | string | Project ID. If not filled in, the default project will be used. Sub-accounts must fill in. Please refer to the GetProjectList interface. | No |
| Name | string | Log Package Name | Yes |
| ClusterId | string | Cluster ID | Yes |
| NodeId | string | Node id, Slow log mongos node not selectable | Yes |
| Begin | int | Log start time, earliest is 7x24 hours ago | Yes |
| End | int | Log end time, the time interval cannot exceed 24 hours | Yes |
| LogType | string | Log Type: SlowLog, ErrorLog | Yes |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.surfercloud.com/?Action=BackupUMongoDBLog
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=ndyCAElz
&Name=bMrgJltF
&ClusterId=RhaQNXRs
&NodeId=xVfbZIuK
&Begin=6
&End=2
&LogType=Slow_LogResponse Example
{
"Action": "BackupUMongoDBLogResponse",
"RetCode": 0
}