この API を呼び出して、MongoDB インスタンスのログ監査機能が有効になっているかどうかをクエリできます。
この API を呼び出す際に、インスタンスは実行中の状態にある必要があります。
注 この API は、レプリカセットインスタンスとシャードクラスタインスタンスの両方をサポートします。 DescribeAuditPolicy は、スタンドアロンインスタンスでは実行できません。
デバッグ
OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。
リクエストパラメータ
パラメータ | データ型 | 必須 | 例 | 説明 |
---|---|---|---|---|
Action | String | はい | DescribeAuditPolicy |
実行する操作。 値を DescribeAuditPolicy に設定します。 |
DBInstanceId | String | はい | dds-bpxxxxxxxx |
インスタンス ID。 |
AccessKeyId | String | いいえ | LTAIgbTGpxxxxxx |
Alibaba Cloud から提供された AccessKey ID。 |
レスポンスパラメータ
パラメータ | タイプ | 例 | 説明 |
---|---|---|---|
LogAuditStatus | String | Enable |
ログ監査機能の状態。 有効値:
デフォルト値: Disabled。 |
RequestId | String | 111E7B16-0A87-4CBA-B271-F34AD61E099F |
リクエスト ID。 |
例
リクエストの例
http(s)://mongodb.aliyuncs.com/? Action=DescribeAuditPolicy
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>
通常のレスポンス例
XML
形式
<DescribeAuditPolicyResponse>
<LogAuditStatus>Enable</LogAuditStatus>
<RequestId>111E7B16-0A87-4CBA-B271-F34AD61E099F</RequestId>
</DescribeAuditPolicyResponse>
JSON
形式
{
"LogAuditStatus":"Enable",
"RequestId":"111E7B16-0A87-4CBA-B271-F34AD61E099F"
}