---
name: "getPetUploadSign"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.6.27" }
title: "getPetUploadSign - 获取宠物相关文件上传签名"
---

## getPetUploadSign

> [VERSION] @ray-js/ray >= 1.6.27

### 描述

获取宠物相关文件上传签名

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `data` | `GetPetUploadSign` | 是 | 请求参数：bizType 业务类型（如 pet、petFeature、temp），fileName 含扩展名的文件名 |

### 返回值

类型: `Promise<GetPetUploadSignResult>`

Promise，resolve 值为 objectKey、url 及上传所需 headers

##### GetPetUploadSignResult

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `objectKey` | `string` | 文件objectKey(云端会按规则生成) |
| `url` | `string` | 待上传url |
| `headers` | `{ [key: string]: any }` | 上传headers |

##### GetPetUploadSignResult.headers 的属性

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |


### 引用对象

##### `type` GetPetUploadSign

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `bizType` | `string` | 业务类型，pet-宠物头像，petFeature-宠物特征，temp-临时文件，分析食物成分 |
| `fileName` | `string` | 文件名称，带扩展名，如xxx.png |


### 示例代码

#### 请求示例

```typescript
import { getPetUploadSign } from '@ray-js/ray';

getPetUploadSign({
  bizType: 'pet',
  fileName: 'test.png',
});
```

#### 返回示例

```json
{
  "objectKey": "xxx",
  "url": "xxxx",
  "headers": {}
}
```