telnyx-storage-javascript

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Telnyx Storage - JavaScript

Installation

安装

bash

npm install telnyx

bash

npm install telnyx

Setup

设置

javascript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

All examples below assume

client

is already initialized as shown above.

javascript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

以下所有示例均假设

client

已按照上述方式初始化。

Create Presigned Object URL

创建预签名对象URL

Returns a timed and authenticated URL to download (GET) or upload (PUT) an object.

POST /storage/buckets/{bucketName}/{objectName}/presigned_url

javascript

const response = await client.storage.buckets.createPresignedURL('', { bucketName: '' });

console.log(response.content);

返回一个带时间限制且经过认证的URL，用于下载（GET）或上传（PUT）对象。

POST /storage/buckets/{bucketName}/{objectName}/presigned_url

javascript

const response = await client.storage.buckets.createPresignedURL('', { bucketName: '' });

console.log(response.content);

Get Bucket SSL Certificate

获取存储桶SSL证书

Returns the stored certificate detail of a bucket, if applicable.

GET /storage/buckets/{bucketName}/ssl_certificate

javascript

const sslCertificate = await client.storage.buckets.sslCertificate.retrieve('');

console.log(sslCertificate.data);

返回存储桶的已存储证书详情（如适用）。

GET /storage/buckets/{bucketName}/ssl_certificate

javascript

const sslCertificate = await client.storage.buckets.sslCertificate.retrieve('');

console.log(sslCertificate.data);

Add SSL Certificate

添加SSL证书

Uploads an SSL certificate and its matching secret so that you can use Telnyx's storage as your CDN.

PUT /storage/buckets/{bucketName}/ssl_certificate

javascript

const sslCertificate = await client.storage.buckets.sslCertificate.create('');

console.log(sslCertificate.data);

上传SSL证书及其匹配的密钥，以便您可以将Telnyx存储用作CDN。

PUT /storage/buckets/{bucketName}/ssl_certificate

javascript

const sslCertificate = await client.storage.buckets.sslCertificate.create('');

console.log(sslCertificate.data);

Remove SSL Certificate

删除SSL证书

Deletes an SSL certificate and its matching secret.

DELETE /storage/buckets/{bucketName}/ssl_certificate

javascript

const sslCertificate = await client.storage.buckets.sslCertificate.delete('');

console.log(sslCertificate.data);

删除SSL证书及其匹配的密钥。

DELETE /storage/buckets/{bucketName}/ssl_certificate

javascript

const sslCertificate = await client.storage.buckets.sslCertificate.delete('');

console.log(sslCertificate.data);

Get API Usage

获取API使用情况

Returns the detail on API usage on a bucket of a particular time period, group by method category.

GET /storage/buckets/{bucketName}/usage/api

javascript

const response = await client.storage.buckets.usage.getAPIUsage('', {
  filter: { end_time: '2019-12-27T18:11:19.117Z', start_time: '2019-12-27T18:11:19.117Z' },
});

console.log(response.data);

返回特定时间段内存储桶的API使用详情，按方法类别分组。

GET /storage/buckets/{bucketName}/usage/api

javascript

const response = await client.storage.buckets.usage.getAPIUsage('', {
  filter: { end_time: '2019-12-27T18:11:19.117Z', start_time: '2019-12-27T18:11:19.117Z' },
});

console.log(response.data);

Get Bucket Usage

获取存储桶使用情况

Returns the amount of storage space and number of files a bucket takes up.

GET /storage/buckets/{bucketName}/usage/storage

javascript

const response = await client.storage.buckets.usage.getBucketUsage('');

console.log(response.data);

返回存储桶占用的存储空间大小和文件数量。

GET /storage/buckets/{bucketName}/usage/storage

javascript

const response = await client.storage.buckets.usage.getBucketUsage('');

console.log(response.data);

List Migration Source coverage

列出迁移源覆盖范围

GET /storage/migration_source_coverage

javascript

const response = await client.storage.listMigrationSourceCoverage();

console.log(response.data);

GET /storage/migration_source_coverage

javascript

const response = await client.storage.listMigrationSourceCoverage();

console.log(response.data);

List all Migration Sources

列出所有迁移源

GET /storage/migration_sources

javascript

const migrationSources = await client.storage.migrationSources.list();

console.log(migrationSources.data);

GET /storage/migration_sources

javascript

const migrationSources = await client.storage.migrationSources.list();

console.log(migrationSources.data);

Create a Migration Source

创建迁移源

Create a source from which data can be migrated from.

POST /storage/migration_sources

— Required:

provider

provider_auth

bucket_name

javascript

const migrationSource = await client.storage.migrationSources.create({
  bucket_name: 'bucket_name',
  provider: 'aws',
  provider_auth: {},
});

console.log(migrationSource.data);

创建一个可从中迁移数据的源。

POST /storage/migration_sources

— 必填项：

provider

provider_auth

bucket_name

javascript

const migrationSource = await client.storage.migrationSources.create({
  bucket_name: 'bucket_name',
  provider: 'aws',
  provider_auth: {},
});

console.log(migrationSource.data);

Get a Migration Source

获取迁移源

GET /storage/migration_sources/{id}

javascript

const migrationSource = await client.storage.migrationSources.retrieve('');

console.log(migrationSource.data);

GET /storage/migration_sources/{id}

javascript

const migrationSource = await client.storage.migrationSources.retrieve('');

console.log(migrationSource.data);

Delete a Migration Source

删除迁移源

DELETE /storage/migration_sources/{id}

javascript

const migrationSource = await client.storage.migrationSources.delete('');

console.log(migrationSource.data);

DELETE /storage/migration_sources/{id}

javascript

const migrationSource = await client.storage.migrationSources.delete('');

console.log(migrationSource.data);

List all Migrations

列出所有迁移任务

GET /storage/migrations

javascript

const migrations = await client.storage.migrations.list();

console.log(migrations.data);

GET /storage/migrations

javascript

const migrations = await client.storage.migrations.list();

console.log(migrations.data);

Create a Migration

创建迁移任务

Initiate a migration of data from an external provider into Telnyx Cloud Storage.

POST /storage/migrations

— Required:

source_id

target_bucket_name

target_region

javascript

const migration = await client.storage.migrations.create({
  source_id: 'source_id',
  target_bucket_name: 'target_bucket_name',
  target_region: 'target_region',
});

console.log(migration.data);

启动从外部提供商到Telnyx云存储的数据迁移。

POST /storage/migrations

— 必填项：

source_id

target_bucket_name

target_region

javascript

const migration = await client.storage.migrations.create({
  source_id: 'source_id',
  target_bucket_name: 'target_bucket_name',
  target_region: 'target_region',
});

console.log(migration.data);

Get a Migration

获取迁移任务

GET /storage/migrations/{id}

javascript

const migration = await client.storage.migrations.retrieve('');

console.log(migration.data);

GET /storage/migrations/{id}

javascript

const migration = await client.storage.migrations.retrieve('');

console.log(migration.data);

Stop a Migration

停止迁移任务

POST /storage/migrations/{id}/actions/stop

javascript

const response = await client.storage.migrations.actions.stop('');

console.log(response.data);

POST /storage/migrations/{id}/actions/stop

javascript

const response = await client.storage.migrations.actions.stop('');

console.log(response.data);