Obter uma configuração do oplog S3 por ID

Recupera a configuração do armazenamento de oplog3 de um s.

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

Resource

GET /oplog/s3Configs/{S3-OPLOG-CONFIG-ID}

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
S3-OPLOG-CONFIG-ID	string	O identificador exclusivo que representa essa configuração oplog S3.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome	Tipo	necessidade	Descrição	Default
pretty	booleano	Opcional	Flag indicating whether the response body is in a prettyprint format.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deve envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui: `status`: Código de resposta HTTP `content`: Corpo de resposta esperado	`false`

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Nome	Tipo	Descrição
acceptTos	booleano	Sinalizador que indica se você aceitou os termos de serviço para usar armazenamentos compatíveis com S3com o MongoDB Ops Manager. Você deve definir isso como `true` para criar um armazenamento compatível com S3.
assignEnabled	booleano	Sinalizador que indica se você pode atribuir tarefas de backup a esse armazenamento de dados.
Chave de acesso AWS	string	ID da chave de acesso daAWS que pode acessar o bucket de armazenamento compatível com o S3 especificado em s3BucketName.
Chave secreta AWS	string	Chave de acesso secreta da AWS que pode acessar o bucket de armazenamento compatível com o S3 especificado em s3BucketName.
customCertificates	array	Lista de certificados de autoridade de certificação válidos que se aplicam ao bucket de armazenamento associado compatível com S3.
customCertificates[n].filename	string	Nome que identifica o arquivo PEM da Autoridade de certificação.
customCertificates[n].certString	string	Conteúdo do arquivo PEM da autoridade de certificação que compõem sua cadeia de autoridade de certificação.
disableProxyS3	booleano	Sinalizador que indica se o HTTP proxy deve ser utilizado ao conectar-se ao armazenamento compatível com S3.
Credenciais criptografadas	booleano	Sinalizador que indica se o nome de usuário e a senha deste armazenamento de oplog de armazenamento compatível com S3foram criptografados usando a ferramenta de credenciais.
id	string	Nome que identifica exclusivamente este armazenamento de oplog de armazenamento compatível com S3 .
rótulos	array de strings	Array de marcações para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais armazenamentos de oplog compatíveis com S3.
links	array de objetos	Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays `links` nas respostas incluem pelo menos um link chamado `self`. Os relacionamentos entre URLs são explicados na Especificação de links da web.
OIDC	objeto	Configurações de autenticaçãoOIDC para este armazenamento. O objeto `oidc` contém os seguintes campos: `enabled`: booleano. Indica se a autenticação OIDC está habilitada para este armazenamento. `method`: string. Um de `callback`, `azure`, `gcp` ou `k8s`. `tokenUri`: Corda. O ponto de extremidade do token IdP. Presente somente quando `method` é `callback`. `clientId`: Corda. O ID do cliente registrado com o IdP. `clientSecret`: string. O Ops Manager redige esse valor na resposta e não retorna o segredo bruto do cliente. `scope`: Corda. O escopo OAuth2 solicitado do IdP. Presente somente quando `method` é `callback`. `tokenResource`: string. O identificador de público ou recurso para o token de identidade da carga de trabalho. Presente apenas quando `method` é `azure` ou `gcp`.
pathStyleAccessEnabled	booleano	Sinalizador que indica o estilo deste endpoint. `true`: Endpoint de URL no estilo de caminho. Exemplo: `s3.amazonaws.com/<bucket>` `false`: Endpoint de URL no estilo de host virtual. Exemplo: `<bucket>.s3.amazonaws.com` Para revisar as convenções de URL do bucket de armazenamento compatível com o S3, consulte a documentação do AWS S3.
s3BucketEndpoint	string	URL que o Ops Manager usa para acessar esse bucket de armazenamento compatível com S3.
Nome do bucket do S3	string	Nome do bucket de armazenamento compatível com S3que hospeda o armazenamento de oplog de armazenamento compatível com S3 .
s3RegionOverride	string	Região onde reside seu contêiner de armazenamento compatível com S3. Esse campo se aplica somente se o s3BucketEndpoint do seu armazenamento de armazenamento compatível com S3 não suportar o escopo de região. MongoDB Ops Manager retorna esse campo somente se você o tiver incluído ao criar ou atualizar esse armazenamento de oplog de armazenamento compatível com S3.
sseEnabled	booleano	Sinalizador que indica se este armazenamento3de oplog de armazenamento compatível com S habilita a criptografia do lado do servidor.
ssl	booleano	Sinalizador que indica se este armazenamento de oplog de armazenamento compatível com S3só aceita conexões criptografadas usando TLS.
uri	string	Connection string que se conecta ao banco de dados de metadados desse armazenamento de oplog de armazenamento compatível com S3. Esse banco de dados armazena as localizações dos blocos no bucket de armazenamento compatível com S3 .
writeConcern	string	Write concern usado para este armazenamento de oplog. O Ops Manager retorna um dos seguintes valores: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` Para saber mais sobre os níveis de reconhecimento de escrita no MongoDB, consulte Write Concern.

Exemplo de solicitação

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

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

1 {
2   "assignmentEnabled": true,
3   "awsAccessKey": "access",
4   "awsSecretKey": "secret",
5   "customCertificates" : [{
6     "filename" : "CA.pem",
7     "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----"
8   }],
9   "encryptedCredentials": false,
10   "id": "id",
11   "labels": [
12     "l1",
13     "l2"
14   ],
15   "links": [
16     {
17       "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs/{S3-OPLOG-CONFIG-ID}",
18       "rel": "self"
19     }
20   ],
21   "s3BucketEndpoint": "http://backup.example.com/oplog",
22   "s3BucketName": "oplog",
23   "uri": "mongodb://localhost:27017",
24   "ssl": true,
25   "writeConcern": "W2"
26 }

Voltar

S3 Oplog

Obter todos

1	{
2	"assignmentEnabled": true,
3	"awsAccessKey": "access",
4	"awsSecretKey": "secret",
5	"customCertificates" : [{
6	"filename" : "CA.pem",
7	"certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----"
8	}],
9	"encryptedCredentials": false,
10	"id": "id",
11	"labels": [
12	"l1",
13	"l2"
14	],
15	"links": [
16	{
17	"href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs/{S3-OPLOG-CONFIG-ID}",
18	"rel": "self"
19	}
20	],
21	"s3BucketEndpoint": "http://backup.example.com/oplog",
22	"s3BucketName": "oplog",
23	"uri": "mongodb://localhost:27017",
24	"ssl": true,
25	"writeConcern": "W2"
26	}