alibabacloud-mongodb-instances-manage

Alibaba Cloud MongoDB インスタンス管理

Alibaba Cloud ApsaraDB for MongoDB インスタンス（スタンドアロン（開発／テスト用）、レプリカセット（読み取り負荷の高い用途）、シャーディングクラスター（高い同時実行性））を作成、管理します。

インストール要件

事前確認：Aliyun CLI >= 3.3.3 が必要です aliyun version を実行して、バージョンが 3.3.3 以上であることを確認してください。インストールされていない場合、またはバージョンが低い場合は、 references/cli-installation-guide.md を参照してインストールしてください。

[MUST] 自動プラグインインストールを有効にするには、aliyun configure set --auto-plugin-install true を実行してください。 [MUST] 既存のプラグインを常に最新の状態に保つため、aliyun plugin update を実行してください。

aliyun version
aliyun plugin install --names dds kms resourcemanager bssopenapi

[MUST] CLI User-Agent — aliyun CLI コマンドを実行するたびに、次を含める必要があります： --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

[MUST] AI モードを有効にする — エージェントスキルの実行には AI モードが必要です。 CLI コマンドを実行する前に、次のコマンドを実行してください：

aliyun configure ai-mode enable
aliyun configure ai-mode set-user-agent --user-agent "AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage"

[MUST] あらゆる終了時に AI モードを無効にする — どのような理由であっても最終回答を提示する前に、必ず最初に AI モードを無効にしてください。これは、ワークフローの成功、ワークフローの失敗、エラー／例外、ユーザーによるキャンセル、セッション終了、または以後 CLI コマンドを実行しないその他すべてのケースに適用されます。

aliyun configure ai-mode disable

情報表示の基準

[MUST] ユーザーに表示するすべての情報は、次の要件に従う必要があります：

1. 出力を捏造しない：表示する情報はすべて、実際の API クエリ結果に基づいている必要があります。推測、捏造、つなぎ合わせは固く禁じられています
2. 切り捨てへの対応：API レスポンスが切り捨てられている場合（省略されている場合など）、表示する前に再クエリして完全な結果を取得する必要があります
3. 件数の検証：表示する件数は、API が返した TotalCount／実際の件数と一致している必要があります
4. 時間の推測をしない：公式ドキュメントに根拠がない時間の見積もりは提示しないでください。API ポーリングでステータスのみを確認してください
5. 書き込み操作後の応答基準：書き込み操作（作成、仕様の変更、クラウドディスクの再構成、ノードの追加／削除など）を実行した後は、RequestId（および利用可能な場合は DBInstanceId／OrderId）のみを表示し、インスタンスのステータスをポーリングするかどうかをユーザーに尋ねてください。ユーザーの確認前に自動でポーリングを開始しないでください。
6. インスタンス作成後の自動ポーリング規則：
   • 新しく作成したインスタンスが Running ステータスになるまで、通常 10～25 分かかります
   • シナリオ A：ユーザーがインスタンスを作成するだけで、後続の操作がない場合 → ポーリングするかどうかを尋ねてください
   • シナリオ B：作成後に後続の操作（仕様変更、ホワイトリストの設定など）があり、ユーザーがステータスを手動で確認すると明示していない場合 → describe-db-instance-attribute を 30 秒ごとにクエリし、ステータスが Running になるかタイムアウト（30 分）するまで必ず自動でポーリングしてください
   • シナリオ C：ユーザーが「自分で確認します」「後で対応します」などと明示している場合 → 自動でポーリングせず、シナリオ A として処理してください
7. インスタンス作成後のセキュリティ設定に関する案内：インスタンスの作成が完了した後（ステータスが Running になった後）、セキュリティ設定を行うかどうかを必ず積極的に尋ねてください（「パラメーターの確認」セクションのセキュリティ設定メニューを参照）
8. サブスクリプションインスタンスの表示：残り日数を表示してください。10 日以内に期限が切れるインスタンスについては、一覧の下に警告を表示し、更新を案内してください

