MarkLogic Server 11.0 Product Documentation
admin.groupSetS3Proxyadmin.groupSetS3Proxy(
config as element(configuration),
group-id as (Number|String),
value as String
) as element(configuration)
Summary
This function sets the URL of the proxy server used by the group
to access AWS S3 storage.
Parameters |
config |
A configuration specification, typically as returned
from one of the Admin module functions.
|
group-id |
The ID of the group to which the App Server belongs.
Typically, this is the result of an admin:group-get-id
call.
|
value |
The URL of the proxy server. The proxy URL should start with https://
(for example, https://proxy.marklogic.com:8080 ). If you don't specify the
port number, MarkLogic assumes the proxy server is listening on port 8080.
|
Required Privileges
This operation requires at least one of the following privileges:
http://marklogic.com/xdmp/privileges/admin/group-security
http://marklogic.com/xdmp/privileges/admin/group-security/{id}
Example
const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const groupid = admin.groupGetId(config, "Default")
admin.groupGetS3Proxy(config, groupid, "https://s3proxy.marklogic.com.8080")
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.