Nanoseconds Produce Minutes

    @volcengine/openapi
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.1 • Public • Published

    Volcano Engine OpenAPI node sdk

    中文文档

    Installation

    npm install -S @volcengine/openapi

    Basic Usage

    1. Setting OpenAPI service's AK&SK

    Available in three settings

    1. Use API to set AK&SK

    // Use the default service instance. You can also create a new instance.
    // `const iamService = new iam.IamService();`
    const iamService = iam.defaultService;
    
    // set aksk
    iamService.setAccessKeyId(AccessKeyId);
    iamService.setSecretKey(SecretKey);
    // If you use sts to request, you need to set up `SessionToken` after aksk is set
    iamService.setSessionToken(SessionToken);

    2. Use environment variables to set AK & SK

    VOLC_ACCESSKEY="your ak" VOLC_SECRETKEY="your sk"

    3. Use configuration file

    Put it in ~/.volc/config in json format, the format is:

    {"VOLC_ACCESSKEY":"your ak","VOLC_SECRETKEY":"your sk"}
    

    Request OpenAPI

    Take the ListUsers API of the iam service as an example

    import { iam } from'@volcengine/openapi';
    
    async function main(AccessKeyId, SecretKey) {
       // Use the default service instance. You can also create a new instance.
       // `const iamService = new iam.IamService();`
       const iamService = iam.defaultService;
    
       // set aksk
       iamService.setAccessKeyId(AccessKeyId);
       iamService.setSecretKey(SecretKey);
      
       // Request OpenAPI
       const usersResponse = await iamService.ListUsers({
         Limit: 10,
         Offset: 0,
       });
    }

    OpenAPI signature method

    import {Signer} from '@volcengine/openapi';
    
    // http request data
    const openApiRequestData: RequestObj = {
        region: 'cn-north-1',
        method: 'GET',
        // [optional] http request url query
        params: {},
        // http request headers
        headers: {},
        // [optional] http request body
        body: "",
    }
    
    const signer = new Signer(openApiRequestData, "iam");
    
    // sign
    signer.addAuthorization({accessKeyId, secretKey, sessionToken});
    
    // Print signed headers
    console.log(openApiRequestData.headers);

    Keywords

    none

    Install

    npm i @volcengine/openapi

    DownloadsWeekly Downloads

    157

    Version

    1.2.1

    License

    ISC

    Unpacked Size

    726 kB

    Total Files

    80

    Last publish

    Collaborators

    • moonball
    • shushushu
    • changzhn
    • wudechang
    • lixiangfeiorg
    • goldvideo
    • leonardo-fu
    • awesome-starling
    • zhang6464
    • volcanoengine
    • bytednpm