インスタンスステータスの事前確認基準

[MUST] クエリ以外の操作を実行する前に、インスタンスステータスを確認する必要があります：

1. describe-db-instance-attribute を呼び出して DBInstanceStatus を確認します
2. ステータスが Running の場合にのみ操作を実行できます

ステータス	説明	実行可否
Running	実行中	✅
DBInstanceClassChanging	仕様を変更中	❌
NodeCreating / NodeDeleting	ノードを作成／削除中	❌
Creating	作成中	❌
Locked	ロック中	❌ 先に原因を調査します

Locked ステータスの診断（LockMode フィールドを確認します）：

• LockByDiskQuota：ディスク使用量が上限を超えています。ストレージの拡張またはデータのクリーンアップ後に自動的にロックが解除されます
• その他の値：料金の未払い、または有効期限切れです。更新またはチャージしてください

aliyun dds describe-db-instance-attribute --db-instance-id <id> --region <region> \
  --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage 2>&1 | grep '"DBInstanceStatus"'

認証

事前確認：Alibaba Cloud の認証情報が必要です

• AK/SK の値を読み取ったり、エコーしたり、出力したりしてはなりません（echo $ALIBABA_CLOUD_ACCESS_KEY_ID は実行しないでください）
• 認証情報の状態の確認には aliyun configure list のみを使用してください

aliyun configure list

有効なプロファイルがない場合は、RAM コンソールから認証情報を取得し、このセッション外で設定してください。

RAM 権限

このスキルには、以下の RAM 権限が必要です。完全なリストについては、references/ram-policies.md § Full Permission Quick Referenceを参照してください。

[MUST] 権限エラーへの対応： Forbidden.RAM／NoPermission／Forbidden／SubAccountNoPermission を検出した場合：

1. 不足している権限を特定します（エラーメッセージから Action と Resource を抽出します）
2. 権限を申請するため、references/ram-policies.md を参照するようユーザーに案内します
3. 再試行する前に、権限が付与されたことをユーザーが確認するまで待機します。権限の問題が解決する前に実行を続行してはなりません

---

リージョンとインスタンスの照会

[MUST] リージョン確認基準：

1. ユーザーがリージョンを指定していない場合は、まずリージョンを尋ねてください。リージョンを順に検索してはなりません
2. ユーザーが明示的に不明だと述べた場合に限り、次の順序で検索します：cn-beijing → cn-shanghai → ap-southeast-1 → us-west-1 → us-east-1 → cn-hangzhou → cn-shenzhen → cn-chengdu → cn-hongkong。それでも見つからない場合は DescribeRegions を呼び出して、残りのリージョンを取得します
3. クエリのルーティング：cn-hangzhou 経由のクエリで、他のリージョンのインスタンスが返される場合があります。表示時には、クエリパラメーターではなく、API が返す RegionId フィールドに基づいて RegionId を設定してください
4. 一覧表示：インスタンスタイプごとに分類する必要があります。サブスクリプションインスタンスには残り日数を表示し、有効期限まで10日以内のインスタンスには一覧の下に警告を表示して、更新するよう案内してください

# Query instance list
# If user specifies instance type, query that type only; if not specified, must query both types separately:
aliyun dds describe-db-instances --biz-region-id <region> --db-instance-type replicate --page-size 50 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
aliyun dds describe-db-instances --biz-region-id <region> --db-instance-type sharding --page-size 50 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# ⚠️ Without --db-instance-type, only replicate is returned by default; sharded clusters will be missed

# Query single instance details
aliyun dds describe-db-instance-attribute --db-instance-id <id> --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

# Query all supported regions
aliyun dds describe-regions --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

リージョンをまたいだ検索スクリプトと全リージョンのスキャンスクリプトについては、references/operations.md § Query Regions and Instancesを参照してください

パラメーターの確認

