すべての S3 ブロックストア構成を取得する

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答ドキュメント
results embeddedDocument
リクエストの例
応答例
応答ヘッダー
レスポンス本体

すべての s3 ブロックストアの構成を取得します。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

Resource

GET /snapshot/s3Configs

リクエストパスパラメーター

このエンドポイントは、HTTP リクエストパスパラメーターを使用しません。

リクエストクエリパラメータ

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope : true`を設定します。結果のリストを返すエンドポイントの場合、 `content`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`

assignableOnly	ブール値	この S3 ブロックストアに新しいバックアップジョブを割り当てることができるかどうかを示すフラグ。	`true`

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、 `results`埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つの S3 ブロックストアです。

名前

タイプ

説明

acceptTos

ブール値

MongoDB Ops Managerで S3 互換ストレージを使用するためのサービス利用規約に同意したかどうかを示すフラグ。 S3 互換ストレージストアを作成するには、これをtrueに設定する必要があります。

割り当てEnabled

ブール値

このデータストアにバックアップジョブを割り当てられるかどうかを示すフラグ。

awsAccessKey

string

s3bucketName で指定された S3 互換ストレージバケットにアクセスできるアクセスAmazon Web Services キーID 。

awsSecretKey

string

Amazon Web Servicesシークレットアクセスキー。 s3bucketNameで指定された S3 互換ストレージバケットにアクセスできます。

customCertificates

配列

関連付けられている S3 互換ストレージバケットに適用される有効な証明機関証明書のリスト。

customCertificates[n].filename

string

認証局PEMファイルを識別する名前。

customCertificates[n].certString

string

証明機関チェーンを構成する証明機関PEMファイルの内容。

disableProxyS3

ブール値

S3 互換ストレージに接続するときに HTTP proxyを使用するかどうかを示すフラグ。

encryptionCredentials

ブール値

この S3 互換ストレージブロックストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。

string

この S3 互換ストレージブロックストアを一意に識別する名前。

labels

文字列の配列

がどの MongoDB Ops ManagerS3 ブロックストアに割り当てることができるバックアップジョブを管理するためのタグの配列。

Links

オブジェクト配列

サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。

loadFactory

integer

このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。このオプションは、複数のスナップショットストアが使用されている場合にのみ必要です。

Load Factorの詳細については、「 1 つの既存のブロックストアの編集」を参照してください。

pathTypeAccessEnabled

ブール値

このエンドポイントのスタイルを示すフラグ。

値	S3 ブロックストアエンドポイントの形式	例
`true`	パス形式のURLエンドポイント	`s3.amazonaws.com/<bucket>`
`false`	仮想ホストスタイルのURLエンドポイント	`<bucket>.s3.amazonaws.com`

S3 互換のストレージバケットURL 規則を確認するには、Amazon Web Services S3 のドキュメントを参照してください。

s3Authメソッド

string

s3BucketNameで指定された S3 互換ストレージバケットへのアクセスを許可するために使用される方法。

このオプションに指定できる値はKEYS 、 IAM_ROLEです。

`KEYS` またはなし	MongoDB Ops Manager は、 `awsAccessKey`と`awsSecretKey`を使用して、 `s3BucketName`で指定された S3 互換ストレージバケットへのアクセスを承認します。
`IAM_ROLE`	MongoDB Ops Managerは、 Amazon Web Services IAMロールを使用して、`s3BucketName` で指定された S3 互換ストレージバケットへのアクセスを承認します。 `awsAccessKey`フィールドと`awsSecretKey`フィールドは無視されます。詳しくは、Amazon Web Services のドキュメントを参照してください。

s3bucketEndpoint

string

MongoDB Ops Manager がこの S3 互換ストレージバケットにアクセスするために使用するURL 。

s3bucketName

string

S3 互換ストレージブロックストアをホストする S3 互換ストレージバケットの名前。

s3MaxConnections

integer

この S3 互換ストレージブロックストアへの最大接続数を示す正の整数。

s3RegionServeride

string

S3 互換ストレージバケットが存在するリージョン。このフィールドは、S3 互換ストレージストアのs3bucketEndpointがリージョンのスコープをサポートしていない場合にのみ適用されます。

MongoDB Ops Managerは、この S3 互換ストレージブロックストアを作成または更新したときにこのフィールドを含めた場合にのみ、このフィールドを返します。

sseEnabled

ブール値

この S3 互換ストレージブロックストアがサーバー側の暗号化を有効にしているかどうかを示すフラグ。

ssl

ブール値

この S3 互換ストレージブロックストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。

uri

string

この S3 互換ストレージブロックストアのメタデータデータベースに接続する接続string 。このデータベースは、 Amazon Web Services S3 互換のストレージバケットにブロックの場所を保存します。

writeConcern

string

このブロックストアに使用される書込み保証 (write concern)。

MongoDB Ops Manager は、次のいずれかの値を返します。

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

MongoDB の書込み (write) 確認応答レベルの詳細については、「書込み保証 (write concern) 」を参照してください。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true'

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{
  "links" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "assignmentEnabled": true,
    "awsAccessKey": "access",
    "awsSecretKey": "secret",
    "encryptedCredentials": false,
    "id": "id",
    "labels": [
      "l1",
      "l2"
    ],
    "links": [
      {
        "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-ID}",
        "rel": "self"
      }
    ],
    "loadFactor": 50,
    "s3BucketEndpoint": "http://example.com/backupbucket",
    "s3BucketName": "buck1",
    "uri": "mongodb://localhost:27017",
    "ssl": true,
    "writeConcern": "W2"
  } ],
  "totalCount" : 1
}

戻る

ID を使用して 1 つの S3 ブロックストア構成を取得

1 つの S3 ブロックストア構成を作成

Resource

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

応答

応答ドキュメント

results embeddedDocument

リクエストの例

応答例

応答ヘッダー

レスポンス本体

リクエストパスパラメーター

リクエストクエリパラメータ

リクエストボディパラメータ

`results` embeddedDocument