# Tencent Cloud TencentDB for MongoDB API

> Tencent Cloud TencentDB for MongoDB API on Apizie: 97 endpoints (Assign Project, Check DBInstance Elastic Cpu Scalable, Close Audit Service, Create Account User, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:tencent-mongodb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:tencent-mongodb`
- Category: Cloud
- Status: byok
- Source: https://www.tencentcloud.com/document/api
- Page: https://apizie.tech/api/cloud/tencent-mongodb
- OpenAPI: https://apizie.tech/api/cloud/tencent-mongodb/openapi.json

Tencent Cloud API 3.0 for TencentDB for MongoDB (mongodb). Every call is signed with TC3-HMAC-SHA256 using your SecretId and SecretKey.

## Endpoints

### Assign Project
`POST https://apizie.tech/v1/cloud:tencent-mongodb/assign-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| ProjectId | integer | yes |  |

### Check DBInstance Elastic Cpu Scalable
`POST https://apizie.tech/v1/cloud:tencent-mongodb/check-dbinstance-elastic-cpu-scalable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | no |  |

### Close Audit Service
`POST https://apizie.tech/v1/cloud:tencent-mongodb/close-audit-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Create Account User
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-account-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserName | string | yes |  |
| Password | string | yes |  |
| MongoUserPassword | string | no |  |
| UserDesc | string | no |  |
| AuthRole | array | no |  |

### Create Audit Log File
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-audit-log-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| StartTime | string | yes |  |
| EndTime | string | yes |  |
| Order | string | no |  |
| OrderBy | string | no |  |
| Filter | object | no |  |

### Create Backup DBInstance
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-backup-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| BackupMethod | integer | yes |  |
| BackupRemark | string | no |  |
| BackupRetentionDays | integer | no |  |

### Create Backup Download Task
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-backup-download-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| BackupName | string | yes |  |
| BackupSets | array | yes |  |

### Create DBInstance
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| NodeNum | integer | yes |  |
| Memory | integer | yes |  |
| Volume | integer | yes |  |
| MongoVersion | string | yes |  |
| GoodsNum | integer | yes |  |
| Zone | string | yes |  |
| Period | integer | yes |  |
| MachineCode | string | yes |  |
| ClusterType | string | yes |  |
| ReplicateSetNum | integer | yes |  |
| ProjectId | integer | no |  |
| VpcId | string | no |  |
| SubnetId | string | no |  |
| Password | string | no |  |
| Tags | array | no |  |
| AutoRenewFlag | integer | no |  |
| AutoVoucher | integer | no |  |
| Clone | integer | no |  |
| Father | string | no |  |
| SecurityGroup | array | no |  |
| RestoreTime | string | no |  |
| InstanceName | string | no |  |
| AvailabilityZoneList | array | no |  |
| MongosCpu | integer | no |  |
| MongosMemory | integer | no |  |
| MongosNodeNum | integer | no |  |
| ReadonlyNodeNum | integer | no |  |
| ReadonlyNodeAvailabilityZoneList | array | no |  |
| HiddenZone | string | no |  |
| ParamTemplateId | string | no |  |
| DataEncryption | string | no |  |
| EncryptionKeySource | string | no |  |
| KeyId | string | no |  |
| KmsRegion | string | no |  |
| CpuCore | integer | no |  |

### Create DBInstance Hour
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-dbinstance-hour` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Memory | integer | yes |  |
| Volume | integer | yes |  |
| ReplicateSetNum | integer | yes |  |
| NodeNum | integer | yes |  |
| MongoVersion | string | yes |  |
| MachineCode | string | yes |  |
| GoodsNum | integer | yes |  |
| ClusterType | string | yes |  |
| Zone | string | yes |  |
| VpcId | string | no |  |
| SubnetId | string | no |  |
| Password | string | no |  |
| ProjectId | integer | no |  |
| Tags | array | no |  |
| Clone | integer | no |  |
| Father | string | no |  |
| SecurityGroup | array | no |  |
| RestoreTime | string | no |  |
| InstanceName | string | no |  |
| AvailabilityZoneList | array | no |  |
| MongosCpu | integer | no |  |
| MongosMemory | integer | no |  |
| MongosNodeNum | integer | no |  |
| ReadonlyNodeNum | integer | no |  |
| ReadonlyNodeAvailabilityZoneList | array | no |  |
| HiddenZone | string | no |  |
| ParamTemplateId | string | no |  |
| DataEncryption | string | no |  |
| EncryptionKeySource | string | no |  |
| KeyId | string | no |  |
| KmsRegion | string | no |  |
| CpuCore | integer | no |  |

### Create DBInstance Param Tpl
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-dbinstance-param-tpl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TplName | string | yes |  |
| MongoVersion | string | no |  |
| ClusterType | string | no |  |
| TplDesc | string | no |  |
| Params | array | no |  |
| MirrorTplId | string | no |  |

### Create Instance Role
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-instance-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RoleName | string | yes |  |
| Database | string | no |  |
| Privileges | array | no |  |
| InheritedRoles | array | no |  |

### Create Instance User
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-instance-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserName | string | yes |  |
| Password | string | no |  |
| EncryptedPassword | string | no |  |
| Database | string | no |  |
| Roles | array | no |  |
| AuthRole | array | no |  |
| Description | string | no |  |
| EnablePasswordRotation | integer | no |  |

### Create Log Download Task
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-log-download-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| StartTime | string | yes |  |
| EndTime | string | yes |  |
| NodeNames | array | no |  |
| LogComponents | array | no |  |
| LogLevels | array | no |  |
| LogIds | array | no |  |
| LogConnections | array | no |  |
| LogDetailParams | array | no |  |

### Create Slow Log Pattern Download Task
`POST https://apizie.tech/v1/cloud:tencent-mongodb/create-slow-log-pattern-download-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| StartTime | string | yes |  |
| EndTime | string | yes |  |
| ThresholdMs | integer | no |  |
| Commands | array | no |  |

### Delete Account User
`POST https://apizie.tech/v1/cloud:tencent-mongodb/delete-account-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserName | string | yes |  |
| MongoUserPassword | string | no |  |

### Delete Audit Log File
`POST https://apizie.tech/v1/cloud:tencent-mongodb/delete-audit-log-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| FileName | string | yes |  |

### Delete DBBackups
`POST https://apizie.tech/v1/cloud:tencent-mongodb/delete-dbbackups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| BackupIds | array | yes |  |

### Delete Instance Role
`POST https://apizie.tech/v1/cloud:tencent-mongodb/delete-instance-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RoleName | string | yes |  |
| Database | string | no |  |

### Delete Instance User
`POST https://apizie.tech/v1/cloud:tencent-mongodb/delete-instance-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserName | string | yes |  |
| Database | string | no |  |

### Delete Log Download Task
`POST https://apizie.tech/v1/cloud:tencent-mongodb/delete-log-download-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TaskId | string | yes |  |

### Describe Account Users
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-account-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Async Request Info
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-async-request-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| AsyncRequestId | string | yes |  |

### Describe Audit Config
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-audit-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Audit Instance List
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-audit-instance-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| AuditSwitch | integer | no |  |
| Filters | array | no |  |
| AuditMode | integer | no |  |
| Limit | integer | no |  |
| Offset | integer | no |  |

### Describe Audit Log Files
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-audit-log-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Limit | integer | no |  |
| Offset | integer | no |  |
| FileName | string | no |  |

### Describe Audit Logs
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-audit-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| StartTime | string | yes |  |
| EndTime | string | yes |  |
| Filter | object | no |  |
| Limit | integer | no |  |
| Offset | integer | no |  |
| Order | string | no |  |
| OrderBy | string | no |  |

### Describe Backup Download Task
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-backup-download-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| BackupName | string | no |  |
| StartTime | string | no |  |
| EndTime | string | no |  |
| Limit | integer | no |  |
| Offset | integer | no |  |
| OrderBy | string | no |  |
| OrderByType | string | no |  |
| Status | array | no |  |

### Describe Backup Rules
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-backup-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Client Connections
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-client-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Limit | integer | no |  |
| Offset | integer | no |  |

### Describe Current Op
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-current-op` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Ns | string | no |  |
| MillisecondRunning | integer | no |  |
| Op | string | no |  |
| ReplicaSetName | string | no |  |
| State | string | no |  |
| Limit | integer | no |  |
| Offset | integer | no |  |
| OrderBy | string | no |  |
| OrderByType | string | no |  |

### Describe DBBackups
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-dbbackups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| BackupMethod | integer | no |  |
| Limit | integer | no |  |
| Offset | integer | no |  |

### Describe DBInstance Deal
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-dbinstance-deal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| DealId | string | yes |  |

### Describe DBInstance Log To CLS
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-dbinstance-log-to-cls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| CLSRegion | string | no |  |

### Describe DBInstance Namespace
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-dbinstance-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| DbName | string | no |  |

### Describe DBInstance Node Property
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-dbinstance-node-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| NodeIds | array | no |  |
| Roles | array | no |  |
| OnlyHidden | boolean | no |  |
| Priority | integer | no |  |
| Votes | integer | no |  |
| Tags | array | no |  |

### Describe DBInstance Param Tpl
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-dbinstance-param-tpl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TplIds | array | no |  |
| TplNames | array | no |  |
| MongoVersion | array | no |  |
| TplType | string | no |  |

### Describe DBInstance Param Tpl Detail
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-dbinstance-param-tpl-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TplId | string | yes |  |
| ParamName | string | no |  |

### Describe DBInstance URL
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-dbinstance-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe DBInstances
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | no |  |
| InstanceType | integer | no |  |
| ClusterType | integer | no |  |
| Status | array | no |  |
| VpcId | string | no |  |
| SubnetId | string | no |  |
| PayMode | integer | no |  |
| Limit | integer | no |  |
| Offset | integer | no |  |
| OrderBy | string | no |  |
| OrderByType | string | no |  |
| ProjectIds | array | no |  |
| SearchKey | string | no |  |
| Tags | array | no |  |

### Describe Detailed Slow Logs
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-detailed-slow-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| StartTime | string | yes |  |
| EndTime | string | yes |  |
| ExecTime | integer | no |  |
| Commands | array | no |  |
| Texts | array | no |  |
| NodeNames | array | no |  |
| QueryHash | array | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| OrderBy | string | no |  |
| OrderByType | string | no |  |

### Describe Instance Params
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-instance-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Instance Roles
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-instance-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Database | string | no |  |
| RoleType | array | no |  |
| RoleName | string | no |  |
| SearchKey | string | no |  |
| OrderBy | string | no |  |
| OrderType | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |

### Describe Instance SSL
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-instance-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Instance Users
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-instance-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserName | string | no |  |
| Database | string | no |  |
| OrderBy | string | no |  |
| OrderType | string | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |

### Describe Log Download Tasks
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-log-download-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Limit | integer | no |  |
| Offset | integer | no |  |
| StartTime | string | no |  |
| EndTime | string | no |  |

### Describe Mongodb Logs
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-mongodb-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| StartTime | string | yes |  |
| EndTime | string | yes |  |
| NodeNames | array | no |  |
| LogComponents | array | no |  |
| LogLevels | array | no |  |
| LogIds | array | no |  |
| LogConnections | array | no |  |
| LogDetailParams | array | no |  |
| Offset | integer | no |  |
| Limit | integer | no |  |

### Describe Password Rotation
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-password-rotation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |

### Describe SRVConnection Domain
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-srvconnection-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Security Group
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Slow Log Patterns
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-slow-log-patterns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| StartTime | string | yes |  |
| EndTime | string | yes |  |
| SlowMS | integer | yes |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| Format | string | no |  |

### Describe Slow Logs
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-slow-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| StartTime | string | yes |  |
| EndTime | string | yes |  |
| SlowMS | integer | yes |  |
| Offset | integer | no |  |
| Limit | integer | no |  |
| Format | string | no |  |

### Describe Spec Info
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-spec-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Zone | string | no |  |

### Describe Transparent Data Encryption Status
`POST https://apizie.tech/v1/cloud:tencent-mongodb/describe-transparent-data-encryption-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Disable SRVConnection Url
`POST https://apizie.tech/v1/cloud:tencent-mongodb/disable-srvconnection-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Drop DBInstance Param Tpl
`POST https://apizie.tech/v1/cloud:tencent-mongodb/drop-dbinstance-param-tpl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TplId | string | yes |  |

### Enable Password Rotation
`POST https://apizie.tech/v1/cloud:tencent-mongodb/enable-password-rotation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |

### Enable SRVConnection Url
`POST https://apizie.tech/v1/cloud:tencent-mongodb/enable-srvconnection-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Enable Transparent Data Encryption
`POST https://apizie.tech/v1/cloud:tencent-mongodb/enable-transparent-data-encryption` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| KmsRegion | string | yes |  |
| KeyId | string | no |  |

### Enable Wan Service
`POST https://apizie.tech/v1/cloud:tencent-mongodb/enable-wan-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| LoadBalancerId | string | yes |  |
| NodeList | array | yes |  |

### Flash Back DBInstance
`POST https://apizie.tech/v1/cloud:tencent-mongodb/flash-back-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| TargetFlashbackTime | string | yes |  |
| TargetDatabases | array | yes |  |
| TargetInstanceId | string | no |  |

### Flush Instance Router Config
`POST https://apizie.tech/v1/cloud:tencent-mongodb/flush-instance-router-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Increase DBInstance Connection Limit
`POST https://apizie.tech/v1/cloud:tencent-mongodb/increase-dbinstance-connection-limit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |

### Inquire Price Create DBInstances
`POST https://apizie.tech/v1/cloud:tencent-mongodb/inquire-price-create-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Zone | string | yes |  |
| NodeNum | integer | yes |  |
| Memory | integer | yes |  |
| Volume | integer | yes |  |
| MongoVersion | string | yes |  |
| MachineCode | string | yes |  |
| GoodsNum | integer | yes |  |
| ClusterType | string | yes |  |
| ReplicateSetNum | integer | yes |  |
| Period | integer | no |  |
| InstanceChargeType | string | no |  |
| MongosCpu | integer | no |  |
| MongosMemory | integer | no |  |
| MongosNum | integer | no |  |
| ConfigServerCpu | integer | no |  |
| ConfigServerMemory | integer | no |  |
| ConfigServerVolume | integer | no |  |
| ReadonlyNodeNum | integer | no |  |
| Cpu | integer | no |  |

### Inquire Price Modify DBInstance Spec
`POST https://apizie.tech/v1/cloud:tencent-mongodb/inquire-price-modify-dbinstance-spec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Memory | integer | yes |  |
| Volume | integer | yes |  |
| NodeNum | integer | no |  |
| ReplicateSetNum | integer | no |  |
| Cpu | integer | no |  |

### Inquire Price Renew DBInstances
`POST https://apizie.tech/v1/cloud:tencent-mongodb/inquire-price-renew-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| InstanceChargePrepaid | object | yes |  |

### Instance Enable SSL
`POST https://apizie.tech/v1/cloud:tencent-mongodb/instance-enable-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Enable | boolean | yes |  |

### Isolate DBInstance
`POST https://apizie.tech/v1/cloud:tencent-mongodb/isolate-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Kill Ops
`POST https://apizie.tech/v1/cloud:tencent-mongodb/kill-ops` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Operations | array | yes |  |

### Modify Audit Service
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-audit-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| LogExpireDay | integer | no |  |
| AuditAll | boolean | no |  |
| RuleFilters | array | no |  |

### Modify Backup Expire Time
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-backup-expire-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| ExpireTime | string | yes |  |
| BackupIds | array | yes |  |

### Modify DBInstance Log To CLS
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-dbinstance-log-to-cls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| LogType | string | yes |  |
| Status | string | yes |  |
| CreateLogset | boolean | no |  |
| Logset | string | no |  |
| CreateLogTopic | boolean | no |  |
| LogTopic | string | no |  |
| CLSRegion | string | no |  |

### Modify DBInstance Network Address
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-dbinstance-network-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| OldIpExpiredTime | integer | yes |  |
| NewUniqVpcId | string | yes |  |
| NewUniqSubnetId | string | yes |  |
| NetworkAddresses | array | no |  |

### Modify DBInstance Param Tpl
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-dbinstance-param-tpl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TplId | string | yes |  |
| TplName | string | no |  |
| TplDesc | string | no |  |
| Params | array | no |  |

### Modify DBInstance Security Group
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-dbinstance-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| SecurityGroupIds | array | yes |  |

### Modify DBInstance Spec
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-dbinstance-spec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Memory | integer | no |  |
| Volume | integer | no |  |
| NodeNum | integer | no |  |
| ReplicateSetNum | integer | no |  |
| InMaintenance | integer | no |  |
| MongosMemory | string | no |  |
| AddNodeList | array | no |  |
| RemoveNodeList | array | no |  |
| Cpu | integer | no |  |
| MachineCode | string | no |  |
| ModifyShardList | array | no |  |

### Modify Instance Az
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-instance-az` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| PrimaryNodeZone | string | yes |  |
| SecondaryNodeZone | array | yes |  |
| HiddenNodeZone | string | no |  |
| ReadonlyNodeZone | array | no |  |
| InMaintenance | integer | no |  |

### Modify Instance Params
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-instance-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| InstanceParams | array | yes |  |
| ModifyType | string | no |  |

### Modify SRVConnection Url
`POST https://apizie.tech/v1/cloud:tencent-mongodb/modify-srvconnection-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| CustomDomain | string | yes |  |

### Offline Isolated DBInstance
`POST https://apizie.tech/v1/cloud:tencent-mongodb/offline-isolated-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Open Audit Service
`POST https://apizie.tech/v1/cloud:tencent-mongodb/open-audit-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| LogExpireDay | integer | yes |  |
| AuditAll | boolean | no |  |
| RuleFilters | array | no |  |

### Promote DBInstance To Active
`POST https://apizie.tech/v1/cloud:tencent-mongodb/promote-dbinstance-to-active` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| MasterId | string | yes |  |

### Rename Instance
`POST https://apizie.tech/v1/cloud:tencent-mongodb/rename-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| NewName | string | yes |  |

### Renew DBInstances
`POST https://apizie.tech/v1/cloud:tencent-mongodb/renew-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| InstanceChargePrepaid | object | yes |  |

### Reset DBInstance Password
`POST https://apizie.tech/v1/cloud:tencent-mongodb/reset-dbinstance-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserName | string | yes |  |
| Password | string | yes |  |

### Restart Nodes
`POST https://apizie.tech/v1/cloud:tencent-mongodb/restart-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| NodeIds | array | yes |  |

### Restore DBInstance
`POST https://apizie.tech/v1/cloud:tencent-mongodb/restore-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RestoreTime | string | yes |  |
| Databases | array | yes |  |

### Scale Down DBInstance Cpu
`POST https://apizie.tech/v1/cloud:tencent-mongodb/scale-down-dbinstance-cpu` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | no |  |

### Scale Up DBInstance Cpu
`POST https://apizie.tech/v1/cloud:tencent-mongodb/scale-up-dbinstance-cpu` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | no |  |
| ExtraCpu | integer | no |  |

### Set Account User Privilege
`POST https://apizie.tech/v1/cloud:tencent-mongodb/set-account-user-privilege` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserName | string | yes |  |
| AuthRole | array | yes |  |

### Set Backup Rules
`POST https://apizie.tech/v1/cloud:tencent-mongodb/set-backup-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| BackupMethod | integer | no |  |
| BackupTime | integer | no |  |
| BackupFrequency | integer | no |  |
| Notify | boolean | no |  |
| BackupRetentionPeriod | integer | no |  |
| ActiveWeekdays | string | no |  |
| LongTermUnit | string | no |  |
| LongTermActiveDays | string | no |  |
| LongTermExpiredDays | integer | no |  |
| OplogExpiredDays | integer | no |  |
| BackupVersion | integer | no |  |
| AlarmWaterLevel | integer | no |  |
| LongTermInterval | string | no |  |
| AlertThreshold | integer | no |  |

### Set DBInstance Deletion Protection
`POST https://apizie.tech/v1/cloud:tencent-mongodb/set-dbinstance-deletion-protection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| EnableDeletionProtection | integer | yes |  |

### Set Instance Maintenance
`POST https://apizie.tech/v1/cloud:tencent-mongodb/set-instance-maintenance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| MaintenanceStart | string | yes |  |
| MaintenanceEnd | string | yes |  |
| MaintenanceDays | string | no |  |

### Terminate DBInstances
`POST https://apizie.tech/v1/cloud:tencent-mongodb/terminate-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Update Instance Role
`POST https://apizie.tech/v1/cloud:tencent-mongodb/update-instance-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| RoleName | string | yes |  |
| Database | string | no |  |
| Privileges | array | no |  |
| InheritedRoles | array | no |  |

### Update Instance User
`POST https://apizie.tech/v1/cloud:tencent-mongodb/update-instance-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserName | string | yes |  |
| Database | string | no |  |
| Password | string | no |  |
| EncryptedPassword | string | no |  |
| Roles | array | no |  |
| AuthRole | array | no |  |
| Description | string | no |  |

### Upgrade DBInstance Kernel Version
`POST https://apizie.tech/v1/cloud:tencent-mongodb/upgrade-dbinstance-kernel-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| InMaintenance | integer | no |  |

### Upgrade Db Instance Version
`POST https://apizie.tech/v1/cloud:tencent-mongodb/upgrade-db-instance-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| MongoVersion | string | yes |  |
| InMaintenance | integer | no |  |

## Example
```
curl "https://apizie.tech/v1/cloud:tencent-mongodb/assign-project" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Tencent Cloud TencentDB for MongoDB API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:tencent-mongodb/assign-project with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Tencent Cloud TencentDB for MongoDB API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Tencent Cloud TencentDB for MongoDB itself also needs your own key from tencentcloudapi.com.

### Can AI agents use the Tencent Cloud TencentDB for MongoDB API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:tencent-mongodb.

### What is the status of the Tencent Cloud TencentDB for MongoDB API?
Needs your own provider key (bring your own key)