[MUST] 作成または変更操作を実行する前に、パラメーターの完全な一覧をユーザーに表示し、Y/Yes の確認を得る必要があります

ワークフロー： パラメーターを収集 → パラメーター一覧を表示 → Y の確認を待機 → 実行 → RequestId／DBInstanceId のみを表示 → ポーリングするかどうかを尋ねる → 完了後にセキュリティ設定の案内を表示

インスタンス作成後に、セキュリティ設定の案内メニューを表示する必要があります：

[0] Set root password         - Cannot connect without password (priority)
[1] Set IP whitelist          - Configure allowed access IPs
[2] Bind ECS security group   - Control access via security group
[3] Associate global whitelist template - Use unified whitelist template
[4] Modify maintenance window - Set maintenance window
[5] Allocate public address   - Enable public access (dev/test only)
[N] Skip

パラメーター確認の完全な形式と必須／任意パラメーターの表については、references/operations.md § Parameter Confirmationを参照してください

コアワークフロー

ステップ	名前	種類	説明
0	リソースグループの作成	任意	リソースグループの管理が必要な場合に実行します
0.5	KMS インスタンスの作成	任意	クラウドディスクの暗号化が必要な場合に実行します
1	VPC／VSwitch の照会	任意	ユーザーが VPC を指定していない場合に実行します
2	VPC／VSwitch の検証	必須	VPC／VSwitch が利用可能であることを確認します
3	ゾーンの検証	スタンドアロンでは必須	対象ゾーンがスタンドアロンをサポートしていることを確認します
4	パラメーターの確認	必須	作成前に必ず確認します
5	インスタンスの作成	必須	コア操作です
6	作成の確認	必須	インスタンスの作成が成功したことを確認します

ステップ	スキップ条件
リソースグループの作成	デフォルトのリソースグループを使用する場合
KMS インスタンスの作成	デフォルトのキーを使用する場合、または暗号化しない場合
VPC／VSwitch の照会	ユーザーがすでに VPC／VSwitch ID を指定している場合（ただし、検証は引き続き必須です）
ゾーンの検証	レプリカセットまたはシャーデッドクラスターのインスタンスを作成する場合

[MUST] ユーザーが VPC／VSwitch を指定した場合の必須検証： ユーザーが VPC ID と VSwitch ID を指定していても、正確性と利用可能性を検証するため、必ず最初に次の API を呼び出してください：

1. describe-rds-vpcs：VPC ID が存在し、利用可能かどうかを検証します
2. describe-rds-vswitchs：VSwitch ID が指定された VPC 内に存在し、対象ゾーンと一致するかどうかを検証します
3. 検証に失敗した場合は、具体的なエラーをユーザーに伝え、修正方法を案内してください。未検証の VPC／VSwitch を使ってインスタンスを直接作成してはいけません

[MUST] VPC／VSwitch の検証には DDS 専用 API を使用してください。汎用の VPC API（vpc DescribeVpcs／vpc DescribeVSwitches）は禁止されています：

# Step 1: Query available VPC list for specified zone (DDS-specific)
aliyun dds describe-rds-vpcs --zone-id <zone> --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

# Step 2: Query available VSwitches under specified VPC (DDS-specific)
aliyun dds describe-rds-vswitchs --vpc-id <vpc-id> --zone-id <zone> --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

詳細なコマンドとパラメーターについては、references/operations.md § Step 2: Query and Validate VPC and VSwitch を参照してください

レプリカセットインスタンスの作成

• --db-instance-class は describe-available-resource を使って照会する必要があります（仕様はリージョン／ゾーン／バージョン／ストレージタイプによって異なります）
• --zone-id は --vswitch-id のゾーンと一致させる必要があります。一致しない場合、InvalidVpcIdRegion.NotSupported エラーが発生します
• マルチゾーン配置には --secondary-zone-id と --hidden-zone-id が必要です

