更新时间:2024-12-02 GMT+08:00

获取错误日志下载链接

接口说明

获取错误日志下载链接。

约束说明

错误日志下载链接在更新时间后15分钟内有效。

URI

  • URI格式

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

  • URI样例

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

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

从IAM服务获取的用户Token。请参考认证鉴权

project_id

string

path

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。

请求消息

  • 参数说明
    表2 参数说明

    名称

    参数类型

    是否必选

    描述

    file_name_list

    Array of strings

    需要下载的文件的文件名列表。

    node_id_list

    Array of strings

    节点ID列表,取空值,表示查询实例下所有允许查询的节点。

    使用请参考《DDS API参考》的“查询实例列表”响应消息表“nodes 数据结构说明”的“id”。

    允许查询的节点如下:

    • 集群下面的mongos、shard、config节点。
    • 副本集、单节点下面的所有节点。

请求示例

获取错误日志下载链接,按照需要下载的文件的文件名列表或节点ID列表
{
  "file_name_list": [
    "0541c9f81e80d2201fccc00b92ad6ec0_052f8a12dfed43fbb27c2020e3c3c507no02_errorlog_20201117104809"
  ],
  "node_id_list": [
    "052f8a12dfed43fbb27c2020e3c3c507no02"
  ]
}

响应消息

  • 参数说明
    表3 参数说明

    名称

    参数类型

    说明

    list

    List

    错误日志下载链接列表。

    详情请参见表4

    status

    String

    错误日志下载链接生成状态。

    • FINISH,表示下载链接已经生成完成。
    • CREATING,表示正在生成文件,准备下载链接。
    • FAILED,表示存在日志文件准备失败。

    count

    Integer

    错误日志链接数量。

    表4 list字段数据结构说明

    名称

    参数类型

    说明

    node_name

    String

    节点名称。

    file_name

    String

    生成的下载文件名。

    status

    String

    当前链接的生成状态。

    • SUCCESS,表示下载链接已经生成完成。
    • EXPORTING,表示正在生成文件,准备下载链接。
    • FAILED,表示存在日志文件准备失败。

    file_size

    String

    文件大小,单位为 KB。

    file_link

    String

    下载链接。

    说明:

    下载链接在更新时间的15分钟内有效,超出时间会重新获取。

    update_at

    Long

    更新时间。

  • 响应示例
    {
      "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.xxxxx.xxxxx.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
    }

SDK

单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码

错误码

详情请参见错误码