この API は、MongoDB インスタンスのデータベースアカウントの情報をクエリする場合に呼び出すことができます。
注 この API では、ルートアカウントの情報のみをクエリできます。
デバッグ
OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。
リクエストパラメータ
| パラメータ | データ型 | 必須 | 例 | 説明 |
|---|---|---|---|---|
| DBInstanceId | String | はい | dds-bpxxxxxxxx |
インスタンス ID。 |
| Action | String | いいえ | DescribeAccounts |
実行する操作。 値を DescribeAccounts に設定します。 |
| AccountName | String | いいえ | root |
アカウントの名前。 値を root に設定します。 |
| AccessKeyId | String | いいえ | LTAIgbTGpxxxxxx |
Alibaba Cloud から提供された AccessKey ID。 |
レスポンスパラメータ
| パラメータ | タイプ | 例 | 説明 |
|---|---|---|---|
| アカウント |
データベースアカウントの詳細リスト。 |
||
| └AccountDescription | String | Administrator |
アカウントの説明。 |
| └AccountName | String | root |
アカウントの名前。 |
| └AccountStatus | String | Available |
アカウントの状態。
|
| └DBInstanceId | String | dds-bpxxxxxxxx |
アカウントが属するインスタンスの名前。 |
| RequestId | String | B562A65B-39AB-4EE8-8635-5A222054FB35 |
リクエスト ID。 |
例
リクエストの例
http(s)://mongodb.aliyuncs.com/? Action=DescribeAccounts
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>
通常のレスポンスの例
XML 形式
<DescribeAccountsResponse>
<Accounts>
<Account>
<AccountStatus>Available</AccountStatus>
<AccountDescription>Administrator</AccountDescription>
<DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>
<AccountName>root</AccountName>
</Account>
</Accounts>
<RequestId>A806B0FC-CFCC-48D8-8AEC-34C892806B40</RequestId>
</DescribeAccountsResponse>
JSON 形式
{
"Accounts":{
"Account":[
{
"AccountStatus":"Available",
"AccountDescription":"Administrator",
"DBInstanceId":"dds-bpxxxxxxxx",
"AccountName":"root"
}
]
},
"RequestId":"A806B0FC-CFCC-48D8-8AEC-34C892806B40"
}