ucloud-sdk-python3 0.11.122__tar.gz → 0.11.124__tar.gz

{ucloud_sdk_python3-0.11.122 → ucloud_sdk_python3-0.11.124}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ucloud-sdk-python3
-Version: 0.11.122
+Version: 0.11.124
 Summary: UCloud Service Development Kit - Python
 Home-page: https://github.com/ucloud/ucloud-sdk-python3
 Author: ucloud
@@ -31,19 +31,19 @@ Provides-Extra: doc
 Requires-Dist: requests; extra == "doc"
 Requires-Dist: sphinx; extra == "doc"
 Provides-Extra: dev
-Requires-Dist: requests_mock; extra == "dev"
-Requires-Dist: flake8>=3.6.0; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: requests; extra == "dev"
+Requires-Dist: flake8>=3.6.0; extra == "dev"
 Requires-Dist: pytest>=4.6; extra == "dev"
+Requires-Dist: requests_mock; extra == "dev"
+Requires-Dist: requests; extra == "dev"
+Requires-Dist: black; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Provides-Extra: ci
-Requires-Dist: requests_mock; extra == "ci"
-Requires-Dist: flake8>=3.6.0; extra == "ci"
 Requires-Dist: sphinx; extra == "ci"
-Requires-Dist: requests; extra == "ci"
 Requires-Dist: pytest>=4.6; extra == "ci"
+Requires-Dist: flake8>=3.6.0; extra == "ci"
+Requires-Dist: requests; extra == "ci"
+Requires-Dist: requests_mock; extra == "ci"
 Requires-Dist: pytest-cov; extra == "ci"
 
 <p align="center">

{ucloud_sdk_python3-0.11.122 → ucloud_sdk_python3-0.11.124}/ucloud/client.py

@@ -562,6 +562,16 @@ class Client(client.Client):
             self.logger,
         )
 
+    def sandbox(self):
+        from ucloud.services.sandbox.client import SandboxClient
+
+        return SandboxClient(
+            self._auto_config("sandbox"),
+            self.transport,
+            self.middleware,
+            self.logger,
+        )
+
     def vpc(self):
         from ucloud.services.vpc.client import VPCClient
 

ucloud_sdk_python3-0.11.124/ucloud/services/sandbox/client.py

