生成扩展日志链接（SQL Server）

功能介绍

生成扩展日志下载链接。

• 调用接口前，您需要了解API 认证鉴权。

接口约束

该接口仅支持SQL Server数据库引擎。

URI

• URI格式

  POST /v3/{project_id}/instances/{instance_id}/xellog-download

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  instance_id	是	要查询的实例ID。

请求消息

请求示例

获取扩展日志下载链接。

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/xellog-download
{
	"file_name":"sqlserver_xellog_name.xel"
}

响应消息

• 正常响应要素说明

  表3 要素说明

  名称	参数类型	说明
  list	List	扩展日志下载链接列表，详见表4。
  count	Integer	扩展日志链接数量。

  表4 linkInfo字段数据结构说明

  名称	参数类型	说明
  file_name	String	生成的下载文件名。
  status	String	链接的生成状态。 FINISH，表示下载链接已经生成。 EXPORTING，表示正在生成文件。 FAILED，表示存在日志文件准备失败。
  file_size	String	文件大小，单位：KB。
  file_link	String	下载链接，链接的生成状态为EXPORTING，或者FAILED时不予返回。
  create_at	String	生成时间。
  update_at	String	更新时间。

• 正常响应样例
  正在生成扩展日志下载链接

  {
      "list": [
          {
              "file_name": "HkEngineEventFile_0_133337769850300000.xel",
              "status": "EXPORTING",
              "file_size": "0",
              "create_at": "2023-08-14T03:35:24+0000",
              "update_at": "2023-08-14T03:35:24+0000"
          }
      ],
      "count": 1
  }

  扩展日志下载链接获取成功

  {
      "list": [
          {
              "file_name": "HkEngineEventFile_0_133337769850300000.xel",
              "status": "SUCCESS",
              "file_size": "0",
              "file_link": "https://obs.xxx:443/xxx-7a95af72c4d54a31ae0663263f0e35ea/6e22b18b43a74e4486264194f6e09f66_EL_HkEngineEventFile_0_133337769850300000.xel?xxx",
              "create_at": "2023-08-14T03:35:41+0000",
              "update_at": "2023-08-14T03:35:41+0000"
          }
      ],
      "count": 1
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。