repository·master·Indexed 20 days ago
https://github.com/tencentcloud/tencentcloud-sdk-nodejsA developer toolset for interacting with TencentCloud API 3.0, allowing Node.js developers to programmatically manage cloud resources such as CVM and VPC. The SDK supports product-specific installations to reduce bundle size, a full SDK version, and a Slim version. It includes a Common Client for generic API calls and supports secure credential management via Instance Roles. Requires Node.js version 10.0.0 or higher.
Starting from version 4.0.714, the SDK supports a Common Client approach. By installing the tencentcloud-sdk-nodejs-common package, you can make requests to any product without needing the specific product package installed.
Warning: You must know the exact parameters required by the API interface, otherwise the call will fail.
For enhanced security, instead of passing static secretId and secretKey, you can use TencentCloud Instance Roles. When a role is bound to your instance, you can use a specialized credential class to fetch temporary credentials automatically.
Usage Example:
const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
const client = new XxxClient({
credential: new CvmRoleCredential(),
region: "ap-shanghai",
})const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
new XxxClient({
credential: new CvmRoleCredential(),
})You can install the SDK via npm using three different approaches depending on your project needs:
cvm for Cloud Virtual Machine or vpc for Virtual Private Cloud).Prerequisites:
SecretID and SecretKey) obtained from the TencentCloud Console.# Install a specific product (Recommended)
npm install tencentcloud-sdk-nodejs-cvm --save
npm install tencentcloud-sdk-nodejs-vpc --save
# Install the full SDK
npm install tencentcloud-sdk-nodejs --save
# Install the Slim version (Compressed, no types)
npm install tencentcloud-sdk-slim-nodejs --saveWhen installing a specific product SDK (e.g., tencentcloud-sdk-nodejs-cvm), you must update your require or import statements to use the product-specific package name instead of the generic tencentcloud-sdk-nodejs package.
Example for CVM SDK:
// Incorrect for product-specific packages
// const tencentcloud = require("tencentcloud-sdk-nodejs")
// const CvmClient = tencentcloud.cvm.v20170312.Client
// Correct
const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
const CvmClient = cvm.v20170312.Clientconst { cvm } = require("tencentcloud-sdk-nodejs-cvm")
const CvmClient = cvm.v20170312.Clientchdfs service (v20190718) allows you to manage Cloud File Systems, including creation, deletion, modification, and capacity management. You can also manage mount points, access groups, access rules, lifecycle rules, and resource tags.When creating a KTV Robot via CreateKTVRobotRequest, you can provide an array of SyncRobotCommand objects to initialize the robot with specific instructions. These commands are executed in the order provided.
Supported Command values include:
Play: Start playback.Pause: Pause playback.SwitchPrevious: Play the previous song.SwitchNext: Play the next song.SetPlayMode: Change the playback mode.Seek: Adjust playback position.SetPlaylist: Change the playlist.SetAudioParam: Change audio parameters.SendMessage: Send a custom message.SetDestroyMode: Set the room destruction mode.SetRealVolume: Set the actual volume (replaces the deprecated SetVolume).Each command requires its corresponding input object (e.g., PlayCommandInput for Play, SeekCommandInput for Seek).
// Example of initializing a robot with commands
const request: CreateKTVRobotRequest = {
RTCSystem: 'TRTC',
JoinRoomInput: { /* ... */ },
SyncRobotCommands: [
{
Command: 'SetRealVolume',
SetRealVolumeCommandInput: { RealVolume: 70 }
},
{
Command: 'Play',
PlayCommandInput: { Index: 0 }
}
]
};If you are working in a network environment that requires a proxy, you can configure it in two ways:
proxy parameter within the profile.httpProfile object when creating the Client.http_proxy.Failure to configure a proxy in such environments may result in connection timeout errors.
The Monitor object provides details about the monitoring status of a copyright work. It includes information such as:
WorkId and WorkNameWorkType (e.g., 01-Video, 02-Audio, 03-Text, 04-Image)MonitorStatus (e.g., 0-Pending, 1-Monitoring, 2-Not Monitoring, 3-Paused)TortPlatNum and TortURLNum (counts of infringing platforms and URLs)EvidenceStatus (status of evidence preservation)Access control is managed through Access Groups and Access Rules.
Access Group: A container for rules. Managed via CreateAccessGroupRequest, ModifyAccessGroupRequest, and DeleteAccessGroupRequest.
Access Rule: Defines specific permissions within a group. Managed via CreateAccessRulesRequest and ModifyAccessRulesRequest.
AccessRule Properties:
Address: Network segment or IP.AccessMode: 1 for Read-only, 2 for Read/Write.Priority: 1 to 100 (lower value = higher priority).The CDWPG (Cloud Data Warehouse PostgreSQL) service provides several operations to manage cluster instances, including creation, modification, scaling, and destruction.
Key operations include:
The tencentcloud-sdk-nodejs package provides the foundational building blocks for interacting with TencentCloud services. The core modules exported from the common entry point include:
SecretId and SecretKey.When creating or modifying an MCP Server via CreateMcpServerRequest or ModifyMcpServerRequest, you must specify the Mode. Supported modes are:
proxy: Proxy mode.wrap: Wrap/encapsulation mode.