Add cloud box id

Author: zhuxiaolong37

alibabacloud_oss_v2/__init__.py

@@ -41,6 +41,7 @@
 from .models.bucket_tags import *
 from .models.bucket_meta_query import *
 from .models.bucket_https_config import *
+from .models.cloud_box import *
 
 from .config import Config
 from .client import Client

alibabacloud_oss_v2/_client.py

@@ -151,6 +151,7 @@ def resolve_config(self, config: Config) ->Tuple[_Options, _InnerOptions]:
         _resolve_signer(config, options)
         _resolve_address_style(config, options)
         _resolve_feature_flags(config, options)
+        _resolve_cloud_box(config, options)
         self._resolve_httpclient(config, options) # pylint: disable=no-member
 
         inner = _InnerOptions()
@@ -568,6 +569,29 @@ def _resolve_feature_flags(config: Config, options: _Options) -> None:
     if utils.safety_bool(config.disable_download_crc64_check):
         options.feature_flags = options.feature_flags & ~defaults.FF_ENABLE_CRC64_CHECK_DOWNLOAD
 
+
+def _resolve_cloud_box(config: Config, options: _Options) -> None:
+    """cloud box"""
+    if config.cloud_box_id is not None:
+        options.region = str(config.cloud_box_id)
+        options.product = defaults.CLOUD_BOX_PRODUCT
+        return
+
+    if not config.enable_auto_detect_cloud_box_id:
+        return
+
+    host = options.endpoint.hostname
+    if not (host.endswith(".oss-cloudbox.aliyuncs.com") or
+            host.endswith(".oss-cloudbox-control.aliyuncs.com")):
+        return
+
+    keys = host.split(".")
+    if len(keys) != 5 or not keys[0].startswith("cb-"):
+        return
+    options.region = keys[0]
+    options.product = defaults.CLOUD_BOX_PRODUCT
+
+
 def _apply_operation_metadata(op_input: OperationInput, options: _Options) -> None:
     handlers = op_input.op_metadata.get('opm-response-handler', None)
     if handlers is not None:

alibabacloud_oss_v2/client.py

