Cloud

constructor(path?: string, name: string, region?: string)

构造方法。

Cloud

createInstance(path?: string, name: string, region?: string)

创建Cloud实例。

Auth

auth()

创建Cloud Auth实例。

CloudDB

database(config: DatabaseConfig)

创建CloudDB实例。

CloudFunction

function()

创建CloudFunction实例。

Region

用于定义数据处理位置。

constructor(path?: string, name: string, region?: string)

初始化Cloud实例。

path

可选，认证凭据文件（agc-apiclient-xxx-xxx.json）路径。

name

Cloud实例名称。

region

可选，实例所属的数据处理位置。

createInstance(path?: string, name: string, region?: string): Cloud

初始化Cloud实例。

path

string

可选，认证凭据文件路径。

name

string

Cloud实例名称。

region

string

可选，数据处理位置。

Cloud

Cloud对象。

auth(): Auth

获取与数据处理位置对应的Auth实例。

Auth

Auth对象。

database(config: DatabaseConfig): CloudDB

获取与数据处理位置对应的CloudDB实例。只有在获取实例后，才能传递存储区配置并进行数据管理。

config: DatabaseConfig

DatabaseConfig对象，包含存储区的名称和traceId。

traceId用于跟踪请求操作，您可以本地开发环境的日志中查看traceId。云数据库基于traceId提供日志检索能力，方便根据traceId在云监控定位异常问题请求。

traceId可以通过以下两种方式生成：

• 用户自定义：该traceId可用于跟踪后续的所有请求操作。通过传入参数自定义traceId，若传入非法的traceId，系统将自动生成一个traceId。

  自定义traceId的长度必须大于或等于1个字符，小于或等于32个字符，只能包含以下2种类型：

  • 字母（a-f）
  • 数字（0-9）
• 系统自动生成：如果未自定义traceId，系统将自动为每个请求生成对应的traceId，以便跟踪定位每个请求操作。

CloudDB

如果成功调用API，将获得CloudDB对象。您可通过collection方法对CloudDB对象进行增删改查操作。

function(): CloudFunction

获取与数据处理位置对应的CloudFunction实例。

CloudFunction

CloudFunction对象。

REGION_CN

中国区域。

REGION_RU

俄罗斯区域。

REGION_SG

新加坡区域。

REGION_DE

德国区域。