aliyun dds create-db-instance \
  --biz-region-id <region> --zone-id <zone> --engine-version <ver> \
  --db-instance-class <class> --db-instance-storage <GB> \
  --vpc-id <vpc> --vswitch-id <vsw> --network-type VPC \
  --replication-factor 3 --storage-type cloud_essd1 --charge-type PostPaid \
  --db-instance-description <name> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Optional: --secondary-zone-id --hidden-zone-id --readonly-replicas --encryption-key --resource-group-id
# Subscription: --charge-type PrePaid --period 1 --auto-renew true

スタンドアロンインスタンスの作成

• --replication-factor 1 --db-type replicate を指定します。ストレージタイプは cloud_essd1 固定です
• スタンドアロン専用の仕様（dds.sn2.large.1 のように .1 で終わるもの、または .single を含むもの）を使う必要があります。レプリカセットの仕様は使用できません
• 一部のリージョン／ゾーンではサポートされていません。作成前に describe-available-resource --replication-factor 1 で照会する必要があります
• InvalidDBInstanceNodeCount エラーが発生した場合は、別のゾーンを試すか、レプリカセットへの切り替えを提案してください

aliyun dds create-db-instance ... --db-type replicate --replication-factor 1 \
  --db-instance-class <standalone-specific-spec> --storage-type cloud_essd1 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

シャーデッドクラスターインスタンスの作成

• Mongos は最低 2 台、Shard は最低 2 台必要です（最大 32 台）。各 Shard はデフォルトで 3 ノードのレプリカセットです
• --mongos／--replica-set パラメーターは繰り返し指定する必要があります（1 回につき 1 ノードを指定します）
• シャーデッドクラスターの仕様を照会するには --db-type sharding を使用します（--db-type normal はレプリカセット専用です）

aliyun dds create-sharding-db-instance \
  --biz-region-id <region> --zone-id <zone> --engine MongoDB --engine-version <ver> \
  --vpc-id <vpc> --vswitch-id <vsw> --network-type VPC \
  --mongos Class=<class> --mongos Class=<class> \
  --replica-set Class=<class> ReadonlyReplicas=0 Storage=20 \
  --replica-set Class=<class> ReadonlyReplicas=0 Storage=20 \
  --config-server Class=<class> Storage=20 \
  --storage-type cloud_essd1 --charge-type PostPaid --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

インスタンス作成エラーの診断

エラー診断テーブルについては、references/operations.md § Instance Creation Error Diagnosis を参照してください

レプリカセットインスタンスの構成変更

【必須】変更前に実施すること：

1. 現在の構成（describe-db-instance-attribute）を照会し、DBInstanceStatus／DBInstanceClass／DBInstanceStorage／ReplicationFactor／ReadonlyReplicas／StorageTypeを抽出します
2. 「現在と変更後」の比較表を表示し、ユーザーからYの確認を得ます
3. ユーザーの確認前に変更コマンドを実行してはいけません

制限事項： ストレージの縮小、インスタンスタイプの変更、ストレージタイプの変更には対応していません（ESSDへの変換には、「クラウドディスクの再構成」セクションを使用してください） 影響： 変更によって、約30秒の短時間の切断が1～2回発生する可能性があります。オフピーク時間帯の実施を推奨します

変更コマンドの実行に成功した後は、RequestId／OrderIdのみを表示します。**自動ポーリングは行わないでください。**開始前に、必ずユーザーに確認してください

aliyun dds modify-db-instance-spec --db-instance-id <id> \
  [--db-instance-class <class>] [--db-instance-storage <GB>] \
  [--replication-factor 3/5/7] [--readonly-replicas 0-5] \
  [--order-type UPGRADE/DOWNGRADE] [--auto-pay true] \
  --effective-time Immediately/MaintainTime --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

パラメーターの詳細については、references/operations.md § レプリカセットインスタンスの変更を参照してください

インスタンスの削除

**【必須】**削除前のチェックリスト：

