# 生成扩展日志链接（SQL Server） - CreateXelLogDownload #### 功能介绍 生成扩展日志下载链接。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=CreateXelLogDownload)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:log:download | read | instance | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### 接口约束 该接口仅支持SQL Server数据库引擎。 #### URI - URI格式 POST /v3/{project_id}/instances/{instance_id}/xellog-download - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | file_name | 是 | String | **参数解释**： 需要下载的文件名。 **约束限制：** 不涉及。 **取值范围：** 不为null和空字符串，只为大小写字母，数字和下划线，以".xel"结尾。 文件名称可以在[查询扩展日志（SQL Server） - ListXellogFiles](https://support.huaweicloud.com/api-rds/rds_06_0127.html)中获取。 **默认取值：** 不涉及。 | #### 请求示例 获取扩展日志下载链接。 ``` POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/xellog-download { "file_name":"sqlserver_xellog_name.xel" } ``` #### 响应消息 - 正常响应要素说明 表3要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | list | List | **参数解释**： 扩展日志下载链接列表，详见[表4]。 | | count | Integer | **参数解释**： 扩展日志链接数量。 **取值范围：** 不涉及。 | 表4linkInfo字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | 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 } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。