@@ -2193,4 +2193,19 @@ def clean_restored_object(self, request: models.CleanRestoredObjectRequest, **kw
         Returns:
             CleanRestoredObjectResult: Response result for CleanRestoredObject operation.
         """
-        return operations.clean_restored_object(self._client, request, **kwargs)
+        return operations.clean_restored_object(self._client, request, **kwargs)
+
+    # cloud box
+    def list_cloud_boxes(self, request: models.ListCloudBoxesRequest, **kwargs
+                    ) -> models.ListCloudBoxesResult:
+        """
+        ListCloudBoxes Lists cloud box buckets that belong to the current account.
+
+        Args:
+            request (ListCloudBoxesRequest): Request parameters for ListCloudBoxes operation.
+
+        Returns:
+            ListCloudBoxesResult: Response result for ListCloudBoxes operation.
+        """
+
+        return operations.list_cloud_boxes(self._client, request, **kwargs)

alibabacloud_oss_v2/config.py

@@ -27,7 +27,9 @@ def __init__(
         disable_upload_crc64_check: Optional[bool] = None,
         disable_download_crc64_check: Optional[bool] = None,
         additional_headers: Optional[List[str]] = None,
-        user_agent: Optional[str] = None
+        user_agent: Optional[str] = None,
+        cloud_box_id: Optional[str] = None,
+        enable_auto_detect_cloud_box_id: Optional[bool] = None
     ) -> None:
         """
         Args:
@@ -67,6 +69,8 @@ def __init__(
                 Set this to `true` to disable this feature.
             additional_headers: (List[str], optional): Additional signable headers.
             user_agent: (str, optional): The optional user specific identifier appended to the User-Agent header.
+            cloud_box_id: (str, optional): The cloud box id.
+            enable_auto_detect_cloud_box_id: (bool, optional): The cloud box id is automatically extracted from endpoint.
         """
         self.region = region
         self.endpoint = endpoint
@@ -90,6 +94,8 @@ def __init__(
         self.disable_download_crc64_check = disable_download_crc64_check
         self.additional_headers = additional_headers
         self.user_agent = user_agent
+        self.cloud_box_id = cloud_box_id
+        self.enable_auto_detect_cloud_box_id = enable_auto_detect_cloud_box_id
 
 def load_default() -> Config:
     """Using the SDK's default configuration"""

alibabacloud_oss_v2/defaults.py

@@ -10,6 +10,9 @@
 # Product for signing
 DEFAULT_PRODUCT = "oss"
 
+# CloudBoxProduct Product of cloud box for signing
+CLOUD_BOX_PRODUCT = "oss-cloudbox"
+
 # The URL's scheme, default is https
 DEFAULT_ENDPOINT_SCHEME = "https"
 

alibabacloud_oss_v2/models/__init__.py

@@ -28,4 +28,5 @@
 from .bucket_style import *
 from .bucket_tags import *
 from .bucket_meta_query import *
-from .bucket_https_config import *
+from .bucket_https_config import *
+from .cloud_box import *

alibabacloud_oss_v2/models/cloud_box.py

@@ -0,0 +1,134 @@
+from typing import Optional, List, Any
+from .. import serde
+from .bucket_basic import Owner
+
+class CloudBoxProperties(serde.Model):
+    """
+    Information about cloud box.
+    """
+
+    _attribute_map = {
+        'id': {'tag': 'xml', 'rename': 'ID'},
+        'name': {'tag': 'xml', 'rename': 'Name'},
+        'region': {'tag': 'xml', 'rename': 'Region'},
+        'control_endpoint': {'tag': 'xml', 'rename': 'ControlEndpoint'},
+        'data_endpoint': {'tag': 'xml', 'rename': 'DataEndpoint'},
+        'alias': {'tag': 'xml', 'rename': 'Alias'},
+    }
+
+    _xml_map = {
+        "name": "CloudBox"
+    }
+
+    def __init__(
+        self,
+        id: Optional[str] = None,
+        name: Optional[str] = None,
+        region: Optional[str] = None,
+        control_endpoint: Optional[str] = None,
+        data_endpoint: Optional[str] = None,
+        alias: Optional[str] = None,
+        **kwargs: Any
+    ) -> None:
+        """
+        Args:
+            id (str, optional): Cloud Box ID.
+            name (str, optional): Cloud Box Name.
+            region (str, optional): Regions supported by Cloud Box.
+            control_endpoint (str, optional): control endpoint.
+            data_endpoint (str, optional): data endpoint.
+            alias (str, optional): The alias of the access point.
+        """
+        super().__init__(**kwargs)
+        self.id = id
+        self.name = name
+        self.region = region
+        self.control_endpoint = control_endpoint
+        self.data_endpoint = data_endpoint
+        self.alias = alias
+
+
+
+class ListCloudBoxesRequest(serde.RequestModel):
+    """
+    The request for the ListCloudBoxes operation.
+    """
+
+    _attribute_map = {
+        "marker": {"tag": "input", "position": "query", "rename": "marker"},
+        "max_keys": {"tag": "input", "position": "query", "rename": "max-keys", "type": "int"},
+        "prefix": {"tag": "input", "position": "query", "rename": "prefix"},
+    }
+
+    def __init__(
+        self,
+        marker: Optional[str] = None,
+        max_keys: Optional[int] = None,
+        prefix: Optional[str] = None,
+        **kwargs: Any
+    ) -> None:
+        """
+        Args:
+            marker (str, optional): The name of the bucket from which the list operation begins.
+            max_keys (int, optional): The maximum number of buckets that can be returned in the single query. Valid values: 1 to 1000.
+            prefix (str, optional): The prefix that the names of returned buckets must contain.
+        """
+        super().__init__(**kwargs)
+        self.marker = marker
+        self.max_keys = max_keys
+        self.prefix = prefix
+
+
+class ListCloudBoxesResult(serde.ResultModel):
+    """
+    The result for the ListCloudBoxes operation.
+    """
+
+    _attribute_map = {
+        'prefix': {'tag': 'xml', 'rename': 'Prefix'},
+        'marker': {'tag': 'xml', 'rename': 'Marker'},
+        'max_keys': {'tag': 'xml', 'rename': 'MaxKeys'},
+        'is_truncated': {'tag': 'xml', 'rename': 'IsTruncated', 'type': 'bool'},
+        'next_marker': {'tag': 'xml', 'rename': 'NextMarker'},
+        "owner": {"tag": "xml", "rename": "Owner", "type": "Owner"},
+        "cloud_boxes": {"tag": "xml", "rename": "CloudBoxes/CloudBox", "type": "[CloudBoxProperties]"},
+    }
+
+    _xml_map = {
+        'name': 'ListCloudBoxResult'
+    }
+
+    _dependency_map = {
+        "Owner": {"new": lambda: Owner()},
+        "CloudBoxProperties": {"new": lambda: CloudBoxProperties()},
+    }
+
+    def __init__(
+        self,
+        prefix: Optional[str] = None,
+        marker: Optional[str] = None,
+        max_keys: Optional[int] = None,
+        is_truncated: Optional[bool] = None,
+        next_marker: Optional[str] = None,
+        owner: Optional[Owner] = None,
+        cloud_boxes: Optional[List[CloudBoxProperties]] = None,
+        **kwargs: Any
+    ) -> None:
+        """
+        Args:
+            prefix (str, optional): The prefix that the names of returned buckets must contain.
+            marker (str, optional): The name of the bucket from which the list operation begins.
+            max_keys (int, optional): The maximum number of buckets that can be returned in the single query. Valid values: 1 to 1000.
+            is_truncated (str, bool): Indicates whether the returned list is truncated. Valid values: * true: indicates that not all results are returned. * false: indicates that all results are returned.
+            next_marker (str, optional): The marker for the next ListBuckets request, which can be used to return the remaining results.
+            owner (Owner, optional): The container that stores information about the object owner.
+            cloud_boxes ([CloudBoxProperties], optional): The container that stores information about cloud box bucket.
+        """
+        super().__init__(**kwargs)
+        self.prefix = prefix
+        self.marker = marker
+        self.max_keys = max_keys
+        self.is_truncated = is_truncated
+        self.next_marker = next_marker
+        self.owner = owner
+        self.cloud_boxes = cloud_boxes

alibabacloud_oss_v2/operations/__init__.py

@@ -28,4 +28,5 @@
 from .bucket_style import *
 from .bucket_tags import *
 from .bucket_meta_query import *
-from .bucket_https_config import *
+from .bucket_https_config import *
+from .cloud_box import *

alibabacloud_oss_v2/operations/cloud_box.py

@@ -0,0 +1,46 @@
+from ..types import OperationInput, CaseInsensitiveDict
+from .. import serde
+from .. import serde_utils
+from .. import models
+from .._client import _SyncClientImpl
+
+def list_cloud_boxes(client: _SyncClientImpl, request: models.ListCloudBoxesRequest, **kwargs) -> models.ListCloudBoxesResult:
+    """
+    ListCloudBoxes Lists cloud box buckets that belong to the current account.
+
+    Args:
+        client (_SyncClientImpl): A agent that sends the request.
+        request (ListCloudBoxesRequest): The request for the ListCloudBoxes operation.
+
+    Returns:
+        ListCloudBoxesResult: The result for the ListCloudBoxes operation.
+    """
+
+    op_input = serde.serialize_input(
+        request=request,
+        op_input=OperationInput(
+            op_name='ListCloudBoxes',
+            method='GET',
+            headers=CaseInsensitiveDict({
+                'Content-Type': 'application/xml',
+            }),
+            parameters={
+                'cloudboxes': '',
+            },
+            op_metadata={'sub-resource': ['cloudboxes']},
+        ),
+        custom_serializer=[
+            serde_utils.add_content_md5
+        ]
+    )
+
+    op_output = client.invoke_operation(op_input, **kwargs)
+
+    return serde.deserialize_output(
+        result=models.ListCloudBoxesResult(),
+        op_output=op_output,
+        custom_deserializer=[
+            serde.deserialize_output_xmlbody
+        ],
+    )
+

sample/list_cloud_boxes.py

@@ -0,0 +1,30 @@
+import argparse
+import alibabacloud_oss_v2 as oss
+
+parser = argparse.ArgumentParser(description="list cloud boxes sample")
+parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
+parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
+
+
+def main():
+
+    args = parser.parse_args()
+
+    # Loading credentials values from the environment variables
+    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
+
+    # Using the SDK's default configuration
+    cfg = oss.config.load_default()
+    cfg.credentials_provider = credentials_provider
+    cfg.region = args.region
+    if args.endpoint is not None:
+        cfg.endpoint = args.endpoint
+
+    client = oss.Client(cfg)
+
+    result = client.list_cloud_boxes(oss.ListCloudBoxesRequest())
+
+    print(vars(result))
+
+if __name__ == "__main__":
+    main()