Obtaining Links for Downloading Error Logs

Description

This API is used to obtain links for downloading error logs.

Restrictions

The link for downloading error logs is valid within 15 minutes after being updated.

URI

• URI format

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/errorlog-download

• URI example

  https://dds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/errorlog-download

Requests

• Parameter description

  Table 2 Parameter description

  Name	Type	Mandatory	Description
  file_name_list	Array of strings	No	The list of the names of the files to be downloaded.
  node_id_list	Array of strings	No	The node ID list. If this parameter is left blank, all nodes in the instance can be queried. For details, see the id value in the nodes data structure table in section "Querying Instances" in the DDS API Reference. Nodes that can be queried: mongos, shard, and config nodes in a cluster. All nodes in a replica set or single node instance.

• Response to the request body

  {
    "file_name_list": [
      "0541c9f81e80d2201fccc00b92ad6ec0_052f8a12dfed43fbb27c2020e3c3c507no02_errorlog_20201117104809"
    ],
    "node_id_list": [
      "052f8a12dfed43fbb27c2020e3c3c507no02"
    ]
  }

Responses

• Parameter description

  Table 3 Parameter description

  Name	Type	Description
  list	List	The list of error log download links. For details, see Table 4.
  status	String	The status of the error log download link. FINISH: The download link has been generated. CREATING: A file is being generated and the download link is to be prepared. FAILED: Log files fail to be prepared.
  count	Integer	The number of error log links.

  Table 4 list field data structure description

  Name	Type	Description
  node_name	String	The node name.
  file_name	String	The name of the generated file for downloading error logs.
  status	String	The status of the current link. SUCCESS: The download link has been generated. EXPORTING: A file is being generated and the download link is to be prepared. FAILED: Log files fail to be prepared.
  file_size	String	The file size in KB.
  file_link	String	The download link. NOTE: The download link is valid within 15 minutes after being updated. After the update time expires, the download link will be obtained again.
  update_at	Long	The update time.

• Response example

  {
    "list": [
      {
        "node_name": "node_1",
        "file_name": "054bc9c1f680d55c1f36c006e5a9f67b_errorlog_download_20200515080614589",
        "status": "SUCCESS",
        "file_size": "0",
        "file_link": "https://rdsbucket.opxxx.svc.rds.xxxxx.southeast.ur.obs.ap-southeast-1.myhuaweicloud.com:443/054bc9c1f680d55c1f36c006e5a9f67b_errorlog_download_20200515080614589?AWSAccessKeyId=1BQ38TBCQHAVQXBUMUTC&Expires=1589530200&response-cache-control=no-cache%2Cno-store&Signature=Fgi4%2BLOJ9frAXyOkz5hRoW5O%2BUM%3D",
        "update_at": 1589529991385
      }
    ],
    "status": "FINISH",
    "count": 1
  }

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.