1. ChargeTypeを確認します。PostPaid → 削除可能、PrePaid → 直接削除できません（有効期限を待つか、コンソールから返金を申請してください）
2. クラウドディスクインスタンスのみ： describe-backup-policyを照会し、BackupRetentionPolicyOnClusterDeletionを確認します（0＝リリース時にすべて削除／1＝最新のバックアップを保持／2＝すべてのバックアップを保持）。削除前に、modify-backup-policy --backup-retention-policy-on-cluster-deletionを使用して変更するかどうかをユーザーに確認してください。詳しくはoperations.mdを参照してください
3. **【必須】**インスタンスID、リージョン、課金タイプ、取り消しできないデータ損失に関する警告をユーザーに表示し、実行前にユーザーが「confirm delete {instance ID}」と返信するよう求めてください

aliyun dds delete-db-instance --db-instance-id <id> --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

シャーデッドクラスターのノード管理

【必須】主な制限事項：

• Mongos／Shardをそれぞれ最低2つ、最大32個維持する必要があります
• 新しいShardの構成（スペックとストレージ）は、既存Shardのうち最も高い構成以上である必要があります
• modify-node-specは厳密に逐次実行する必要があります。次の変更を開始する前に、前の変更が完了する（Running）まで待機してください
• 一括変更のmodify-node-spec-batchでは、Shardの読み取り専用レプリカ数の変更に対応していません。代わりに個別に変更してください
• 複数のShardを変更する場合は、スペックの割り当てと実行順序をユーザーに確認する必要があります
• NodesInfoのStorageは数値型である必要があります（文字列の場合、InvalidParameterエラーになります）

# Query sharded cluster node details (ShardList/MongosList contain NodeId)
aliyun dds describe-db-instance-attribute --db-instance-id <id> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

# Add single node
aliyun dds create-node --db-instance-id <id> --node-type mongos/shard --node-class <class> [--node-storage <GB>] --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

# Batch add nodes (JSON format)
aliyun dds create-node-batch --db-instance-id <id> --nodes-info '{"Shards":[{"DBInstanceClass":"spec","Storage":40}],"Mongos":[{"DBInstanceClass":"spec"}]}' --auto-pay true --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

# Single node modification (strictly serial)
aliyun dds modify-node-spec --db-instance-id <id> --node-id <node-id> --node-class <class> [--node-storage <GB>] [--readonly-replicas 0-5] --effective-time Immediately/MaintainTime --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

# Batch modification (does not support readonly replica changes, requires DBInstanceName)
aliyun dds modify-node-spec-batch --db-instance-id <id> --nodes-info '{"Shards":[{"DBInstanceClass":"spec","DBInstanceName":"d-xxx","Storage":40}]}' --auto-pay true --effective-time Immediately --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

# Release node
aliyun dds delete-node --db-instance-id <id> --node-id <node-id> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

詳細なコマンド例とNodesInfoの形式については、references/operations.md § シャーデッドクラスターのノード管理を参照してください

クラウドディスクの再構成（ディスクタイプのアップグレード）

**【必須】**インスタンススペックの変更とは独立しており、ディスクタイプの変更またはプロビジョンドIOPSの調整に使用します：

• ESSD PL1／PL2／PL3からESSD AutoPL（cloud_auto）への変更のみ対応しており、一方向で元に戻せません
• 前提条件：レプリカセットのストレージが40GB超、シャーデッドクラスターのShardストレージが40GB超
• プロビジョンドIOPSの範囲：0～50000。2回の変更の間隔は1時間超である必要があります
• 実行前にMaxIOPS／MaxMBPS／StorageTypeを照会して表示し、ユーザーからYの確認を得る必要があります
• ユーザーの確認前に実行してはいけません

aliyun dds modify-db-instance-disk-type --db-instance-id <id> \
  --db-instance-storage-type cloud_auto [--provisioned-iops <0~50000>] \
  --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