@@ -0,0 +1,279 @@
+""" Code is generated by ucloud-model, DO NOT EDIT IT. """
+
+import typing
+
+
+from ucloud.core.client import Client
+from ucloud.services.sandbox.schemas import apis
+
+
+class SandboxClient(Client):
+    def __init__(
+        self, config: dict, transport=None, middleware=None, logger=None
+    ):
+        super(SandboxClient, self).__init__(
+            config, transport, middleware, logger
+        )
+
+    def check_sandbox_custom_domain(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """CheckSandboxCustomDomain - 检查自定义域名
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **CustomDomain** (str) - (Required) 自定义域名
+        - **TargetDomain** (str) - (Required) 目标域名
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **Get** (bool) - 如果为true，则表示获取检查结果
+
+        **Response**
+
+        - **Status** (str) - 检查结果Unknown:未知Checking：检查中Success：成功Timeout：超时Error：检查失败
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.CheckSandboxCustomDomainRequestSchema().dumps(d)
+
+        resp = self.invoke("CheckSandboxCustomDomain", d, **kwargs)
+        return apis.CheckSandboxCustomDomainResponseSchema().loads(resp)
+
+    def create_sandbox_site(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """CreateSandboxSite - 创建站点空间
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **APIKey** (str) - (Required) 密钥
+        - **AccessCode** (str) - (Required) 访问码
+        - **KeyID** (str) - (Required) 密钥ID
+        - **Name** (str) - (Required) 站点空间名称
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **Envs** (str) - 环境变量，格式：["key=value"]
+
+        **Response**
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.CreateSandboxSiteRequestSchema().dumps(d)
+
+        # build options
+        kwargs["max_retries"] = 0  # ignore retry when api is not idempotent
+
+        resp = self.invoke("CreateSandboxSite", d, **kwargs)
+        return apis.CreateSandboxSiteResponseSchema().loads(resp)
+
+    def delete_sandbox_site(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """DeleteSandboxSite - 删除站点空间
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **SandboxID** (str) - (Required) 站点沙箱ID
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+
+        **Response**
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.DeleteSandboxSiteRequestSchema().dumps(d)
+
+        resp = self.invoke("DeleteSandboxSite", d, **kwargs)
+        return apis.DeleteSandboxSiteResponseSchema().loads(resp)
+
+    def get_sandbox_site(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """GetSandboxSite - 获取沙箱站点
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **SandboxID** (str) - (Required) 沙箱ID
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+
+        **Response**
+
+        - **Site** (dict) - 见 **Site** 模型定义
+
+        **Response Model**
+
+        **SiteIPAccess**
+        - **IPList** (list) - IP 列表
+        - **Mode** (str) - IP限制模式"":不限制IP“allow”:自定义白名单“deny”:自定义黑名单
+
+
+        **Site**
+        - **AccessCode** (str) - 访问码
+        - **ConnectKey** (str) - 连接密钥
+        - **CustomDomain** (str) - 自定义域名
+        - **CustomDomainError** (str) - 自定义域名签发错误信息
+        - **CustomDomainStatus** (str) - 自定义域名签发状态
+        - **Envs** (list) - 站点环境变量。格式：key=value
+        - **Host** (str) - 站点访问地址
+        - **ID** (str) - 站点ID
+        - **IPAccess** (dict) - 见 **SiteIPAccess** 模型定义
+        - **KeyID** (str) - 站点Key ID
+        - **Name** (str) - 名称
+        - **Ready** (bool) - 是否就绪
+        - **SandboxID** (str) - 沙箱ID
+        - **UpdateTime** (int) - 更新时间
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.GetSandboxSiteRequestSchema().dumps(d)
+
+        resp = self.invoke("GetSandboxSite", d, **kwargs)
+        return apis.GetSandboxSiteResponseSchema().loads(resp)
+
+    def list_sandbox_sites(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """ListSandboxSites - 列出站点空间
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+
+        **Response**
+
+        - **CustomTargetDomain** (str) - 目标域名地址
+        - **Sites** (list) - 见 **Site** 模型定义
+
+        **Response Model**
+
+        **SiteIPAccess**
+        - **IPList** (list) - IP 列表
+        - **Mode** (str) - IP限制模式"":不限制IP“allow”:自定义白名单“deny”:自定义黑名单
+
+
+        **Site**
+        - **AccessCode** (str) - 访问码
+        - **ConnectKey** (str) - 连接密钥
+        - **CustomDomain** (str) - 自定义域名
+        - **CustomDomainError** (str) - 自定义域名签发错误信息
+        - **CustomDomainStatus** (str) - 自定义域名签发状态
+        - **Envs** (list) - 站点环境变量。格式：["key=value"]
+        - **Host** (str) - 站点访问地址
+        - **ID** (str) - 站点ID
+        - **IPAccess** (dict) - 见 **SiteIPAccess** 模型定义
+        - **KeyID** (str) - 站点Key ID
+        - **Name** (str) - 名称
+        - **Ready** (bool) - 是否就绪
+        - **SandboxID** (str) - 沙箱ID
+        - **UpdateTime** (int) - 更新时间
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.ListSandboxSitesRequestSchema().dumps(d)
+
+        resp = self.invoke("ListSandboxSites", d, **kwargs)
+        return apis.ListSandboxSitesResponseSchema().loads(resp)
+
+    def update_sandbox_site(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """UpdateSandboxSite - 更新站点空间
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **SandboxID** (str) - (Required) 站点沙箱ID
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **APIKey** (str) - 更新站点空间API Key
+        - **AccessCode** (str) - 访问码
+        - **Envs** (str) - 更新站点空间环境变量，格式为["Key=Value"]
+        - **IPAccess** (dict) - 见 **UpdateSandboxSiteParamIPAccess** 模型定义
+        - **KeyID** (str) - 更新站点空间Key ID（需要和APIKey一起传）
+        - **Name** (str) - 更新站点空间名称
+
+        **Response**
+
+
+        **Request Model**
+
+        **UpdateSandboxSiteParamIPAccess**
+        - **IPList** (str) - 访问限制IP，格式["192.168.1.2","192.168.1.3"]
+        - **Mode** (str) - 访问模式，- ""：无IP限制- "allow":白名单模式- "deny":黑名单
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.UpdateSandboxSiteRequestSchema().dumps(d)
+
+        resp = self.invoke("UpdateSandboxSite", d, **kwargs)
+        return apis.UpdateSandboxSiteResponseSchema().loads(resp)
+
+    def update_sandbox_site_custom_domain(
+        self, req: typing.Optional[dict] = None, **kwargs
+    ) -> dict:
+        """UpdateSandboxSiteCustomDomain - 更新沙箱站点自定义域名
+
+        **Request**
+
+        - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
+        - **Region** (str) - (Config) 地域。 参见  `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+        - **CustomDomain** (str) - (Required) 自定义域名
+        - **SandboxID** (str) - (Required) 沙箱ID
+        - **Zone** (str) - (Required) 可用区。参见  `可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
+
+        **Response**
+
+
+        """
+        # build request
+        d = {
+            "ProjectId": self.config.project_id,
+            "Region": self.config.region,
+        }
+        req and d.update(req)
+        d = apis.UpdateSandboxSiteCustomDomainRequestSchema().dumps(d)
+
+        resp = self.invoke("UpdateSandboxSiteCustomDomain", d, **kwargs)
+        return apis.UpdateSandboxSiteCustomDomainResponseSchema().loads(resp)

ucloud_sdk_python3-0.11.124/ucloud/services/sandbox/schemas/apis.py

@@ -0,0 +1,209 @@
+""" Code is generated by ucloud-model, DO NOT EDIT IT. """
+
+from ucloud.core.typesystem import schema, fields
+from ucloud.services.sandbox.schemas import models
+
+""" sandbox API Schema
+"""
+
+
+"""
+API: CheckSandboxCustomDomain
+
+检查自定义域名
+"""
+
+
+class CheckSandboxCustomDomainRequestSchema(schema.RequestSchema):
+    """CheckSandboxCustomDomain - 检查自定义域名"""
+
+    fields = {
+        "CustomDomain": fields.Str(required=True, dump_to="CustomDomain"),
+        "Get": fields.Bool(required=False, dump_to="Get"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "TargetDomain": fields.Str(required=True, dump_to="TargetDomain"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class CheckSandboxCustomDomainResponseSchema(schema.ResponseSchema):
+    """CheckSandboxCustomDomain - 检查自定义域名"""
+
+    fields = {
+        "Status": fields.Str(required=True, load_from="Status"),
+    }
+
+
+"""
+API: CreateSandboxSite
+
+创建站点空间
+"""
+
+
+class CreateSandboxSiteRequestSchema(schema.RequestSchema):
+    """CreateSandboxSite - 创建站点空间"""
+
+    fields = {
+        "APIKey": fields.Str(required=True, dump_to="APIKey"),
+        "AccessCode": fields.Str(required=True, dump_to="AccessCode"),
+        "Envs": fields.Str(required=False, dump_to="Envs"),
+        "KeyID": fields.Str(required=True, dump_to="KeyID"),
+        "Name": fields.Str(required=True, dump_to="Name"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class CreateSandboxSiteResponseSchema(schema.ResponseSchema):
+    """CreateSandboxSite - 创建站点空间"""
+
+    fields = {}
+
+
+"""
+API: DeleteSandboxSite
+
+删除站点空间
+"""
+
+
+class DeleteSandboxSiteRequestSchema(schema.RequestSchema):
+    """DeleteSandboxSite - 删除站点空间"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "SandboxID": fields.Str(required=True, dump_to="SandboxID"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class DeleteSandboxSiteResponseSchema(schema.ResponseSchema):
+    """DeleteSandboxSite - 删除站点空间"""
+
+    fields = {}
+
+
+"""
+API: GetSandboxSite
+
+获取沙箱站点
+"""
+
+
+class GetSandboxSiteRequestSchema(schema.RequestSchema):
+    """GetSandboxSite - 获取沙箱站点"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "SandboxID": fields.Str(required=True, dump_to="SandboxID"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class GetSandboxSiteResponseSchema(schema.ResponseSchema):
+    """GetSandboxSite - 获取沙箱站点"""
+
+    fields = {
+        "Site": models.SiteSchema(),
+    }
+
+
+"""
+API: ListSandboxSites
+
+列出站点空间
+"""
+
+
+class ListSandboxSitesRequestSchema(schema.RequestSchema):
+    """ListSandboxSites - 列出站点空间"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class ListSandboxSitesResponseSchema(schema.ResponseSchema):
+    """ListSandboxSites - 列出站点空间"""
+
+    fields = {
+        "CustomTargetDomain": fields.Str(
+            required=False, load_from="CustomTargetDomain"
+        ),
+        "Sites": fields.List(
+            models.SiteSchema(), required=True, load_from="Sites"
+        ),
+    }
+
+
+"""
+API: UpdateSandboxSite
+
+更新站点空间
+"""
+
+
+class UpdateSandboxSiteParamIPAccessSchema(schema.RequestSchema):
+    """UpdateSandboxSiteParamIPAccess -"""
+
+    fields = {
+        "IPList": fields.Str(required=False, dump_to="IPList"),
+        "Mode": fields.Str(required=False, dump_to="Mode"),
+    }
+
+
+class UpdateSandboxSiteRequestSchema(schema.RequestSchema):
+    """UpdateSandboxSite - 更新站点空间"""
+
+    fields = {
+        "APIKey": fields.Str(required=False, dump_to="APIKey"),
+        "AccessCode": fields.Str(required=False, dump_to="AccessCode"),
+        "Envs": fields.Str(required=False, dump_to="Envs"),
+        "IPAccess": UpdateSandboxSiteParamIPAccessSchema(
+            required=False, dump_to="IPAccess"
+        ),
+        "KeyID": fields.Str(required=False, dump_to="KeyID"),
+        "Name": fields.Str(required=False, dump_to="Name"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "SandboxID": fields.Str(required=True, dump_to="SandboxID"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class UpdateSandboxSiteResponseSchema(schema.ResponseSchema):
+    """UpdateSandboxSite - 更新站点空间"""
+
+    fields = {}
+
+
+"""
+API: UpdateSandboxSiteCustomDomain
+
+更新沙箱站点自定义域名
+"""
+
+
+class UpdateSandboxSiteCustomDomainRequestSchema(schema.RequestSchema):
+    """UpdateSandboxSiteCustomDomain - 更新沙箱站点自定义域名"""
+
+    fields = {
+        "CustomDomain": fields.Str(required=True, dump_to="CustomDomain"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "SandboxID": fields.Str(required=True, dump_to="SandboxID"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class UpdateSandboxSiteCustomDomainResponseSchema(schema.ResponseSchema):
+    """UpdateSandboxSiteCustomDomain - 更新沙箱站点自定义域名"""
+
+    fields = {}

ucloud_sdk_python3-0.11.124/ucloud/services/sandbox/schemas/models.py

@@ -0,0 +1,37 @@
+""" Code is generated by ucloud-model, DO NOT EDIT IT. """
+
+from ucloud.core.typesystem import schema, fields
+
+
+class SiteIPAccessSchema(schema.ResponseSchema):
+    """SiteIPAccess - 站点空间-访问设置-IP限制"""
+
+    fields = {
+        "IPList": fields.List(fields.Str()),
+        "Mode": fields.Str(required=False, load_from="Mode"),
+    }
+
+
+class SiteSchema(schema.ResponseSchema):
+    """Site - 站点空间"""
+
+    fields = {
+        "AccessCode": fields.Str(required=True, load_from="AccessCode"),
+        "ConnectKey": fields.Str(required=True, load_from="ConnectKey"),
+        "CustomDomain": fields.Str(required=False, load_from="CustomDomain"),
+        "CustomDomainError": fields.Str(
+            required=False, load_from="CustomDomainError"
+        ),
+        "CustomDomainStatus": fields.Str(
+            required=False, load_from="CustomDomainStatus"
+        ),
+        "Envs": fields.List(fields.Str()),
+        "Host": fields.Str(required=True, load_from="Host"),
+        "ID": fields.Str(required=True, load_from="ID"),
+        "IPAccess": SiteIPAccessSchema(),
+        "KeyID": fields.Str(required=True, load_from="KeyID"),
+        "Name": fields.Str(required=True, load_from="Name"),
+        "Ready": fields.Bool(required=True, load_from="Ready"),
+        "SandboxID": fields.Str(required=True, load_from="SandboxID"),
+        "UpdateTime": fields.Int(required=True, load_from="UpdateTime"),
+    }