Vault API به شما امکان می دهد صادرات Vault را مدیریت کنید. شما می توانید:
ایجاد صادرات — درخواستی را به Vault ارسال کنید تا پیامها یا فایلهایی را که با درخواست شما مطابقت دارند پیدا کرده و به Google Cloud صادر کند.
توجه: شما نمی توانید بیش از 20 صادرات در سراسر سازمان خود داشته باشید. برای بهبود عملکرد، صادرات بزرگ را به مجموعه های کوچکتر تقسیم کنید. به عنوان مثال، به جای اینکه همه چیز را به یکباره صادر کنید، صادرات خود را به ماه تقسیم کنید. مثال دیگر این است که تعداد کمتری از موجودیت ها (مانند کاربران و موجودیت های خاص مانند گروه ها، فضای چت و غیره) را در هر صادرات وارد کنید.
مثال ها:
فهرست صادرات - وضعیت همه صادرات مرتبط با یک موضوع را بازیابی کنید.
دریافت صادرات — بازیابی اطلاعات در مورد صادرات.
صادرات را دانلود کنید — یک صادرات را از Google Cloud دانلود کنید.
صادرات را حذف کنید — صادرات را از موضوعی که دیگر مورد نیاز نیست حذف کنید.
قبل از شروع
برای تنظیم کتابخانه های مورد نیاز و احراز هویت، از طریق Quickstart برای زبان برنامه نویسی خود کار کنید.
برای کار با منابع Vault، حساب باید دارای امتیازات Vault مورد نیاز و دسترسی به موضوع باشد. برای دسترسی به یک موضوع، حساب باید موضوع را ایجاد کرده باشد، موضوع را با آنها به اشتراک گذاشته باشد، یا دارای امتیاز View All Matters باشد.
یک صادرات جیمیل ایجاد کنید
مثال زیر نحوه ایجاد یک صادرات جیمیل را نشان می دهد. این درخواست همه پیامهای Gmail و Hangouts کلاسیک را که معیارهای زیر را دارند صادر میکند:
- پیام های متعلق به حساب های
email1
وemail2
. - پیام های پیش نویس را مستثنی می کند.
- پیام های ارسال شده به
[email protected]
.
نکته: این نمونهها از سیستم کلاسیک صادرات Gmail استفاده میکنند. برای صادر کردن با استفاده از سیستم صادرات جدید ، در MailExportOptions ، useNewExport
روی true تنظیم کنید.
جاوا
public Export createMailAccountHeldDataExports(Vault client, String matterId) {
AccountInfo emailsToSearch = new AccountInfo().setEmails(ImmutableList.of("email1", "email2"));
MailOptions mailQueryOptions = new MailOptions().setExportFormat("PST");
String queryTerms = "to:ceo@solarmora.com";
Query mailQuery =
new Query()
.setCorpus("MAIL")
.setDataScope("HELD_DATA")
.setSearchMethod("ACCOUNT")
.setAccountInfo(emailsToSearch)
.setTerms(queryTerms)
.setMailOptions(mailQueryOptions);
MailExportOptions mailExportOptions =
new MailExportOptions()
.setExportFormat("MBOX")
.showConfidentialModeContent(true);
Export wantedExport =
new Export()
.setMatterId(matterId)
.setName("My first mail accounts export")
.setQuery(mailQuery)
.setExportOptions(new ExportOptions().setMailOptions(mailExportOptions));
return client.matters().exports().create(matter, wantedExport).execute();
}
پایتون
def create_mail_account_held_data_export(service, matter_id):
emails_to_search = ['email1', 'email2']
mail_query_options = {'excludeDrafts': True}
query_terms = 'to:ceo@solarmora.com'
mail_query = {
'corpus': 'MAIL',
'dataScope': 'HELD_DATA',
'searchMethod': 'ACCOUNT',
'accountInfo': {
'emails': emails_to_search
},
'terms': query_terms,
'mailOptions': mail_query_options,
}
mail_export_options = {
'exportFormat': 'MBOX',
'showConfidentialModeContent': True
}
wanted_export = {
'name': 'My first mail accounts export',
'query': mail_query,
'exportOptions': {
'mailOptions': mail_export_options
}
}
return service.matters().exports().create(
matterId=matter_id, body=wanted_export).execute()
صادرات Drive ایجاد کنید
مثال زیر نحوه ایجاد صادرات Drive را نشان می دهد. این درخواست همه فایلهایی را صادر میکند، از جمله فایلهایی که در درایوهای مشترک هستند، که معیارهای زیر را دارند:
- متعلق به واحد سازمانی مشخص شده (به دست آمده با Admin SDK).
بین زمان های مشخص شده ایجاد شدند.
جاوا
public Export createDriveOuAllDataExport(Vault client, String matterId) {
OrgUnitInfo ouToSearch = new OrgUnitInfo().setOrgUnitId("ou id retrieved from admin sdk");
DriveOptions driveQueryOptions = new DriveOptions().setIncludeSharedDrives(true);
Query driveQuery =
new Query()
.setCorpus("DRIVE")
.setDataScope("ALL_DATA")
.setSearchMethod("ORG_UNIT")
.setOrgUnitInfo(ouToSearch)
.setDriveOptions(driveQueryOptions)
.setStartTime("2017-03-16T00:00:00Z")
.setEndTime("2017-03-16T00:00:00Z")
.setTimeZone("Etc/GMT+2");
DriveExportOptions driveExportOptions = new DriveExportOptions().setIncludeAccessInfo(false);
Export wantedExport =
new Export()
.setName("My first drive ou export")
.setQuery(driveQuery)
.setExportOptions(new ExportOptions().setDriveOptions(driveExportOptions));
return client.matters().exports().create(matter, wantedExport).execute();
}
پایتون
def create_drive_ou_all_data_export(service, matter_id):
ou_to_search = 'ou id retrieved from admin sdk'
drive_query_options = {'includeSharedDrives': True}
drive_query = {
'corpus': 'DRIVE',
'dataScope': 'ALL_DATA',
'searchMethod': 'ORG_UNIT',
'orgUnitInfo': {
'org_unit_id': ou_to_search
},
'driveOptions': drive_query_options,
'startTime': '2017-03-16T00:00:00Z',
'endTime': '2017-09-23T00:00:00Z',
'timeZone': 'Etc/GMT+2'
}
drive_export_options = {'includeAccessInfo': False}
wanted_export = {
'name': 'My first drive ou export',
'query': drive_query,
'exportOptions': {
'driveOptions': drive_export_options
}
}
return service.matters().exports().create(
matterId=matter_id, body=wanted_export).execute()
صادرات Meet ایجاد کنید
مثال زیر نحوه ایجاد صادرات Meet را نشان می دهد. این درخواست فایلهای مرتبط با حسابهای موجود در واحد سازمانی مشخص شده را صادر میکند که نام فایلی دارند که از الگوی ضبطهای Meet پیروی میکند.
پایتون
def create_meet_export(service, matter_id, ou_to_search, export_name):
export = {
'name': export_name,
'query': {
'corpus': 'DRIVE',
'dataScope': 'ALL_DATA',
'searchMethod': 'ORG_UNIT',
'terms': 'title:"...-...-... \\(....-..-.. at ..:.. *\\)"',
'orgUnitInfo': {
'orgUnitId': 'id:'+ou_to_search
},
'driveOptions': {
'includeTeamDrives': True,
'includeSharedDrives': True
},
'timeZone': 'Etc/GMT',
'method': 'ORG_UNIT'
},
'exportOptions': {
'driveOptions': {},
'region': 'ANY'
},
}
return service.matters().exports().create(
matterId=matter_id, body=export).execute()
صادر کردن از یک جستجوی ذخیره شده
مثال زیر نحوه ایجاد یک صادرات از یک کوئری ذخیره شده را نشان می دهد.
پایتون
def create_mail_export_from_saved_query(service, matter_id, saved_query_id, export_name):
export = {
'name': export_name,
'exportOptions': {
'mailOptions': {
'exportFormat': 'PST',
'showConfidentialModeContent': True
},
'region': 'ANY'
}
}
export['query'] = service.matters().savedQueries().get(
savedQueryId=saved_query_id, matterId=matter_id).execute()['query']
return service.matters().exports().create(
matterId=matter_id, body=export).execute()
فهرست صادرات
مثال زیر نحوه بازیابی فهرستی از صادرات مرتبط با یک موضوع را نشان می دهد.
جاوا
public class exports {
public ListExportsResponse listExports(Vault client, String matterId) {
return client.matters().exports().list(matterId).execute();
}
پایتون
def list_exports(service, matter_id):
return service.matters().exports().list(matterId=matter_id).execute()
دریافت اطلاعات در مورد صادرات
مثال زیر نحوه دریافت اطلاعات در مورد صادرات خاص را نشان می دهد. توجه: برای دانلود فایلها و پیامهای صادر شده، از Cloud API (در مثال بعدی) استفاده میکنید.
جاوا
public Export getExportById(Vault client, String matterId, String exportId) {
return client.matters().exports().get(matterId, exportId).execute();
}
پایتون
def get_export_by_id(service, matter_id, export_id):
return service.matters().exports().get(
matterId=matter_id, exportId=export_id).execute()
یک صادرات را از Google Cloud بارگیری کنید
مثال زیر نشان میدهد که چگونه میتوان همه صادرات تکمیلشده را در یک موضوع از Google Cloud بارگیری کرد. این درخواست از Vault و Cloud API استفاده می کند.
توجه: برای دانلود یک صادرات، یک حساب کاربری به امتیاز مدیریت صادرات نیاز دارد و موضوع با آنها به اشتراک گذاشته شود.
پایتون
def download_exports(service, matter_id):
"""Google Cloud storage service is authenticated by running
`gcloud auth application-default login` and expects a billing enabled project
in ENV variable `GOOGLE_CLOUD_PROJECT` """
gcpClient = storage.Client()
matter_id = os.environ['MATTERID']
for export in vaultService.matters().exports().list(
matterId=matter_id).execute()['exports']:
if 'cloudStorageSink' in export:
directory = export['name']
if not os.path.exists(directory):
os.makedirs(directory)
print(export['id'])
for sinkFile in export['cloudStorageSink']['files']:
filename = '%s/%s' % (directory, sinkFile['objectName'].split('/')[-1])
objectURI = 'gs://%s/%s' % (sinkFile['bucketName'],
sinkFile['objectName'])
print('get %s to %s' % (objectURI, filename))
gcpClient.download_blob_to_file(objectURI, open(filename, 'wb+'))
یک صادرات را حذف کنید
مثال زیر نحوه حذف یک صادرات را نشان می دهد.
جاوا
public void deleteExportById(Vault client, String matterId, String exportId) {
client.matters().exports().delete(matterId, exportId).execute();
پایتون
def delete_export_by_id(service, matter_id, export_id):
return service.matters().exports().delete(
matterId=matter_id, exportId=export_id).execute()
برای اطلاعات خاص برنامه در مورد جستجو و صادرات از جمله محدودیتهای جستجو، به شروع با جستجو و صادرات Vault مراجعه کنید.