パラメーターの詳細については、references/operations.md § クラウドディスクの再構成を参照してください

IOPSとスループットの計算ルール

【必須】クラウドディスクインスタンスのみに適用されます（ローカルディスクには適用されません）：

• ベースラインのIOPS／スループットを表示する際は、APIが返すMaxIOPS／MaxMBPSフィールドを使用する必要があります。式で計算した値は使用しないでください（実際の値は式による計算値以上です）
• 計算式（参考）：IOPS = min{1800+50×StorageGB, spec limit, disk type limit}
• IOPSを改善する際の優先順位：ストレージの拡張 ＞ スペックのアップグレード ＞ ディスクタイプの変更

スペック上限の全一覧と計算例については、references/operations.md § IOPSとスループットの計算ルールを参照してください

ルートパスワードのリセット

[MUST] シャーデッドクラスターの場合、パスワードをリセットする前に必ずユーザーに確認してください：

どのノードタイプのパスワードをリセットしますか？
[1] db ノード（mongod、業務データを保存）
[2] cs ノード（configServer、クラスターのメタデータを保存）
[3] 両方をリセット（個別に 2 回実行）

ユーザーの回答に基づいて実行回数を決定してください。ユーザーの確認なしに 2 回自動実行してはいけません

パスワードのルール： 8～32 文字で、次のうち 3 種類以上を含める必要があります：大文字、小文字、数字、特殊文字（!@#$%^&*()_+-=）

# Replica set / Standalone
aliyun dds reset-account-password --db-instance-id <id> --account-name root \
  --account-password <pwd> --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

# Sharded cluster (--character-type db or cs, required)
aliyun dds reset-account-password --db-instance-id <id> --account-name root \
  --account-password <pwd> --character-type db --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

---

インスタンスのセキュリティ設定

IP ホワイトリストの管理

[MUST] ホワイトリストを変更する前に：

1. まず現在のホワイトリスト（describe-security-ips）を照会し、ユーザーに表示します
2. 変更モードを尋ねます：Cover（上書き、⚠️既存の IP を削除）／Append（追加、重複する IP があるとエラー）／Extend（拡張、推奨）
3. ユーザーに尋ねずに Cover モードを使用してはいけません

aliyun dds describe-security-ips --db-instance-id <id> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
aliyun dds modify-security-ips --db-instance-id <id> --security-ips <IPs> --modify-mode Extend --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Specify group: add --security-ip-group-name <name>

ECS セキュリティグループの管理

注： シャーデッドクラスターにバインドされた ECS セキュリティグループは、Mongos ノードにのみ適用されます。

aliyun dds modify-security-group-configuration --db-instance-id <id> --security-group-id <sg-id> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
aliyun dds describe-security-group-configuration --db-instance-id <id> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

グローバルホワイトリストテンプレートの管理

[MUST] すべてのグローバルホワイトリストコマンドでは、--region と --biz-region-id の両方を指定する必要があります（同じ値） インスタンスとの関連付けには、--db-instance-id ではなく --db-cluster-id を使用します

# Create
aliyun dds create-global-security-ip-group --biz-region-id <region> --region <region> --global-ig-name <name> --gip-list <IPs> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Query
aliyun dds describe-global-security-ip-group --biz-region-id <region> --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Associate with instance
aliyun dds modify-global-security-ip-group-relation --db-cluster-id <id> --global-security-group-id <gid> --biz-region-id <region> --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

---

パブリックネットワークアドレスの管理

[MUST] SRV アドレスの前提条件： （1）クラウドディスクのみ対応します。（2）パブリック SRV の場合、先にパブリックアドレスを割り当てます。（3）シャーデッドクラスターの場合、先に Mongos ノード（--node-id <s-xxx>）にパブリックアドレスを割り当てます。（4）各手順の間で Running になるまで待ちます

