# Alibaba Cloud ApsaraDB for MongoDB API

> Alibaba Cloud ApsaraDB for MongoDB API on Apizie: 136 endpoints (Applies for an SRV address for an ApsaraDB for MongoDB instance, Applies for an internal network endpoint for a shard or ConfigServer node of an ApsaraDB for MongoDB…, Allocates a public endpoint, Cancels multiple O&M events in batches, …) 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://zieapi.vercel.app/v1/cloud:aliyun-dds/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-dds`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/dds
- Page: https://zieapi.vercel.app/api/cloud/aliyun-dds
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-dds/openapi.json

Alibaba Cloud OpenAPI for ApsaraDB for MongoDB (dds, version 2015-12-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Applies for an SRV address for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/allocate-dbinstance-srv-network-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| NodeId | string | no | The ID of the Mongos or shard node in a sharded cluster instance. You do not need to specify this parameter |
| SrvConnectionType | string | no | The type of the SRV address to apply for. Valid values: vpc: VPC SRV address. public: Public SRV address. The default is the private SRV… |

### Applies for an internal network endpoint for a shard or ConfigServer node of an ApsaraDB for MongoDB…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/allocate-node-private-network-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ZoneId | string | no | The zone ID of the instance. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the zone ID of the… |
| DBInstanceId | string | yes | The instance ID of the sharded cluster |
| NodeId | string | yes | The ID of the shard or Configserver node. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the ID of… |
| AccountName | string | no | The username. The username must start with a lowercase letter and be 4 to 16 characters in length. It can contain lowercase letters,… |
| AccountPassword | string | no | The password. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and… |

### Allocates a public endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/allocate-public-network-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter |
| NodeId | string | no | Instance ID of the Mongos, shard, or ConfigServer node in the sharded cluster instance. You can call the… |

### Cancels multiple O&M events in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/cancel-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Ids | string | yes | The IDs of the O&M events to be canceled in batches. Separate multiple IDs with commas (,) |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries whether a Key Management Service (KMS) key is authorized for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/check-cloud-resource-authorized` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| TargetRegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the region ID |

### Checks whether a MongoDB instance meets the conditions for data restoration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/check-recovery-condition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SourceDBInstance | string | yes | The instance ID of the source instance to recover |
| DatabaseNames | string | no | The names of the databases to be restored. The value is a JSON array. If you do not specify this parameter, all databases are restored by… |
| RestoreTime | string | no | The point in time to which you want to restore the instance. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… |
| BackupId | string | no | The ID of the backup set. You can call the https://help.aliyun.com/document_detail/62172.html operation to query the backup ID. You must… |
| ResourceGroupId | string | no | The ID of the resource group |
| SrcRegion | string | no | The area where the source instance resides. This parameter is required when the backup recover type is rebuilding a deleted instance. This… |
| DestRegion | string | no | The area where the backup set resides during geo-redundancy recover. This parameter is required when the backup recover type is… |
| RestoreType | string | no | The backup recover type. Valid values: 0: local backup recover 1: local point-in-time recover 2: backup recover of a deleted instance… |
| InstanceType | string | no | The instance type. Valid values: replicate sharding This parameter is required when the backup recover type is rebuilding a deleted… |
| EngineVersion | string | no | The database version. Valid values: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 |

### Queries whether a service-linked role (SLR) has been created
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/check-service-linked-role` (byok)

### Creates a read-only shard account for an ApsaraDB for MongoDB sharded cluster instance with cloud disks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/create-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| AccountName | string | yes | The account name. The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must… |
| AccountPassword | string | yes | The account password. The password must be 8 to 32 characters in length and must contain at least three of the following character types:… |
| CharacterType | string | no | The type of the account to be created. Valid values: db: shard account. This is the default value. cs: Configserver account. normal:… |
| Roles | string | no | The list of authorized roles for the account (JSON-encoded) |
| DBName | string | no | The database to which the account belongs. This is the database where the account is created or on which the account operates. Default… |
| AccountDescription | string | no | The description of the account |

### Creates a backup for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/create-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| BackupMethod | string | no | The backup method of the instance. Valid values: Snapshot: snapshot backup Logical: logical backup Physical: physical backup (default)… |
| BackupRetentionPeriod | integer | no | The retention period of the backup. This parameter is applicable only to replica set and sharded cluster instances with cloud disks. If… |

### Creates or clones an ApsaraDB for MongoDB replica set instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/create-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the region ID. If you call this… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the zone ID |
| EngineVersion | string | yes | The database engine version. Valid values: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 If you call this operation to clone clone instance or restore clone… |
| DBInstanceClass | string | yes | The instance type. You can call the https://help.aliyun.com/document_detail/149719.html operation to query the available instance types |
| DBInstanceStorage | integer | yes | The instance storage capacity. Unit: GB. The valid values depend on the instance type. For details, see… |
| DBInstanceDescription | string | no | The instance name. The name must meet the following requirements: Must start with a Chinese character or a letter. Can contain digits,… |
| SecurityIPList | string | no | The IP whitelist of the instance. Separate multiple IP addresses with commas (,). Duplicate IP addresses are not allowed. The following… |
| AccountPassword | string | no | The password of the root account. The password must meet the following requirements: Must contain at least three of the following… |
| Period | integer | no | The subscription duration of the instance. Unit: months. Valid values: 1 to 9 (integers), 12, 24, 36, and 60. This parameter is available… |
| ChargeType | string | no | The billing method of the instance. Valid values: PostPaid: default value. Pay-as-you-go. PrePaid: Subscription. If you set this parameter… |
| NetworkType | string | no | The network type of the instance. Valid values: VPC: Virtual Private Cloud |
| VpcId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID |
| SrcDBInstanceId | string | no | The source instance ID. If you call this operation to clone clone instance, you must configure this parameter along with the BackupId or… |
| BackupId | string | no | The backup ID. You can invoke the https://help.aliyun.com/document_detail/62172.html operation to query the backup ID. This parameter is… |
| RestoreTime | string | no | The point in time to recover the instance to. You can specify any point in time within the last 7 days. Specify the time in the yyyy-MM-dd… |
| BusinessInfo | string | no | The additional information about the business |
| AutoRenew | string | no | Specifies whether to enable auto-renewal for the instance. Valid values: true: enables auto-renewal. false: default value. Disables… |
| DatabaseNames | string | no | The name of the database. When you invoke this operation to clone a clone instance, you can specify this parameter to clone specific… |
| CouponNo | string | no | Specifies whether to use a coupon. Valid values: default or null (default): uses a coupon. youhuiquan_promotion_option_id_for_blank: does… |
| StorageEngine | string | no | The storage engine of the instance. The value is fixed as WiredTiger. If you call this operation to clone clone instance or restore clone… |
| ReplicationFactor | string | no | The number of primary and secondary nodes in the replica set instance. Valid values: 3 (default) 5 7 This parameter is not required for… |
| ReadonlyReplicas | string | no | The number of read-only nodes in the replica set instance. Valid values: 0 to 5 (integers). Default value: 0 |
| ResourceGroupId | string | no | The ResourceGroupId |
| ClusterId | string | no | The ClusterId |
| Engine | string | no | The database engine. The value is fixed as MongoDB |
| StorageType | string | no | The storage type. Valid values: cloud_essd1: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. cloud_auto: ESSD AutoPL disk.… |
| SecondaryZoneId | string | no | The zone where the secondary node is deployed to implement multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G.… |
| HiddenZoneId | string | no | The zone where the hidden node is deployed to implement multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G.… |
| Tag | string | no | The user-defined tags (JSON-encoded) |
| GlobalSecurityGroupIds | string | no | The global IP whitelist templates for the instance. Separate multiple templates with commas (,). Duplicate templates are not allowed.… |
| Encrypted | string | no | Specifies whether to enable cloud disk encryption |
| EncryptionKey | string | no | The custom key ID |
| ProvisionedIops | integer | no | The provisioned performance (IOPS). Valid values: 0 to 50000 |
| RestoreType | string | no | The backup restoration type. Valid values: 0: recovers the instance to a specified backup set. 1: recovers the instance to a specified… |
| SrcRegion | string | no | The region where the source instance resides. This parameter is required when the restoration type is 2 or 3 |

### Creates a global IP whitelist template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/create-global-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/61933.html to query regions |
| GlobalIgName | string | yes | The name of the IP whitelist template. The name must meet the following requirements: It can contain only lowercase letters, digits, and… |
| GIpList | string | yes | The IP addresses in the whitelist template. Separate multiple IP addresses with commas (,). A maximum of 1,000 IP addresses or CIDR blocks… |

### Adds a shard node or a mongos node to an ApsaraDB for MongoDB sharded cluster instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/create-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID of the sharded cluster instance |
| NodeClass | string | yes | The instance type of the shard node or mongos node. For more information about instance types, see… |
| NodeStorage | integer | no | The disk space of the node. Unit: GB. The valid values vary based on the storage type. For more information, see… |
| NodeType | string | yes | The node type. Valid values: shard: shard node. mongos: mongos node |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. This is the default value. Make sure that… |
| ReadonlyReplicas | integer | no | The number of read-only nodes in the shard node. Valid values: 0 to 5. Default value: 0. This parameter is supported only on the China site |
| BusinessInfo | string | no | The additional parameter for business information |
| CouponNo | string | no | Specifies whether to use a coupon. Valid values: default or null: uses a coupon. This is the default value.… |
| ShardDirect | string | no | Specifies whether to apply for a direct connection endpoint for the shard node. Valid values: true: applies for a direct connection… |
| AccountName | string | no | The username. Valid values: The username must start with a lowercase letter. The username can contain lowercase letters, digits, and… |
| AccountPassword | string | no | The password of the account. Valid values: The password must contain at least three of the following character types: uppercase letters,… |
| SearchDBInstanceClass | string | no | The instance type of the search node to be added |
| SearchStorage | integer | no | The storage capacity of the search node to be added |
| SearchNodeCount | integer | no | The number of search nodes to be added |

### Adds multiple Mongos or shard nodes to an ApsaraDB for MongoDB sharded cluster instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/create-node-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| FromApp | string | no | The source of the request. Valid values: OpenApi: OpenAPI. mongo_buy: The console |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: (Default) Automatic payment is enabled. Make sure that your account has… |
| DBInstanceId | string | yes | The instance ID |
| NodesInfo | string | yes | The specifications of the Mongos or shard nodes to be added. For more information about the specifications, see… |
| CouponNo | string | no | Specifies whether to use a coupon. Valid values: default or null: (Default) A coupon is used. youhuiquan_promotion_option_id_for_blank: No… |
| BusinessInfo | string | no | The business information |
| ShardDirect | string | no | Specifies whether to apply for a direct connection endpoint for the shard node. Valid values: true: Applies for a direct connection… |
| AccountName | string | no | The name of the account. Valid values: The name must start with a lowercase letter. The name can contain lowercase letters, digits, and… |
| AccountPassword | string | no | The password of the account. Valid values: The password must contain at least three of the following character types: uppercase letters,… |

### Creates a role tag for an instance node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/create-node-role-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| ShardList | string | no | The shard node ID. This parameter is available only when you create a role tag for a shard node of a sharded cluster instance |

### Creates or clones an ApsaraDB for MongoDB sharded cluster instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/create-sharding-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the region ID |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the zone ID |
| Engine | string | yes | The database engine. Set the value to MongoDB |
| EngineVersion | string | yes | The database version number. Valid values: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 For more information about the constraints on storage engines and… |
| DBInstanceDescription | string | no | The name of the instance. The name must meet the following requirements: It must start with a letter or a Chinese character. It can… |
| SecurityIPList | string | no | The IP address whitelist of the instance. Separate multiple IP addresses with commas (,). Duplicate IP addresses are not supported. The… |
| AccountPassword | string | no | The password of the root account. The password must meet the following requirements: It must contain at least three of the following… |
| ChargeType | string | no | The billing method of the instance. Valid values: PostPaid: Pay-as-you-go. This is the default value. PrePaid: Subscription. If you set… |
| Period | integer | no | The subscription duration of the instance. Unit: months. Valid values: 1 to 9, 12, 24, 36, and 60. This parameter is required and takes… |
| NetworkType | string | no | The network type of the instance. Valid values: VPC: VPC |
| VpcId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID |
| SrcDBInstanceId | string | no | The source instance ID. This parameter is required only when you call this operation to clone an instance. You must also specify the… |
| RestoreTime | string | no | The point in time to which you want to restore the instance. You can specify any point in time within the last seven days. Specify the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| StorageEngine | string | no | The storage engine of the instance. Set the value to WiredTiger. When you call this operation to clone an instance, the value of this… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal for the instance. Valid values: true: Enables auto-renewal. false: Disables auto-renewal. You… |
| ProtocolType | string | no | The type of the access protocol. Valid values: mongodb: MongoDB protocol. dynamodb: DynamoDB protocol |
| Mongos | string | yes | The information about the mongos nodes (JSON-encoded) |
| ReplicaSet | string | yes | The information about the shard nodes (JSON-encoded) |
| ConfigServer | string | yes | The information about the ConfigServer nodes (JSON-encoded) |
| ResourceGroupId | string | no | The ResourceGroupId |
| SecondaryZoneId | string | no | The secondary zone 1 for multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G. cn-hangzhou-h: Hangzhou Zone H.… |
| HiddenZoneId | string | no | The secondary zone 2 for multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G. cn-hangzhou-h: Hangzhou Zone H.… |
| StorageType | string | no | The storage type. Valid values: cloud_essd1: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. local_ssd: local SSD. Instances of… |
| GlobalSecurityGroupIds | string | no | The global IP address whitelist templates of the instance. Separate multiple templates with commas (,). Duplicate templates are not… |
| Tag | string | no | The custom tags (JSON-encoded) |
| Encrypted | string | no | Specifies whether to enable cloud disk encryption |
| EncryptionKey | string | no | The ID of the custom key |
| ProvisionedIops | integer | no | The provisioned IOPS |
| SrcRegion | string | no | The region where the source instance is located. This parameter is required when the backup restoration type is rebuilding a deleted… |
| BackupId | string | no | The ID of the cluster backup. This parameter is required only when RestoreType is set to 2 or 3 |
| RestoreType | string | no | The backup restoration type. Valid values: 1: Restore the instance to a specified point in time. 2: Restore a released instance to a… |
| DestRegion | string | no | The region where the cross-region backup is stored |

### Deletes a MongoDB backup set
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/delete-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| BackupId | string | yes | The backup ID |

### Releases a pay-as-you-go MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/delete-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| ClientToken | string | no | A token that ensures the idempotence of the request. The client generates this value, which must be unique among different requests. The… |

### Deletes a global IP address whitelist template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/delete-global-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query region IDs |
| GlobalIgName | string | no | The name of the IP address whitelist template. The name must meet the following requirements: It can contain only lowercase letters,… |
| GlobalSecurityGroupId | string | yes | The ID of the IP address whitelist template |

### Deletes a shard or mongos node from an ApsaraDB for MongoDB sharded cluster instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/delete-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| NodeId | string | yes | The ID of the shard or mongos node to be deleted. You can call the https://help.aliyun.com/document_detail/61923.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |

### Queries the database account information of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| AccountName | string | no | The account name |
| CharacterType | string | no | The account type |
| DBName | string | no | The database to which the account belongs |

### Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-active-operation-maintenance-config` (byok)

### Queries the details of O&M tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-active-operation-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The ID of the region to which the pending events belong. You can call the https://help.aliyun.com/document_detail/61933.html operation to… |
| TaskType | string | yes | The task type. Valid values: rds_apsaradb_ha: primary/secondary node switch. rds_apsaradb_transfer: instance migration.… |
| IsHistory | integer | no | Specifies whether to return historical tasks. Valid values: 0: returns current tasks. This is the default value. 1: returns historical tasks |
| PageSize | integer | no | The maximum number of entries to return on each page. The value must be greater than 10. Default value: 30 |
| PageNumber | integer | no | The page number. The value must be greater than 0 and not exceed the maximum value of the Integer data type. Default value: 1 |
| ProductId | string | no | The product ID |

### Queries the number of operation and maintenance tasks on an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-active-operation-task-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the types and number of O&M tasks for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-active-operation-task-region` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TaskType | string | yes | The task type. Valid values: rds_apsaradb_ha: a primary/secondary node switchover. rds_apsaradb_transfer: an instance migration.… |
| IsHistory | integer | no | Specifies whether to return historical tasks. Valid values: 0: The default value. Returns current tasks. 1: Returns historical tasks |

### Queries the types of Operation and Maintenance tasks and the number of tasks of each type for an ApsaraDB…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-active-operation-task-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| IsHistory | integer | no | Specifies whether to return historical O\&M tasks. Valid values: 0 (default): The system returns only pending O\&M tasks. 1: The system… |
| ResourceGroupId | string | no | The resource group ID. You can call the https://help.aliyun.com/document_detail/146130.html operation to query the resource group ID |

### Queries O&M task details for MongoDB instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | no | The ID of the region where the pending event is located. Call the DescribeRegions operation to obtain the region ID. A value of all… |
| TaskType | string | no | The task type. Valid values: rds_apsaradb_ha: primary-secondary node switchover. rds_apsaradb_transfer: instance migration.… |
| PageSize | integer | no | The number of entries per page. Valid values: 30, 50, and 100. Default value: 30 |
| PageNumber | integer | no | The page number. The value must be greater than 0. Default value: 1 |
| ProductId | string | no | The product name. For MongoDB instances, set this parameter to MongoDB |
| DbType | string | no | The database type. Default value: all |
| Status | integer | no | The task status. This parameter filters the returned tasks. -1: all tasks. 3: pending tasks. 4: running tasks. 5: successfully completed… |
| InsName | string | no | The name of the instance. This parameter is optional. You can specify only one instance name |
| AllowChange | integer | no | Specifies whether the time can be changed. Valid values: -1 (default): returns all tasks. 0: returns only tasks whose time cannot be… |
| AllowCancel | integer | no | Specifies whether the task can be canceled. Valid values: -1 (default): returns all tasks. 0: returns only tasks that cannot be canceled.… |
| ChangeLevel | string | no | The level of the task. Valid values: all (default): returns all tasks. S0: returns tasks for exception fixing. S1: returns tasks for… |
| ResourceGroupId | string | no | The resource group ID |

### Queries advanced backup policies
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-advanced-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Queries whether advanced backup is enabled
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-advanced-backup-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Queries the audit log types collected for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-audit-log-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance |
| RoleType | string | no | The role of the node in the instance. Valid values: mongos: mongos node. db : shard node. logic : logical instance |

### Checks whether audit logging is enabled for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-audit-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Queries the audit logs of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-audit-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If you specify a sharded cluster instance ID for this parameter, you must also specify the NodeId parameter |
| NodeId | string | no | Instance ID of a mongos node or shard node in the sharded cluster instance. This parameter is available only when DBInstanceId is set to… |
| StartTime | string | yes | The start time of the query. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format. The time must be in UTC |
| EndTime | string | yes | The end time of the query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format. The… |
| Database | string | no | The name of the database. The default value is all databases |
| User | string | no | The database account. The default value is all accounts |
| Form | string | no | The display format of the returned audit records. Valid values: File: Triggers the generation of an audit log file. If you set this… |
| QueryKeywords | string | no | The keywords to query. Separate multiple keywords with spaces. You can specify a maximum of 10 keywords |
| LogicalOperator | string | no | The logical operator for keyword search. The default value is and |
| PageSize | integer | no | The number of records per page. Valid values: 30 (default), 50, and 100 |
| PageNumber | integer | no | The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer type. Default value: 1 |
| OrderType | string | no | The order in which the queried slow logs are sorted by time. Valid values: asc: sorts results in ascending order by time. desc: sorts… |

### Queries a list of the zones that are supported by an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-availability-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the latest available… |
| ZoneId | string | no | The zone ID of the instance. You can call the https://help.aliyun.com/document_detail/61933.html operation to query available zones |
| InstanceChargeType | string | no | The billing method of the product. Valid values: PrePaid: subscription PostPaid: pay-as-you-go |
| DbType | string | no | The architecture of the instance. Valid values: normal: replica set instance sharding: sharded cluster instance |
| ResourceGroupId | string | no | The ID of the resource group. For more information, see https://help.aliyun.com/document_detail/151181.html |
| AcceptLanguage | string | no | The language of the returned RegionName and ZoneName parameter values. Valid values: zh (default): Chinese en: English |
| StorageSupport | string | no | The storage type. Valid values: cloud: displays only zones available for instances that use cloud disks. local: only displays zones… |
| MongoType | string | no | The edition of the instance. High-Available Edition and Preview Edition (dbfs) are supported |
| StorageType | string | no | The storage type. Valid values: cloud_essd1: PL1 Enterprise SSDs (ESSDs) cloud_essd2: PL2 ESSDs cloud_essd3: PL3 ESSDs local_ssd: local… |
| ExcludeZoneId | string | no | The zone ID that is excluded from the query results |
| ExcludeSecondaryZoneId | string | no | The secondary zone ID that is excluded from the query results. You can configure the ExcludeZoneId and ExcludeSecondaryZoneId parameters… |
| DBInstanceClass | string | no | The instance type of the instance |
| EngineVersion | string | no | The database engine version of the instance |
| ReplicationFactor | string | no | The number of nodes in the instance. This parameter is available only for replica set instances. Valid values: 1 3 5 7 |
| InstanceType | string | no | The architecture of the instance. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance |

### Queries the engine versions to which an ApsaraDB for MongoDB instance can be upgraded
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-available-engine-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance |

### Queries the available resources in the specified zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-available-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The ID of the region. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the latest available regions |
| ZoneId | string | no | The ID of the zone. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the available zones |
| InstanceChargeType | string | no | The billing method of the instance. Valid values: PrePaid (default): subscription PostPaid: pay-as-you-go |
| DbType | string | no | The architecture of the instance. Valid values: normal: replica set instance sharding: sharded cluster instance |
| ResourceGroupId | string | no | The ID of the resource group |
| StorageType | string | no | The storage type of the instance. Valid values: local_ssd: local SSD cloud_essd1: PL1 enhanced SSD (ESSD) cloud_essd2: PL2 ESSD… |
| DBInstanceClass | string | no | The instance type of the instance |
| EngineVersion | string | no | The major engine version of the instance |
| ReplicationFactor | string | no | The number of nodes, only applicable to replica sets |

### Queries the databases at a specified time or the databases in a specified backup set before you restore a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-backup-dbs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PageNumber | integer | no | The page number of the page to return. The value must be an integer that is greater than 0. Default value: 1 |
| PageSize | integer | no | The number of entries to return per page. Default value: 30. Valid values: 30, 50, and 100 |
| SourceDBInstance | string | yes | The ID of the source instance |
| RestoreTime | string | no | The point in time to which the instance is restored. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The… |
| BackupId | string | no | The backup ID. You can call the https://help.aliyun.com/document_detail/62172.html operation to query the backup ID. You must specify one… |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the backup policy of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| InstanceType | string | no | The instance type. Valid values: replicate: replica set instance sharding: sharded cluster instance |
| SrcRegion | string | no | The region where the instance is deployed |

### Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-backup-storage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The ID of the region where the instance is located. Call the https://help.aliyun.com/document_detail/62010.html operation to query the… |
| DBInstanceId | string | yes | The instance ID |
| NodeId | string | no | The ID of the shard node in the sharded cluster instance. This parameter is required if the DBInstanceId parameter specifies the ID of a… |

### Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-backup-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| BackupJobId | string | no | The backup job ID. If you call https://help.aliyun.com/document_detail/468439.html to perform a manual backup, you can pass the returned… |

### Queries the backup list of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter |
| NodeId | string | no | Instance ID of the shard node in the sharded cluster instance. This parameter is required if you set the DBInstanceId parameter to… |
| BackupId | string | no | The instance ID. If you set the DBInstanceId parameter to the ID of a sharded cluster instance, the number of instance IDs is the same as… |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the yyyy-MM-dd T HH:mm Z format (UTC). This parameter is invalid if BackupId… |
| EndTime | string | no | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm Z format… |
| SrcRegion | string | no | The region where the instance resides. This parameter is required to restore a deleted instance. This parameter is required for… |
| DestRegion | string | no | The region where the backup resides. This parameter is required for geo-redundancy backups |
| ResourceGroupId | string | no | The resource group ID |
| BackupJobId | string | no | The backup task ID |

### Query log backup files for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-binlog-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The ID of the region |
| DBInstanceId | string | yes | The ID of the instance. If the instance is a sharded cluster, you must also specify the NodeId parameter |
| NodeId | string | no | The ID of the mongos node or shard node in the sharded cluster instance. This parameter is applicable only to sharded cluster instances |
| StartTime | string | yes | The start time of the query. The time is in the yyyy-MM-ddTHH:mm:ss.xxxZ format. The time is displayed in UTC |
| EndTime | string | yes | The end time of the query. The time must be later than the start time. The time is in the yyyy-MM-ddTHH:mm:ss.xxxZ format. The time is… |
| PageSize | integer | no | The number of entries to return on each page |
| PageNumber | integer | no | The page number |
| SrcRegion | string | no | The region of the source instance for a cross-region backup. This parameter is required when you query cross-region backups |
| DestRegion | string | no | The region where the cross-region backup is stored. This parameter is required when you query cross-region backups |
| BinlogId | string | no | The binlog ID. This parameter is not currently supported |
| ResourceGroupId | string | no | The resource group ID |

### Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-cluster-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance |
| BackupId | string | no | The ID of the cluster backup |
| PageNo | integer | no | The number of the page to return. The value must be a positive integer. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30 (Default) 50 100 |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in Coordinated Universal Time… |
| EndTime | string | no | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The… |
| IsOnlyGetClusterBackUp | string | no | Specifies whether to query the information about the child nodes in the cluster backup. Valid values: true: Returns only the basic… |
| SrcRegion | string | no | The region where the instance resides. This parameter is required when you query the backup sets of a released instance. This parameter is… |
| DestRegion | string | no | The region where the geo-redundant backup resides. This parameter is required when you query geo-redundant backups |
| ResourceGroupId | string | no | The ID of the resource group |
| BackupJobId | string | no | The ID of the backup job |

### Queries the restorable time range of a sharded cluster instance that uses cloud disks in ApsaraDB for MongoDB
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-cluster-recover-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| SrcRegion | string | no | The region where the source instance of the geo-redundancy backup resides. This parameter is required when you query a geo-redundancy backup |
| DestRegion | string | no | The region where the geo-redundancy backup set resides. This parameter is required when you query a geo-redundancy backup |
| ResourceGroupId | string | no | The resource group ID |
| OnlyDbTableRecovery | string | no | The OnlyDbTableRecovery |

### Queries the details of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Engine | string | no | The database engine. Set the value to MongoDB |
| DBInstanceId | string | yes | The instance ID |
| ResourceGroupId | string | no | The resource group ID. For more information about resource groups, see https://help.aliyun.com/document_detail/151181.html. This parameter… |
| IsDelete | string | no | Specifies whether the instance is deleted. Valid values: false: The instance is running. Queries the information of running instances.… |

### Queries the details of a specific key for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstance-encryption-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| EncryptionKey | string | no | The custom encryption key of the instance. You can call https://help.aliyun.com/document_detail/151729.html to query the custom keys of… |
| EncryptionType | string | no | The key scenario to query. Valid values: TDE: Queries transparent data encryption key information. CloudDisk: Queries cloud disk… |

### Queries the collection frequency of monitoring data for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstance-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Queries the performance data of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstance-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. NodeId is required when specifying a sharded cluster instance ID |
| NodeId | string | no | The ID of a mongos or shard node in the sharded cluster instance. This parameter lets you query the performance of a single node.… |
| Key | string | yes | The performance metrics. For more information, see https://help.aliyun.com/document_detail/216973.html. To specify multiple metrics,… |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The… |
| RoleId | string | no | The role ID of a node in a standalone or replica set instance. To query the role ID, call the… |
| Interval | string | no | The data granularity of the performance metrics in seconds. Valid values: 5, 30, 60, 600, 1800, 3600, and 86400 |
| ReplicaSetRole | string | no | The role of a node in a standalone or replica set instance. Valid values: Primary: The primary node. Secondary: A secondary node.… |
| SearchId | string | no | The Search node ID. Available only after the Search feature is enabled for the instance |

### Query SSL configuration details for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstance-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Gets instance type details
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstance-spec-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceClass | string | yes | The instance type. You can query this parameter by calling the DescribeDBInstanceAttribute… |

### Queries the primary/secondary switching logs of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstance-switch-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-mm-ddThh:mmZ format. The time must be in UTC |
| EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-mm-ddThh:mmZ format. The time must be in UTC.… |
| PageNumber | integer | no | The number of the page to return. The value must be an integer that is greater than 0 and less than or equal to the maximum value… |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30 |
| DBInstanceId | string | no | The instance ID |

### Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstance-tdeinfo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Queries a list of MongoDB instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the region ID |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| DBInstanceId | string | no | The instance ID |
| ReplicationFactor | string | no | The number of nodes in the replica set instance. Valid values: 3 5 7 |
| DBInstanceDescription | string | no | The instance name. The name must meet the following requirements: It must start with a Chinese character or a letter. It can contain… |
| ExpireTime | string | no | The expiration time of the instance in the yyyy-MM-ddTHH:mm:ssZ format (UTC). This parameter is used to filter instances whose expiration… |
| DBInstanceStatus | string | no | The instance status. For more details about valid values, see https://help.aliyun.com/document_detail/63870.html |
| DBInstanceType | string | no | The instance type. Valid values: sharding: sharded cluster instance. replicate: default value. Replica set instance or single-node… |
| DBInstanceClass | string | no | The instance specification. For more information about valid values, see https://help.aliyun.com/document_detail/57141.html |
| Engine | string | no | The database engine. Set the value to MongoDB |
| EngineVersion | string | no | The database engine version. Valid values: 7.0 6.0 5.0 4.4 4.2 4.0 3.4 |
| NetworkType | string | no | The network type of the instance. Valid values: Classic: classic network. VPC: VPC |
| VpcId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID of the VPC |
| ChargeType | string | no | The billing method of the instance. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the zone ID |
| Expired | string | no | The expiration status of the instance. Valid values: true: expired. false: not expired |
| ConnectionDomain | string | no | The endpoint of the node. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the endpoint |
| ResourceGroupId | string | no | The resource group ID |
| Tag | string | no | The tags (JSON-encoded) |
| DBNodeType | string | no | Specifies whether to filter standard or test instances. Single-node instances and DBFS instances: customized Standard instances (replica… |

### Queries the overview of one or more ApsaraDB for MongoDB instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-dbinstances-overview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. Call https://help.aliyun.com/document_detail/61933.html to query the latest region list |
| InstanceIds | string | no | The ID of the instance whose overview you want to query. If you do not specify this parameter, an overview of all instances in your… |
| InstanceStatus | string | no | The status of the instance. For more information, see https://help.aliyun.com/document_detail/63870.html |
| ChargeType | string | no | The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go |
| NetworkType | string | no | The network type of the instance. Valid values: Classic: classic network VPC: virtual private cloud (VPC) |
| EngineVersion | string | no | The database engine version of the instance. Valid values: 5.0, 4.4, 4.2, 4.0, and 3.4 |
| InstanceClass | string | no | The instance type. For more information about the instance types available for different instance architectures, see:… |
| VpcId | string | no | The ID of the VPC |
| VSwitchId | string | no | The ID of the vSwitch |
| InstanceType | string | no | The instance architecture. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance serverless:… |
| ZoneId | string | no | The ID of the zone |
| ResourceGroupId | string | no | The ID of the resource group. For more information about resource groups, see https://help.aliyun.com/document_detail/151181.html |
| ShowTags | string | no | Specifies whether to return instance tags. The default value is false |

### Queries the error logs of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-error-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If you specify a sharded cluster instance ID for this parameter, you must also specify the NodeId parameter |
| NodeId | string | no | The ID of a mongos node or shard node in the sharded cluster instance. This parameter is available only when the DBInstanceId parameter is… |
| RoleType | string | no | The role of the node in the instance. Valid values: primary: primary node. secondary: secondary node. search: search node. If the NodeId… |
| StartTime | string | yes | The start time of the query. Specify the time in the yyyy-MM-dd T HH:mm Z format. The time must be in UTC |
| EndTime | string | yes | The end time of the query. The end time must be later than the start time, and the interval between the end time and the start time cannot… |
| DBName | string | no | The name of the database |
| PageSize | integer | no | The number of entries per page. Valid values: 30 to 100 |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 |
| ResourceGroupId | string | no | The resource group ID. For more information about resource groups, see https://help.aliyun.com/document_detail/151181.html |
| QueryKeywords | string | no | The keywords to search for. Separate multiple keywords with spaces. You can specify a maximum of 10 keywords |
| LogicalOperator | string | no | The logical operator for keyword search. Default value: and |

### Queries the global IP whitelist templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-global-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the region ID |
| GlobalSecurityGroupId | string | no | The ID of the IP whitelist template |

### Queries the mapping between an instance and a global IP address whitelist template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-global-security-ipgroup-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/61933.html to query the available regions |
| DBClusterId | string | yes | The instance ID |

### Queries a list of tasks in the task center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-history-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the pending event. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent… |
| PageSize | integer | no | The number of entries per page. Valid values: 10 to 100. Default value: 10 |
| PageNumber | integer | no | The number of the page to return. The value must be a positive integer. Default value: 1 |
| InstanceType | string | no | The instance type of the instance. Set the value to Instance |
| Status | string | no | The task status. Valid values: Scheduled: The task is waiting to be executed. Running: The task is running. Succeed: The task is… |
| InstanceId | string | no | The instance ID. Separate multiple instance IDs with commas (,). You can specify up to 30 instance IDs. This parameter is empty by… |
| TaskId | string | no | The task ID. Separate multiple task IDs with commas (,). You can specify up to 30 task IDs. This parameter is empty by default, which… |
| TaskType | string | no | The task type. This parameter is left empty by default, which indicates that all types of tasks are queried. Valid values: CreateIns:… |
| FromStartTime | string | yes | The start time of the O\&M task to perform. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… |
| ToStartTime | string | yes | The end time of the O\&M task to perform. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… |
| FromExecTime | integer | no | The minimum execution duration of the task. This parameter is used to filter tasks whose execution duration is longer than the minimum… |
| ToExecTime | integer | no | The maximum execution duration of the task. This parameter is used to filter tasks whose execution duration is shorter than or equal to… |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the overview of a task in the task center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-history-tasks-stat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the pending event. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent… |
| Status | string | no | The task status. Valid values: Scheduled: The task is waiting to be executed. Running: The task is running. Succeed: The task is… |
| InstanceId | string | no | The instance ID. Separate multiple instance IDs with commas (,). You can specify up to 30 instance IDs. This parameter is empty by… |
| TaskId | string | no | The task ID. Separate multiple task IDs with commas (,). You can specify up to 30 task IDs. This parameter is empty by default, which… |
| TaskType | string | no | The task type. This parameter is left empty by default, which indicates that all types of tasks are queried. Valid values: CreateIns:… |
| FromStartTime | string | yes | The start time of the O\&M task to perform. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… |
| ToStartTime | string | yes | The end time of the O\&M task to perform. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… |
| FromExecTime | integer | no | The minimum execution duration of the task. This parameter is used to filter tasks whose execution duration is longer than the minimum… |
| ToExecTime | integer | no | The maximum execution duration of the task. This parameter is used to filter tasks whose execution duration is shorter than or equal to… |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the auto-renewal status of MongoDB instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-instance-auto-renewal-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the region ID of the… |
| DBInstanceId | string | no | The ID of the instance |
| DBInstanceType | string | no | The category of the instance. Valid values: replicate: the standalone or replica set instance sharding: the sharded cluster instance… |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30 |
| PageNumber | integer | no | The number of the page to return. The value must be a positive integer that does not exceed the maximum value of the Integer parameter.… |

### Queries the restorable time ranges of an ApsaraDB for MongoDB replica set instance with cloud disks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-instance-recover-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| DestRegion | string | no | The region where the geo-redundancy backup set is stored. This parameter is required when you query geo-redundancy backups |
| SrcRegion | string | no | The area where the source instance of the geo-redundancy backup resides. This parameter is required when you query geo-redundancy backups |
| ResourceGroupId | string | no | The resource group ID |
| OnlyDbTableRecovery | string | no | The OnlyDbTableRecovery |

### Queries the release notes of minor engine versions for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-kernel-release-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| KernelVersion | string | no | The minor engine version of the database. Example: mongodb_20180522_0.4.8. You can obtain the minor engine version in the Specifications… |

### Queries Key Management Service (KMS) keys that are available for disk encryption
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-kms-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent region list |

### You can view the configuration of MongoDB Log Service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-mongo-dblog-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. Call https://help.aliyun.com/document_detail/61939.html to query the instance ID |

### Queries the parameter modification records of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-parameter-modification-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter |
| NodeId | string | no | The ID of the mongos node or shard node whose parameter modification records you want to query in the instance. This parameter is valid… |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | yes | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.… |
| CharacterType | string | no | The role of the instance. Valid values: db: shard cs: Configserver mongos: mongos logic: sharded cluster instance |

### Queries the default parameter templates for MongoDB instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-parameter-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent region list |
| Engine | string | yes | The database engine. Set the value to mongodb |
| EngineVersion | string | yes | The database version number. Valid values: 7.0 6.0 5.0 4.4 4.2 4.0 3.4 |
| Role | string | no | The role of the instance. Valid values: db: the shard role of a sharded cluster instance. cs: the config server role of a sharded cluster… |

### Queries the parameter settings of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If you specify the ID of a sharded cluster instance for this parameter, you must also specify the NodeId parameter |
| NodeId | string | no | Instance ID of the mongos or shard node in the sharded cluster instance. This parameter is available only when the DBInstanceId parameter… |
| CharacterType | string | no | The role type of the instance. Valid values: db: shard role cs: config server role mongos: mongos role |
| ExtraParam | string | no | The extended parameter |

### Queries pricing information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the region ID |
| OrderType | string | yes | The order type. Valid values: BUY: Create an instance. UPGRADE: Upgrade instance configurations. RENEW: Renew an instance |
| DBInstances | string | yes | The JSON-formatted string that contains multiple pieces of information about instances. For metric descriptions and more JSON format… |
| CommodityCode | string | no | The commodity code. Valid values: dds: pay-as-you-go replica set instance badds: subscription replica set instance dds_sharding:… |
| ProductCode | string | no | The product code. Default value: dds |
| BusinessInfo | string | no | The additional parameter for business information |
| CouponNo | string | no | Specifies whether to use a coupon. Valid values: default or null (default): Use a coupon. youhuiquan_promotion_option_id_for_blank: Do not… |
| OrderParamOut | string | no | Specifies whether to return order parameters. Valid values: false (default): Do not return order parameters. true: Return order parameters |
| ResourceGroupId | string | no | The resource group ID. For more information about resource groups, see https://help.aliyun.com/document_detail/151181.html |

### Retrieves a list of vSwitches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-rds-vswitchs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| VpcId | string | no | The ID of VPC |
| ZoneId | string | no | The zone ID |
| ResourceGroupId | string | no | The resource group ID |

### Retrieves a list of VPCs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-rds-vpcs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ZoneId | string | no | The zone ID |
| ResourceGroupId | string | no | The resource group ID |

### Queries all regions and zones supported for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. If you do not specify this parameter, all supported regions are queried |
| AcceptLanguage | string | no | The language of the values of the returned RegionName and ZoneName parameters. Valid values: zh (default) en |

### Get the price to renew a specific MongoDB instance for one month
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-renewal-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BusinessInfo | string | no | Additional business information, provided as a JSON string |
| CouponNo | string | no | Specifies whether to use a coupon. Valid values: default or null (default): Use a coupon. youhuiquan_promotion_option_id_for_blank: Do not… |
| DBInstanceId | string | yes | The instance ID |

### Retrieves the role information and connection details for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-replica-set-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Queries the backup and restoration instances of a MongoDB instance within the last 7 days
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-restore-dbinstance-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| DBInstanceId | string | yes | The instance ID |
| CreationTimeAfter | string | yes | The start time used to query instances. Only instances created after this time are returned. Specify the time in the yyyy-MM-dd T HH:00:00… |

### Describes the status of a tag for a node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-role-tag-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Queries the roles and zones of each node in a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-role-zone-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Queries the running logs of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-running-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter |
| NodeId | string | no | Instance ID of the mongos or shard node in the sharded cluster instance. This parameter is available only if you set the DBInstanceId… |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the yyyy-MM-dd T HH:mm Z format (UTC) |
| EndTime | string | yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm Z format… |
| DBName | string | no | The name of the database |
| RoleType | string | no | The role of the node in the instance. Valid values: primary: primary node. secondary: secondary node. search: search node. If you set the… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 to 100 |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 |
| OrderType | string | no | The order in which the returned running logs are sorted by time. Valid values: asc: ascending order. desc: descending order |
| ResourceGroupId | string | no | The resource group ID |
| RoleId | string | no | The role ID of the node. You can call https://help.aliyun.com/document_detail/62134.html to query the role ID |
| QueryKeywords | string | no | The keywords for the query. Separate multiple keywords with spaces. You can specify up to 10 keywords |
| LogicalOperator | string | no | The logical operator for keyword-based search. Default value: and |

### Queries the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB for MongoDB…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-security-group-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance |

### Retrieves the IP whitelists of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-security-ips` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance |
| ShowHDMIps | string | no | Whether to display DAS whitelist information |

### Retrieves the connection information for a MongoDB sharded cluster instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-sharding-network-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| NodeId | string | no | The ID of a mongos, shard, or ConfigServer node in the sharded cluster instance. You can call the… |
| NetworkType | string | no | The network type. Valid values: VPC: virtual private cloud. Classic: classic network. Public: public network |

### Queries slow query log entries for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-slow-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the `NodeId` parameter |
| NodeId | string | no | The ID of the shard node. This parameter is required only when you specify the `DBInstanceId` parameter to the ID of a sharded cluster… |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | yes | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.… |
| DBName | string | no | The name of the database |
| QueryKeywords | string | no | The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces |
| LogicalOperator | string | no | The logical relationship among multiple keywords. or and (default value) |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30 to 100 |
| PageNumber | integer | no | The page number of the page to return. The value must be a positive integer that does not exceed the maximum value of the INTEGER data… |
| OrderType | string | no | The order of time in which the log entries to return are sorted. Valid values: asc: The log entries are sorted by time in ascending order.… |
| ResourceGroupId | string | no | The ID of the resource group to which the instances you want to query belong |

### Queries all tags in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent… |
| ResourceType | string | no | The resource type. Set the value to INSTANCE |
| ResourceGroupId | string | no | The ID of the resource group |
| NextToken | string | no | The token used to start the next query to retrieve more results. This parameter is not required in the first query. If not all results are… |

### Queries the custom key list of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-user-encryption-key-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| TargetRegionId | string | no | The target zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query available zones |
| RoleARN | string | no | The Alibaba Cloud Resource Name (ARN) of the specified role. Format: `acs:ram::$accountID:role/$roleName `. Default value:… |

### Retrieves a paginated list of VPCs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/describe-vpcs-for-mongo-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ZoneId | string | no | The zone ID |
| PageNumber | integer | no | The page number. Valid values: an integer greater than 0 and up to the maximum value of the Integer data type. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Valid values: an integer greater than 0 and up to the maximum value of the Integer data type. Default… |
| ResourceGroupId | string | no | The resource group ID |

### Destroys an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/destroy-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | no | The instance ID. InstanceId and DBInstanceId serve the same function. You need only to specify one of them |
| DBInstanceId | string | no | The instance ID. InstanceId and DBInstanceId serve the same function. You need only to specify one of them |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| ResourceGroupId | string | no | The ID of the resource group |

### Evaluates whether sufficient resources are available before you create an instance or change the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/evaluate-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/61933.html to query available regions |
| ZoneId | string | yes | The zone ID. You can call https://help.aliyun.com/document_detail/61933.html to query available zones |
| Engine | string | no | The database engine. Set the value to MongoDB |
| EngineVersion | string | yes | The database engine version |
| DBInstanceClass | string | no | The instance type. This parameter is required when you evaluate resources for a replica set instance. For more information about instance… |
| ShardsInfo | string | no | The shard information of the sharded cluster instance. This parameter is required when you evaluate resources for a sharded cluster… |
| DBInstanceId | string | no | The instance ID. This parameter is required when you evaluate resources for changing instance specifications |
| ReplicationFactor | string | no | The number of nodes in the instance. For a standalone instance, set the value to 1. For an instance with shared storage, set the value to… |
| ReadonlyReplicas | string | no | The number of read-only nodes in the instance. Valid values: 1 to 5. This parameter is not required for standalone instances or serverless… |
| Storage | string | no | The storage capacity of the replica set instance. Unit: GB. This parameter is required when the instance uses cloud disks. |

### Queries the relationship between ApsaraDB for MongoDB instances and tags
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the region ID of the… |
| ResourceType | string | yes | The resource type. Set the value to INSTANCE |
| NextToken | string | no | The token used to start the next query to retrieve more results. This parameter is not required in the first query. If not all results are… |
| ResourceId | string | no | The resource IDs. You must specify this parameter or the Tag parameter (JSON-encoded) |
| Tag | string | no | The tags that are attached to the resources (JSON-encoded) |

### Migrates the zone of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/migrate-available-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If the network type of the instance is VPC, you must also specify the Vswitch parameter |
| ZoneId | string | yes | The ID of the destination zone. The destination zone and the current zone of the instance are in the same region. You can call the… |
| Vswitch | string | no | The ID of the vSwitch in the destination zone. This parameter is required when the network type of the instance is VPC |
| EffectiveTime | string | no | The effective time for migrating the zone. The instance must be active. Valid values: Immediately: Takes effect immediately. MaintainTime:… |
| SecondaryZoneId | string | no | The ID of destination secondary zone 1 |
| HiddenZoneId | string | no | The ID of destination secondary zone 2 |

### Migrates a MongoDB instance to another zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/migrate-to-other-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | The instance ID. If the network type of the instance is VPC, you must also specify the VSwitchId parameter |
| ZoneId | string | yes | The ID of the destination zone. The destination zone must be in the same region as the current zone of the instance. You can call the… |
| EffectiveTime | string | no | The effective period for the zone migration. Valid values: Immediately (default): The migration becomes active immediately. MaintainTime:… |
| VSwitchId | string | no | The ID of the vSwitch in the destination zone. This parameter is available and required only when the network type of the instance is VPC |

### Modifies the description of the root account in a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-account-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| AccountName | string | yes | The name of the account whose description you want to modify |
| DBName | string | no | The database to which the account belongs |
| AccountDescription | string | yes | Sets the description of the account. The description cannot start with http:// or https://. The description must start with a Chinese or… |
| CharacterType | string | no | The type of the account whose description you want to modify. Valid values: db: shard account cs: config server account normal: default… |

### Modifies the O&M task configuration of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-active-operation-maintenance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| CycleType | string | no | The cycle type. Valid values: Month: Monthly. Week: Weekly |
| CycleTime | string | no | The list of days in the O&M cycle, separated by commas (,). If CycleType is set to Month, each item is an integer from 1 to 28, which… |
| MaintainStartTime | string | no | The start time of the instance O&M window. The time is in the HH:mmZ format and in UTC |
| MaintainEndTime | string | no | The end time of the instance O&M window. The time is in the HH:mmZ format and in UTC |
| Status | integer | no | Specifies whether the configuration takes effect. Valid values: 1: Effective. 2: Invalid |

### Modifies the switchover time of scheduled O&M tasks for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Ids | string | yes | The IDs of the O&M tasks. Separate multiple IDs with commas (,). You can call the DescribeActiveOperationTasks operation to retrieve the… |
| SwitchTime | string | yes | The scheduled switchover time to be set. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The time cannot be… |
| ImmediateStart | integer | no | Specifies whether to immediately enter the execution scheduling phase. Valid values: 0: No. This is the default value. 1: Yes. If this… |
| ResourceGroupId | string | no | The ID of the resource group |

### Modifies the advanced backup policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-advanced-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| PreferredBackupTime | string | no | The time period during which the backup is performed. The format is HH:mm Z- HH:mm Z (UTC). The time range is limited to 1 hour |
| SnapshotBackupType | string | no | The snapshot backup type. Valid values: Flash: backup within seconds. Standard: standard backup. This is the default value |
| BackupRetentionPolicyOnClusterDeletion | integer | yes | The backup retention policy. Valid values: 0: All backup sets of the instance are deleted immediately when the instance is released. 1:… |
| AdvancedBackupDataPolicies | string | no | The list of backup policies (JSON-encoded) |
| AdvancedBackupLogPolicies | string | no | The list of log backup policies (JSON-encoded) |

### Enables advanced backup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-advanced-backup-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Modifies the collection types of audit logs for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-audit-log-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| Filter | string | yes | The collection types of audit logs. Separate multiple collection types with commas (,). admin: O&M and management operations. slow: Slow… |
| RoleType | string | no | The role of the node in the instance. Valid values: db: shard node mongos: mongos node Metric description This parameter applies only to… |

### Settings the audit log switch or log storage duration for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-audit-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| AuditStatus | string | yes | The status of audit logging. Valid values: enable: Enables audit logging. disabled: Disables audit logging |
| StoragePeriod | integer | no | In the Standard edition, this parameter specifies the retention period of audit logs. Valid values: 1 to 365. Default value: 30. Unit:… |
| AuditLogSwitchSource | string | no | The source of the audit log request. Valid value: Console |
| ServiceType | string | no | The edition of audit logging. Valid values: Trial: Free Trial edition. Standard: Standard edition. V2_Standard: DAS Enterprise Edition… |
| HotStoragePeriod | integer | no | This parameter takes effect only in the V2_Standard edition (DAS Enterprise Edition NoSQL-compatible audit logs) and specifies the hot… |

### Modifies the time-to-live (TTL) of a MongoDB backup set
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-backup-expire-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| BackupExpireTime | string | no | The time-to-live (TTL) of the backup. The time must be in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.… |
| BackupId | string | yes | The backup ID |

### Modifies the backup policy of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| PreferredBackupTime | string | no | The time period during which backups are performed. The format is HH:mm Z- HH:mm Z (UTC). The time period is limited to 1 hour |
| PreferredBackupPeriod | string | no | The backup cycle. Valid values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday:… |
| BackupRetentionPeriod | integer | no | The number of days for which full backups are retained. For users who created instances before September 10, 2021, the default retention… |
| EnableBackupLog | integer | no | Specifies whether to enable log backup. Valid values: 0: Disables log backup. This is the default value. 1: Enables log backup. Sharded… |
| LogBackupRetentionPeriod | integer | no | The number of days for which log backups are retained. Default value: 7. Valid values: 7 to 730 |
| SnapshotBackupType | string | no | The snapshot backup type. Valid values: Flash: Backup within seconds. Standard: Standard backup. This is the default value |
| BackupInterval | string | no | The high-frequency backup frequency. Valid values: -1: Disables high-frequency backups. 30: Every 30 minutes. 60: Every 1 hour. 120: Every… |
| HighFrequencyBackupRetention | integer | no | The number of days for which high-frequency backups are retained. Before you use this parameter, make sure that the BackupInterval… |
| BackupRetentionPolicyOnClusterDeletion | integer | no | The backup data retention policy. Valid values: 0: Deletes all backup sets of the instance immediately when the instance is released. 1:… |
| CrossBackupType | string | no | The operation policy for cross-region backup. Valid values: update: Modifies the cross-region backup policy. delete: Deletes the… |
| SrcRegion | string | no | The region where the instance is deployed. This parameter is required to recover deleted instances. This parameter is required for… |
| DestRegion | string | no | The region where backups are stored. This parameter is required for cross-region backup |
| CrossRetentionType | string | no | The retention type for cross-region backup. Valid values: delay: Retains backups for a specified period. never: Never expires. This… |
| CrossRetentionValue | integer | no | The retention period for cross-region backup. Valid values: 3 to 1825 days. This parameter is required for cross-region backup. This… |
| CrossBackupPeriod | string | no | The days of the week when cross-region backup is performed. Valid values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday.… |
| EnableCrossLogBackup | integer | no | Specifies whether to enable cross-region log backup. This parameter is required for cross-region backup. 1: Enables cross-region log… |
| CrossLogRetentionType | string | no | The retention type for cross-region log backup. Valid values: delay: Retains backups for a specified period. never: Never expires. This… |
| CrossLogRetentionValue | integer | no | The retention period for cross-region log backup. Valid values: 3 to 1825 days. The value must be less than or equal to the value of… |
| InstanceType | string | no | The instance type. Valid values: replicate sharding This parameter is required when the backup recovery type is set to rebuilding a… |
| PreserveOneEachHour | string | no | Specifies whether to enable hourly sparse backup. Valid values: true: If the backup frequency is set to minutes, all snapshots taken… |

### Modifies instance release protection configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| DBInstanceReleaseProtection | string | no | Specifies whether to enable instance release protection. Valid values: true: enabled. false: disabled |

### Modifies instance configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| ConfigName | string | yes | The configuration item name |
| ConfigValue | string | yes | The configuration item value |

### Modifies the endpoint and port of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-connection-string` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. If you specify the ID of a sharded cluster instance for this parameter, you must also specify the NodeId parameter |
| NodeId | string | no | Instance ID of the Mongos node in the sharded cluster instance. You can specify only one Mongos node ID in each call. This parameter is… |
| CurrentConnectionString | string | no | The current endpoint, which is the endpoint to be modified |
| NewConnectionString | string | no | The new endpoint. The endpoint must meet the following requirements: It must start with a lowercase letter. It must end with a lowercase… |
| NewPort | integer | no | The new port number. Valid values: 1000 to 65535. This parameter is active only when the DBInstanceId parameter is set to a cloud disk… |
| PortModifyOnly | string | no | Specifies whether to modify only port numbers. If you modify only port numbers, batch modification is supported |
| NetworkType | string | no | The network type of the connection string when only port numbers are modified |
| ForceModifySuffix | string | no | The ForceModifySuffix |

### Modifies the name of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. To modify the name of a shard or mongos node in a sharded cluster instance, you must also specify the NodeId parameter |
| NodeId | string | no | The ID of the shard or mongos node in the sharded cluster instance. This parameter is valid only if you set the DBInstanceId parameter to… |
| DBInstanceDescription | string | yes | The name of the instance. The name cannot start with `http://` or `https://`. It must start with a letter. It must be 2 to 256 characters… |

### Modifies the disk type of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-disk-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DbInstanceStorageType | string | no | The disk type after the modification. Valid value: cloud_auto: ESSD AutoPL disk |
| ProvisionedIops | integer | no | The provisioned IOPS. Valid values: 0 to 50000 |
| DBInstanceId | string | yes | The instance ID |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: Enables automatic payment. Make sure that your account has a sufficient… |
| BusinessInfo | string | no | The business information. This is an additional parameter |
| CouponNo | string | no | The coupon code. The default value is `youhuiquan_promotion_option_id_for_blank` |
| ExtraParam | string | no | An additional parameter |
| AutoRenew | string | no | Specifies whether to enable auto-renewal for the instance. Valid values: true: Enables auto-renewal. false: Disables auto-renewal. Default… |
| OrderType | string | no | The order type. Valid values: UPGRADE: Upgrades the instance configuration. DOWNGRADE: Downgrades the instance configuration. This… |

### Modifies the maintenance window of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-maintain-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| MaintainStartTime | string | yes | The start time of the maintenance window. Specify the time in the ISO 8601 standard in the HH:mmZ format. The time must be in UTC |
| MaintainEndTime | string | yes | The end time of the maintenance window. Specify the time in the ISO 8601 standard in the HH:mmZ format. The time must be in UTC. The end… |

### Set the monitoring collection granularity for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance |
| Granularity | string | yes | The collection frequency of monitoring data. Valid values: 1 or 300. Unit: seconds |

### Extends the classic network retention period for a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-net-expire-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| ConnectionString | string | no | The endpoint of the instance |
| ClassicExpendExpiredDays | integer | yes | Sets the retention period of the original classic network endpoint. Valid values: 14, 30, 60, and 120. Unit: days |

### Switches the network type of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-network-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| NetworkType | string | yes | The target network type to which you want to switch the instance. Valid values: VPC: switches the network type to VPC |
| VpcId | string | no | The VPC ID. This parameter is required when the NetworkType parameter settings is set to VPC |
| VSwitchId | string | no | The vSwitch ID in the VPC. This parameter is required when the NetworkType parameter settings is set to VPC |
| RetainClassic | string | no | Specifies whether to retain the original classic network address when you switch the network type to VPC. Settings. Valid values: True:… |
| ClassicExpiredDays | integer | no | The retention period of the original classic network address when you switch the network type to VPC. Settings. Valid values: 14, 30, 60,… |
| ZoneId | string | yes | The zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the zone ID |

### Modifies the SSL configuration of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| SSLAction | string | yes | The operation to perform on the SSL feature. Valid values: Open: Enables Secure Sockets Layer (SSL) encryption. Close: Disables Secure… |
| SwitchMode | string | no | The time when the SSL configuration of the MongoDB instance is modified. Valid values: 0: Modifies the configuration immediately. 1:… |
| ForceEncryption | string | no | Specifies whether to force Secure Sockets Layer (SSL) encryption for connections. Valid values: 1: Forces Secure Sockets Layer (SSL)… |

### Modifies the specifications or storage space of ApsaraDB for MongoDB standalone instances, replica set…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-spec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| DBInstanceClass | string | no | The instance type. For more information, see https://help.aliyun.com/document_detail/57141.html. You can also call the… |
| DBInstanceStorage | string | no | Instance storage space of the instance. Valid values: 10 to 3000. Unit: GB. The step size is 10 GB. The valid values are subject to the… |
| OrderType | string | no | The type of configuration change. Valid values: UPGRADE: upgrades the configurations. This is the default value. DOWNGRADE: downgrades the… |
| AutoPay | string | no | Specifies whether to enable automatic payment for the instance. Valid values: true: enables automatic payment. This is the default value.… |
| BusinessInfo | string | no | The business information |
| ReplicationFactor | string | no | The number of nodes in the instance. Default value: 3. For a replica set instance, valid values are 3, 5, and 7. For a standalone… |
| ReadonlyReplicas | string | no | The number of read-only nodes. Valid values: 0 to 5. If the instance is connected only over the classic network and a VPC, you must enable… |
| CouponNo | string | no | Specifies whether to use a coupon. Valid values: default or null: uses a coupon. This is the default value.… |
| EffectiveTime | string | no | The time when the configuration change takes effect. Valid values: Immediately: takes effect immediately. This is the default value.… |
| ExtraParam | string | no | The additional parameter. Valid values: async: returns the result after the configuration change order is created. sync: returns the… |
| TargetZoneId | string | no | The destination zone for instance migration when you migrate the instance across zones and change its configurations at the same time.… |
| TargetSecondaryZoneId | string | no | The destination zone for the secondary node when you cloud disk instance across zones and change its configurations at the same time. This… |
| TargetHiddenZoneId | string | no | The destination zone for the hidden node when you cloud disk instance across zones and change its configurations at the same time. This… |
| AlignPrimaryZone | string | no | Specifies whether to automatically align the primary node to the primary zone for a multi-zone instance after operations such as… |
| TargetVswitchId | string | no | The ID of the destination vSwitch when you cloud disk instance across zones and change its configurations at the same time. This parameter… |
| SearchNodeClass | string | no | The specifications of the search node for the configuration change |
| SearchNodeStorage | integer | no | The storage capacity of the search node for the configuration change |
| SearchNodeCount | integer | no | The number of search nodes for the configuration change |

### Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-dbinstance-tde` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| TDEStatus | string | yes | The TDE status. Valid values: enabled, which indicates that TDE is enabled. You cannot disable TDE after it is enabled. Proceed with caution |
| EncryptorName | string | no | The encryption method. Valid values: aes-256-cbc. This parameter is available only when the TDEStatus parameter is set to enabled |
| EncryptionKey | string | no | The ID of the custom key. Custom keys are supported only in the following regions. In other regions, the default key is used for… |
| RoleARN | string | no | The ARN of the specified role. Format: `acs:ram::$accountID:role/$roleName`. `$accountID`: the ID of the Alibaba Cloud account. You can… |
| SwitchMode | string | no | The time to modify the Transparent Data Encryption (TDE) status of the MongoDB instance. Valid values: 0: immediately. 1: within the O&M… |

### Modifies the global IP whitelist template associated with an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-global-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent… |
| GlobalIgName | string | yes | The name of the IP whitelist template |
| GlobalSecurityGroupId | string | yes | The ID of the IP whitelist template |
| GIpList | string | yes | The IP addresses in the whitelist template. Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or… |

### Modifies the name of a global IP whitelist template associated with an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-global-security-ipgroup-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent… |
| GlobalIgName | string | yes | The name of the IP whitelist template. The name must meet the following requirements: It can contain lowercase letters, digits, and… |
| GlobalSecurityGroupId | string | yes | The ID of the IP whitelist template |

### Modifies the mapping between a global whitelist template and an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-global-security-ipgroup-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent… |
| DBClusterId | string | yes | The instance ID |
| GlobalSecurityGroupId | string | yes | The ID of the IP whitelist template |

### Enables or disables auto-renewal for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-instance-auto-renewal-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the region ID of the… |
| DBInstanceId | string | yes | The ID of the instance |
| Duration | string | no | The auto-renewal period. Valid values: 1 to 12. Unit: month. This parameter is valid only when AutoRenew is set to true |
| AutoRenew | string | yes | Specifies whether to enable auto-renewal. Valid values: true false If this parameter is set to true, you must set the Duration parameter |

### Disables password-free access over Virtual Private Cloud (VPC) for an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-instance-vpc-auth-mode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| NodeId | string | no | The ID of the mongos node in the sharded cluster instance. This parameter can be used only when the instance type is sharded cluster |
| VpcAuthMode | string | no | Specify whether to disable password-free access over VPC. Set the value to Close |

### Modifies the specifications and storage space of nodes in a MongoDB sharded cluster instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-node-spec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| NodeId | string | yes | The ID of the shard or mongos node in the sharded cluster instance. You can call the https://help.aliyun.com/document_detail/62010.html… |
| NodeClass | string | no | The specifications of the shard or mongos node. For more information, see https://help.aliyun.com/document_detail/57141.html |
| NodeStorage | integer | no | The storage space of the shard node. The step size is 10 GB. For local SSDs, valid values: 10 to 2000. For PL1 ESSDs, valid values: 20 to… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| FromApp | string | no | The source of the request. Valid values: OpenApi: The request is sent from OpenAPI. mongo_buy: The request is sent from the console |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true (default): Automatic payment is enabled. Make sure that your account has… |
| EffectiveTime | string | no | The effective period of the configuration change. Valid values: Immediately (default): The configuration change takes effect immediately.… |
| SwitchTime | string | no | The time when the configuration change is executed. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format. The time must be in UTC.… |
| OrderType | string | no | The order type. Valid values: UPGRADE: Upgrade. DOWNGRADE: Downgrade |
| ReadonlyReplicas | integer | no | The number of read-only nodes in the shard node. Valid values: 0 to 5. The value must be an integer |
| BusinessInfo | string | no | The additional parameter that contains business information |
| CouponNo | string | no | Specifies whether to use a coupon. Valid values: default or null (default): Use a coupon. youhuiquan_promotion_option_id_for_blank: Do not… |
| TargetZoneId | string | no | The destination primary zone for zone migration. This parameter is supported only for cloud disk instances. |
| TargetSecondaryZoneId | string | no | The destination secondary zone for zone migration. This parameter is supported only for cloud disk instances. |
| TargetHiddenZoneId | string | no | The destination hidden zone for zone migration. This parameter is supported only for cloud disk instances. |
| AlignPrimaryZone | string | no | Specifies whether to automatically align the primary node to the primary zone after operations such as specification changes for… |
| TargetVswitchId | string | no | The ID of the destination vSwitch for zone migration. This parameter is supported only for cloud disk instances. |

### Modifies the configurations of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-node-spec-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query available regions |
| DBInstanceId | string | yes | The instance ID of the instance whose configurations you want to modify |
| NodesInfo | string | yes | The specifications of the Mongos or shard nodes to be modified. For more information, see https://help.aliyun.com/document_detail/57141.html |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. Make sure that your account has sufficient… |
| EffectiveTime | string | no | The effective period of the configuration change. Valid values: Immediately: The configuration change takes effect immediately.… |
| OrderType | string | no | The type of the configuration change. Valid values: UPGRADE: upgrades the configurations. DOWNGRADE: downgrades the configurations. This… |
| CouponNo | string | no | Specifies whether to use a coupon. Valid values: default or null: uses a coupon. This is the default value.… |
| BusinessInfo | string | no | The business information |
| TargetVswitchId | string | no | The ID of the destination vSwitch when you migrate the instance across zones and change its configurations at the same time. This… |
| TargetHiddenZoneId | string | no | The destination zone of the hidden node when you migrate the instance across zones and change its configurations at the same time. This… |
| AlignPrimaryZone | string | no | Specifies whether to automatically align the primary node to the primary zone after operations such as configuration changes for a… |
| TargetZoneId | string | no | The destination zone of the primary node when you migrate the instance across zones and change its configurations at the same time. This… |
| TargetSecondaryZoneId | string | no | The destination zone of the secondary node when you migrate the instance across zones and change its configurations at the same time. This… |

### Modifies the parameters of an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the instance. To query the latest region list, call the https://help.aliyun.com/document_detail/61933.html operation |
| DBInstanceId | string | yes | The instance ID. If this parameter is a sharded cluster instance ID, you must also specify the NodeId parameter |
| NodeId | string | no | The ID of the mongos or shard node in the sharded cluster instance. This parameter is active only when the DBInstanceId parameter is set… |
| Parameters | string | yes | The parameters and their new values. The value must be a JSON string. Example:… |
| CharacterType | string | no | The type of the node. Valid values: db: shard node. cs: Configserver node. mongos: mongos node |
| SwitchMode | string | no | The time to apply the parameter modifications. Valid values: 0: Immediately. 1: During the maintenance window |

### Moves an ApsaraDB for MongoDB instance to a specified resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the region ID |
| DBInstanceId | string | yes | The ID of the instance |
| ResourceGroupId | string | yes | The ID of the resource group. For more information, see https://help.aliyun.com/document_detail/151181.html |

### Modifies the ECS security group bound to an ApsaraDB for MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-security-group-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance |
| SecurityGroupId | string | yes | The ID of the ECS security group. You can bind up to 10 ECS security groups to an ApsaraDB for MongoDB instance. You can call the… |

### Modifies the IP whitelist of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-security-ips` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| SecurityIps | string | yes | The list of IP addresses in the IP whitelist group. Separate multiple IP addresses with commas (,). IP addresses cannot be duplicated. A… |
| ModifyMode | string | no | The modification method. Valid values: Cover: Overwrites the original whitelist. Append: Appends to the whitelist. An error is returned if… |
| SecurityIpGroupName | string | no | The name of the IP whitelist group to modify. Default value: default |
| SecurityIpGroupAttribute | string | no | The attribute of the whitelist group. The value can contain uppercase letters, lowercase letters, and digits. The maximum length is 120… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run without calling the operation. The system checks the… |

### Modifies the SRV connection address of a MongoDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/modify-srv-network-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| NewConnectionString | string | yes | The new connection address. The address must meet the following requirements: Starts with a lowercase letter. Ends with a lowercase letter… |
| ConnectionType | string | yes | The type of the SRV connection address to modify. Valid values: VPC: virtual private cloud (VPC) Public: Internet connection |

…and 16 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-dds/allocate-dbinstance-srv-network-address" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraDB for MongoDB API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-dds/allocate-dbinstance-srv-network-address with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud ApsaraDB for MongoDB API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dds.

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