aliyunoss-cli
    Preparing search index...

    Interface Options

    interface Options {
        accessKeyId: string;
        accessKeySecret: string;
        authorizationV4?: boolean;
        bucket?: string;
        cname?: boolean;
        endpoint?: string;
        internal?: boolean;
        refreshSTSToken?: () => Promise<
            { accessKeyId: string; accessKeySecret: string; stsToken: string },
        >;
        refreshSTSTokenInterval?: number;
        region?: string;
        secure?: boolean;
        stsToken?: string;
        timeout?: string | number;
    }
    Index
    accessKeyId accessKeySecret authorizationV4? bucket? cname? endpoint? internal? refreshSTSToken? refreshSTSTokenInterval? region? secure? stsToken? timeout?
    accessKeyId: string

    access secret you create

    accessKeySecret: string

    access secret you create

    authorizationV4?: boolean

    Use V4 signature. Default is false.

    bucket?: string

    the default bucket you want to access If you don't have any bucket, please use putBucket() create one first.

    cname?: boolean

    use custom domain name

    endpoint?: string

    oss region domain. It takes priority over region.

    internal?: boolean

    access OSS with aliyun internal network or not, default is false. If your servers are running on aliyun too, you can set true to save lot of money.

    refreshSTSToken?: () => Promise<
        { accessKeyId: string; accessKeySecret: string; stsToken: string },
    >

    used by auto set stsToken、accessKeyId、accessKeySecret when sts info expires. return value must be object contains stsToken、accessKeyId、accessKeySecret

    refreshSTSTokenInterval?: number

    use time (ms) of refresh STSToken interval it should be less than sts info expire interval, default is 300000ms(5min) when sts info expires.

    region?: string

    the bucket data region location, please see Data Regions, default is oss-cn-hangzhou.

    secure?: boolean

    instruct OSS client to use HTTPS (secure: true) or HTTP (secure: false) protocol.

    stsToken?: string

    used by temporary authorization

    timeout?: string | number

    instance level timeout for all operations, default is 60s

    Settings
    Member Visibility

    On This Page
    Properties