シャーデッドクラスターのパブリック SRV の確認フロー： describe-sharding-network-address → パブリックアドレスがなければ → allocate-public-network-address --node-id <mongos-s-xxx> → Running になるまで待機 → allocate-db-instance-srv-network-address --srv-connection-type public → Running になるまで待機 → srv を含む NodeType=logic を確認

[MUST] ネットワークアドレス照会の API 選択ルール：

• レプリカセット：describe-replica-set-role を必ず使用します
• シャーデッドクラスター：describe-sharding-network-address を必ず使用します
• 禁止：ネットワークアドレスの照会に describe-db-instance-attribute を使用してはいけません。シャーデッドクラスターの完全なネットワーク情報は返されません。結果では、NetworkType=Public はパブリックを、NodeType=logic と ConnectionType=SRV の組み合わせは SRV アドレスを表します

# Allocate public address (add --node-id <s-xxx> for sharded clusters)
aliyun dds allocate-public-network-address --db-instance-id <id> [--node-id <s-xxx>] --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Release non-SRV public address
aliyun dds release-public-network-address --db-instance-id <id> [--node-id <s-xxx>] --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Release SRV public address (sharded cluster MUST use --node-id <mongos-id> + --connection-type SRV; omitting either causes InvalidParameters.Format)
aliyun dds release-public-network-address --db-instance-id <id> --node-id <s-xxx> --connection-type SRV --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Allocate SRV address (vpc=private, public=public; public SRV requires public network address first)
aliyun dds allocate-db-instance-srv-network-address --db-instance-id <id> --srv-connection-type vpc/public --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Query (replica set)
aliyun dds describe-replica-set-role --db-instance-id <id> --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Query (sharded cluster)
aliyun dds describe-sharding-network-address --db-instance-id <id> --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

---

インスタンスの更新管理

更新はサブスクリプションインスタンスにのみ適用されます。自動更新は翌日から有効になり、有効化した当日に料金は発生しません。料金の再試行スケジュールについては、references/operations.md を参照してください。

# Manual renewal (--period: 1~9, 12, 24, 36 months)
aliyun dds renew-db-instance --db-instance-id <id> --period <months> --auto-pay true --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Enable auto-renewal (--duration required, in months)
aliyun dds modify-instance-auto-renewal-attribute --db-instance-id <id> --auto-renew true --duration 1 --biz-region-id <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Disable auto-renewal
aliyun dds modify-instance-auto-renewal-attribute --db-instance-id <id> --auto-renew false --biz-region-id <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

インスタンスの課金タイプの変換

前提条件：インスタンスのステータスが Running であり、レガシー仕様ではないこと [MUST] transform-instance-charge-type を使用してください（TransformToPrePaid は使用してはいけません。この API は禁止されています）

# Pay-As-You-Go → Subscription
aliyun dds transform-instance-charge-type --instance-id <id> --charge-type PrePaid --period 1 --pricing-cycle Month --auto-pay true --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage
# Subscription → Pay-As-You-Go (no period needed, may involve refund)
aliyun dds transform-instance-charge-type --instance-id <id> --charge-type PostPaid --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

インスタンスのメンテナンス時間帯の管理

aliyun dds modify-db-instance-maintain-time --db-instance-id <id> --maintain-start-time "01:00Z" --maintain-end-time "02:00Z" --user-agent AlibabaCloud-Agent-Skills/alibabacloud-mongodb-instances-manage

---

追加操作

[MUST] 以下のすべての操作では、インスタンスのステータスが Running である必要があります。書き込み操作の応答標準（§ 情報表示基準、項目 5）に従ってください。 CLI コマンドとパラメーターの詳細については、references/operations.md § 追加操作を参照してください。

