{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dds/allocate-dbinstance-srv-network-address":{"post":{"operationId":"cloud_aliyun_dds_allocate_dbinstance_srv_network_address","summary":"Applies for an SRV address for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"NodeId":{"type":"string","description":"The ID of the Mongos or shard node in a sharded cluster instance. You do not need to specify this parameter"},"SrvConnectionType":{"type":"string","enum":["vpc","public"],"description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/allocate-node-private-network-address":{"post":{"operationId":"cloud_aliyun_dds_allocate_node_private_network_address","summary":"Applies for an internal network endpoint for a shard or ConfigServer node of an ApsaraDB for MongoDB…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","NodeId"],"properties":{"ZoneId":{"type":"string","description":"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":{"type":"string","description":"The instance ID of the sharded cluster"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"The username. The username must start with a lowercase letter and be 4 to 16 characters in length. It can contain lowercase letters,…"},"AccountPassword":{"type":"string","description":"The password. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/allocate-public-network-address":{"post":{"operationId":"cloud_aliyun_dds_allocate_public_network_address","summary":"Allocates a public endpoint","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"Instance ID of the Mongos, shard, or ConfigServer node in the sharded cluster instance. You can call the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/cancel-active-operation-tasks":{"post":{"operationId":"cloud_aliyun_dds_cancel_active_operation_tasks","summary":"Cancels multiple O&M events in batches","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Ids"],"properties":{"Ids":{"type":"string","description":"The IDs of the O&M events to be canceled in batches. Separate multiple IDs with commas (,)"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/check-cloud-resource-authorized":{"post":{"operationId":"cloud_aliyun_dds_check_cloud_resource_authorized","summary":"Queries whether a Key Management Service (KMS) key is authorized for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","TargetRegionId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"TargetRegionId":{"type":"string","description":"The region ID of the instance. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the region ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/check-recovery-condition":{"post":{"operationId":"cloud_aliyun_dds_check_recovery_condition","summary":"Checks whether a MongoDB instance meets the conditions for data restoration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SourceDBInstance"],"properties":{"SourceDBInstance":{"type":"string","description":"The instance ID of the source instance to recover"},"DatabaseNames":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The ID of the resource group"},"SrcRegion":{"type":"string","description":"The area where the source instance resides. This parameter is required when the backup recover type is rebuilding a deleted instance. This…"},"DestRegion":{"type":"string","description":"The area where the backup set resides during geo-redundancy recover. This parameter is required when the backup recover type is…"},"RestoreType":{"type":"string","description":"The backup recover type. Valid values: 0: local backup recover 1: local point-in-time recover 2: backup recover of a deleted instance…"},"InstanceType":{"type":"string","description":"The instance type. Valid values: replicate sharding This parameter is required when the backup recover type is rebuilding a deleted…"},"EngineVersion":{"type":"string","description":"The database version. Valid values: 8.0 7.0 6.0 5.0 4.4 4.2 4.0"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/check-service-linked-role":{"post":{"operationId":"cloud_aliyun_dds_check_service_linked_role","summary":"Queries whether a service-linked role (SLR) has been created","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/create-account":{"post":{"operationId":"cloud_aliyun_dds_create_account","summary":"Creates a read-only shard account for an ApsaraDB for MongoDB sharded cluster instance with cloud disks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","AccountName","AccountPassword"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"AccountName":{"type":"string","description":"The account name. The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must…"},"AccountPassword":{"type":"string","description":"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":{"type":"string","enum":["db","cs","normal"],"description":"The type of the account to be created. Valid values: db: shard account. This is the default value. cs: Configserver account. normal:…"},"Roles":{"type":"string","description":"The list of authorized roles for the account (JSON-encoded)"},"DBName":{"type":"string","description":"The database to which the account belongs. This is the database where the account is created or on which the account operates. Default…"},"AccountDescription":{"type":"string","description":"The description of the account"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/create-backup":{"post":{"operationId":"cloud_aliyun_dds_create_backup","summary":"Creates a backup for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"BackupMethod":{"type":"string","description":"The backup method of the instance. Valid values: Snapshot: snapshot backup Logical: logical backup Physical: physical backup (default)…"},"BackupRetentionPeriod":{"type":"integer","description":"The retention period of the backup. This parameter is applicable only to replica set and sharded cluster instances with cloud disks. If…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/create-dbinstance":{"post":{"operationId":"cloud_aliyun_dds_create_dbinstance","summary":"Creates or clones an ApsaraDB for MongoDB replica set instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","EngineVersion","DBInstanceClass","DBInstanceStorage"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the zone ID"},"EngineVersion":{"type":"string","enum":["4.0","4.2","4.4","5.0","6.0","7.0","3.4","8.0","8.3"],"description":"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":{"type":"string","description":"The instance type. You can call the https://help.aliyun.com/document_detail/149719.html operation to query the available instance types"},"DBInstanceStorage":{"type":"integer","description":"The instance storage capacity. Unit: GB. The valid values depend on the instance type. For details, see…"},"DBInstanceDescription":{"type":"string","description":"The instance name. The name must meet the following requirements: Must start with a Chinese character or a letter. Can contain digits,…"},"SecurityIPList":{"type":"string","description":"The IP whitelist of the instance. Separate multiple IP addresses with commas (,). Duplicate IP addresses are not allowed. The following…"},"AccountPassword":{"type":"string","description":"The password of the root account. The password must meet the following requirements: Must contain at least three of the following…"},"Period":{"type":"integer","description":"The subscription duration of the instance. Unit: months. Valid values: 1 to 9 (integers), 12, 24, 36, and 60. This parameter is available…"},"ChargeType":{"type":"string","enum":["PrePaid","PostPaid"],"description":"The billing method of the instance. Valid values: PostPaid: default value. Pay-as-you-go. PrePaid: Subscription. If you set this parameter…"},"NetworkType":{"type":"string","enum":["VPC"],"description":"The network type of the instance. Valid values: VPC: Virtual Private Cloud"},"VpcId":{"type":"string","description":"The VPC ID"},"VSwitchId":{"type":"string","description":"The vSwitch ID"},"SrcDBInstanceId":{"type":"string","description":"The source instance ID. If you call this operation to clone clone instance, you must configure this parameter along with the BackupId or…"},"BackupId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The additional information about the business"},"AutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal for the instance. Valid values: true: enables auto-renewal. false: default value. Disables…"},"DatabaseNames":{"type":"string","description":"The name of the database. When you invoke this operation to clone a clone instance, you can specify this parameter to clone specific…"},"CouponNo":{"type":"string","description":"Specifies whether to use a coupon. Valid values: default or null (default): uses a coupon. youhuiquan_promotion_option_id_for_blank: does…"},"StorageEngine":{"type":"string","enum":["WiredTiger"],"description":"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":{"type":"string","description":"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":{"type":"string","description":"The number of read-only nodes in the replica set instance. Valid values: 0 to 5 (integers). Default value: 0"},"ResourceGroupId":{"type":"string","description":"The ResourceGroupId"},"ClusterId":{"type":"string","description":"The ClusterId"},"Engine":{"type":"string","enum":["MongoDB"],"description":"The database engine. The value is fixed as MongoDB"},"StorageType":{"type":"string","description":"The storage type. Valid values: cloud_essd1: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. cloud_auto: ESSD AutoPL disk.…"},"SecondaryZoneId":{"type":"string","description":"The zone where the secondary node is deployed to implement multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G.…"},"HiddenZoneId":{"type":"string","description":"The zone where the hidden node is deployed to implement multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G.…"},"Tag":{"type":"string","description":"The user-defined tags (JSON-encoded)"},"GlobalSecurityGroupIds":{"type":"string","description":"The global IP whitelist templates for the instance. Separate multiple templates with commas (,). Duplicate templates are not allowed.…"},"Encrypted":{"type":"string","description":"Specifies whether to enable cloud disk encryption"},"EncryptionKey":{"type":"string","description":"The custom key ID"},"ProvisionedIops":{"type":"integer","description":"The provisioned performance (IOPS). Valid values: 0 to 50000"},"RestoreType":{"type":"string","enum":["0","1","2","3","4"],"description":"The backup restoration type. Valid values: 0: recovers the instance to a specified backup set. 1: recovers the instance to a specified…"},"SrcRegion":{"type":"string","description":"The region where the source instance resides. This parameter is required when the restoration type is 2 or 3"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/create-global-security-ipgroup":{"post":{"operationId":"cloud_aliyun_dds_create_global_security_ipgroup","summary":"Creates a global IP whitelist template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","GlobalIgName","GIpList"],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call https://help.aliyun.com/document_detail/61933.html to query regions"},"GlobalIgName":{"type":"string","description":"The name of the IP whitelist template. The name must meet the following requirements: It can contain only lowercase letters, digits, and…"},"GIpList":{"type":"string","description":"The IP addresses in the whitelist template. Separate multiple IP addresses with commas (,). A maximum of 1,000 IP addresses or CIDR blocks…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/create-node":{"post":{"operationId":"cloud_aliyun_dds_create_node","summary":"Adds a shard node or a mongos node to an ApsaraDB for MongoDB sharded cluster instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","NodeClass","NodeType"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID of the sharded cluster instance"},"NodeClass":{"type":"string","description":"The instance type of the shard node or mongos node. For more information about instance types, see…"},"NodeStorage":{"type":"integer","description":"The disk space of the node. Unit: GB. The valid values vary based on the storage type. For more information, see…"},"NodeType":{"type":"string","enum":["mongos","shard"],"description":"The node type. Valid values: shard: shard node. mongos: mongos node"},"ClientToken":{"type":"string","description":"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":{"type":"string","description":"Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. This is the default value. Make sure that…"},"ReadonlyReplicas":{"type":"integer","description":"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":{"type":"string","description":"The additional parameter for business information"},"CouponNo":{"type":"string","description":"Specifies whether to use a coupon. Valid values: default or null: uses a coupon. This is the default value.…"},"ShardDirect":{"type":"string","description":"Specifies whether to apply for a direct connection endpoint for the shard node. Valid values: true: applies for a direct connection…"},"AccountName":{"type":"string","description":"The username. Valid values: The username must start with a lowercase letter. The username can contain lowercase letters, digits, and…"},"AccountPassword":{"type":"string","description":"The password of the account. Valid values: The password must contain at least three of the following character types: uppercase letters,…"},"SearchDBInstanceClass":{"type":"string","description":"The instance type of the search node to be added"},"SearchStorage":{"type":"integer","description":"The storage capacity of the search node to be added"},"SearchNodeCount":{"type":"integer","description":"The number of search nodes to be added"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/create-node-batch":{"post":{"operationId":"cloud_aliyun_dds_create_node_batch","summary":"Adds multiple Mongos or shard nodes to an ApsaraDB for MongoDB sharded cluster instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","NodesInfo"],"properties":{"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of…"},"FromApp":{"type":"string","description":"The source of the request. Valid values: OpenApi: OpenAPI. mongo_buy: The console"},"AutoPay":{"type":"string","description":"Specifies whether to enable automatic payment. Valid values: true: (Default) Automatic payment is enabled. Make sure that your account has…"},"DBInstanceId":{"type":"string","description":"The instance ID"},"NodesInfo":{"type":"string","description":"The specifications of the Mongos or shard nodes to be added. For more information about the specifications, see…"},"CouponNo":{"type":"string","description":"Specifies whether to use a coupon. Valid values: default or null: (Default) A coupon is used. youhuiquan_promotion_option_id_for_blank: No…"},"BusinessInfo":{"type":"string","description":"The business information"},"ShardDirect":{"type":"string","description":"Specifies whether to apply for a direct connection endpoint for the shard node. Valid values: true: Applies for a direct connection…"},"AccountName":{"type":"string","description":"The name of the account. Valid values: The name must start with a lowercase letter. The name can contain lowercase letters, digits, and…"},"AccountPassword":{"type":"string","description":"The password of the account. Valid values: The password must contain at least three of the following character types: uppercase letters,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/create-node-role-tag":{"post":{"operationId":"cloud_aliyun_dds_create_node_role_tag","summary":"Creates a role tag for an instance node","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"ShardList":{"type":"string","description":"The shard node ID. This parameter is available only when you create a role tag for a shard node of a sharded cluster instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/create-sharding-dbinstance":{"post":{"operationId":"cloud_aliyun_dds_create_sharding_dbinstance","summary":"Creates or clones an ApsaraDB for MongoDB sharded cluster instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","Engine","EngineVersion","Mongos","ReplicaSet","ConfigServer"],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the region ID"},"ZoneId":{"type":"string","description":"The zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the zone ID"},"Engine":{"type":"string","enum":["MongoDB"],"description":"The database engine. Set the value to MongoDB"},"EngineVersion":{"type":"string","enum":["3.0","3.2","3.4","4.0","4.2","4.4","5.0","6.0","7.0","8.0","8.3"],"description":"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":{"type":"string","description":"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":{"type":"string","description":"The IP address whitelist of the instance. Separate multiple IP addresses with commas (,). Duplicate IP addresses are not supported. The…"},"AccountPassword":{"type":"string","description":"The password of the root account. The password must meet the following requirements: It must contain at least three of the following…"},"ChargeType":{"type":"string","enum":["PrePaid","PostPaid"],"description":"The billing method of the instance. Valid values: PostPaid: Pay-as-you-go. This is the default value. PrePaid: Subscription. If you set…"},"Period":{"type":"integer","description":"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":{"type":"string","enum":["VPC","Classic"],"description":"The network type of the instance. Valid values: VPC: VPC"},"VpcId":{"type":"string","description":"The VPC ID"},"VSwitchId":{"type":"string","description":"The vSwitch ID"},"SrcDBInstanceId":{"type":"string","description":"The source instance ID. This parameter is required only when you call this operation to clone an instance. You must also specify the…"},"RestoreTime":{"type":"string","description":"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":{"type":"string","description":"The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to…"},"StorageEngine":{"type":"string","enum":["WiredTiger","RocksDB"],"description":"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":{"type":"string","description":"Specifies whether to enable auto-renewal for the instance. Valid values: true: Enables auto-renewal. false: Disables auto-renewal. You…"},"ProtocolType":{"type":"string","enum":["mongodb","dynamodb"],"description":"The type of the access protocol. Valid values: mongodb: MongoDB protocol. dynamodb: DynamoDB protocol"},"Mongos":{"type":"string","description":"The information about the mongos nodes (JSON-encoded)"},"ReplicaSet":{"type":"string","description":"The information about the shard nodes (JSON-encoded)"},"ConfigServer":{"type":"string","description":"The information about the ConfigServer nodes (JSON-encoded)"},"ResourceGroupId":{"type":"string","description":"The ResourceGroupId"},"SecondaryZoneId":{"type":"string","description":"The secondary zone 1 for multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G. cn-hangzhou-h: Hangzhou Zone H.…"},"HiddenZoneId":{"type":"string","description":"The secondary zone 2 for multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G. cn-hangzhou-h: Hangzhou Zone H.…"},"StorageType":{"type":"string","description":"The storage type. Valid values: cloud_essd1: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. local_ssd: local SSD. Instances of…"},"GlobalSecurityGroupIds":{"type":"string","description":"The global IP address whitelist templates of the instance. Separate multiple templates with commas (,). Duplicate templates are not…"},"Tag":{"type":"string","description":"The custom tags (JSON-encoded)"},"Encrypted":{"type":"string","description":"Specifies whether to enable cloud disk encryption"},"EncryptionKey":{"type":"string","description":"The ID of the custom key"},"ProvisionedIops":{"type":"integer","description":"The provisioned IOPS"},"SrcRegion":{"type":"string","description":"The region where the source instance is located. This parameter is required when the backup restoration type is rebuilding a deleted…"},"BackupId":{"type":"string","description":"The ID of the cluster backup. This parameter is required only when RestoreType is set to 2 or 3"},"RestoreType":{"type":"string","enum":["0","1","2","3","4"],"description":"The backup restoration type. Valid values: 1: Restore the instance to a specified point in time. 2: Restore a released instance to a…"},"DestRegion":{"type":"string","description":"The region where the cross-region backup is stored"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/delete-backup":{"post":{"operationId":"cloud_aliyun_dds_delete_backup","summary":"Deletes a MongoDB backup set","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","BackupId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"BackupId":{"type":"string","description":"The backup ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/delete-dbinstance":{"post":{"operationId":"cloud_aliyun_dds_delete_dbinstance","summary":"Releases a pay-as-you-go MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"ClientToken":{"type":"string","description":"A token that ensures the idempotence of the request. The client generates this value, which must be unique among different requests. The…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/delete-global-security-ipgroup":{"post":{"operationId":"cloud_aliyun_dds_delete_global_security_ipgroup","summary":"Deletes a global IP address whitelist template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","GlobalSecurityGroupId"],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query region IDs"},"GlobalIgName":{"type":"string","description":"The name of the IP address whitelist template. The name must meet the following requirements: It can contain only lowercase letters,…"},"GlobalSecurityGroupId":{"type":"string","description":"The ID of the IP address whitelist template"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/delete-node":{"post":{"operationId":"cloud_aliyun_dds_delete_node","summary":"Deletes a shard or mongos node from an ApsaraDB for MongoDB sharded cluster instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","NodeId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-accounts":{"post":{"operationId":"cloud_aliyun_dds_describe_accounts","summary":"Queries the database account information of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"AccountName":{"type":"string","description":"The account name"},"CharacterType":{"type":"string","description":"The account type"},"DBName":{"type":"string","description":"The database to which the account belongs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-active-operation-maintenance-config":{"post":{"operationId":"cloud_aliyun_dds_describe_active_operation_maintenance_config","summary":"Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-active-operation-task":{"post":{"operationId":"cloud_aliyun_dds_describe_active_operation_task","summary":"Queries the details of O&M tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","TaskType"],"properties":{"Region":{"type":"string","description":"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":{"type":"string","description":"The task type. Valid values: rds_apsaradb_ha: primary/secondary node switch. rds_apsaradb_transfer: instance migration.…"},"IsHistory":{"type":"integer","description":"Specifies whether to return historical tasks. Valid values: 0: returns current tasks. This is the default value. 1: returns historical tasks"},"PageSize":{"type":"integer","description":"The maximum number of entries to return on each page. The value must be greater than 10. Default value: 30"},"PageNumber":{"type":"integer","description":"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":{"type":"string","description":"The product ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-active-operation-task-count":{"post":{"operationId":"cloud_aliyun_dds_describe_active_operation_task_count","summary":"Queries the number of operation and maintenance tasks on an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ResourceGroupId":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-active-operation-task-region":{"post":{"operationId":"cloud_aliyun_dds_describe_active_operation_task_region","summary":"Queries the types and number of O&M tasks for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskType"],"properties":{"TaskType":{"type":"string","description":"The task type. Valid values: rds_apsaradb_ha: a primary/secondary node switchover. rds_apsaradb_transfer: an instance migration.…"},"IsHistory":{"type":"integer","description":"Specifies whether to return historical tasks. Valid values: 0: The default value. Returns current tasks. 1: Returns historical tasks"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-active-operation-task-type":{"post":{"operationId":"cloud_aliyun_dds_describe_active_operation_task_type","summary":"Queries the types of Operation and Maintenance tasks and the number of tasks of each type for an ApsaraDB…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"IsHistory":{"type":"integer","description":"Specifies whether to return historical O\\&M tasks. Valid values: 0 (default): The system returns only pending O\\&M tasks. 1: The system…"},"ResourceGroupId":{"type":"string","description":"The resource group ID. You can call the https://help.aliyun.com/document_detail/146130.html operation to query the resource group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-active-operation-tasks":{"post":{"operationId":"cloud_aliyun_dds_describe_active_operation_tasks","summary":"Queries O&M task details for MongoDB instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Region":{"type":"string","description":"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":{"type":"string","description":"The task type. Valid values: rds_apsaradb_ha: primary-secondary node switchover. rds_apsaradb_transfer: instance migration.…"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 30, 50, and 100. Default value: 30"},"PageNumber":{"type":"integer","description":"The page number. The value must be greater than 0. Default value: 1"},"ProductId":{"type":"string","description":"The product name. For MongoDB instances, set this parameter to MongoDB"},"DbType":{"type":"string","description":"The database type. Default value: all"},"Status":{"type":"integer","description":"The task status. This parameter filters the returned tasks. -1: all tasks. 3: pending tasks. 4: running tasks. 5: successfully completed…"},"InsName":{"type":"string","description":"The name of the instance. This parameter is optional. You can specify only one instance name"},"AllowChange":{"type":"integer","description":"Specifies whether the time can be changed. Valid values: -1 (default): returns all tasks. 0: returns only tasks whose time cannot be…"},"AllowCancel":{"type":"integer","description":"Specifies whether the task can be canceled. Valid values: -1 (default): returns all tasks. 0: returns only tasks that cannot be canceled.…"},"ChangeLevel":{"type":"string","description":"The level of the task. Valid values: all (default): returns all tasks. S0: returns tasks for exception fixing. S1: returns tasks for…"},"ResourceGroupId":{"type":"string","description":"The resource group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-advanced-backup-policy":{"post":{"operationId":"cloud_aliyun_dds_describe_advanced_backup_policy","summary":"Queries advanced backup policies","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-advanced-backup-status":{"post":{"operationId":"cloud_aliyun_dds_describe_advanced_backup_status","summary":"Queries whether advanced backup is enabled","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-audit-log-filter":{"post":{"operationId":"cloud_aliyun_dds_describe_audit_log_filter","summary":"Queries the audit log types collected for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"},"RoleType":{"type":"string","description":"The role of the node in the instance. Valid values: mongos: mongos node. db : shard node. logic : logical instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-audit-policy":{"post":{"operationId":"cloud_aliyun_dds_describe_audit_policy","summary":"Checks whether audit logging is enabled for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-audit-records":{"post":{"operationId":"cloud_aliyun_dds_describe_audit_records","summary":"Queries the audit logs of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","StartTime","EndTime"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you specify a sharded cluster instance ID for this parameter, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The name of the database. The default value is all databases"},"User":{"type":"string","description":"The database account. The default value is all accounts"},"Form":{"type":"string","enum":["File","Stream"],"description":"The display format of the returned audit records. Valid values: File: Triggers the generation of an audit log file. If you set this…"},"QueryKeywords":{"type":"string","description":"The keywords to query. Separate multiple keywords with spaces. You can specify a maximum of 10 keywords"},"LogicalOperator":{"type":"string","enum":["and","or"],"description":"The logical operator for keyword search. The default value is and"},"PageSize":{"type":"integer","description":"The number of records per page. Valid values: 30 (default), 50, and 100"},"PageNumber":{"type":"integer","description":"The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer type. Default value: 1"},"OrderType":{"type":"string","enum":["desc","asc"],"description":"The order in which the queried slow logs are sorted by time. Valid values: asc: sorts results in ascending order by time. desc: sorts…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-availability-zones":{"post":{"operationId":"cloud_aliyun_dds_describe_availability_zones","summary":"Queries a list of the zones that are supported by an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The zone ID of the instance. You can call the https://help.aliyun.com/document_detail/61933.html operation to query available zones"},"InstanceChargeType":{"type":"string","enum":["PrePaid","PostPaid"],"description":"The billing method of the product. Valid values: PrePaid: subscription PostPaid: pay-as-you-go"},"DbType":{"type":"string","enum":["normal","sharding"],"description":"The architecture of the instance. Valid values: normal: replica set instance sharding: sharded cluster instance"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group. For more information, see https://help.aliyun.com/document_detail/151181.html"},"AcceptLanguage":{"type":"string","description":"The language of the returned RegionName and ZoneName parameter values. Valid values: zh (default): Chinese en: English"},"StorageSupport":{"type":"string","description":"The storage type. Valid values: cloud: displays only zones available for instances that use cloud disks. local: only displays zones…"},"MongoType":{"type":"string","description":"The edition of the instance. High-Available Edition and Preview Edition (dbfs) are supported"},"StorageType":{"type":"string","description":"The storage type. Valid values: cloud_essd1: PL1 Enterprise SSDs (ESSDs) cloud_essd2: PL2 ESSDs cloud_essd3: PL3 ESSDs local_ssd: local…"},"ExcludeZoneId":{"type":"string","description":"The zone ID that is excluded from the query results"},"ExcludeSecondaryZoneId":{"type":"string","description":"The secondary zone ID that is excluded from the query results. You can configure the ExcludeZoneId and ExcludeSecondaryZoneId parameters…"},"DBInstanceClass":{"type":"string","description":"The instance type of the instance"},"EngineVersion":{"type":"string","description":"The database engine version of the instance"},"ReplicationFactor":{"type":"string","description":"The number of nodes in the instance. This parameter is available only for replica set instances. Valid values: 1 3 5 7"},"InstanceType":{"type":"string","description":"The architecture of the instance. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-available-engine-version":{"post":{"operationId":"cloud_aliyun_dds_describe_available_engine_version","summary":"Queries the engine versions to which an ApsaraDB for MongoDB instance can be upgraded","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-available-resource":{"post":{"operationId":"cloud_aliyun_dds_describe_available_resource","summary":"Queries the available resources in the specified zone","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The ID of the zone. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the available zones"},"InstanceChargeType":{"type":"string","enum":["PrePaid","PostPaid"],"description":"The billing method of the instance. Valid values: PrePaid (default): subscription PostPaid: pay-as-you-go"},"DbType":{"type":"string","enum":["normal","sharding"],"description":"The architecture of the instance. Valid values: normal: replica set instance sharding: sharded cluster instance"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"},"StorageType":{"type":"string","enum":["local_ssd","cloud_essd1","cloud_essd2","cloud_essd3","cloud_auto"],"description":"The storage type of the instance. Valid values: local_ssd: local SSD cloud_essd1: PL1 enhanced SSD (ESSD) cloud_essd2: PL2 ESSD…"},"DBInstanceClass":{"type":"string","description":"The instance type of the instance"},"EngineVersion":{"type":"string","description":"The major engine version of the instance"},"ReplicationFactor":{"type":"string","description":"The number of nodes, only applicable to replica sets"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-backup-dbs":{"post":{"operationId":"cloud_aliyun_dds_describe_backup_dbs","summary":"Queries the databases at a specified time or the databases in a specified backup set before you restore a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SourceDBInstance"],"properties":{"PageNumber":{"type":"integer","description":"The page number of the page to return. The value must be an integer that is greater than 0. Default value: 1"},"PageSize":{"type":"integer","enum":["30","50","100"],"description":"The number of entries to return per page. Default value: 30. Valid values: 30, 50, and 100"},"SourceDBInstance":{"type":"string","description":"The ID of the source instance"},"RestoreTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-backup-policy":{"post":{"operationId":"cloud_aliyun_dds_describe_backup_policy","summary":"Queries the backup policy of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"InstanceType":{"type":"string","enum":["replicate","sharding"],"description":"The instance type. Valid values: replicate: replica set instance sharding: sharded cluster instance"},"SrcRegion":{"type":"string","description":"The region where the instance is deployed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-backup-storage":{"post":{"operationId":"cloud_aliyun_dds_describe_backup_storage","summary":"Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The instance ID"},"NodeId":{"type":"string","description":"The ID of the shard node in the sharded cluster instance. This parameter is required if the DBInstanceId parameter specifies the ID of a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-backup-tasks":{"post":{"operationId":"cloud_aliyun_dds_describe_backup_tasks","summary":"Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"BackupJobId":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-backups":{"post":{"operationId":"cloud_aliyun_dds_describe_backups","summary":"Queries the backup list of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"Instance ID of the shard node in the sharded cluster instance. This parameter is required if you set the DBInstanceId parameter to…"},"BackupId":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"integer","enum":["30","50","100"],"description":"The number of entries per page. Valid values: 30 (default) 50 100"},"StartTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The region where the instance resides. This parameter is required to restore a deleted instance. This parameter is required for…"},"DestRegion":{"type":"string","description":"The region where the backup resides. This parameter is required for geo-redundancy backups"},"ResourceGroupId":{"type":"string","description":"The resource group ID"},"BackupJobId":{"type":"string","description":"The backup task ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-binlog-files":{"post":{"operationId":"cloud_aliyun_dds_describe_binlog_files","summary":"Query log backup files for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","StartTime","EndTime"],"properties":{"RegionId":{"type":"string","description":"The ID of the region"},"DBInstanceId":{"type":"string","description":"The ID of the instance. If the instance is a sharded cluster, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"The ID of the mongos node or shard node in the sharded cluster instance. This parameter is applicable only to sharded cluster instances"},"StartTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"The number of entries to return on each page"},"PageNumber":{"type":"integer","description":"The page number"},"SrcRegion":{"type":"string","description":"The region of the source instance for a cross-region backup. This parameter is required when you query cross-region backups"},"DestRegion":{"type":"string","description":"The region where the cross-region backup is stored. This parameter is required when you query cross-region backups"},"BinlogId":{"type":"string","description":"The binlog ID. This parameter is not currently supported"},"ResourceGroupId":{"type":"string","description":"The resource group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-cluster-backups":{"post":{"operationId":"cloud_aliyun_dds_describe_cluster_backups","summary":"Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"},"BackupId":{"type":"string","description":"The ID of the cluster backup"},"PageNo":{"type":"integer","description":"The number of the page to return. The value must be a positive integer. Default value: 1"},"PageSize":{"type":"integer","enum":["30","50","100","10","20","5"],"description":"The number of entries to return on each page. Valid values: 30 (Default) 50 100"},"StartTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"Specifies whether to query the information about the child nodes in the cluster backup. Valid values: true: Returns only the basic…"},"SrcRegion":{"type":"string","description":"The region where the instance resides. This parameter is required when you query the backup sets of a released instance. This parameter is…"},"DestRegion":{"type":"string","description":"The region where the geo-redundant backup resides. This parameter is required when you query geo-redundant backups"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"},"BackupJobId":{"type":"string","description":"The ID of the backup job"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-cluster-recover-time":{"post":{"operationId":"cloud_aliyun_dds_describe_cluster_recover_time","summary":"Queries the restorable time range of a sharded cluster instance that uses cloud disks in ApsaraDB for MongoDB","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"SrcRegion":{"type":"string","description":"The region where the source instance of the geo-redundancy backup resides. This parameter is required when you query a geo-redundancy backup"},"DestRegion":{"type":"string","description":"The region where the geo-redundancy backup set resides. This parameter is required when you query a geo-redundancy backup"},"ResourceGroupId":{"type":"string","description":"The resource group ID"},"OnlyDbTableRecovery":{"type":"string","description":"The OnlyDbTableRecovery"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstance-attribute":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstance_attribute","summary":"Queries the details of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"Engine":{"type":"string","enum":["MongoDB"],"description":"The database engine. Set the value to MongoDB"},"DBInstanceId":{"type":"string","description":"The instance ID"},"ResourceGroupId":{"type":"string","description":"The resource group ID. For more information about resource groups, see https://help.aliyun.com/document_detail/151181.html. This parameter…"},"IsDelete":{"type":"string","description":"Specifies whether the instance is deleted. Valid values: false: The instance is running. Queries the information of running instances.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstance-encryption-key":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstance_encryption_key","summary":"Queries the details of a specific key for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"EncryptionKey":{"type":"string","description":"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":{"type":"string","enum":["TDE","CloudDisk"],"description":"The key scenario to query. Valid values: TDE: Queries transparent data encryption key information. CloudDisk: Queries cloud disk…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstance-monitor":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstance_monitor","summary":"Queries the collection frequency of monitoring data for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstance-performance":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstance_performance","summary":"Queries the performance data of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","Key","StartTime","EndTime"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. NodeId is required when specifying a sharded cluster instance ID"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"The performance metrics. For more information, see https://help.aliyun.com/document_detail/216973.html. To specify multiple metrics,…"},"StartTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The role ID of a node in a standalone or replica set instance. To query the role ID, call the…"},"Interval":{"type":"string","description":"The data granularity of the performance metrics in seconds. Valid values: 5, 30, 60, 600, 1800, 3600, and 86400"},"ReplicaSetRole":{"type":"string","enum":["Primary","Secondary","Readonly"],"description":"The role of a node in a standalone or replica set instance. Valid values: Primary: The primary node. Secondary: A secondary node.…"},"SearchId":{"type":"string","description":"The Search node ID. Available only after the Search feature is enabled for the instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstance-ssl":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstance_ssl","summary":"Query SSL configuration details for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstance-spec-info":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstance_spec_info","summary":"Gets instance type details","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceClass"],"properties":{"InstanceClass":{"type":"string","description":"The instance type. You can query this parameter by calling the DescribeDBInstanceAttribute…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstance-switch-log":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstance_switch_log","summary":"Queries the primary/secondary switching logs of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"StartTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"integer","enum":["30","50","100"],"description":"The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30"},"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstance-tdeinfo":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstance_tdeinfo","summary":"Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstances":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstances","summary":"Queries a list of MongoDB instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the region ID"},"PageNumber":{"type":"integer","description":"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":{"type":"integer","enum":["30","50","100"],"description":"The number of entries per page. Valid values: 30 (default) 50 100"},"DBInstanceId":{"type":"string","description":"The instance ID"},"ReplicationFactor":{"type":"string","description":"The number of nodes in the replica set instance. Valid values: 3 5 7"},"DBInstanceDescription":{"type":"string","description":"The instance name. The name must meet the following requirements: It must start with a Chinese character or a letter. It can contain…"},"ExpireTime":{"type":"string","description":"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":{"type":"string","description":"The instance status. For more details about valid values, see https://help.aliyun.com/document_detail/63870.html"},"DBInstanceType":{"type":"string","description":"The instance type. Valid values: sharding: sharded cluster instance. replicate: default value. Replica set instance or single-node…"},"DBInstanceClass":{"type":"string","description":"The instance specification. For more information about valid values, see https://help.aliyun.com/document_detail/57141.html"},"Engine":{"type":"string","enum":["MongoDB"],"description":"The database engine. Set the value to MongoDB"},"EngineVersion":{"type":"string","description":"The database engine version. Valid values: 7.0 6.0 5.0 4.4 4.2 4.0 3.4"},"NetworkType":{"type":"string","description":"The network type of the instance. Valid values: Classic: classic network. VPC: VPC"},"VpcId":{"type":"string","description":"The VPC ID"},"VSwitchId":{"type":"string","description":"The vSwitch ID of the VPC"},"ChargeType":{"type":"string","description":"The billing method of the instance. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go"},"ZoneId":{"type":"string","description":"The zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the zone ID"},"Expired":{"type":"string","description":"The expiration status of the instance. Valid values: true: expired. false: not expired"},"ConnectionDomain":{"type":"string","description":"The endpoint of the node. You can call the https://help.aliyun.com/document_detail/62010.html operation to query the endpoint"},"ResourceGroupId":{"type":"string","description":"The resource group ID"},"Tag":{"type":"string","description":"The tags (JSON-encoded)"},"DBNodeType":{"type":"string","description":"Specifies whether to filter standard or test instances. Single-node instances and DBFS instances: customized Standard instances (replica…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-dbinstances-overview":{"post":{"operationId":"cloud_aliyun_dds_describe_dbinstances_overview","summary":"Queries the overview of one or more ApsaraDB for MongoDB instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId"],"properties":{"RegionId":{"type":"string","description":"The region ID. Call https://help.aliyun.com/document_detail/61933.html to query the latest region list"},"InstanceIds":{"type":"string","description":"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":{"type":"string","description":"The status of the instance. For more information, see https://help.aliyun.com/document_detail/63870.html"},"ChargeType":{"type":"string","description":"The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go"},"NetworkType":{"type":"string","description":"The network type of the instance. Valid values: Classic: classic network VPC: virtual private cloud (VPC)"},"EngineVersion":{"type":"string","description":"The database engine version of the instance. Valid values: 5.0, 4.4, 4.2, 4.0, and 3.4"},"InstanceClass":{"type":"string","description":"The instance type. For more information about the instance types available for different instance architectures, see:…"},"VpcId":{"type":"string","description":"The ID of the VPC"},"VSwitchId":{"type":"string","description":"The ID of the vSwitch"},"InstanceType":{"type":"string","description":"The instance architecture. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance serverless:…"},"ZoneId":{"type":"string","description":"The ID of the zone"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group. For more information about resource groups, see https://help.aliyun.com/document_detail/151181.html"},"ShowTags":{"type":"string","description":"Specifies whether to return instance tags. The default value is false"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-error-log-records":{"post":{"operationId":"cloud_aliyun_dds_describe_error_log_records","summary":"Queries the error logs of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","StartTime","EndTime"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you specify a sharded cluster instance ID for this parameter, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"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":{"type":"string","enum":["primary","secondary","search"],"description":"The role of the node in the instance. Valid values: primary: primary node. secondary: secondary node. search: search node. If the NodeId…"},"StartTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The name of the database"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 30 to 100"},"PageNumber":{"type":"integer","description":"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":{"type":"string","description":"The resource group ID. For more information about resource groups, see https://help.aliyun.com/document_detail/151181.html"},"QueryKeywords":{"type":"string","description":"The keywords to search for. Separate multiple keywords with spaces. You can specify a maximum of 10 keywords"},"LogicalOperator":{"type":"string","enum":["and","or"],"description":"The logical operator for keyword search. Default value: and"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-global-security-ipgroup":{"post":{"operationId":"cloud_aliyun_dds_describe_global_security_ipgroup","summary":"Queries the global IP whitelist templates","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The ID of the IP whitelist template"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-global-security-ipgroup-relation":{"post":{"operationId":"cloud_aliyun_dds_describe_global_security_ipgroup_relation","summary":"Queries the mapping between an instance and a global IP address whitelist template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","DBClusterId"],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call https://help.aliyun.com/document_detail/61933.html to query the available regions"},"DBClusterId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-history-tasks":{"post":{"operationId":"cloud_aliyun_dds_describe_history_tasks","summary":"Queries a list of tasks in the task center","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FromStartTime","ToStartTime"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"integer","description":"The number of entries per page. Valid values: 10 to 100. Default value: 10"},"PageNumber":{"type":"integer","description":"The number of the page to return. The value must be a positive integer. Default value: 1"},"InstanceType":{"type":"string","description":"The instance type of the instance. Set the value to Instance"},"Status":{"type":"string","description":"The task status. Valid values: Scheduled: The task is waiting to be executed. Running: The task is running. Succeed: The task is…"},"InstanceId":{"type":"string","description":"The instance ID. Separate multiple instance IDs with commas (,). You can specify up to 30 instance IDs. This parameter is empty by…"},"TaskId":{"type":"string","description":"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":{"type":"string","description":"The task type. This parameter is left empty by default, which indicates that all types of tasks are queried. Valid values: CreateIns:…"},"FromStartTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"The minimum execution duration of the task. This parameter is used to filter tasks whose execution duration is longer than the minimum…"},"ToExecTime":{"type":"integer","description":"The maximum execution duration of the task. This parameter is used to filter tasks whose execution duration is shorter than or equal to…"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-history-tasks-stat":{"post":{"operationId":"cloud_aliyun_dds_describe_history_tasks_stat","summary":"Queries the overview of a task in the task center","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","FromStartTime","ToStartTime"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The task status. Valid values: Scheduled: The task is waiting to be executed. Running: The task is running. Succeed: The task is…"},"InstanceId":{"type":"string","description":"The instance ID. Separate multiple instance IDs with commas (,). You can specify up to 30 instance IDs. This parameter is empty by…"},"TaskId":{"type":"string","description":"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":{"type":"string","description":"The task type. This parameter is left empty by default, which indicates that all types of tasks are queried. Valid values: CreateIns:…"},"FromStartTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"The minimum execution duration of the task. This parameter is used to filter tasks whose execution duration is longer than the minimum…"},"ToExecTime":{"type":"integer","description":"The maximum execution duration of the task. This parameter is used to filter tasks whose execution duration is shorter than or equal to…"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-instance-auto-renewal-attribute":{"post":{"operationId":"cloud_aliyun_dds_describe_instance_auto_renewal_attribute","summary":"Queries the auto-renewal status of MongoDB instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The ID of the instance"},"DBInstanceType":{"type":"string","description":"The category of the instance. Valid values: replicate: the standalone or replica set instance sharding: the sharded cluster instance…"},"PageSize":{"type":"integer","enum":["30","50","100"],"description":"The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30"},"PageNumber":{"type":"integer","description":"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.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-instance-recover-time":{"post":{"operationId":"cloud_aliyun_dds_describe_instance_recover_time","summary":"Queries the restorable time ranges of an ApsaraDB for MongoDB replica set instance with cloud disks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"DestRegion":{"type":"string","description":"The region where the geo-redundancy backup set is stored. This parameter is required when you query geo-redundancy backups"},"SrcRegion":{"type":"string","description":"The area where the source instance of the geo-redundancy backup resides. This parameter is required when you query geo-redundancy backups"},"ResourceGroupId":{"type":"string","description":"The resource group ID"},"OnlyDbTableRecovery":{"type":"string","description":"The OnlyDbTableRecovery"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-kernel-release-notes":{"post":{"operationId":"cloud_aliyun_dds_describe_kernel_release_notes","summary":"Queries the release notes of minor engine versions for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"KernelVersion":{"type":"string","description":"The minor engine version of the database. Example: mongodb_20180522_0.4.8. You can obtain the minor engine version in the Specifications…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-kms-keys":{"post":{"operationId":"cloud_aliyun_dds_describe_kms_keys","summary":"Queries Key Management Service (KMS) keys that are available for disk encryption","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent region list"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-mongo-dblog-config":{"post":{"operationId":"cloud_aliyun_dds_describe_mongo_dblog_config","summary":"You can view the configuration of MongoDB Log Service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. Call https://help.aliyun.com/document_detail/61939.html to query the instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-parameter-modification-history":{"post":{"operationId":"cloud_aliyun_dds_describe_parameter_modification_history","summary":"Queries the parameter modification records of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","StartTime","EndTime"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The role of the instance. Valid values: db: shard cs: Configserver mongos: mongos logic: sharded cluster instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-parameter-templates":{"post":{"operationId":"cloud_aliyun_dds_describe_parameter_templates","summary":"Queries the default parameter templates for MongoDB instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Engine","EngineVersion"],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the most recent region list"},"Engine":{"type":"string","description":"The database engine. Set the value to mongodb"},"EngineVersion":{"type":"string","description":"The database version number. Valid values: 7.0 6.0 5.0 4.4 4.2 4.0 3.4"},"Role":{"type":"string","enum":["normal","db","cs","physical","mongos","single"],"description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-parameters":{"post":{"operationId":"cloud_aliyun_dds_describe_parameters","summary":"Queries the parameter settings of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you specify the ID of a sharded cluster instance for this parameter, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"Instance ID of the mongos or shard node in the sharded cluster instance. This parameter is available only when the DBInstanceId parameter…"},"CharacterType":{"type":"string","description":"The role type of the instance. Valid values: db: shard role cs: config server role mongos: mongos role"},"ExtraParam":{"type":"string","description":"The extended parameter"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-price":{"post":{"operationId":"cloud_aliyun_dds_describe_price","summary":"Queries pricing information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OrderType","DBInstances"],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the region ID"},"OrderType":{"type":"string","enum":["BUY","UPGRADE","RENEW","DOWNGRADE"],"description":"The order type. Valid values: BUY: Create an instance. UPGRADE: Upgrade instance configurations. RENEW: Renew an instance"},"DBInstances":{"type":"string","description":"The JSON-formatted string that contains multiple pieces of information about instances. For metric descriptions and more JSON format…"},"CommodityCode":{"type":"string","description":"The commodity code. Valid values: dds: pay-as-you-go replica set instance badds: subscription replica set instance dds_sharding:…"},"ProductCode":{"type":"string","description":"The product code. Default value: dds"},"BusinessInfo":{"type":"string","description":"The additional parameter for business information"},"CouponNo":{"type":"string","description":"Specifies whether to use a coupon. Valid values: default or null (default): Use a coupon. youhuiquan_promotion_option_id_for_blank: Do not…"},"OrderParamOut":{"type":"string","enum":["false","true"],"description":"Specifies whether to return order parameters. Valid values: false (default): Do not return order parameters. true: Return order parameters"},"ResourceGroupId":{"type":"string","description":"The resource group ID. For more information about resource groups, see https://help.aliyun.com/document_detail/151181.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-rds-vswitchs":{"post":{"operationId":"cloud_aliyun_dds_describe_rds_vswitchs","summary":"Retrieves a list of vSwitches","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"VpcId":{"type":"string","description":"The ID of VPC"},"ZoneId":{"type":"string","description":"The zone ID"},"ResourceGroupId":{"type":"string","description":"The resource group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-rds-vpcs":{"post":{"operationId":"cloud_aliyun_dds_describe_rds_vpcs","summary":"Retrieves a list of VPCs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ZoneId":{"type":"string","description":"The zone ID"},"ResourceGroupId":{"type":"string","description":"The resource group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-regions":{"post":{"operationId":"cloud_aliyun_dds_describe_regions","summary":"Queries all regions and zones supported for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"RegionId":{"type":"string","description":"The region ID. If you do not specify this parameter, all supported regions are queried"},"AcceptLanguage":{"type":"string","description":"The language of the values of the returned RegionName and ZoneName parameters. Valid values: zh (default) en"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-renewal-price":{"post":{"operationId":"cloud_aliyun_dds_describe_renewal_price","summary":"Get the price to renew a specific MongoDB instance for one month","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"BusinessInfo":{"type":"string","description":"Additional business information, provided as a JSON string"},"CouponNo":{"type":"string","description":"Specifies whether to use a coupon. Valid values: default or null (default): Use a coupon. youhuiquan_promotion_option_id_for_blank: Do not…"},"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-replica-set-role":{"post":{"operationId":"cloud_aliyun_dds_describe_replica_set_role","summary":"Retrieves the role information and connection details for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-restore-dbinstance-list":{"post":{"operationId":"cloud_aliyun_dds_describe_restore_dbinstance_list","summary":"Queries the backup and restoration instances of a MongoDB instance within the last 7 days","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","CreationTimeAfter"],"properties":{"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","enum":["30","50","100","5"],"description":"The number of entries per page"},"DBInstanceId":{"type":"string","description":"The instance ID"},"CreationTimeAfter":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-role-tag-status":{"post":{"operationId":"cloud_aliyun_dds_describe_role_tag_status","summary":"Describes the status of a tag for a node","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-role-zone-info":{"post":{"operationId":"cloud_aliyun_dds_describe_role_zone_info","summary":"Queries the roles and zones of each node in a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-running-log-records":{"post":{"operationId":"cloud_aliyun_dds_describe_running_log_records","summary":"Queries the running logs of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","StartTime","EndTime"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"Instance ID of the mongos or shard node in the sharded cluster instance. This parameter is available only if you set the DBInstanceId…"},"StartTime":{"type":"string","description":"The beginning of the time range to query. Specify the time in the yyyy-MM-dd T HH:mm Z format (UTC)"},"EndTime":{"type":"string","description":"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":{"type":"string","description":"The name of the database"},"RoleType":{"type":"string","enum":["primary","secondary","search"],"description":"The role of the node in the instance. Valid values: primary: primary node. secondary: secondary node. search: search node. If you set the…"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 30 to 100"},"PageNumber":{"type":"integer","description":"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":{"type":"string","enum":["desc","asc"],"description":"The order in which the returned running logs are sorted by time. Valid values: asc: ascending order. desc: descending order"},"ResourceGroupId":{"type":"string","description":"The resource group ID"},"RoleId":{"type":"string","description":"The role ID of the node. You can call https://help.aliyun.com/document_detail/62134.html to query the role ID"},"QueryKeywords":{"type":"string","description":"The keywords for the query. Separate multiple keywords with spaces. You can specify up to 10 keywords"},"LogicalOperator":{"type":"string","enum":["and","or"],"description":"The logical operator for keyword-based search. Default value: and"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-security-group-configuration":{"post":{"operationId":"cloud_aliyun_dds_describe_security_group_configuration","summary":"Queries the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB for MongoDB…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-security-ips":{"post":{"operationId":"cloud_aliyun_dds_describe_security_ips","summary":"Retrieves the IP whitelists of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"},"ShowHDMIps":{"type":"string","description":"Whether to display DAS whitelist information"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-sharding-network-address":{"post":{"operationId":"cloud_aliyun_dds_describe_sharding_network_address","summary":"Retrieves the connection information for a MongoDB sharded cluster instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"NodeId":{"type":"string","description":"The ID of a mongos, shard, or ConfigServer node in the sharded cluster instance. You can call the…"},"NetworkType":{"type":"string","description":"The network type. Valid values: VPC: virtual private cloud. Classic: classic network. Public: public network"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-slow-log-records":{"post":{"operationId":"cloud_aliyun_dds_describe_slow_log_records","summary":"Queries slow query log entries for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","StartTime","EndTime"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the `NodeId` parameter"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The name of the database"},"QueryKeywords":{"type":"string","description":"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":{"type":"string","enum":["and","or"],"description":"The logical relationship among multiple keywords. or and (default value)"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. Valid values: 30 to 100"},"PageNumber":{"type":"integer","description":"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":{"type":"string","enum":["desc","asc"],"description":"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":{"type":"string","description":"The ID of the resource group to which the instances you want to query belong"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-tags":{"post":{"operationId":"cloud_aliyun_dds_describe_tags","summary":"Queries all tags in a specified region","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The resource type. Set the value to INSTANCE"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"},"NextToken":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-user-encryption-key-list":{"post":{"operationId":"cloud_aliyun_dds_describe_user_encryption_key_list","summary":"Queries the custom key list of an instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"TargetRegionId":{"type":"string","description":"The target zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query available zones"},"RoleARN":{"type":"string","description":"The Alibaba Cloud Resource Name (ARN) of the specified role. Format: `acs:ram::$accountID:role/$roleName `. Default value:…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/describe-vpcs-for-mongo-db":{"post":{"operationId":"cloud_aliyun_dds_describe_vpcs_for_mongo_db","summary":"Retrieves a paginated list of VPCs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"RegionId":{"type":"string","description":"The region ID"},"ZoneId":{"type":"string","description":"The zone ID"},"PageNumber":{"type":"integer","description":"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":{"type":"integer","enum":["30","50"],"description":"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":{"type":"string","description":"The resource group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/destroy-instance":{"post":{"operationId":"cloud_aliyun_dds_destroy_instance","summary":"Destroys an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"InstanceId":{"type":"string","description":"The instance ID. InstanceId and DBInstanceId serve the same function. You need only to specify one of them"},"DBInstanceId":{"type":"string","description":"The instance ID. InstanceId and DBInstanceId serve the same function. You need only to specify one of them"},"ClientToken":{"type":"string","description":"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":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/evaluate-resource":{"post":{"operationId":"cloud_aliyun_dds_evaluate_resource","summary":"Evaluates whether sufficient resources are available before you create an instance or change the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","ZoneId","EngineVersion"],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call https://help.aliyun.com/document_detail/61933.html to query available regions"},"ZoneId":{"type":"string","description":"The zone ID. You can call https://help.aliyun.com/document_detail/61933.html to query available zones"},"Engine":{"type":"string","enum":["MongoDB"],"description":"The database engine. Set the value to MongoDB"},"EngineVersion":{"type":"string","enum":["3.4","4.0","4.2","4.4","5.0","6.0","7.0","8.0","8.3"],"description":"The database engine version"},"DBInstanceClass":{"type":"string","description":"The instance type. This parameter is required when you evaluate resources for a replica set instance. For more information about instance…"},"ShardsInfo":{"type":"string","description":"The shard information of the sharded cluster instance. This parameter is required when you evaluate resources for a sharded cluster…"},"DBInstanceId":{"type":"string","description":"The instance ID. This parameter is required when you evaluate resources for changing instance specifications"},"ReplicationFactor":{"type":"string","enum":["1","3","5","7","2"],"description":"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":{"type":"string","enum":["1","2","3","4","5"],"description":"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":{"type":"string","description":"The storage capacity of the replica set instance. Unit: GB. This parameter is required when the instance uses cloud disks."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/list-tag-resources":{"post":{"operationId":"cloud_aliyun_dds_list_tag_resources","summary":"Queries the relationship between ApsaraDB for MongoDB instances and tags","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","ResourceType"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The resource type. Set the value to INSTANCE"},"NextToken":{"type":"string","description":"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":{"type":"string","description":"The resource IDs. You must specify this parameter or the Tag parameter (JSON-encoded)"},"Tag":{"type":"string","description":"The tags that are attached to the resources (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/migrate-available-zone":{"post":{"operationId":"cloud_aliyun_dds_migrate_available_zone","summary":"Migrates the zone of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","ZoneId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If the network type of the instance is VPC, you must also specify the Vswitch parameter"},"ZoneId":{"type":"string","description":"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":{"type":"string","description":"The ID of the vSwitch in the destination zone. This parameter is required when the network type of the instance is VPC"},"EffectiveTime":{"type":"string","enum":["Immediately","MaintainTime","0","1"],"description":"The effective time for migrating the zone. The instance must be active. Valid values: Immediately: Takes effect immediately. MaintainTime:…"},"SecondaryZoneId":{"type":"string","description":"The ID of destination secondary zone 1"},"HiddenZoneId":{"type":"string","description":"The ID of destination secondary zone 2"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/migrate-to-other-zone":{"post":{"operationId":"cloud_aliyun_dds_migrate_to_other_zone","summary":"Migrates a MongoDB instance to another zone","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","ZoneId"],"properties":{"InstanceId":{"type":"string","description":"The instance ID. If the network type of the instance is VPC, you must also specify the VSwitchId parameter"},"ZoneId":{"type":"string","description":"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":{"type":"string","enum":["Immediately","MaintainTime","0","1"],"description":"The effective period for the zone migration. Valid values: Immediately (default): The migration becomes active immediately. MaintainTime:…"},"VSwitchId":{"type":"string","description":"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"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-account-description":{"post":{"operationId":"cloud_aliyun_dds_modify_account_description","summary":"Modifies the description of the root account in a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","AccountName","AccountDescription"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"AccountName":{"type":"string","description":"The name of the account whose description you want to modify"},"DBName":{"type":"string","description":"The database to which the account belongs"},"AccountDescription":{"type":"string","description":"Sets the description of the account. The description cannot start with http:// or https://. The description must start with a Chinese or…"},"CharacterType":{"type":"string","enum":["db","cs","normal"],"description":"The type of the account whose description you want to modify. Valid values: db: shard account cs: config server account normal: default…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-active-operation-maintenance-config":{"post":{"operationId":"cloud_aliyun_dds_modify_active_operation_maintenance_config","summary":"Modifies the O&M task configuration of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CycleType":{"type":"string","description":"The cycle type. Valid values: Month: Monthly. Week: Weekly"},"CycleTime":{"type":"string","description":"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":{"type":"string","description":"The start time of the instance O&M window. The time is in the HH:mmZ format and in UTC"},"MaintainEndTime":{"type":"string","description":"The end time of the instance O&M window. The time is in the HH:mmZ format and in UTC"},"Status":{"type":"integer","enum":["1","2"],"description":"Specifies whether the configuration takes effect. Valid values: 1: Effective. 2: Invalid"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-active-operation-tasks":{"post":{"operationId":"cloud_aliyun_dds_modify_active_operation_tasks","summary":"Modifies the switchover time of scheduled O&M tasks for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Ids","SwitchTime"],"properties":{"Ids":{"type":"string","description":"The IDs of the O&M tasks. Separate multiple IDs with commas (,). You can call the DescribeActiveOperationTasks operation to retrieve the…"},"SwitchTime":{"type":"string","description":"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":{"type":"integer","description":"Specifies whether to immediately enter the execution scheduling phase. Valid values: 0: No. This is the default value. 1: Yes. If this…"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-advanced-backup-policy":{"post":{"operationId":"cloud_aliyun_dds_modify_advanced_backup_policy","summary":"Modifies the advanced backup policy","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","BackupRetentionPolicyOnClusterDeletion"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"PreferredBackupTime":{"type":"string","description":"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":{"type":"string","enum":["Standard","Flash"],"description":"The snapshot backup type. Valid values: Flash: backup within seconds. Standard: standard backup. This is the default value"},"BackupRetentionPolicyOnClusterDeletion":{"type":"integer","enum":["0","1","2"],"description":"The backup retention policy. Valid values: 0: All backup sets of the instance are deleted immediately when the instance is released. 1:…"},"AdvancedBackupDataPolicies":{"type":"string","description":"The list of backup policies (JSON-encoded)"},"AdvancedBackupLogPolicies":{"type":"string","description":"The list of log backup policies (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-advanced-backup-status":{"post":{"operationId":"cloud_aliyun_dds_modify_advanced_backup_status","summary":"Enables advanced backup","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-audit-log-filter":{"post":{"operationId":"cloud_aliyun_dds_modify_audit_log_filter","summary":"Modifies the collection types of audit logs for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","Filter"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"Filter":{"type":"string","description":"The collection types of audit logs. Separate multiple collection types with commas (,). admin: O&M and management operations. slow: Slow…"},"RoleType":{"type":"string","description":"The role of the node in the instance. Valid values: db: shard node mongos: mongos node Metric description This parameter applies only to…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-audit-policy":{"post":{"operationId":"cloud_aliyun_dds_modify_audit_policy","summary":"Settings the audit log switch or log storage duration for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","AuditStatus"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"AuditStatus":{"type":"string","enum":["enable","disabled","Enable","Disabled"],"description":"The status of audit logging. Valid values: enable: Enables audit logging. disabled: Disables audit logging"},"StoragePeriod":{"type":"integer","description":"In the Standard edition, this parameter specifies the retention period of audit logs. Valid values: 1 to 365. Default value: 30. Unit:…"},"AuditLogSwitchSource":{"type":"string","description":"The source of the audit log request. Valid value: Console"},"ServiceType":{"type":"string","description":"The edition of audit logging. Valid values: Trial: Free Trial edition. Standard: Standard edition. V2_Standard: DAS Enterprise Edition…"},"HotStoragePeriod":{"type":"integer","description":"This parameter takes effect only in the V2_Standard edition (DAS Enterprise Edition NoSQL-compatible audit logs) and specifies the hot…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-backup-expire-time":{"post":{"operationId":"cloud_aliyun_dds_modify_backup_expire_time","summary":"Modifies the time-to-live (TTL) of a MongoDB backup set","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","BackupId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"BackupExpireTime":{"type":"string","description":"The time-to-live (TTL) of the backup. The time must be in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.…"},"BackupId":{"type":"string","description":"The backup ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-backup-policy":{"post":{"operationId":"cloud_aliyun_dds_modify_backup_policy","summary":"Modifies the backup policy of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"PreferredBackupTime":{"type":"string","description":"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":{"type":"string","description":"The backup cycle. Valid values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday:…"},"BackupRetentionPeriod":{"type":"integer","description":"The number of days for which full backups are retained. For users who created instances before September 10, 2021, the default retention…"},"EnableBackupLog":{"type":"integer","description":"Specifies whether to enable log backup. Valid values: 0: Disables log backup. This is the default value. 1: Enables log backup. Sharded…"},"LogBackupRetentionPeriod":{"type":"integer","description":"The number of days for which log backups are retained. Default value: 7. Valid values: 7 to 730"},"SnapshotBackupType":{"type":"string","description":"The snapshot backup type. Valid values: Flash: Backup within seconds. Standard: Standard backup. This is the default value"},"BackupInterval":{"type":"string","description":"The high-frequency backup frequency. Valid values: -1: Disables high-frequency backups. 30: Every 30 minutes. 60: Every 1 hour. 120: Every…"},"HighFrequencyBackupRetention":{"type":"integer","description":"The number of days for which high-frequency backups are retained. Before you use this parameter, make sure that the BackupInterval…"},"BackupRetentionPolicyOnClusterDeletion":{"type":"integer","enum":["0","1","2"],"description":"The backup data retention policy. Valid values: 0: Deletes all backup sets of the instance immediately when the instance is released. 1:…"},"CrossBackupType":{"type":"string","enum":["update","delete"],"description":"The operation policy for cross-region backup. Valid values: update: Modifies the cross-region backup policy. delete: Deletes the…"},"SrcRegion":{"type":"string","description":"The region where the instance is deployed. This parameter is required to recover deleted instances. This parameter is required for…"},"DestRegion":{"type":"string","description":"The region where backups are stored. This parameter is required for cross-region backup"},"CrossRetentionType":{"type":"string","enum":["delay","never"],"description":"The retention type for cross-region backup. Valid values: delay: Retains backups for a specified period. never: Never expires. This…"},"CrossRetentionValue":{"type":"integer","description":"The retention period for cross-region backup. Valid values: 3 to 1825 days. This parameter is required for cross-region backup. This…"},"CrossBackupPeriod":{"type":"string","description":"The days of the week when cross-region backup is performed. Valid values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday.…"},"EnableCrossLogBackup":{"type":"integer","description":"Specifies whether to enable cross-region log backup. This parameter is required for cross-region backup. 1: Enables cross-region log…"},"CrossLogRetentionType":{"type":"string","enum":["never","delay"],"description":"The retention type for cross-region log backup. Valid values: delay: Retains backups for a specified period. never: Never expires. This…"},"CrossLogRetentionValue":{"type":"integer","description":"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":{"type":"string","enum":["sharding","replicate"],"description":"The instance type. Valid values: replicate sharding This parameter is required when the backup recovery type is set to rebuilding a…"},"PreserveOneEachHour":{"type":"string","description":"Specifies whether to enable hourly sparse backup. Valid values: true: If the backup frequency is set to minutes, all snapshots taken…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-attribute":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_attribute","summary":"Modifies instance release protection configuration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"DBInstanceReleaseProtection":{"type":"string","description":"Specifies whether to enable instance release protection. Valid values: true: enabled. false: disabled"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-config":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_config","summary":"Modifies instance configuration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","ConfigName","ConfigValue"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"ConfigName":{"type":"string","description":"The configuration item name"},"ConfigValue":{"type":"string","description":"The configuration item value"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-connection-string":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_connection_string","summary":"Modifies the endpoint and port of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you specify the ID of a sharded cluster instance for this parameter, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"The current endpoint, which is the endpoint to be modified"},"NewConnectionString":{"type":"string","description":"The new endpoint. The endpoint must meet the following requirements: It must start with a lowercase letter. It must end with a lowercase…"},"NewPort":{"type":"integer","description":"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":{"type":"string","description":"Specifies whether to modify only port numbers. If you modify only port numbers, batch modification is supported"},"NetworkType":{"type":"string","enum":["vpc","public"],"description":"The network type of the connection string when only port numbers are modified"},"ForceModifySuffix":{"type":"string","description":"The ForceModifySuffix"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-description":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_description","summary":"Modifies the name of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","DBInstanceDescription"],"properties":{"DBInstanceId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-disk-type":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_disk_type","summary":"Modifies the disk type of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DbInstanceStorageType":{"type":"string","description":"The disk type after the modification. Valid value: cloud_auto: ESSD AutoPL disk"},"ProvisionedIops":{"type":"integer","description":"The provisioned IOPS. Valid values: 0 to 50000"},"DBInstanceId":{"type":"string","description":"The instance ID"},"AutoPay":{"type":"string","description":"Specifies whether to enable automatic payment. Valid values: true: Enables automatic payment. Make sure that your account has a sufficient…"},"BusinessInfo":{"type":"string","description":"The business information. This is an additional parameter"},"CouponNo":{"type":"string","description":"The coupon code. The default value is `youhuiquan_promotion_option_id_for_blank`"},"ExtraParam":{"type":"string","description":"An additional parameter"},"AutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal for the instance. Valid values: true: Enables auto-renewal. false: Disables auto-renewal. Default…"},"OrderType":{"type":"string","description":"The order type. Valid values: UPGRADE: Upgrades the instance configuration. DOWNGRADE: Downgrades the instance configuration. This…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-maintain-time":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_maintain_time","summary":"Modifies the maintenance window of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","MaintainStartTime","MaintainEndTime"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"MaintainStartTime":{"type":"string","description":"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":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-monitor":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_monitor","summary":"Set the monitoring collection granularity for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","Granularity"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"},"Granularity":{"type":"string","description":"The collection frequency of monitoring data. Valid values: 1 or 300. Unit: seconds"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-net-expire-time":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_net_expire_time","summary":"Extends the classic network retention period for a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","ClassicExpendExpiredDays"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"ConnectionString":{"type":"string","description":"The endpoint of the instance"},"ClassicExpendExpiredDays":{"type":"integer","description":"Sets the retention period of the original classic network endpoint. Valid values: 14, 30, 60, and 120. Unit: days"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-network-type":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_network_type","summary":"Switches the network type of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","NetworkType","ZoneId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"NetworkType":{"type":"string","description":"The target network type to which you want to switch the instance. Valid values: VPC: switches the network type to VPC"},"VpcId":{"type":"string","description":"The VPC ID. This parameter is required when the NetworkType parameter settings is set to VPC"},"VSwitchId":{"type":"string","description":"The vSwitch ID in the VPC. This parameter is required when the NetworkType parameter settings is set to VPC"},"RetainClassic":{"type":"string","description":"Specifies whether to retain the original classic network address when you switch the network type to VPC. Settings. Valid values: True:…"},"ClassicExpiredDays":{"type":"integer","description":"The retention period of the original classic network address when you switch the network type to VPC. Settings. Valid values: 14, 30, 60,…"},"ZoneId":{"type":"string","description":"The zone ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the zone ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-ssl":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_ssl","summary":"Modifies the SSL configuration of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","SSLAction"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"SSLAction":{"type":"string","enum":["Open","Close","Update"],"description":"The operation to perform on the SSL feature. Valid values: Open: Enables Secure Sockets Layer (SSL) encryption. Close: Disables Secure…"},"SwitchMode":{"type":"string","enum":["0","1"],"description":"The time when the SSL configuration of the MongoDB instance is modified. Valid values: 0: Modifies the configuration immediately. 1:…"},"ForceEncryption":{"type":"string","description":"Specifies whether to force Secure Sockets Layer (SSL) encryption for connections. Valid values: 1: Forces Secure Sockets Layer (SSL)…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-spec":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_spec","summary":"Modifies the specifications or storage space of ApsaraDB for MongoDB standalone instances, replica set…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"DBInstanceClass":{"type":"string","description":"The instance type. For more information, see https://help.aliyun.com/document_detail/57141.html. You can also call the…"},"DBInstanceStorage":{"type":"string","description":"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":{"type":"string","enum":["UPGRADE","DOWNGRADE"],"description":"The type of configuration change. Valid values: UPGRADE: upgrades the configurations. This is the default value. DOWNGRADE: downgrades the…"},"AutoPay":{"type":"string","description":"Specifies whether to enable automatic payment for the instance. Valid values: true: enables automatic payment. This is the default value.…"},"BusinessInfo":{"type":"string","description":"The business information"},"ReplicationFactor":{"type":"string","enum":["1","3","5","7","2"],"description":"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":{"type":"string","description":"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":{"type":"string","description":"Specifies whether to use a coupon. Valid values: default or null: uses a coupon. This is the default value.…"},"EffectiveTime":{"type":"string","enum":["Immediately","MaintainTime","0","1"],"description":"The time when the configuration change takes effect. Valid values: Immediately: takes effect immediately. This is the default value.…"},"ExtraParam":{"type":"string","description":"The additional parameter. Valid values: async: returns the result after the configuration change order is created. sync: returns the…"},"TargetZoneId":{"type":"string","description":"The destination zone for instance migration when you migrate the instance across zones and change its configurations at the same time.…"},"TargetSecondaryZoneId":{"type":"string","description":"The destination zone for the secondary node when you cloud disk instance across zones and change its configurations at the same time. This…"},"TargetHiddenZoneId":{"type":"string","description":"The destination zone for the hidden node when you cloud disk instance across zones and change its configurations at the same time. This…"},"AlignPrimaryZone":{"type":"string","description":"Specifies whether to automatically align the primary node to the primary zone for a multi-zone instance after operations such as…"},"TargetVswitchId":{"type":"string","description":"The ID of the destination vSwitch when you cloud disk instance across zones and change its configurations at the same time. This parameter…"},"SearchNodeClass":{"type":"string","description":"The specifications of the search node for the configuration change"},"SearchNodeStorage":{"type":"integer","description":"The storage capacity of the search node for the configuration change"},"SearchNodeCount":{"type":"integer","description":"The number of search nodes for the configuration change"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-dbinstance-tde":{"post":{"operationId":"cloud_aliyun_dds_modify_dbinstance_tde","summary":"Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","TDEStatus"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"TDEStatus":{"type":"string","description":"The TDE status. Valid values: enabled, which indicates that TDE is enabled. You cannot disable TDE after it is enabled. Proceed with caution"},"EncryptorName":{"type":"string","description":"The encryption method. Valid values: aes-256-cbc. This parameter is available only when the TDEStatus parameter is set to enabled"},"EncryptionKey":{"type":"string","description":"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":{"type":"string","description":"The ARN of the specified role. Format: `acs:ram::$accountID:role/$roleName`. `$accountID`: the ID of the Alibaba Cloud account. You can…"},"SwitchMode":{"type":"string","enum":["0","1"],"description":"The time to modify the Transparent Data Encryption (TDE) status of the MongoDB instance. Valid values: 0: immediately. 1: within the O&M…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-global-security-ipgroup":{"post":{"operationId":"cloud_aliyun_dds_modify_global_security_ipgroup","summary":"Modifies the global IP whitelist template associated with an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","GlobalIgName","GlobalSecurityGroupId","GIpList"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The name of the IP whitelist template"},"GlobalSecurityGroupId":{"type":"string","description":"The ID of the IP whitelist template"},"GIpList":{"type":"string","description":"The IP addresses in the whitelist template. Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-global-security-ipgroup-name":{"post":{"operationId":"cloud_aliyun_dds_modify_global_security_ipgroup_name","summary":"Modifies the name of a global IP whitelist template associated with an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","GlobalIgName","GlobalSecurityGroupId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The name of the IP whitelist template. The name must meet the following requirements: It can contain lowercase letters, digits, and…"},"GlobalSecurityGroupId":{"type":"string","description":"The ID of the IP whitelist template"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-global-security-ipgroup-relation":{"post":{"operationId":"cloud_aliyun_dds_modify_global_security_ipgroup_relation","summary":"Modifies the mapping between a global whitelist template and an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","DBClusterId","GlobalSecurityGroupId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The instance ID"},"GlobalSecurityGroupId":{"type":"string","description":"The ID of the IP whitelist template"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-instance-auto-renewal-attribute":{"post":{"operationId":"cloud_aliyun_dds_modify_instance_auto_renewal_attribute","summary":"Enables or disables auto-renewal for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","DBInstanceId","AutoRenew"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The ID of the instance"},"Duration":{"type":"string","description":"The auto-renewal period. Valid values: 1 to 12. Unit: month. This parameter is valid only when AutoRenew is set to true"},"AutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal. Valid values: true false If this parameter is set to true, you must set the Duration parameter"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-instance-vpc-auth-mode":{"post":{"operationId":"cloud_aliyun_dds_modify_instance_vpc_auth_mode","summary":"Disables password-free access over Virtual Private Cloud (VPC) for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"Specify whether to disable password-free access over VPC. Set the value to Close"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-node-spec":{"post":{"operationId":"cloud_aliyun_dds_modify_node_spec","summary":"Modifies the specifications and storage space of nodes in a MongoDB sharded cluster instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","NodeId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"The specifications of the shard or mongos node. For more information, see https://help.aliyun.com/document_detail/57141.html"},"NodeStorage":{"type":"integer","description":"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":{"type":"string","description":"The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of…"},"FromApp":{"type":"string","description":"The source of the request. Valid values: OpenApi: The request is sent from OpenAPI. mongo_buy: The request is sent from the console"},"AutoPay":{"type":"string","description":"Specifies whether to enable automatic payment. Valid values: true (default): Automatic payment is enabled. Make sure that your account has…"},"EffectiveTime":{"type":"string","enum":["Immediately","MaintainTime","0","1","TimePoint","2"],"description":"The effective period of the configuration change. Valid values: Immediately (default): The configuration change takes effect immediately.…"},"SwitchTime":{"type":"string","description":"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":{"type":"string","enum":["UPGRADE","DOWNGRADE"],"description":"The order type. Valid values: UPGRADE: Upgrade. DOWNGRADE: Downgrade"},"ReadonlyReplicas":{"type":"integer","description":"The number of read-only nodes in the shard node. Valid values: 0 to 5. The value must be an integer"},"BusinessInfo":{"type":"string","description":"The additional parameter that contains business information"},"CouponNo":{"type":"string","description":"Specifies whether to use a coupon. Valid values: default or null (default): Use a coupon. youhuiquan_promotion_option_id_for_blank: Do not…"},"TargetZoneId":{"type":"string","description":"The destination primary zone for zone migration. This parameter is supported only for cloud disk instances."},"TargetSecondaryZoneId":{"type":"string","description":"The destination secondary zone for zone migration. This parameter is supported only for cloud disk instances."},"TargetHiddenZoneId":{"type":"string","description":"The destination hidden zone for zone migration. This parameter is supported only for cloud disk instances."},"AlignPrimaryZone":{"type":"string","description":"Specifies whether to automatically align the primary node to the primary zone after operations such as specification changes for…"},"TargetVswitchId":{"type":"string","description":"The ID of the destination vSwitch for zone migration. This parameter is supported only for cloud disk instances."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-node-spec-batch":{"post":{"operationId":"cloud_aliyun_dds_modify_node_spec_batch","summary":"Modifies the configurations of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","NodesInfo"],"properties":{"RegionId":{"type":"string","description":"The region ID. You can call the https://help.aliyun.com/document_detail/61933.html operation to query available regions"},"DBInstanceId":{"type":"string","description":"The instance ID of the instance whose configurations you want to modify"},"NodesInfo":{"type":"string","description":"The specifications of the Mongos or shard nodes to be modified. For more information, see https://help.aliyun.com/document_detail/57141.html"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to…"},"AutoPay":{"type":"string","description":"Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. Make sure that your account has sufficient…"},"EffectiveTime":{"type":"string","description":"The effective period of the configuration change. Valid values: Immediately: The configuration change takes effect immediately.…"},"OrderType":{"type":"string","enum":["UPGRADE","DOWNGRADE"],"description":"The type of the configuration change. Valid values: UPGRADE: upgrades the configurations. DOWNGRADE: downgrades the configurations. This…"},"CouponNo":{"type":"string","description":"Specifies whether to use a coupon. Valid values: default or null: uses a coupon. This is the default value.…"},"BusinessInfo":{"type":"string","description":"The business information"},"TargetVswitchId":{"type":"string","description":"The ID of the destination vSwitch when you migrate the instance across zones and change its configurations at the same time. This…"},"TargetHiddenZoneId":{"type":"string","description":"The destination zone of the hidden node when you migrate the instance across zones and change its configurations at the same time. This…"},"AlignPrimaryZone":{"type":"string","description":"Specifies whether to automatically align the primary node to the primary zone after operations such as configuration changes for a…"},"TargetZoneId":{"type":"string","description":"The destination zone of the primary node when you migrate the instance across zones and change its configurations at the same time. This…"},"TargetSecondaryZoneId":{"type":"string","description":"The destination zone of the secondary node when you migrate the instance across zones and change its configurations at the same time. This…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-parameters":{"post":{"operationId":"cloud_aliyun_dds_modify_parameters","summary":"Modifies the parameters of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","Parameters"],"properties":{"RegionId":{"type":"string","description":"The region ID of the instance. To query the latest region list, call the https://help.aliyun.com/document_detail/61933.html operation"},"DBInstanceId":{"type":"string","description":"The instance ID. If this parameter is a sharded cluster instance ID, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"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":{"type":"string","description":"The parameters and their new values. The value must be a JSON string. Example:…"},"CharacterType":{"type":"string","description":"The type of the node. Valid values: db: shard node. cs: Configserver node. mongos: mongos node"},"SwitchMode":{"type":"string","description":"The time to apply the parameter modifications. Valid values: 0: Immediately. 1: During the maintenance window"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-resource-group":{"post":{"operationId":"cloud_aliyun_dds_modify_resource_group","summary":"Moves an ApsaraDB for MongoDB instance to a specified resource group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","ResourceGroupId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The ID of the instance"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group. For more information, see https://help.aliyun.com/document_detail/151181.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-security-group-configuration":{"post":{"operationId":"cloud_aliyun_dds_modify_security_group_configuration","summary":"Modifies the ECS security group bound to an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","SecurityGroupId"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"},"SecurityGroupId":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-security-ips":{"post":{"operationId":"cloud_aliyun_dds_modify_security_ips","summary":"Modifies the IP whitelist of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","SecurityIps"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"SecurityIps":{"type":"string","description":"The list of IP addresses in the IP whitelist group. Separate multiple IP addresses with commas (,). IP addresses cannot be duplicated. A…"},"ModifyMode":{"type":"string","enum":["Cover","Append","Delete","Extend"],"description":"The modification method. Valid values: Cover: Overwrites the original whitelist. Append: Appends to the whitelist. An error is returned if…"},"SecurityIpGroupName":{"type":"string","description":"The name of the IP whitelist group to modify. Default value: default"},"SecurityIpGroupAttribute":{"type":"string","description":"The attribute of the whitelist group. The value can contain uppercase letters, lowercase letters, and digits. The maximum length is 120…"},"ClientToken":{"type":"string","description":"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":{"type":"string","description":"Specifies whether to perform a dry run. Valid values: true: performs a dry run without calling the operation. The system checks the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-srv-network-address":{"post":{"operationId":"cloud_aliyun_dds_modify_srv_network_address","summary":"Modifies the SRV connection address of a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","NewConnectionString","ConnectionType"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"NewConnectionString":{"type":"string","description":"The new connection address. The address must meet the following requirements: Starts with a lowercase letter. Ends with a lowercase letter…"},"ConnectionType":{"type":"string","enum":["VPC","Public"],"description":"The type of the SRV connection address to modify. Valid values: VPC: virtual private cloud (VPC) Public: Internet connection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/modify-task-info":{"post":{"operationId":"cloud_aliyun_dds_modify_task_info","summary":"Modifies the information of a task in the task center for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","TaskId","StepName","TaskAction"],"properties":{"RegionId":{"type":"string","description":"The region ID of the instance. You can call the https://help.aliyun.com/document_detail/61933.html operation to query the region ID"},"TaskId":{"type":"string","description":"The task ID. Separate multiple IDs with commas (,). You can specify up to 10 task IDs"},"StepName":{"type":"string","description":"The name of the step visible to the user"},"TaskAction":{"type":"string","description":"The action name that corresponds to the state described in the actionInfo parameter of the…"},"ActionParams":{"type":"string","description":"A action-related parameter. This parameter can be extended based on your business requirements. This parameter value varies with the value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/release-node-private-network-address":{"post":{"operationId":"cloud_aliyun_dds_release_node_private_network_address","summary":"Releases the internal endpoint of a shard or Configserver node for a sharded cluster instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the sharded cluster instance"},"NodeId":{"type":"string","description":"The ID of the shard or Configserver node. Call the https://help.aliyun.com/document_detail/62010.html API to query the ID of the shard or…"},"NetworkType":{"type":"string","description":"The network type of the internal endpoint for the node. Valid values: VPC: virtual private cloud. Classic: classic network. Call the…"},"ConnectionType":{"type":"string","description":"The type of the public endpoint. Valid values: SRV Normal This parameter is available only when the endpoint to be released is an SRV…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/release-public-network-address":{"post":{"operationId":"cloud_aliyun_dds_release_public_network_address","summary":"Releases the public endpoint of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter"},"NodeId":{"type":"string","description":"The ID of the mongos, shard, or Configserver node in the sharded cluster instance. This parameter is valid only if you set the…"},"ConnectionType":{"type":"string","description":"The public endpoint type. Valid values: SRV Normal This parameter is valid only when you want to release an SRV endpoint"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/renew-dbinstance":{"post":{"operationId":"cloud_aliyun_dds_renew_dbinstance","summary":"Manually renews an ApsaraDB for MongoDB subscription instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","Period"],"properties":{"ClientToken":{"type":"string","description":"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 make…"},"DBInstanceId":{"type":"string","description":"The instance ID"},"Period":{"type":"integer","description":"The subscription period of the instance. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36"},"AutoPay":{"type":"string","description":"Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. Make sure that you have sufficient balance…"},"BusinessInfo":{"type":"string","description":"The business information"},"CouponNo":{"type":"string","description":"Specifies whether to use coupons. Default value: null. Valid values: default or null: uses coupons.…"},"AutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal. Valid values: true false Default value: false"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/reset-account-password":{"post":{"operationId":"cloud_aliyun_dds_reset_account_password","summary":"Resets the password of a database account for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","AccountName","AccountPassword"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"AccountName":{"type":"string","description":"The name of the account whose password you want to reset. Set the value to root"},"AccountPassword":{"type":"string","description":"The new password. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits,…"},"CharacterType":{"type":"string","enum":["db","cs","normal"],"description":"The role type of the instance. If the instance is a sharded cluster instance, this parameter is required. Valid values: db and cs. If the…"},"DBName":{"type":"string","description":"The name of the database to which the account belongs. Default value: admin. The name must be 1 to 63 characters in length and cannot…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/restart-dbinstance":{"post":{"operationId":"cloud_aliyun_dds_restart_dbinstance","summary":"Restarts a MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"},"NodeId":{"type":"string","description":"The ID of the shard or mongos node in the sharded cluster instance. If you do not specify this parameter for a sharded cluster instance,…"},"SwitchMode":{"type":"string","enum":["0","1"],"description":"The time when the instance is restarted. Valid values: 0: Immediately. 1: Within the O&M window"},"NodeType":{"type":"string","enum":["db","mongos","cs"],"description":"The NodeType"},"ParallelRestartMongos":{"type":"string","description":"Specifies whether to restart mongos nodes in parallel. This parameter takes effect only when you restart multiple mongos nodes at a time"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/restart-node":{"post":{"operationId":"cloud_aliyun_dds_restart_node","summary":"Restarts a single node of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","RoleId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID. If the instance is a sharded cluster instance, you must also specify `NodeId`"},"NodeId":{"type":"string","description":"Instance ID of the Mongos node, Shard node, or ConfigServer node in the sharded cluster instance. You can call the…"},"RoleId":{"type":"string","description":"The role ID of the node. You can call the https://help.aliyun.com/document_detail/468469.html operation to query the node IDs of a replica…"},"SwitchMode":{"type":"string","enum":["0","1"],"description":"The execution time. Valid values: 0: immediately. This is the default value. 1: during the maintenance window. You can call the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/switch-dbinstance-ha":{"post":{"operationId":"cloud_aliyun_dds_switch_dbinstance_ha","summary":"Switches the primary and secondary nodes for an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"},"NodeId":{"type":"string","description":"The ID of the shard node in the sharded cluster instance. You must specify this parameter if you set the DBInstanceId parameter to the ID…"},"RoleIds":{"type":"string","description":"The IDs of the roles who switch the primary and secondary nodes for the instance. You can call the…"},"SwitchMode":{"type":"integer","enum":["0","1"],"description":"The time when the primary and secondary nodes are switched. Valid values: 0: The primary and secondary nodes are immediately switched. 1:…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/tag-resources":{"post":{"operationId":"cloud_aliyun_dds_tag_resources","summary":"Binds tags to ApsaraDB for MongoDB instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","ResourceType","ResourceId","Tag"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The resource type. Set the value to INSTANCE"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"},"ResourceId":{"type":"string","description":"The details of the tags bound to the instance (JSON-encoded)"},"Tag":{"type":"string","description":"The tags that are attached to the resources (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/transfer-cluster-backup":{"post":{"operationId":"cloud_aliyun_dds_transfer_cluster_backup","summary":"Switches the backup mode of an ApsaraDB for MongoDB sharded cluster instance to the cluster backup mode.…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/transform-instance-charge-type":{"post":{"operationId":"cloud_aliyun_dds_transform_instance_charge_type","summary":"Transforms the billing method of an ApsaraDB for MongoDB database instance by converting a pay-as-you-go…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","ChargeType"],"properties":{"InstanceId":{"type":"string","description":"The instance ID"},"Period":{"type":"integer","description":"The subscription duration. Valid values: If PricingCycle is set to Month: 1 to 9. If PricingCycle is set to Year: 1, 2, 3, and 5"},"AutoPay":{"type":"string","description":"Specifies whether automatic payment is enabled for the order. Valid values: true: enables automatic payment for the order. false: requires…"},"BusinessInfo":{"type":"string","description":"The additional parameter for business information"},"AutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal upon expiration. Valid values: true: enables auto-renewal. false: disables auto-renewal. Default…"},"CouponNo":{"type":"string","description":"Specifies whether to use a coupon. Valid values: default or null (default): uses a coupon. youhuiquan_promotion_option_id_for_blank: does…"},"ChargeType":{"type":"string","enum":["PrePaid","PostPaid","PREPAY","POSTPAY"],"description":"The billing method of the instance. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go"},"PricingCycle":{"type":"string","enum":["Month","Year"],"description":"The unit of the subscription duration. Valid values: Month: months. Year: years. Default value: Month"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/transform-to-pre-paid":{"post":{"operationId":"cloud_aliyun_dds_transform_to_pre_paid","summary":"Changes the billing method of an ApsaraDB for MongoDB instance from pay-as-you-go to subscription","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","Period"],"properties":{"InstanceId":{"type":"string","description":"The ID of the instance"},"Period":{"type":"integer","description":"The subscription duration of the instance. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36"},"AutoPay":{"type":"string","description":"Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. false: disables automatic payment. For more…"},"BusinessInfo":{"type":"string","description":"The business information. This is an additional parameter"},"AutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal for the instance. Valid values: true false Default value: false"},"CouponNo":{"type":"string","description":"The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/untag-resources":{"post":{"operationId":"cloud_aliyun_dds_untag_resources","summary":"Removes a tag if the tag is not added to another instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","ResourceType","ResourceId"],"properties":{"RegionId":{"type":"string","description":"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":{"type":"string","description":"The resource type. Set the value to INSTANCE"},"All":{"type":"string","description":"Specifies whether to remove all tags from the instances. Valid values: true: removes all tags from the instances. false: does not remove…"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"},"ResourceId":{"type":"string","description":"The resource IDs (JSON-encoded)"},"TagKey":{"type":"string","description":"The tag keys of the resource (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/upgrade-dbinstance-engine-version":{"post":{"operationId":"cloud_aliyun_dds_upgrade_dbinstance_engine_version","summary":"Upgrades the database version of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId","EngineVersion"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"},"EngineVersion":{"type":"string","enum":["3.4","4.0","4.2","4.4","5.0","6.0","7.0","8.0","8.3"],"description":"The database version to which you want to upgrade. Valid values: 3.4, 4.0, and 4.2. This database version must be later than the current…"},"SwitchMode":{"type":"integer","enum":["0","1"],"description":"The time when to perform the upgrade. Valid values: 0: immediately performs the upgrade. 1: performs the upgrade during the maintenance…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/upgrade-dbinstance-kernel-version":{"post":{"operationId":"cloud_aliyun_dds_upgrade_dbinstance_kernel_version","summary":"Upgrades the minor version of an ApsaraDB for MongoDB instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DBInstanceId"],"properties":{"DBInstanceId":{"type":"string","description":"The ID of the instance"},"SwitchMode":{"type":"string","enum":["0","1"],"description":"The time when to perform the upgrade. Valid values: 0: immediately performs the upgrade. 1: performs the upgrade during the maintenance…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dds/version":{"post":{"operationId":"cloud_aliyun_dds_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}