1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2026-05-22 10:05:29 +02:00
Files
OpenIntegrations/docs/en/md/S3/Buckets-managment/Head-bucket.mdx
T
Vitaly the Alpaca (bot) 2e809b51b0 Main build (Jenkins)
2024-11-17 16:09:58 +03:00

94 lines
2.8 KiB
Plaintext

---
sidebar_position: 3
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Head bucket
Checks if the bucket is available for the current account or account by ID
`Function HeadBucket(Val Name, Val BasicData, Val Directory = True, Val AccountID = "", Val Headers = Undefined) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Name | --name | String | ✔ | Bucket name |
| BasicData | --basic | Structure of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
| Directory | --dir | Boolean | ✖ | True > Directory Bucket, False > General Purpose Bucket |
| AccountID | --account | String | ✖ | Account ID to verify that hes the bucket owner |
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
Returns: Structure of KeyAndValue - serialized JSON response from storage
<br/>
:::tip
Method at AWS documentation: [HeadBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
Region = "BTC";
BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
Name = "opi-dirbucket3";
Result = OPI_S3.HeadBucket(Name, BasicData, True);
Result = OPI_S3.HeadBucket(Name, BasicData, True, "1234");
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
# JSON data can also be passed as a path to a .json file
oint s3 HeadBucket \
--name "opi-dirbucket3" \
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" \
--account "1234"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
:: JSON data can also be passed as a path to a .json file
oint s3 HeadBucket ^
--name "opi-dirbucket3" ^
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" ^
--account "1234"
```
</TabItem>
</Tabs>
```json title="Result"
{
"status": 200,
"response": {},
"headers": {
"Accept-Ranges": "bytes",
"Content-Length": "0",
"Content-Type": "application/xml",
"Date": "Sun, 17 Nov 2024 10:36:33 GMT",
"Server": "MinIO",
"Strict-Transport-Security": "max-age=31536000; includeSubDomains",
"Vary": "Origin,Accept-Encoding",
"X-Amz-Id-2": "93c576aa54c960b355da9e2934476635fe3243f5df9dbb4db8b7c0d94bec7cd1",
"X-Amz-Request-Id": "1808BB1DC88D7EAE",
"X-Content-Type-Options": "nosniff",
"X-Xss-Protection": "1; mode=block"
}
}
```