操作	CLI コマンド	主な制約
インスタンスの再起動	restart-db-instance	[MUST] 実行前に、インスタンス ID と、約 30 秒間接続が切断されることをユーザーに確認してください。オフピーク時の実行を推奨します
ノードの再起動	restart-node --node-id --role-id	[MUST] 実行前に、インスタンス ID と対象ノード（RoleType/RoleId）をユーザーに確認してください。クラウドディスクのみ（StorageType=cloud_*）に対応し、ローカルディスクでは InsType.NotSupport が返されます。describe-role-zone-info で RoleId を取得してください（Hidden を含みます）。describe-replica-set-role には Hidden は含まれません。シャーディングクラスターでは --node-id（例：d-xxx）と --role-id の両方が必要です
手動バックアップ	create-backup --backup-method	クラウドディスクでは --backup-method Snapshot の指定が必須です。ローカルディスクでは Physical/Logical を指定します。クラウドディスクのレプリカセット／シャーディングクラスターでは --backup-retention-period（7～730、または -1 で永久保存）が必要です。応答では BackupJobId を使用してください（非推奨の BackupId は使用しないでください）。describe-backup-tasks でポーリングした後、describe-backups --backup-job-id で照会してください。operations.md を参照してください
バックアップの照会	describe-backups --start-time --end-time	時刻の形式：yyyy-MM-ddTHH:mmZ（UTC）。応答：Backups.Backup[]。ジョブで絞り込むには --backup-job-id を指定します
バックアップポリシーの照会	describe-backup-policy	保持日数とバックアップ時間帯を確認します
バックアップポリシーの変更	modify-backup-policy	[MUST] 他のフィールドのみを変更する場合も、常に --preferred-backup-time と --preferred-backup-period の両方を指定してください（必須）。まず describe-backup-policy で現在の値を照会してください。シャーディングクラスターではログバックアップを無効にできません
メジャーバージョンのアップグレード	upgrade-db-instance-engine-version	一方向の操作で、元に戻せません。まず利用可能なバージョンを照会してください
カーネルバージョンのアップグレード	upgrade-db-instance-kernel-version	レプリカセットとシャーディングクラスターのみ対応します（スタンドアロンは対象外です）
HA スイッチオーバー	switch-db-instance-ha	[MUST] まず describe-role-zone-info でノードを照会してください。ロールを入れ替える2 つのノード（例：Primary↔Secondary、Secondary↔Hidden など）をユーザーに確認してください。シャーディングクラスターでは --node-id が必須です
アカウントの作成	create-account	クラウドディスクのシャーディングクラスターのみ対応します。名前は小文字で 3～16 文字です
アカウントの照会	describe-accounts	データベースアカウントを一覧表示します
タグのバインド	tag-resources --resource-type INSTANCE	--resource-id にはスペース区切りのリストを指定します。--tag Key=<k> Value=<v> は繰り返し指定できます。インスタンスあたり最大 20 個のタグを設定できます。--biz-region-id を使用してください。operations.md を参照してください
タグのバインド解除	untag-resources --resource-type INSTANCE	指定したタグキーを削除します
タグの照会	list-tag-resources --resource-type INSTANCE	[MUST] タグの照会 API として list-tag-resources のみを使用してください。禁止事項：代替手段として DescribeDBInstances の Tags フィールドや describe-tags を使用しないでください

CLI で利用できない機能

機能	説明
KMS インスタンスの有効化	KMS インスタンスの作成後、KMS Console で有効化し、VPC/VSwitch を設定する必要があります
無料トライアルの申し込み	Alibaba Cloud Free Trial ページから申し込む必要があります

検証方法

詳細については、references/verification-method.md を参照してください。

ベストプラクティス

詳細については、references/operations.md § ベストプラクティス を参照してください。

参考資料

参考資料	説明
references/operations.md	詳細なCLIコマンド例、パラメータ表、IOPS計算仕様表
references/related-apis.md	外部ドキュメントへのリンクを含む、APIおよびCLIコマンドの完全な一覧
references/ram-policies.md	RAM権限ポリシー
references/verification-method.md	検証方法
references/cli-installation-guide.md	CLIのインストールガイド
references/acceptance-criteria.md	テストの受け入れ基準