export= | @types/ali-oss

Hierarchy

export=

Index

Constructors

constructor

Methods

Constructors

constructor

new export=(options: Options): export=

- Defined in index.d.ts:730
Parameters
- options: Options
Returns export=

Methods

abortMultipartUpload

abortMultipartUpload(name: string, uploadId: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:1050
Abort a multipart upload for object.

Parameters
- name: string
- uploadId: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

append

append(name: string, file: any, options?: AppendObjectOptions): Promise<AppendObjectResult>

- Defined in index.d.ts:908
Append an object to the bucket, it's almost same as put, but it can add content to existing object rather than override it.

Parameters
- name: string
- file: any
- Optional options: AppendObjectOptions
Returns Promise<AppendObjectResult>

completeMultipartUpload

completeMultipartUpload(name: string, uploadId: string, parts: { etag: string; number: number }[], options?: CompleteMultipartUploadOptions): Promise<CompleteMultipartUploadResult>

- Defined in index.d.ts:1009
After uploading all data parts, you must call the Complete Multipart Upload API to complete Multipart Upload for the entire file.

Parameters
- name: string
- uploadId: string
- parts: { etag: string; number: number }[]
- Optional options: CompleteMultipartUploadOptions
Returns Promise<CompleteMultipartUploadResult>

copy

copy(name: string, sourceName: string, options?: CopyObjectOptions): Promise<CopyAndPutMetaResult>

- Defined in index.d.ts:943
Copy an object from sourceName to name.

Parameters
- name: string
- sourceName: string
- Optional options: CopyObjectOptions
Returns Promise<CopyAndPutMetaResult>

createVod

createVod(id: string, name: string, time: { endTime: number; startTime: number }, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:1098
Create a VOD playlist for the channel.

Parameters
- id: string
- name: string
- time: { endTime: number; startTime: number }
  - endTime: number
  - startTime: number
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

delete

delete(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:938
Delete an object from the bucket.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

deleteBucket

deleteBucket(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:756
Delete an empty bucket.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

deleteBucketCORS

deleteBucketCORS(name: string): Promise<NormalSuccessResponse>

- Defined in index.d.ts:883
Delete CORS rules of the bucket object.

Parameters
- name: string
Returns Promise<NormalSuccessResponse>

deleteBucketLifecycle

deleteBucketLifecycle(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:863
Delete the bucket object lifecycle.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

deleteBucketLogging

deleteBucketLogging(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:797
Delete the bucket logging settings.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

deleteBucketReferer

deleteBucketReferer(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:840
Delete the bucket request Referer white list.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

deleteBucketWebsite

deleteBucketWebsite(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:816
Delete the bucket website config.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

deleteChannel

deleteChannel(id: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:1073
Delete a live channel.

Parameters
- id: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

deleteMulti

deleteMulti(names: string[], options?: DeleteMultiOptions): Promise<DeleteMultiResult>

- Defined in index.d.ts:953
Delete multi objects in one request.

Parameters
- names: string[]
- Optional options: DeleteMultiOptions
Returns Promise<DeleteMultiResult>

generateObjectUrl

generateObjectUrl(name: string, baseUrl?: string): string

- Defined in index.d.ts:918
Get the Object url. If provide baseUrl, will use baseUrl instead the default bucket and endpoint. Suggest use generateObjectUrl instead of getObjectUrl.

Parameters
- name: string
- Optional baseUrl: string
Returns string

get

get(name: string, file?: any, options?: GetObjectOptions): Promise<GetObjectResult>

- Defined in index.d.ts:928
Get an object from the bucket.

Parameters
- name: string
- Optional file: any
- Optional options: GetObjectOptions
Returns Promise<GetObjectResult>

getACL

getACL(name: string, options?: RequestOptions): Promise<GetACLResult>

- Defined in index.d.ts:968
Get object's ACL.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<GetACLResult>

getBucketACL

getBucketACL(name: string, options?: RequestOptions): Promise<{ acl: string; res: NormalSuccessResponse }>

- Defined in index.d.ts:778
Get the bucket ACL. acl - acl settings string

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<{ acl: string; res: NormalSuccessResponse }>

getBucketCORS

getBucketCORS(name: string): Promise<{ res: NormalSuccessResponse; rules: CORSRule[] }>

- Defined in index.d.ts:878
Get CORS rules of the bucket object.

Parameters
- name: string
Returns Promise<{ res: NormalSuccessResponse; rules: CORSRule[] }>

getBucketInfo

getBucketInfo(name: string): Promise<any>

- Defined in index.d.ts:761
Get bucket information,include CreationDate、ExtranetEndpoint、IntranetEndpoint、Location、Name、StorageClass、 Owner、AccessControlList

Parameters
- name: string
Returns Promise<any>

getBucketLifecycle

getBucketLifecycle(name: string, options?: RequestOptions): Promise<{ res: NormalSuccessResponse; rules: LifecycleRule[] }>

- Defined in index.d.ts:855
Get the bucket object lifecycle.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<{ res: NormalSuccessResponse; rules: LifecycleRule[] }>

getBucketLocation

getBucketLocation(name: string): Promise<any>

- Defined in index.d.ts:766
Get bucket location

Parameters
- name: string
Returns Promise<any>

getBucketLogging

getBucketLogging(name: string, options?: RequestOptions): Promise<{ enable: boolean; prefix: string; res: NormalSuccessResponse }>

- Defined in index.d.ts:789
Get the bucket logging settings.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<{ enable: boolean; prefix: string; res: NormalSuccessResponse }>

getBucketReferer

getBucketReferer(name: string, options?: RequestOptions): Promise<{ allowEmpty: boolean; referers: string[]; res: NormalSuccessResponse }>

- Defined in index.d.ts:832
Get the bucket request Referer white list.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<{ allowEmpty: boolean; referers: string[]; res: NormalSuccessResponse }>

getBucketWebsite

getBucketWebsite(name: string, options?: RequestOptions): Promise<{ error: string; index: string; res: NormalSuccessResponse }>

- Defined in index.d.ts:808
Get the bucket website config.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<{ error: string; index: string; res: NormalSuccessResponse }>

getChannel

getChannel(id: string, options?: RequestOptions): Promise<{ data: PutChannelConf; res: NormalSuccessResponse }>

- Defined in index.d.ts:1065
Get live channel info.

Parameters
- id: string
- Optional options: RequestOptions
Returns Promise<{ data: PutChannelConf; res: NormalSuccessResponse }>

getChannelHistory

getChannelHistory(id: string, options?: RequestOptions): Promise<ChannelHistoryResult>

- Defined in index.d.ts:1093
Get the live channel history.

Parameters
- id: string
- Optional options: RequestOptions
Returns Promise<ChannelHistoryResult>

getChannelStatus

getChannelStatus(id: string, options?: RequestOptions): Promise<GetChannelResult>

- Defined in index.d.ts:1083
Get the live channel status.

Parameters
- id: string
- Optional options: RequestOptions
Returns Promise<GetChannelResult>

getObjectUrl

getObjectUrl(name: string, baseUrl?: string): string

- Defined in index.d.ts:913
Get the Object url. If provide baseUrl, will use baseUrl instead the default endpoint.

Parameters
- name: string
- Optional baseUrl: string
Returns string

getRtmpUrl

getRtmpUrl(channelId?: string, options?: GetRtmpUrlOptions): string

- Defined in index.d.ts:1108
Get signatured rtmp url for publishing.

Parameters
- Optional channelId: string
- Optional options: GetRtmpUrlOptions
Returns string

getStream

getStream(name?: string, options?: GetStreamOptions): Promise<GetStreamResult>

- Defined in index.d.ts:933
Get an object read stream.

Parameters
- Optional name: string
- Optional options: GetStreamOptions
Returns Promise<GetStreamResult>

head

head(name: string, options?: HeadObjectOptions): Promise<HeadObjectResult>

- Defined in index.d.ts:923
Head an object and get the meta info.

Parameters
- name: string
- Optional options: HeadObjectOptions
Returns Promise<HeadObjectResult>

initMultipartUpload

initMultipartUpload(name: string, options?: InitMultipartUploadOptions): Promise<InitMultipartUploadResult>

- Defined in index.d.ts:978
multi upload

Parameters
- name: string
- Optional options: InitMultipartUploadOptions
Returns Promise<InitMultipartUploadResult>

list

list(query: ListObjectsQuery, options: RequestOptions): Promise<ListObjectResult>

- Defined in index.d.ts:889
List objects in the bucket.

Parameters
- query: ListObjectsQuery
- options: RequestOptions
Returns Promise<ListObjectResult>

listBuckets

listBuckets(query: ListBucketsQueryType, options?: RequestOptions): Promise<Bucket[]>

- Defined in index.d.ts:738
List buckets in this account.

Parameters
- query: ListBucketsQueryType
- Optional options: RequestOptions
Returns Promise<Bucket[]>

listChannels

listChannels(query: ListChannelsQuery, options?: RequestOptions): Promise<ListChannelsResult>

- Defined in index.d.ts:1088
List channels.

Parameters
- query: ListChannelsQuery
- Optional options: RequestOptions
Returns Promise<ListChannelsResult>

listParts

listParts(name: string, uploadId: string, query?: ListPartsQuery, options?: RequestOptions): Promise<ListPartsResult>

- Defined in index.d.ts:1035
The ListParts command can be used to list all successfully uploaded parts mapped to a specific upload ID, i.e.: those not completed and not aborted.

Parameters
- name: string
- uploadId: string
- Optional query: ListPartsQuery
- Optional options: RequestOptions
Returns Promise<ListPartsResult>

listUploads

listUploads(query: ListUploadsQuery, options?: RequestOptions): Promise<ListUploadsResult>

- Defined in index.d.ts:1045
List on-going multipart uploads, i.e.: those not completed and not aborted.

Parameters
- query: ListUploadsQuery
- Optional options: RequestOptions
Returns Promise<ListUploadsResult>

multipartUpload

multipartUpload(name: string, file: any, options: MultipartUploadOptions): Promise<MultipartUploadResult>

- Defined in index.d.ts:1019
Upload file with OSS multipart.

Parameters
- name: string
- file: any
- options: MultipartUploadOptions
Returns Promise<MultipartUploadResult>

multipartUploadCopy

multipartUploadCopy(name: string, sourceData: MultipartUploadCopySourceData, options?: MultipartUploadOptions): Promise<MultipartUploadCopyResult>

- Defined in index.d.ts:1026
Copy file with OSS multipart. this function contains head, initMultipartUpload, uploadPartCopy, completeMultipartUpload. When copying a file larger than 1 GB, you should use the Upload Part Copy method. If you want to copy a file smaller than 1 GB, see Copy Object.

Parameters
- name: string
- sourceData: MultipartUploadCopySourceData
- Optional options: MultipartUploadOptions
Returns Promise<MultipartUploadCopyResult>

put

put(name: string, file: any, options?: PutObjectOptions): Promise<PutObjectResult>

- Defined in index.d.ts:894
Add an object to the bucket.

Parameters
- name: string
- file: any
- Optional options: PutObjectOptions
Returns Promise<PutObjectResult>

putACL

putACL(name: string, acl: ACLType, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:963
Set object's ACL.

Parameters
- name: string
- acl: ACLType
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

putBucket

putBucket(name: string, options?: PutBucketOptions): Promise<{ bucket: string; res: NormalSuccessResponse }>

- Defined in index.d.ts:743
Create a new bucket.

Parameters
- name: string
- Optional options: PutBucketOptions
Returns Promise<{ bucket: string; res: NormalSuccessResponse }>

putBucketACL

putBucketACL(name: string, acl: ACLType, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:772
Update the bucket ACL.

Parameters
- name: string
- acl: ACLType
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

putBucketCORS

putBucketCORS(name: string, rules: CORSRule[], options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:869
Set CORS rules of the bucket object

Parameters
- name: string
- rules: CORSRule[]
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

putBucketLifecycle

putBucketLifecycle(name: string, rules: LifecycleRule[], options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:846
Set the bucket object lifecycle.

Parameters
- name: string
- rules: LifecycleRule[]
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

putBucketLogging

putBucketLogging(name: string, prefix?: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:784
Update the bucket logging settings. Log file will create every one hour and name format: -YYYY-mm-DD-HH-MM-SS-UniqueString.

Parameters
- name: string
- Optional prefix: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

putBucketReferer

putBucketReferer(name: string, allowEmpty: boolean, referers: string[], options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:822
Set the bucket request Referer white list.

Parameters
- name: string
- allowEmpty: boolean
- referers: string[]
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

putBucketWebsite

putBucketWebsite(name: string, config: PutBucketWebsiteConfig): Promise<NormalSuccessResponse>

- Defined in index.d.ts:803
Set the bucket as a static website.

Parameters
- name: string
- config: PutBucketWebsiteConfig
Returns Promise<NormalSuccessResponse>

putChannel

putChannel(id: string, conf: PutChannelConf, options?: RequestOptions): Promise<PutChannelResult>

- Defined in index.d.ts:1060
Create a live channel.

Parameters
- id: string
- conf: PutChannelConf
- Optional options: RequestOptions
Returns Promise<PutChannelResult>

putChannelStatus

putChannelStatus(id: string, status?: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:1078
Change the live channel status.

Parameters
- id: string
- Optional status: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

putMeta

putMeta(name: string, meta: UserMeta, options: RequestOptions): Promise<CopyAndPutMetaResult>

- Defined in index.d.ts:948
Set an exists object meta.

Parameters
- name: string
- meta: UserMeta
- options: RequestOptions
Returns Promise<CopyAndPutMetaResult>

putStream

putStream(name: string, stream: any, options?: PutStreamOptions): Promise<{ name: string; res: NormalSuccessResponse }>

- Defined in index.d.ts:899
Add a stream object to the bucket.

Parameters
- name: string
- stream: any
- Optional options: PutStreamOptions
Returns Promise<{ name: string; res: NormalSuccessResponse }>

restore

restore(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:973
Restore Object.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

signatureUrl

signatureUrl(name: string, options?: SignatureUrlOptions): string

- Defined in index.d.ts:958
Create a signature url for download or upload object. When you put object with signatureUrl ,you need to pass Content-Type.Please look at the example.

Parameters
- name: string
- Optional options: SignatureUrlOptions
Returns string

uploadPart

uploadPart(name: string, uploadId: string, partNo: number, file: any, start: number, end: number, options?: RequestOptions): Promise<UploadPartResult>

- Defined in index.d.ts:983
After initiating a Multipart Upload event, you can upload data in parts based on the specified object name and Upload ID.

Parameters
- name: string
- uploadId: string
- partNo: number
- file: any
- start: number
- end: number
- Optional options: RequestOptions
Returns Promise<UploadPartResult>

uploadPartCopy

uploadPartCopy(name: string, uploadId: string, partNo: number, range: string, sourceData: { sourceBucketName: string; sourceKey: string }, options: { headers?: object; timeout?: number }): Promise<UploadPartResult>

- Defined in index.d.ts:997
Using Upload Part Copy, you can copy data from an existing object and upload a part of the data. When copying a file larger than 1 GB, you must use the Upload Part Copy method. If you want to copy a file smaller than 1 GB, see Copy Object.

Parameters
- name: string
- uploadId: string
- partNo: number
- range: string
- sourceData: { sourceBucketName: string; sourceKey: string }
  - sourceBucketName: string
  - sourceKey: string
- options: { headers?: object; timeout?: number }
  - Optional headers?: object
  - Optional timeout?: number
Returns Promise<UploadPartResult>

useBucket

useBucket(name: string): void

- Defined in index.d.ts:751
Use the bucket.

Parameters
- name: string
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

options: Options

Returns export=

Methods

abortMultipartUpload

Parameters

name: string

uploadId: string

Optional options: RequestOptions

Returns Promise<NormalSuccessResponse>

append

Parameters

name: string

file: any

Optional options: AppendObjectOptions

Returns Promise<AppendObjectResult>

completeMultipartUpload

Parameters

name: string

uploadId: string

parts: { etag: string; number: number }[]

Optional options: CompleteMultipartUploadOptions

Returns Promise<CompleteMultipartUploadResult>

copy

Parameters

name: string

sourceName: string

Optional options: CopyObjectOptions

Returns Promise<CopyAndPutMetaResult>

createVod

Parameters

id: string

name: string

time: { endTime: number; startTime: number }

endTime: number

startTime: number

Optional options: RequestOptions

Returns Promise<NormalSuccessResponse>

delete

Parameters

name: string

Optional options: RequestOptions

Returns Promise<NormalSuccessResponse>

deleteBucket

Parameters

name: string

Optional options: RequestOptions

Returns Promise<NormalSuccessResponse>

deleteBucketCORS

Parameters

name: string

Returns Promise<NormalSuccessResponse>

deleteBucketLifecycle

Parameters

name: string

Optional options: RequestOptions

Returns Promise<NormalSuccessResponse>

deleteBucketLogging

Parameters

name: string

Optional options: RequestOptions

Returns Promise<NormalSuccessResponse>

deleteBucketReferer

Parameters

name: string

Optional options: RequestOptions

Returns Promise<NormalSuccessResponse>

deleteBucketWebsite

Parameters

name: string

Optional options: RequestOptions

Returns Promise<NormalSuccessResponse>

deleteChannel

Parameters