From 1dbf162f6c9994d06b414b58b336849ef254093d Mon Sep 17 00:00:00 2001 From: ucloud-bot Date: Tue, 22 Sep 2020 04:00:39 +0000 Subject: [PATCH] auto release for 0.9.3 --- README.md | 2 +- examples/auth/README.md | 15 + examples/auth/__init__.py | 1 + examples/auth/main.py | 16 + tests/test_unit/test_core/consts.py | 3 + tests/test_unit/test_core/test_auth.py | 4 + tests/test_unit/test_core/test_client.py | 96 +- tests/test_unit/test_core/test_encoder.py | 1 + tests/test_unit/test_core/test_transport.py | 163 ++- ucloud/client.py | 8 +- ucloud/core/auth/_cfg.py | 4 +- ucloud/core/client/_client.py | 89 +- ucloud/core/exc/__init__.py | 10 +- ucloud/core/exc/_exc.py | 42 +- ucloud/core/transport/_requests.py | 11 +- ucloud/core/transport/http.py | 34 +- ucloud/core/transport/utils.py | 2 +- ucloud/core/typesystem/encoder.py | 2 + ucloud/core/typesystem/fields.py | 2 +- ucloud/core/utils/deco.py | 2 +- ucloud/core/utils/middleware.py | 8 +- ucloud/helpers/utils.py | 6 +- ucloud/helpers/wait.py | 4 +- ucloud/services/ipsecvpn/client.py | 40 +- ucloud/services/ipsecvpn/schemas/apis.py | 12 +- ucloud/services/ipsecvpn/schemas/models.py | 12 +- ucloud/services/pathx/client.py | 60 +- ucloud/services/pathx/schemas/apis.py | 36 +- ucloud/services/pathx/schemas/models.py | 6 +- ucloud/services/stepflow/client.py | 34 +- ucloud/services/stepflow/schemas/apis.py | 12 +- ucloud/services/stepflow/schemas/models.py | 9 +- ucloud/services/uaccount/client.py | 56 +- ucloud/services/uaccount/schemas/apis.py | 36 +- ucloud/services/uaccount/schemas/models.py | 9 +- ucloud/services/ucdn/client.py | 234 ++-- ucloud/services/ucdn/schemas/apis.py | 102 +- ucloud/services/ucdn/schemas/models.py | 45 +- ucloud/services/ucloudstack/client.py | 1041 ++++++++++------- ucloud/services/ucloudstack/schemas/apis.py | 770 ++++++------ ucloud/services/ucloudstack/schemas/models.py | 167 +-- ucloud/services/udb/client.py | 610 +++++----- ucloud/services/udb/schemas/apis.py | 282 ++--- ucloud/services/udb/schemas/models.py | 27 +- ucloud/services/udisk/client.py | 210 ++-- ucloud/services/udisk/schemas/apis.py | 96 +- ucloud/services/udisk/schemas/models.py | 9 +- ucloud/services/udpn/client.py | 80 +- ucloud/services/udpn/schemas/apis.py | 42 +- ucloud/services/udpn/schemas/models.py | 6 +- ucloud/services/ufs/client.py | 46 +- ucloud/services/ufs/schemas/apis.py | 24 +- ucloud/services/ufs/schemas/models.py | 3 +- ucloud/services/uhost/client.py | 418 +++---- ucloud/services/uhost/schemas/apis.py | 174 +-- ucloud/services/uhost/schemas/models.py | 27 +- ucloud/services/uhub/client.py | 76 +- ucloud/services/uhub/schemas/apis.py | 42 +- ucloud/services/uhub/schemas/models.py | 9 +- ucloud/services/ulb/client.py | 276 ++--- ucloud/services/ulb/schemas/apis.py | 120 +- ucloud/services/ulb/schemas/models.py | 24 +- ucloud/services/umem/client.py | 400 +++---- ucloud/services/umem/schemas/apis.py | 144 +-- ucloud/services/umem/schemas/models.py | 27 +- ucloud/services/unet/client.py | 376 +++--- ucloud/services/unet/schemas/apis.py | 192 +-- ucloud/services/unet/schemas/models.py | 51 +- ucloud/services/uphost/client.py | 172 +-- ucloud/services/uphost/schemas/apis.py | 66 +- ucloud/services/uphost/schemas/models.py | 21 +- ucloud/services/usms/client.py | 122 +- ucloud/services/usms/schemas/apis.py | 60 +- ucloud/services/usms/schemas/models.py | 12 +- ucloud/services/vpc/client.py | 40 +- ucloud/services/vpc/schemas/apis.py | 120 +- ucloud/services/vpc/schemas/models.py | 21 +- ucloud/testing/driver/_step.py | 2 +- ucloud/testing/env.py | 2 +- ucloud/testing/funcs.py | 10 +- ucloud/testing/op.py | 48 +- ucloud/testing/utest.py | 4 +- ucloud/version.py | 2 +- 83 files changed, 3759 insertions(+), 3940 deletions(-) create mode 100644 examples/auth/README.md create mode 100644 examples/auth/__init__.py create mode 100644 examples/auth/main.py create mode 100644 tests/test_unit/test_core/consts.py diff --git a/README.md b/README.md index 5a8dc96..5e2b8eb 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,4 @@ This client can run on Linux, macOS and Windows. - Website: https://www.ucloud.cn/ - Free software: Apache 2.0 license -- [Documentation](https://ucloud.github.io/ucloud-sdk-python2/) +- [Documentation](https://docs.ucloud.cn/opensdk-python/) diff --git a/examples/auth/README.md b/examples/auth/README.md new file mode 100644 index 0000000..b5cbf07 --- /dev/null +++ b/examples/auth/README.md @@ -0,0 +1,15 @@ +# UCloud SDK Auth Example + +## What is the goal + +Create signature from request payload. + +## Setup Environment + +Don't need. + +## How to run + +```sh +python main.py +``` diff --git a/examples/auth/__init__.py b/examples/auth/__init__.py new file mode 100644 index 0000000..40a96af --- /dev/null +++ b/examples/auth/__init__.py @@ -0,0 +1 @@ +# -*- coding: utf-8 -*- diff --git a/examples/auth/main.py b/examples/auth/main.py new file mode 100644 index 0000000..b073841 --- /dev/null +++ b/examples/auth/main.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- + +from ucloud.core import auth + + +def main(): + cred = auth.Credential( + "ucloudsomeone@example.com1296235120854146120", + "46f09bb9fab4f12dfc160dae12273d5332b5debe", + ) + d = {"Action": "DescribeUHostInstance", "Region": "cn-bj2", "Limit": 10} + print(cred.verify_ac(d)) + + +if __name__ == "__main__": + main() diff --git a/tests/test_unit/test_core/consts.py b/tests/test_unit/test_core/consts.py new file mode 100644 index 0000000..04ad3a2 --- /dev/null +++ b/tests/test_unit/test_core/consts.py @@ -0,0 +1,3 @@ +# -*- coding: utf-8 -*- + +TEST_URL = "https://api.ucloud.cn/" diff --git a/tests/test_unit/test_core/test_auth.py b/tests/test_unit/test_core/test_auth.py index 4128ff3..411c8bd 100644 --- a/tests/test_unit/test_core/test_auth.py +++ b/tests/test_unit/test_core/test_auth.py @@ -24,3 +24,7 @@ def test_verify_ac(): "46f09bb9fab4f12dfc160dae12273d5332b5debe", ) assert cred.verify_ac(d) == "4f9ef5df2abab2c6fccd1e9515cb7e2df8c6bb65" + assert cred.to_dict() == { + "public_key": "ucloudsomeone@example.com1296235120854146120", + "private_key": "46f09bb9fab4f12dfc160dae12273d5332b5debe", + } diff --git a/tests/test_unit/test_core/test_client.py b/tests/test_unit/test_core/test_client.py index 4549389..908d947 100644 --- a/tests/test_unit/test_core/test_client.py +++ b/tests/test_unit/test_core/test_client.py @@ -1,16 +1,21 @@ # -*- coding: utf-8 -*- -import os +import json +import uuid import pytest import logging +import collections +import requests_mock from ucloud.client import Client from ucloud.core import exc +from ucloud.core.transport import RequestsTransport, http from ucloud.testing.mock import MockedTransport +from tests.test_unit.test_core import consts logger = logging.getLogger(__name__) -@pytest.fixture(scope="session", autouse=True) +@pytest.fixture(scope="function", autouse=True) def client(): return Client( { @@ -29,49 +34,68 @@ def transport(): return MockedTransport() -class TestClient(object): - def test_client_invoke(self, client, transport): - transport.mock_data(lambda _: {"RetCode": 0, "Action": "Foo"}) - client.transport = transport - assert client.invoke("Foo") == {"RetCode": 0, "Action": "Foo"} +def test_client_invoke(client): + expected = {"RetCode": 0, "Action": "Foo"} + with requests_mock.Mocker() as m: + m.post( + consts.TEST_URL, + text=json.dumps(expected), + headers={http.REQUEST_UUID_HEADER_KEY: str(uuid.uuid4())}, + ) + assert client.invoke("Foo") == expected + - def test_client_invoke_code_error(self, client, transport): - transport.mock_data(lambda _: {"RetCode": 171, "Action": "Foo"}) - client.transport = transport +def test_client_invoke_code_error(client): + expected = {"RetCode": 171, "Action": "Foo", "Message": "签名错误"} + with requests_mock.Mocker() as m: + m.post( + consts.TEST_URL, + text=json.dumps(expected), + headers={http.REQUEST_UUID_HEADER_KEY: str(uuid.uuid4())}, + ) with pytest.raises(exc.RetCodeException): try: client.invoke("Foo") except exc.RetCodeException as e: - assert str(e) - expected = {"RetCode": 171, "Action": "Foo", "Message": ""} - assert e.json() == expected + assert e.retryable is False + assert e.json() == { + "RetCode": 171, + "Action": "Foo", + "Message": "签名错误", + } raise e - def test_client_invoke_with_retryable_error(self, client, transport): - transport.mock_data(lambda _: {"RetCode": 10000, "Action": "Foo"}) - client.transport = transport + +def test_client_invoke_with_retryable_error(client): + with requests_mock.Mocker() as m: + m.post( + consts.TEST_URL, + text=json.dumps({"RetCode": 10000, "Action": "Foo"}), + ) with pytest.raises(exc.RetCodeException): client.invoke("Foo") - def test_client_invoke_with_unexpected_error(self, client, transport): - def raise_error(_): - raise ValueError("temporary error") - transport.mock_data(raise_error) - client.transport = transport - with pytest.raises(ValueError): - client.invoke("Foo") +def test_client_invoke_with_unexpected_error(client): + def raise_error(_): + raise ValueError("temporary error") + + transport = RequestsTransport() + transport.middleware.request(raise_error) + client.transport = transport + with pytest.raises(ValueError): + client.invoke("Foo") + - def test_client_try_import(self, client): - assert client.pathx() - assert client.stepflow() - assert client.uaccount() - assert client.udb() - assert client.udpn() - assert client.udisk() - assert client.uhost() - assert client.ulb() - assert client.umem() - assert client.unet() - assert client.uphost() - assert client.vpc() +def test_client_try_import(client): + for name in dir(client): + if name.startswith("_") or name in [ + "invoke", + "logged_request_handler", + "logged_response_handler", + "logged_exception_handler", + ]: + continue + client_factory = getattr(client, name) + if isinstance(client_factory, collections.Callable): + print(client_factory()) diff --git a/tests/test_unit/test_core/test_encoder.py b/tests/test_unit/test_core/test_encoder.py index 083bf5a..2f82646 100644 --- a/tests/test_unit/test_core/test_encoder.py +++ b/tests/test_unit/test_core/test_encoder.py @@ -14,6 +14,7 @@ ({"foo": True}, {"foo": "true"}), ({"foo": False}, {"foo": "false"}), ({"IP": ["127.0.0.1"]}, {"IP.0": "127.0.0.1"}), + ({"TemplateParams": [u"中文"]}, {"TemplateParams.0": u"中文"}), ({"IP": ["foo", "bar"]}, {"IP.0": "foo", "IP.1": "bar"}), ({"IP": [{"foo": "bar"}]}, {"IP.0.foo": "bar"}), ], diff --git a/tests/test_unit/test_core/test_transport.py b/tests/test_unit/test_core/test_transport.py index ec519fb..69ff658 100644 --- a/tests/test_unit/test_core/test_transport.py +++ b/tests/test_unit/test_core/test_transport.py @@ -1,72 +1,129 @@ # -*- coding: utf-8 -*- +import json +import uuid import pytest import logging -from ucloud.core.transport import RequestsTransport, Request, Response, utils +import requests_mock +from collections import Counter +from tests.test_unit.test_core.consts import TEST_URL +from ucloud.core import exc +from ucloud.core.transport import ( + RequestsTransport, + Request, + Response, + utils, + http, +) logger = logging.getLogger(__name__) -@pytest.fixture(scope="function", autouse=True) -def transport(): +@pytest.fixture(name="transport", scope="function", autouse=True) +def transport_factory(): return RequestsTransport() -class TestTransport(object): - def test_transport_send(self, transport): - req = Request( - url="http://httpbin.org/anything", - method="post", - json={"foo": "bar"}, - ) - resp = transport.send(req) - assert resp.text - assert resp.json()["json"] == {"foo": "bar"} +@pytest.mark.parametrize( + argnames=("status_code", "content", "expect", "expect_exc", "retryable"), + argvalues=( + ( + 200, + '{"Action": "Mock", "RetCode": 0}', + {"Action": "Mock", "RetCode": 0}, + None, + False, + ), + (500, "{}", None, exc.HTTPStatusException, False), + (429, "{}", None, exc.HTTPStatusException, True), + (500, "x", None, exc.HTTPStatusException, False), + (200, "x", None, exc.InvalidResponseException, False), + ), +) +def test_transport( + transport, status_code, content, expect, expect_exc, retryable +): + with requests_mock.Mocker() as m: + m.post(TEST_URL, text=content, status_code=status_code) + got_exc = None + try: + resp = transport.send(Request(url=TEST_URL, method="post", json={})) + assert resp.json() == expect + except Exception as e: + got_exc = e + if expect_exc: + assert str(got_exc) + assert got_exc.retryable == retryable + assert isinstance(got_exc, expect_exc) - def test_transport_handler(self, transport): - global_env = {} - def request_handler(r): - global_env["req"] = r - return r +def test_transport_handler(transport): + req_key, resp_key, exc_key = "req", "resp", "exc" + counter = Counter({req_key: 0, resp_key: 0, exc_key: 0}) - def response_handler(r): - global_env["resp"] = r - return r + def request_handler(r): + counter[req_key] += 1 + return r - transport.middleware.request(handler=request_handler) - transport.middleware.response(handler=response_handler) - req = Request( - url="http://httpbin.org/anything", - method="post", - json={"foo": "bar"}, + def response_handler(r): + counter[resp_key] += 1 + return r + + def exception_handler(r): + counter[exc_key] += 1 + return r + + transport.middleware.request(handler=request_handler) + transport.middleware.response(handler=response_handler) + transport.middleware.exception(handler=exception_handler) + expect = {"foo": "bar"} + req = Request(url=TEST_URL, method="post", json=expect) + with requests_mock.Mocker() as m: + request_uuid = str(uuid.uuid4()) + m.post( + TEST_URL, + text=json.dumps(expect), + status_code=200, + headers={http.REQUEST_UUID_HEADER_KEY: request_uuid}, ) resp = transport.send(req) assert resp.text - assert resp.json()["json"] == {"foo": "bar"} - assert "req" in global_env - assert "resp" in global_env - - -class TestResponse(object): - def test_guess_json_utf(self): - import json - - encodings = [ - "utf-32", - "utf-8-sig", - "utf-16", - "utf-8", - "utf-16-be", - "utf-16-le", - "utf-32-be", - "utf-32-le", - ] - for e in encodings: - s = json.dumps("表意字符").encode(e) - assert utils.guess_json_utf(s) == e - - def test_response_empty_content(self): - r = Response("http://foo.bar", "post") - assert not r.text + assert resp.json() == expect + assert resp.request_uuid == request_uuid + with pytest.raises(Exception): + transport.send(Request(url="/")) + assert counter[req_key] == 2 + assert counter[resp_key] == 1 + assert counter[exc_key] == 1 + + +def test_guess_json_utf(): + encodings = [ + "utf-32", + "utf-8-sig", + "utf-16", + "utf-8", + "utf-16-be", + "utf-16-le", + "utf-32-be", + "utf-32-le", + ] + for e in encodings: + s = json.dumps("表意字符").encode(e) + assert utils.guess_json_utf(s) == e + + +def test_request_methods(): + req = Request( + TEST_URL, data={"foo": 42}, json={"bar": 42}, params={"q": "search"} + ) + assert req.payload() == {"foo": 42, "bar": 42, "q": "search"} + + +def test_response_methods(): + r = Response(TEST_URL, "post") + assert not r.text + assert r.json() is None + r = Response(TEST_URL, "post", content=b"\xd6", encoding="utf-8") + with pytest.raises(exc.InvalidResponseException): assert r.json() is None diff --git a/ucloud/client.py b/ucloud/client.py index a9e9187..caa97c4 100644 --- a/ucloud/client.py +++ b/ucloud/client.py @@ -1,13 +1,13 @@ # -*- coding: utf-8 -*- """ Code is generated by ucloud-model, DO NOT EDIT IT. """ -from ucloud._compat import CompactClient +from ucloud.core import client -class Client(CompactClient): - def __init__(self, config, transport=None, middleware=None): +class Client(client.Client): + def __init__(self, config, transport=None, middleware=None, logger=None): self._config = config - super(Client, self).__init__(config, transport, middleware) + super(Client, self).__init__(config, transport, middleware, logger) def pathx(self): from ucloud.services.pathx.client import PathXClient diff --git a/ucloud/core/auth/_cfg.py b/ucloud/core/auth/_cfg.py index 7b2264f..d7357c5 100644 --- a/ucloud/core/auth/_cfg.py +++ b/ucloud/core/auth/_cfg.py @@ -13,7 +13,7 @@ class CredentialSchema(schema.Schema): def verify_ac(private_key, params): - """ calculate signature by private_key/public_key + """calculate signature by private_key/public_key the keys can be found on `APIKey documentation `__ @@ -39,7 +39,7 @@ def verify_ac(private_key, params): class Credential(object): - """ credential is the object to store credential information + """credential is the object to store credential information the keys can be found on `APIKey documentation `__ diff --git a/ucloud/core/client/_client.py b/ucloud/core/client/_client.py index bed8035..ed738ba 100644 --- a/ucloud/core/client/_client.py +++ b/ucloud/core/client/_client.py @@ -9,30 +9,30 @@ RequestsTransport, Request, SSLOption, + http, ) from ucloud.core.typesystem import encoder from ucloud.core.utils import log from ucloud.core.utils.middleware import Middleware from ucloud.core import auth, exc -default_transport = RequestsTransport() - class Client(object): def __init__(self, config, transport=None, middleware=None, logger=None): cfg, cred = self._parse_dict_config(config) self.config = cfg self.credential = cred - self.transport = transport or default_transport + self.transport = transport or RequestsTransport() self.logger = logger or log.default_logger if middleware is None: middleware = Middleware() middleware.response(self.logged_response_handler) middleware.request(self.logged_request_handler) + middleware.exception(self.logged_exception_handler) self._middleware = middleware def invoke(self, action, args=None, **options): - """ invoke will invoke the action with arguments data and options + """invoke will invoke the action with arguments data and options :param str action: the api action, like `CreateUHostInstance` :param dict args: arguments of api(action), see doc: `UCloud API Documentation `__ @@ -40,12 +40,13 @@ def invoke(self, action, args=None, **options): """ retries = 0 max_retries = options.get("max_retries") or self.config.max_retries + timeout = options.get("timeout") or self.config.timeout while retries <= max_retries: try: - return self._send(action, args or {}, **options) + return self._send( + action, args or {}, max_retries=max_retries, timeout=timeout + ) except exc.UCloudException as e: - for handler in self.middleware.exception_handlers: - handler(e) if e.retryable and retries != max_retries: logging.info( "Retrying {action}: {args}".format( @@ -55,56 +56,70 @@ def invoke(self, action, args=None, **options): retries += 1 continue raise e - except Exception as e: - for handler in self.middleware.exception_handlers: - handler(e) - raise e @property def middleware(self): return self._middleware def logged_request_handler(self, req): - self.logger.info("[request] {} {}".format(req.get("Action", ""), req)) + action = req.get("Action", "") + self.logger.info("[request] {} {}".format(action, req)) return req - def logged_response_handler(self, resp): + def logged_response_handler(self, resp, http_resp=None): + action = resp.get("Action", "") + request_uuid = http_resp and http_resp.request_uuid self.logger.info( - "[response] {} {}".format(resp.get("Action", ""), resp) + "[response] [{}] {} {}".format(request_uuid or "*", action, resp) ) return resp + def logged_exception_handler(self, e): + if isinstance(e, exc.RetCodeException): + self.logger.warning(e) + else: + self.logger.exception(e) + return e + @staticmethod def _parse_dict_config(config): return Config.from_dict(config), auth.Credential.from_dict(config) - def _send(self, action, args, **options): + def _send(self, action, args, max_retries, timeout): args["Action"] = action for handler in self.middleware.request_handlers: args = handler(args) - req = self._build_http_request(args) - max_retries = options.get("max_retries") or self.config.max_retries - timeout = options.get("timeout") or self.config.timeout - resp = self.transport.send( - req, - ssl_option=SSLOption( - self.config.ssl_verify, - self.config.ssl_cacert, - self.config.ssl_cert, - self.config.ssl_key, - ), - timeout=timeout, - max_retries=max_retries, - ).json() - for handler in self.middleware.response_handlers: - resp = handler(resp) - if int(resp.get("RetCode", -1)) != 0: - raise exc.RetCodeException( - action=req.data.get("Action"), - code=int(resp.get("RetCode")), - message=resp.get("Message"), + try: + req = self._build_http_request(args) + resp = self.transport.send( + req, + ssl_option=SSLOption( + self.config.ssl_verify, + self.config.ssl_cacert, + self.config.ssl_cert, + self.config.ssl_key, + ), + timeout=timeout, + max_retries=max_retries, ) - return resp + data = resp.json() + except Exception as e: + for handler in self.middleware.exception_handlers: + handler(e) + raise e + for handler in self.middleware.response_handlers: + data = handler(data, resp) + if int(data.get("RetCode", -1)) == 0: + return data + ret_code_exc = exc.RetCodeException( + action=req.data.get("Action", ""), + code=int(data.get("RetCode", 0)), + message=data.get("Message", ""), + request_uuid=resp.request_uuid, + ) + for handler in self.middleware.exception_handlers: + handler(ret_code_exc) + raise ret_code_exc def _build_http_request(self, args): config = { diff --git a/ucloud/core/exc/__init__.py b/ucloud/core/exc/__init__.py index 65bf867..bdf3185 100644 --- a/ucloud/core/exc/__init__.py +++ b/ucloud/core/exc/__init__.py @@ -5,11 +5,7 @@ ValidationException, RetCodeException, RetryTimeoutException, + TransportException, + HTTPStatusException, + InvalidResponseException, ) - -__all__ = [ - "UCloudException", - "ValidationException", - "RetCodeException", - "RetryTimeoutException", -] diff --git a/ucloud/core/exc/_exc.py b/ucloud/core/exc/_exc.py index 7c8af49..d9e7795 100644 --- a/ucloud/core/exc/_exc.py +++ b/ucloud/core/exc/_exc.py @@ -13,18 +13,56 @@ def retryable(self): MAX_COMMON_RET_CODE = 2000 +class TransportException(UCloudException): + pass + + +class HTTPStatusException(TransportException): + def __init__(self, status_code, request_uuid=None): + self.status_code = status_code + self.request_uuid = request_uuid + + @property + def retryable(self): + return self.status_code in [429, 502, 503, 504] + + def __str__(self): + return "[{uuid}] {self.status_code} http status error".format( + self=self, uuid=self.request_uuid or "*" + ) + + +class InvalidResponseException(TransportException): + def __init__(self, content, message, request_uuid=None): + self.content = content + self.message = message + self.request_uuid = request_uuid + + @property + def retryable(self): + return False + + def __str__(self): + return "[{uuid}] {self.message}: {self.content}".format( + self=self, uuid=self.request_uuid or "*" + ) + + class RetCodeException(UCloudException): - def __init__(self, action, code, message): + def __init__(self, action, code, message, request_uuid=None): self.action = action self.code = code self.message = message + self.request_uuid = request_uuid @property def retryable(self): return self.code > MAX_COMMON_RET_CODE def __str__(self): - return "{self.action} - {self.code}: {self.message}".format(self=self) + return "[{uuid}] {self.action} - {self.code}: {self.message}".format( + self=self, uuid=self.request_uuid or "*" + ) def json(self): return { diff --git a/ucloud/core/transport/_requests.py b/ucloud/core/transport/_requests.py index 483f258..585088f 100644 --- a/ucloud/core/transport/_requests.py +++ b/ucloud/core/transport/_requests.py @@ -7,10 +7,11 @@ from ucloud.core.transport import http from ucloud.core.transport.http import Request, Response, SSLOption from ucloud.core.utils.middleware import Middleware +from ucloud.core import exc class RequestsTransport(http.Transport): - """ transport is the implementation of http client, use for send a request and return a http response + """transport is the implementation of http client, use for send a request and return a http response :type max_retries: int :param max_retries: max retries is the max number of transport request when occur http error @@ -34,7 +35,7 @@ def __init__( self._middleware = Middleware() def send(self, req, **options): - """ send request and return the response + """send request and return the response :param req: the full http request descriptor :return: the response of http request @@ -53,7 +54,7 @@ def send(self, req, **options): @property def middleware(self): - """ the middleware object, see :mod: + """the middleware object, see :mod: :return: the transport middleware """ @@ -79,6 +80,10 @@ def _send(self, req, **options): resp = self.convert_response(session_resp) resp.request = req resp.response_time = time.time() + if resp.status_code >= 400: + raise exc.HTTPStatusException( + resp.status_code, resp.request_uuid + ) return resp @staticmethod diff --git a/ucloud/core/transport/http.py b/ucloud/core/transport/http.py index 730c977..4bf892c 100644 --- a/ucloud/core/transport/http.py +++ b/ucloud/core/transport/http.py @@ -2,6 +2,7 @@ import logging import json as json_mod +from ucloud.core import exc from ucloud.core.transport import utils from ucloud.core.utils.compat import str @@ -34,6 +35,9 @@ def payload(self): return payload +REQUEST_UUID_HEADER_KEY = "X-UCLOUD-REQUEST-UUID" + + class Response(object): def __init__( self, @@ -52,27 +56,26 @@ def __init__( self.request = request self.status_code = status_code self.reason = reason - self.headers = headers self.content = content self.encoding = encoding self.response_time = 0 + self.headers = headers or {} + self.request_uuid = self.headers.get(REQUEST_UUID_HEADER_KEY) def json(self, **kwargs): - """ json will return the bytes of content - """ + """json will return the bytes of content""" if not self.content: return None - encoding = utils.guess_json_utf(self.content) - if encoding is not None: - try: - return json_mod.loads(self.content.decode(encoding), **kwargs) - except UnicodeDecodeError: - pass - return json_mod.loads(self.text, **kwargs) + try: + return self._decode_json(**kwargs) + except Exception as e: + raise exc.InvalidResponseException( + self.content, str(e), request_uuid=self.request_uuid + ) @property def text(self): - """ text will return the unicode string of content, + """text will return the unicode string of content, see `requests.Response.text` """ if not self.content: @@ -83,6 +86,15 @@ def text(self): content = str(self.content, errors="replace") return content + def _decode_json(self, **kwargs): + encoding = utils.guess_json_utf(self.content) + if encoding is not None: + try: + return json_mod.loads(self.content.decode(encoding), **kwargs) + except UnicodeDecodeError: + pass + return json_mod.loads(self.text, **kwargs) + class SSLOption(object): def __init__( diff --git a/ucloud/core/transport/utils.py b/ucloud/core/transport/utils.py index a538bc9..aa9df96 100644 --- a/ucloud/core/transport/utils.py +++ b/ucloud/core/transport/utils.py @@ -8,7 +8,7 @@ def guess_json_utf(data): - """ guess_json_utf will detect the encoding of bytes, + """guess_json_utf will detect the encoding of bytes, see `requests.utils.guess_json_utf` :rtype: str diff --git a/ucloud/core/typesystem/encoder.py b/ucloud/core/typesystem/encoder.py index 1962f09..b873397 100644 --- a/ucloud/core/typesystem/encoder.py +++ b/ucloud/core/typesystem/encoder.py @@ -1,5 +1,7 @@ # -*- coding: utf-8 -*- +from ucloud.core.utils.compat import str + def encode(d): result = {} diff --git a/ucloud/core/typesystem/fields.py b/ucloud/core/typesystem/fields.py index 9398cf2..556b01d 100644 --- a/ucloud/core/typesystem/fields.py +++ b/ucloud/core/typesystem/fields.py @@ -8,7 +8,7 @@ class List(abstract.Field): - """ array param is the custom field to parse custom param such as: + """array param is the custom field to parse custom param such as: - IP.N - UDisk.N.Size diff --git a/ucloud/core/utils/deco.py b/ucloud/core/utils/deco.py index 23bded4..7cbda05 100644 --- a/ucloud/core/utils/deco.py +++ b/ucloud/core/utils/deco.py @@ -7,7 +7,7 @@ def deprecated(instead_of="", message=""): - """ deprecated is a decorator to mark a function is deprecated. + """deprecated is a decorator to mark a function is deprecated. it will logging warning when this function called >>> @deprecated(instead_of="new_function") diff --git a/ucloud/core/utils/middleware.py b/ucloud/core/utils/middleware.py index 5f4f1c6..b178fc2 100644 --- a/ucloud/core/utils/middleware.py +++ b/ucloud/core/utils/middleware.py @@ -2,7 +2,7 @@ class Middleware(object): - """ middleware is the object to store request/response handlers + """middleware is the object to store request/response handlers >>> middleware = Middleware() @@ -30,7 +30,7 @@ def __init__(self): self.exception_handlers = [] def request(self, handler, index=-1): - """ request is the request handler register to add request handler. + """request is the request handler register to add request handler. :param handler: request handler function, receive request object and return a new request @@ -42,7 +42,7 @@ def request(self, handler, index=-1): return handler def response(self, handler, index=-1): - """ response is the response handler register to add response handler. + """response is the response handler register to add response handler. :param handler: response handler function, receive response object and return a new response @@ -54,7 +54,7 @@ def response(self, handler, index=-1): return handler def exception(self, handler, index=-1): - """ exception is the exception handler register to add exception handler. + """exception is the exception handler register to add exception handler. :param handler: exception handler function, receive exception object and raise a new exception or ignore it diff --git a/ucloud/helpers/utils.py b/ucloud/helpers/utils.py index f8aeb68..0d28427 100644 --- a/ucloud/helpers/utils.py +++ b/ucloud/helpers/utils.py @@ -20,7 +20,7 @@ def gen_password( min_number=1, min_specials=1, ): - """ generate password for any resource + """generate password for any resource >>> len(gen_password(20)) 20 @@ -69,7 +69,7 @@ def first(arr): def b64encode(s): - """ base64 encode + """base64 encode :param str s: input string :return: base64 string @@ -78,7 +78,7 @@ def b64encode(s): def b64decode(s): - """ base64 decode + """base64 decode :param str s: base64 string :return: output string diff --git a/ucloud/helpers/wait.py b/ucloud/helpers/wait.py index a10d3b5..19970ea 100644 --- a/ucloud/helpers/wait.py +++ b/ucloud/helpers/wait.py @@ -13,7 +13,7 @@ class WaitTimeoutException(exc.UCloudException): class StateConf(object): - """ StateConf is the utilities class to wait the state return by refresh function achieve the specific state, + """StateConf is the utilities class to wait the state return by refresh function achieve the specific state, the generally usage is wait the cloud resource, such as uhost, udb ... is ready after created. """ @@ -69,7 +69,7 @@ def wait_for_state( min_backoff_interval=0.1, max_backoff_interval=MAX_BACKOFF_INTERVAL, ): - """ wait_for_state is a utilities function to wait the state return by refresh function achieve the specific state, + """wait_for_state is a utilities function to wait the state return by refresh function achieve the specific state, the generally usage is wait the cloud resource, such as uhost, udb ... is ready after created. diff --git a/ucloud/services/ipsecvpn/client.py b/ucloud/services/ipsecvpn/client.py index 50fa7d1..b8d6924 100644 --- a/ucloud/services/ipsecvpn/client.py +++ b/ucloud/services/ipsecvpn/client.py @@ -12,26 +12,26 @@ def __init__(self, config, transport=None, middleware=None, logger=None): ) def describe_remote_vpn_gateway(self, req=None, **kwargs): - """ DescribeRemoteVPNGateway - 获取客户VPN网关信息 + """DescribeRemoteVPNGateway - 获取客户VPN网关信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - 数据分页值, 默认为20 - **Offset** (int) - 数据偏移量, 默认为0 - **RemoteVPNGatewayIds** (list) - 客户VPN网关的资源ID，例如RemoteVPNGatewayIds.0代表希望获取客户VPN网关1的信息，RemoteVPNGatewayIds.1代表客户VPN网关2，如果为空，则返回当前Region中所有客户VPN网关实例的信息 - **Tag** (str) - 业务组名称，若指定则返回业务组下所有客户VPN网关信息 - + **Response** - **DataSet** (list) - 见 **RemoteVPNGatewayDataSet** 模型定义 - **TotalCount** (int) - 符合条件的客户VPN网关总数 - + **Response Model** - - **RemoteVPNGatewayDataSet** - + + **RemoteVPNGatewayDataSet** + - **ActiveTunnels** (str) - 活跃的隧道id - **CreateTime** (int) - 创建时间 - **Remark** (str) - 备注 @@ -49,26 +49,26 @@ def describe_remote_vpn_gateway(self, req=None, **kwargs): return apis.DescribeRemoteVPNGatewayResponseSchema().loads(resp) def describe_vpn_tunnel(self, req=None, **kwargs): - """ DescribeVPNTunnel - 获取VPN隧道信息 + """DescribeVPNTunnel - 获取VPN隧道信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - 数据分页值, 默认为20 - **Offset** (int) - 数据偏移量, 默认为0 - **Tag** (str) - 业务组名称，若指定则返回指定的业务组下的所有VPN网关的信息 - **VPNTunnelIds** (list) - VPN隧道的资源ID，例如VPNTunnelIds.0代表希望获取信息的VPN隧道1，VPNTunneIds.1代表VPN隧道2，如果为空，则返回当前Region中所有的VPN隧道实例 - + **Response** - **DataSet** (list) - 见 **VPNTunnelDataSet** 模型定义 - **TotalCount** (int) - VPN隧道总数 - + **Response Model** - - **IPSecData** - + + **IPSecData** + - **IPSecAuthenticationAlgorithm** (str) - IPSec通道中使用的认证算法 - **IPSecEncryptionAlgorithm** (str) - IPSec通道中使用的加密算法 - **IPSecLocalSubnetIds** (list) - 指定VPN连接的本地子网，用逗号分隔 @@ -78,8 +78,8 @@ def describe_vpn_tunnel(self, req=None, **kwargs): - **IPSecSALifetime** (str) - IPSec中SA的生存时间 - **IPSecSALifetimeBytes** (str) - IPSec中SA的生存时间（以字节计） - **IKEData** - + **IKEData** + - **IKEAuthenticationAlgorithm** (str) - IKE认证算法 - **IKEDhGroup** (str) - IKEDH组 - **IKEEncryptionAlgorithm** (str) - IKE加密算法 @@ -90,8 +90,8 @@ def describe_vpn_tunnel(self, req=None, **kwargs): - **IKESALifetime** (str) - IKE秘钥生存时间 - **IKEVersion** (str) - IKE版本 - **VPNTunnelDataSet** - + **VPNTunnelDataSet** + - **CreateTime** (int) - 创建时间 - **IKEData** (dict) - 见 **IKEData** 模型定义 - **IPSecData** (dict) - 见 **IPSecData** 模型定义 diff --git a/ucloud/services/ipsecvpn/schemas/apis.py b/ucloud/services/ipsecvpn/schemas/apis.py index 674c305..fb107e5 100644 --- a/ucloud/services/ipsecvpn/schemas/apis.py +++ b/ucloud/services/ipsecvpn/schemas/apis.py @@ -14,8 +14,7 @@ class DescribeRemoteVPNGatewayRequestSchema(schema.RequestSchema): - """ DescribeRemoteVPNGateway - 获取客户VPN网关信息 - """ + """DescribeRemoteVPNGateway - 获取客户VPN网关信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -28,8 +27,7 @@ class DescribeRemoteVPNGatewayRequestSchema(schema.RequestSchema): class DescribeRemoteVPNGatewayResponseSchema(schema.ResponseSchema): - """ DescribeRemoteVPNGateway - 获取客户VPN网关信息 - """ + """DescribeRemoteVPNGateway - 获取客户VPN网关信息""" fields = { "DataSet": fields.List( @@ -49,8 +47,7 @@ class DescribeRemoteVPNGatewayResponseSchema(schema.ResponseSchema): class DescribeVPNTunnelRequestSchema(schema.RequestSchema): - """ DescribeVPNTunnel - 获取VPN隧道信息 - """ + """DescribeVPNTunnel - 获取VPN隧道信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -63,8 +60,7 @@ class DescribeVPNTunnelRequestSchema(schema.RequestSchema): class DescribeVPNTunnelResponseSchema(schema.ResponseSchema): - """ DescribeVPNTunnel - 获取VPN隧道信息 - """ + """DescribeVPNTunnel - 获取VPN隧道信息""" fields = { "DataSet": fields.List( diff --git a/ucloud/services/ipsecvpn/schemas/models.py b/ucloud/services/ipsecvpn/schemas/models.py index 820b870..4a21091 100644 --- a/ucloud/services/ipsecvpn/schemas/models.py +++ b/ucloud/services/ipsecvpn/schemas/models.py @@ -5,8 +5,7 @@ class RemoteVPNGatewayDataSetSchema(schema.ResponseSchema): - """ RemoteVPNGatewayDataSet - DescribeRemoteVPNGateway返回参数 - """ + """RemoteVPNGatewayDataSet - DescribeRemoteVPNGateway返回参数""" fields = { "ActiveTunnels": fields.Str(required=False, load_from="ActiveTunnels"), @@ -27,8 +26,7 @@ class RemoteVPNGatewayDataSetSchema(schema.ResponseSchema): class IPSecDataSchema(schema.ResponseSchema): - """ IPSecData - IPSec参数 - """ + """IPSecData - IPSec参数""" fields = { "IPSecAuthenticationAlgorithm": fields.Str( @@ -53,8 +51,7 @@ class IPSecDataSchema(schema.ResponseSchema): class IKEDataSchema(schema.ResponseSchema): - """ IKEData - IKE信息 - """ + """IKEData - IKE信息""" fields = { "IKEAuthenticationAlgorithm": fields.Str( @@ -78,8 +75,7 @@ class IKEDataSchema(schema.ResponseSchema): class VPNTunnelDataSetSchema(schema.ResponseSchema): - """ VPNTunnelDataSet - DescribeVPNTunnel信息 - """ + """VPNTunnelDataSet - DescribeVPNTunnel信息""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), diff --git a/ucloud/services/pathx/client.py b/ucloud/services/pathx/client.py index f279007..89958cb 100644 --- a/ucloud/services/pathx/client.py +++ b/ucloud/services/pathx/client.py @@ -10,11 +10,11 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(PathXClient, self).__init__(config, transport, middleware, logger) def create_global_ssh_instance(self, req=None, **kwargs): - """ CreateGlobalSSHInstance - 创建GlobalSSH实例 + """CreateGlobalSSHInstance - 创建GlobalSSH实例 **Request** - - **ProjectId** (str) - (Config) 项目ID,如org-xxxx。请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID,如org-xxxx。请参考 `GetProjectList接口 `_ - **Area** (str) - (Required) 填写支持SSH访问IP的地区名称，如“洛杉矶”，“新加坡”，“香港”，“东京”，“华盛顿”，“法兰克福”。Area和AreaCode两者必填一个 - **AreaCode** (str) - (Required) AreaCode, 区域航空港国际通用代码。Area和AreaCode两者必填一个 - **Port** (int) - (Required) SSH端口，1-65535且不能使用80，443端口 @@ -23,13 +23,13 @@ def create_global_ssh_instance(self, req=None, **kwargs): - **CouponId** (str) - 使用代金券可冲抵部分费用 - **Quantity** (int) - 购买数量 - **Remark** (str) - 备注信息 - + **Response** - **AcceleratingDomain** (str) - 加速域名，访问该域名可就近接入 - **InstanceId** (str) - 实例ID，资源唯一标识 - **Message** (str) - 提示信息 - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -39,17 +39,17 @@ def create_global_ssh_instance(self, req=None, **kwargs): return apis.CreateGlobalSSHInstanceResponseSchema().loads(resp) def delete_global_ssh_instance(self, req=None, **kwargs): - """ DeleteGlobalSSHInstance - 删除GlobalSSH实例 + """DeleteGlobalSSHInstance - 删除GlobalSSH实例 **Request** - - **ProjectId** (str) - (Config) 项目ID,如org-xxxx。请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID,如org-xxxx。请参考 `GetProjectList接口 `_ - **InstanceId** (str) - (Required) 实例Id,资源的唯一标识 - + **Response** - **Message** (str) - 提示信息 - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -58,22 +58,22 @@ def delete_global_ssh_instance(self, req=None, **kwargs): return apis.DeleteGlobalSSHInstanceResponseSchema().loads(resp) def describe_global_ssh_area(self, req=None, **kwargs): - """ DescribeGlobalSSHArea - 获取GlobalSSH覆盖的地区列表 用于控制显示哪些机房地域可以使用SSH特性 + """DescribeGlobalSSHArea - 获取GlobalSSH覆盖的地区列表 用于控制显示哪些机房地域可以使用SSH特性 **Request** - - **ProjectId** (str) - (Config) 项目ID,如org-xxxx。请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID,如org-xxxx。请参考 `GetProjectList接口 `_ - **Region** (str) - (Config) 机房地域代号，如hk、 us-ca、 us-ws等。不填默认为空，返回所有支持地区。 - + **Response** - **AreaSet** (list) - 见 **GlobalSSHArea** 模型定义 - **Message** (str) - 提示信息 - + **Response Model** - - **GlobalSSHArea** - + + **GlobalSSHArea** + - **Area** (str) - GlobalSSH覆盖的地区,如香港、东京、洛杉矶等 - **AreaCode** (str) - 地区代号,以地区AirPort Code - **RegionSet** (list) - ucloud机房代号构成的数组，如["hk","us-ca"] @@ -86,21 +86,21 @@ def describe_global_ssh_area(self, req=None, **kwargs): return apis.DescribeGlobalSSHAreaResponseSchema().loads(resp) def describe_global_ssh_instance(self, req=None, **kwargs): - """ DescribeGlobalSSHInstance - 获取GlobalSSH实例列表（传实例ID获取单个实例信息，不传获取项目下全部实例） + """DescribeGlobalSSHInstance - 获取GlobalSSH实例列表（传实例ID获取单个实例信息，不传获取项目下全部实例） **Request** - - **ProjectId** (str) - (Config) 项目ID，如org-xxxx。请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID，如org-xxxx。请参考 `GetProjectList接口 `_ - **InstanceId** (str) - 实例ID，资源唯一标识 - + **Response** - **InstanceSet** (list) - 见 **GlobalSSHInfo** 模型定义 - + **Response Model** - - **GlobalSSHInfo** - + + **GlobalSSHInfo** + - **AcceleratingDomain** (str) - 加速域名 - **Area** (str) - 被SSH访问的IP所在地区 - **ChargeType** (str) - 支付周期，如Month,Year等 @@ -119,18 +119,18 @@ def describe_global_ssh_instance(self, req=None, **kwargs): return apis.DescribeGlobalSSHInstanceResponseSchema().loads(resp) def modify_global_ssh_port(self, req=None, **kwargs): - """ ModifyGlobalSSHPort - 修改GlobalSSH端口 + """ModifyGlobalSSHPort - 修改GlobalSSH端口 **Request** - - **ProjectId** (str) - (Config) 项目ID，如org-xxxx。请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID，如org-xxxx。请参考 `GetProjectList接口 `_ - **InstanceId** (str) - (Required) 实例ID,资源唯一标识 - **Port** (int) - (Required) 调整后的SSH登陆端口 - + **Response** - **Message** (str) - 提示信息 - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -139,18 +139,18 @@ def modify_global_ssh_port(self, req=None, **kwargs): return apis.ModifyGlobalSSHPortResponseSchema().loads(resp) def modify_global_ssh_remark(self, req=None, **kwargs): - """ ModifyGlobalSSHRemark - 修改GlobalSSH备注 + """ModifyGlobalSSHRemark - 修改GlobalSSH备注 **Request** - - **ProjectId** (str) - (Config) 项目ID，如org-xxxx。请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID，如org-xxxx。请参考 `GetProjectList接口 `_ - **InstanceId** (str) - (Required) 实例ID,资源唯一标识 - **Remark** (str) - 备注信息，不填默认为空字符串 - + **Response** - **Message** (str) - 接口返回消息 - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) diff --git a/ucloud/services/pathx/schemas/apis.py b/ucloud/services/pathx/schemas/apis.py index 266e759..a49b7a5 100644 --- a/ucloud/services/pathx/schemas/apis.py +++ b/ucloud/services/pathx/schemas/apis.py @@ -14,8 +14,7 @@ class CreateGlobalSSHInstanceRequestSchema(schema.RequestSchema): - """ CreateGlobalSSHInstance - 创建GlobalSSH实例 - """ + """CreateGlobalSSHInstance - 创建GlobalSSH实例""" fields = { "Area": fields.Str(required=True, dump_to="Area"), @@ -31,8 +30,7 @@ class CreateGlobalSSHInstanceRequestSchema(schema.RequestSchema): class CreateGlobalSSHInstanceResponseSchema(schema.ResponseSchema): - """ CreateGlobalSSHInstance - 创建GlobalSSH实例 - """ + """CreateGlobalSSHInstance - 创建GlobalSSH实例""" fields = { "AcceleratingDomain": fields.Str( @@ -51,8 +49,7 @@ class CreateGlobalSSHInstanceResponseSchema(schema.ResponseSchema): class DeleteGlobalSSHInstanceRequestSchema(schema.RequestSchema): - """ DeleteGlobalSSHInstance - 删除GlobalSSH实例 - """ + """DeleteGlobalSSHInstance - 删除GlobalSSH实例""" fields = { "InstanceId": fields.Str(required=True, dump_to="InstanceId"), @@ -61,8 +58,7 @@ class DeleteGlobalSSHInstanceRequestSchema(schema.RequestSchema): class DeleteGlobalSSHInstanceResponseSchema(schema.ResponseSchema): - """ DeleteGlobalSSHInstance - 删除GlobalSSH实例 - """ + """DeleteGlobalSSHInstance - 删除GlobalSSH实例""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -75,8 +71,7 @@ class DeleteGlobalSSHInstanceResponseSchema(schema.ResponseSchema): class DescribeGlobalSSHAreaRequestSchema(schema.RequestSchema): - """ DescribeGlobalSSHArea - 获取GlobalSSH覆盖的地区列表 用于控制显示哪些机房地域可以使用SSH特性 - """ + """DescribeGlobalSSHArea - 获取GlobalSSH覆盖的地区列表 用于控制显示哪些机房地域可以使用SSH特性""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -85,8 +80,7 @@ class DescribeGlobalSSHAreaRequestSchema(schema.RequestSchema): class DescribeGlobalSSHAreaResponseSchema(schema.ResponseSchema): - """ DescribeGlobalSSHArea - 获取GlobalSSH覆盖的地区列表 用于控制显示哪些机房地域可以使用SSH特性 - """ + """DescribeGlobalSSHArea - 获取GlobalSSH覆盖的地区列表 用于控制显示哪些机房地域可以使用SSH特性""" fields = { "AreaSet": fields.List( @@ -104,8 +98,7 @@ class DescribeGlobalSSHAreaResponseSchema(schema.ResponseSchema): class DescribeGlobalSSHInstanceRequestSchema(schema.RequestSchema): - """ DescribeGlobalSSHInstance - 获取GlobalSSH实例列表（传实例ID获取单个实例信息，不传获取项目下全部实例） - """ + """DescribeGlobalSSHInstance - 获取GlobalSSH实例列表（传实例ID获取单个实例信息，不传获取项目下全部实例）""" fields = { "InstanceId": fields.Str(required=False, dump_to="InstanceId"), @@ -114,8 +107,7 @@ class DescribeGlobalSSHInstanceRequestSchema(schema.RequestSchema): class DescribeGlobalSSHInstanceResponseSchema(schema.ResponseSchema): - """ DescribeGlobalSSHInstance - 获取GlobalSSH实例列表（传实例ID获取单个实例信息，不传获取项目下全部实例） - """ + """DescribeGlobalSSHInstance - 获取GlobalSSH实例列表（传实例ID获取单个实例信息，不传获取项目下全部实例）""" fields = { "InstanceSet": fields.List( @@ -134,8 +126,7 @@ class DescribeGlobalSSHInstanceResponseSchema(schema.ResponseSchema): class ModifyGlobalSSHPortRequestSchema(schema.RequestSchema): - """ ModifyGlobalSSHPort - 修改GlobalSSH端口 - """ + """ModifyGlobalSSHPort - 修改GlobalSSH端口""" fields = { "InstanceId": fields.Str(required=True, dump_to="InstanceId"), @@ -145,8 +136,7 @@ class ModifyGlobalSSHPortRequestSchema(schema.RequestSchema): class ModifyGlobalSSHPortResponseSchema(schema.ResponseSchema): - """ ModifyGlobalSSHPort - 修改GlobalSSH端口 - """ + """ModifyGlobalSSHPort - 修改GlobalSSH端口""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -159,8 +149,7 @@ class ModifyGlobalSSHPortResponseSchema(schema.ResponseSchema): class ModifyGlobalSSHRemarkRequestSchema(schema.RequestSchema): - """ ModifyGlobalSSHRemark - 修改GlobalSSH备注 - """ + """ModifyGlobalSSHRemark - 修改GlobalSSH备注""" fields = { "InstanceId": fields.Str(required=True, dump_to="InstanceId"), @@ -170,7 +159,6 @@ class ModifyGlobalSSHRemarkRequestSchema(schema.RequestSchema): class ModifyGlobalSSHRemarkResponseSchema(schema.ResponseSchema): - """ ModifyGlobalSSHRemark - 修改GlobalSSH备注 - """ + """ModifyGlobalSSHRemark - 修改GlobalSSH备注""" fields = {"Message": fields.Str(required=False, load_from="Message")} diff --git a/ucloud/services/pathx/schemas/models.py b/ucloud/services/pathx/schemas/models.py index e85ea28..14e8034 100644 --- a/ucloud/services/pathx/schemas/models.py +++ b/ucloud/services/pathx/schemas/models.py @@ -5,8 +5,7 @@ class GlobalSSHAreaSchema(schema.ResponseSchema): - """ GlobalSSHArea - GlobalSSH覆盖地区,包括关联的UCloud机房信息 - """ + """GlobalSSHArea - GlobalSSH覆盖地区,包括关联的UCloud机房信息""" fields = { "Area": fields.Str(required=True, load_from="Area"), @@ -16,8 +15,7 @@ class GlobalSSHAreaSchema(schema.ResponseSchema): class GlobalSSHInfoSchema(schema.ResponseSchema): - """ GlobalSSHInfo - GlobalSSH实例信息 - """ + """GlobalSSHInfo - GlobalSSH实例信息""" fields = { "AcceleratingDomain": fields.Str( diff --git a/ucloud/services/stepflow/client.py b/ucloud/services/stepflow/client.py index dfda061..c0a57c7 100644 --- a/ucloud/services/stepflow/client.py +++ b/ucloud/services/stepflow/client.py @@ -12,21 +12,21 @@ def __init__(self, config, transport=None, middleware=None, logger=None): ) def create_sf_workflow_from_template(self, req=None, **kwargs): - """ CreateSFWorkflowFromTemplate - 导入工作流定义 + """CreateSFWorkflowFromTemplate - 导入工作流定义 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Namespace** (str) - (Required) 需要创建的工作流namespace - **Workflow** (str) - (Required) 描述工作流定义的base64字符串 - **WorkflowName** (str) - (Required) 需要创建的工作流名称 - + **Response** - **Message** (str) - 返回消息 - **Version** (int) - 创建的工作流版本号 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -36,32 +36,32 @@ def create_sf_workflow_from_template(self, req=None, **kwargs): return apis.CreateSFWorkflowFromTemplateResponseSchema().loads(resp) def get_sf_workflow_template(self, req=None, **kwargs): - """ GetSFWorkflowTemplate - 导出工作流定义 + """GetSFWorkflowTemplate - 导出工作流定义 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **WorkflowId** (str) - (Required) 被导出工作流的Id - **WorkflowVersion** (int) - 被导出工作流的版本号。取值范围：WorkflowVersion >= 1；默认会获取发布版本对应的workflow；超过最大版本会返回错误 - + **Response** - **Message** (str) - 返回消息 - **Version** (int) - 导出工作流的版本号 - **Workflow** (dict) - 见 **WorkflowTemplate** 模型定义 - **WorkflowId** (str) - 导出工作流的Id - + **Response Model** - - **Param** - + + **Param** + - **Name** (str) - 参数名称 - **Type** (str) - 参数类型 - **Value** (str) - 参数值 - **ActivityTemplate** - + **ActivityTemplate** + - **Input** (dict) - Activity的输入 - **Name** (str) - Activity的名字 - **Next** (str) - 下一个Activity的名字 @@ -70,8 +70,8 @@ def get_sf_workflow_template(self, req=None, **kwargs): - **Timeout** (str) - Activity的超时时间 - **Type** (str) - Activity的类型 - **WorkflowTemplate** - + **WorkflowTemplate** + - **Activites** (list) - 见 **ActivityTemplate** 模型定义 - **Input** (list) - 见 **Param** 模型定义 - **Output** (list) - 见 **Param** 模型定义 diff --git a/ucloud/services/stepflow/schemas/apis.py b/ucloud/services/stepflow/schemas/apis.py index 20037c4..256b0ac 100644 --- a/ucloud/services/stepflow/schemas/apis.py +++ b/ucloud/services/stepflow/schemas/apis.py @@ -14,8 +14,7 @@ class CreateSFWorkflowFromTemplateRequestSchema(schema.RequestSchema): - """ CreateSFWorkflowFromTemplate - 导入工作流定义 - """ + """CreateSFWorkflowFromTemplate - 导入工作流定义""" fields = { "Namespace": fields.Str(required=True, dump_to="Namespace"), @@ -27,8 +26,7 @@ class CreateSFWorkflowFromTemplateRequestSchema(schema.RequestSchema): class CreateSFWorkflowFromTemplateResponseSchema(schema.ResponseSchema): - """ CreateSFWorkflowFromTemplate - 导入工作流定义 - """ + """CreateSFWorkflowFromTemplate - 导入工作流定义""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -44,8 +42,7 @@ class CreateSFWorkflowFromTemplateResponseSchema(schema.ResponseSchema): class GetSFWorkflowTemplateRequestSchema(schema.RequestSchema): - """ GetSFWorkflowTemplate - 导出工作流定义 - """ + """GetSFWorkflowTemplate - 导出工作流定义""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -58,8 +55,7 @@ class GetSFWorkflowTemplateRequestSchema(schema.RequestSchema): class GetSFWorkflowTemplateResponseSchema(schema.ResponseSchema): - """ GetSFWorkflowTemplate - 导出工作流定义 - """ + """GetSFWorkflowTemplate - 导出工作流定义""" fields = { "Message": fields.Str(required=False, load_from="Message"), diff --git a/ucloud/services/stepflow/schemas/models.py b/ucloud/services/stepflow/schemas/models.py index bac8e96..d53f0fd 100644 --- a/ucloud/services/stepflow/schemas/models.py +++ b/ucloud/services/stepflow/schemas/models.py @@ -5,8 +5,7 @@ class ParamSchema(schema.ResponseSchema): - """ Param - 工作流参数 - """ + """Param - 工作流参数""" fields = { "Name": fields.Str(required=False, load_from="Name"), @@ -16,8 +15,7 @@ class ParamSchema(schema.ResponseSchema): class ActivityTemplateSchema(schema.ResponseSchema): - """ ActivityTemplate - 工作流的Activity定义 - """ + """ActivityTemplate - 工作流的Activity定义""" fields = { "Input": fields.Str(), @@ -31,8 +29,7 @@ class ActivityTemplateSchema(schema.ResponseSchema): class WorkflowTemplateSchema(schema.ResponseSchema): - """ WorkflowTemplate - Workflow对象定义 - """ + """WorkflowTemplate - Workflow对象定义""" fields = { "Activites": fields.List(ActivityTemplateSchema()), diff --git a/ucloud/services/uaccount/client.py b/ucloud/services/uaccount/client.py index 99b43ff..d5b4a19 100644 --- a/ucloud/services/uaccount/client.py +++ b/ucloud/services/uaccount/client.py @@ -12,16 +12,16 @@ def __init__(self, config, transport=None, middleware=None, logger=None): ) def create_project(self, req=None, **kwargs): - """ CreateProject - 创建项目 + """CreateProject - 创建项目 **Request** - **ProjectName** (str) - (Required) 项目名称 - + **Response** - **ProjectId** (str) - 所创建项目的Id - + """ d = {} req and d.update(req) @@ -31,21 +31,21 @@ def create_project(self, req=None, **kwargs): return apis.CreateProjectResponseSchema().loads(resp) def get_project_list(self, req=None, **kwargs): - """ GetProjectList - 获取项目列表 + """GetProjectList - 获取项目列表 **Request** - **IsFinance** (str) - 是否是财务账号 - + **Response** - **ProjectCount** (int) - 项目总数 - **ProjectSet** (list) - 见 **ProjectListInfo** 模型定义 - + **Response Model** - - **ProjectListInfo** - + + **ProjectListInfo** + - **CreateTime** (int) - 创建时间(Unix时间戳) - **IsDefault** (bool) - 是否为默认项目 - **MemberCount** (int) - 项目下成员数量 @@ -63,19 +63,19 @@ def get_project_list(self, req=None, **kwargs): return apis.GetProjectListResponseSchema().loads(resp) def get_region(self, req=None, **kwargs): - """ GetRegion - 获取用户在各数据中心的权限等信息 + """GetRegion - 获取用户在各数据中心的权限等信息 **Request** - + **Response** - **Regions** (list) - 见 **RegionInfo** 模型定义 - + **Response Model** - - **RegionInfo** - + + **RegionInfo** + - **BitMaps** (str) - 用户在此数据中心的权限位 - **IsDefault** (bool) - 是否用户当前默认数据中心 - **Region** (str) - 地域名字，如cn-bj @@ -91,19 +91,19 @@ def get_region(self, req=None, **kwargs): return apis.GetRegionResponseSchema().loads(resp) def get_user_info(self, req=None, **kwargs): - """ GetUserInfo - 获取用户信息 + """GetUserInfo - 获取用户信息 **Request** - + **Response** - **DataSet** (list) - 见 **UserInfo** 模型定义 - + **Response Model** - - **UserInfo** - + + **UserInfo** + - **Admin** (int) - 是否超级管理员 0:否 1:是 - **Administrator** (str) - 管理员 - **AuthState** (str) - 实名认证状态 @@ -129,16 +129,16 @@ def get_user_info(self, req=None, **kwargs): return apis.GetUserInfoResponseSchema().loads(resp) def modify_project(self, req=None, **kwargs): - """ ModifyProject - 修改项目 + """ModifyProject - 修改项目 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **ProjectName** (str) - (Required) 新的项目名称 - + **Response** - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -147,15 +147,15 @@ def modify_project(self, req=None, **kwargs): return apis.ModifyProjectResponseSchema().loads(resp) def terminate_project(self, req=None, **kwargs): - """ TerminateProject - 删除项目 + """TerminateProject - 删除项目 **Request** - **ProjectId** (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。 - + **Response** - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) diff --git a/ucloud/services/uaccount/schemas/apis.py b/ucloud/services/uaccount/schemas/apis.py index ad5aac2..e99ed36 100644 --- a/ucloud/services/uaccount/schemas/apis.py +++ b/ucloud/services/uaccount/schemas/apis.py @@ -14,15 +14,13 @@ class CreateProjectRequestSchema(schema.RequestSchema): - """ CreateProject - 创建项目 - """ + """CreateProject - 创建项目""" fields = {"ProjectName": fields.Str(required=True, dump_to="ProjectName")} class CreateProjectResponseSchema(schema.ResponseSchema): - """ CreateProject - 创建项目 - """ + """CreateProject - 创建项目""" fields = {"ProjectId": fields.Str(required=True, load_from="ProjectId")} @@ -35,15 +33,13 @@ class CreateProjectResponseSchema(schema.ResponseSchema): class GetProjectListRequestSchema(schema.RequestSchema): - """ GetProjectList - 获取项目列表 - """ + """GetProjectList - 获取项目列表""" fields = {"IsFinance": fields.Str(required=False, dump_to="IsFinance")} class GetProjectListResponseSchema(schema.ResponseSchema): - """ GetProjectList - 获取项目列表 - """ + """GetProjectList - 获取项目列表""" fields = { "ProjectCount": fields.Int(required=True, load_from="ProjectCount"), @@ -63,15 +59,13 @@ class GetProjectListResponseSchema(schema.ResponseSchema): class GetRegionRequestSchema(schema.RequestSchema): - """ GetRegion - 获取用户在各数据中心的权限等信息 - """ + """GetRegion - 获取用户在各数据中心的权限等信息""" fields = {} class GetRegionResponseSchema(schema.ResponseSchema): - """ GetRegion - 获取用户在各数据中心的权限等信息 - """ + """GetRegion - 获取用户在各数据中心的权限等信息""" fields = { "Regions": fields.List( @@ -88,15 +82,13 @@ class GetRegionResponseSchema(schema.ResponseSchema): class GetUserInfoRequestSchema(schema.RequestSchema): - """ GetUserInfo - 获取用户信息 - """ + """GetUserInfo - 获取用户信息""" fields = {} class GetUserInfoResponseSchema(schema.ResponseSchema): - """ GetUserInfo - 获取用户信息 - """ + """GetUserInfo - 获取用户信息""" fields = { "DataSet": fields.List( @@ -113,8 +105,7 @@ class GetUserInfoResponseSchema(schema.ResponseSchema): class ModifyProjectRequestSchema(schema.RequestSchema): - """ ModifyProject - 修改项目 - """ + """ModifyProject - 修改项目""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -123,8 +114,7 @@ class ModifyProjectRequestSchema(schema.RequestSchema): class ModifyProjectResponseSchema(schema.ResponseSchema): - """ ModifyProject - 修改项目 - """ + """ModifyProject - 修改项目""" fields = {} @@ -137,14 +127,12 @@ class ModifyProjectResponseSchema(schema.ResponseSchema): class TerminateProjectRequestSchema(schema.RequestSchema): - """ TerminateProject - 删除项目 - """ + """TerminateProject - 删除项目""" fields = {"ProjectId": fields.Str(required=False, dump_to="ProjectId")} class TerminateProjectResponseSchema(schema.ResponseSchema): - """ TerminateProject - 删除项目 - """ + """TerminateProject - 删除项目""" fields = {} diff --git a/ucloud/services/uaccount/schemas/models.py b/ucloud/services/uaccount/schemas/models.py index ce08652..48999f7 100644 --- a/ucloud/services/uaccount/schemas/models.py +++ b/ucloud/services/uaccount/schemas/models.py @@ -5,8 +5,7 @@ class ProjectListInfoSchema(schema.ResponseSchema): - """ ProjectListInfo - 项目信息 - """ + """ProjectListInfo - 项目信息""" fields = { "CreateTime": fields.Int(required=True, load_from="CreateTime"), @@ -21,8 +20,7 @@ class ProjectListInfoSchema(schema.ResponseSchema): class RegionInfoSchema(schema.ResponseSchema): - """ RegionInfo - 数据中心信息 - """ + """RegionInfo - 数据中心信息""" fields = { "BitMaps": fields.Str(required=True, load_from="BitMaps"), @@ -35,8 +33,7 @@ class RegionInfoSchema(schema.ResponseSchema): class UserInfoSchema(schema.ResponseSchema): - """ UserInfo - 用户信息 - """ + """UserInfo - 用户信息""" fields = { "Admin": fields.Int(required=True, load_from="Admin"), diff --git a/ucloud/services/ucdn/client.py b/ucloud/services/ucdn/client.py index 59e1393..7ba3594 100644 --- a/ucloud/services/ucdn/client.py +++ b/ucloud/services/ucdn/client.py @@ -10,16 +10,16 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(UCDNClient, self).__init__(config, transport, middleware, logger) def batch_describe_new_ucdn_domain(self, req=None, **kwargs): - """ BatchDescribeNewUcdnDomain - 批量获取加速域名配置 + """BatchDescribeNewUcdnDomain - 批量获取加速域名配置 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **ChannelType** (str) - 渠道ucdn、ufile、uvideo - **DomainId** (list) - 域名id，创建域名时生成的资源id，默认获取账号下的所有域名信息，n为自然数 - **Limit** (int) - 返回数据长度，如果制定了Offset，则默认20，否则默认全部，非负整数 - **Offset** (int) - 数据偏移量，默认0，非负整数 - + **Response** - **Arrearage** (list) - 标识欠费的数组，数组含有下列元素值， 1=国内流量有欠费 2=国外流量有欠费 3=国内带宽有欠费 4=国外带宽有欠费 @@ -29,11 +29,11 @@ def batch_describe_new_ucdn_domain(self, req=None, **kwargs): - **MaxDomainNum** (int) - 最大域名数量，默认20 - **TotalCount** (int) - 满足条件的域名个数 - **Vip** (str) - vip标示，yes-是 no-否 - + **Response Model** - - **CacheConf** - + + **CacheConf** + - **CacheBehavior** (int) - 是否缓存，1为缓存，0为不缓存。为0的情况下，CacheTTL和CacheUnit强制不生效 - **CacheTTL** (int) - 缓存时间 - **CacheUnit** (str) - 缓存时间的单位。sec（秒），min（分钟），hour（小时），day（天） @@ -43,12 +43,12 @@ def batch_describe_new_ucdn_domain(self, req=None, **kwargs): - **IgnoreQueryString** (int) - 是否忽略参数缓存（0为不忽略，1为忽略，默认为0） - **PathPattern** (str) - 路径模式，支持正则 - **AccessConf** - + **AccessConf** + - **IpBlacklist** (str) - 多个ip用逗号隔开 - **DomainInfo** - + **DomainInfo** + - **AccessConf** (dict) - 见 **AccessConf** 模型定义 - **AreaCode** (str) - 查询带宽区域 cn代表国内 abroad代表海外 不填默认为全部区域 - **CacheConf** (list) - 见 **CacheConf** 模型定义 @@ -83,35 +83,35 @@ def batch_describe_new_ucdn_domain(self, req=None, **kwargs): return apis.BatchDescribeNewUcdnDomainResponseSchema().loads(resp) def describe_new_ucdn_prefetch_cache_task(self, req=None, **kwargs): - """ DescribeNewUcdnPrefetchCacheTask - 获取预取任务状态 + """DescribeNewUcdnPrefetchCacheTask - 获取预取任务状态 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **BeginTime** (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值 - **EndTime** (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。 - **Limit** (int) - 返回数据长度,默认全部，自然数 - **Offset** (int) - 数据偏移量，默认为0，自然数 - **Status** (str) - 需要获取的内容预热的状态，枚举值：success：成功；wait：等待处理；process：正在处理；failure：失败； unknow：未知，默认选择所有状态 - **TaskId** (list) - 提交任务时返回的任务ID - + **Response** - **TaskList** (list) - 见 **TaskInfo** 模型定义 - **TotalCount** (int) - 预热任务的总数 - + **Response Model** - - **UrlProgressInfo** - + + **UrlProgressInfo** + - **CreateTime** (int) - 刷新任务创建的时间。格式为Unix Timestamp - **FinishTime** (int) - 任务完成时间。格式为Unix Timestamp - **Progress** (int) - 刷新进度，单位% - **Status** (str) - 刷新任务的当前状态，枚举值：success：成功；wait：排队中；process：处理中；failure：失败； unknow：未知 - **Url** (str) - 刷新的单条url - **TaskInfo** - + **TaskInfo** + - **CreateTime** (int) - 刷新任务创建的时间。格式为Unix Timestamp - **Status** (str) - 刷新任务的当前状态，枚举值：success：成功；wait：排队中；process：处理中；failure：失败； unknow：未知 - **TaskId** (str) - 提交任务时返回的任务ID @@ -126,35 +126,35 @@ def describe_new_ucdn_prefetch_cache_task(self, req=None, **kwargs): return apis.DescribeNewUcdnPrefetchCacheTaskResponseSchema().loads(resp) def describe_new_ucdn_refresh_cache_task(self, req=None, **kwargs): - """ DescribeNewUcdnRefreshCacheTask - 获取域名刷新任务状态 + """DescribeNewUcdnRefreshCacheTask - 获取域名刷新任务状态 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **BeginTime** (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值 - **EndTime** (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。 - **Limit** (int) - 返回数据长度,默认全部，自然数 - **Offset** (int) - 数据偏移量，默认为0，自然数 - **Status** (str) - 需要获取的内容刷新的状态，枚举值：success：成功；wait：等待处理；process：正在处理；failure：失败； unknow：未知，默认选择所有状态 - **TaskId** (list) - 提交任务时返回的任务ID - + **Response** - **TaskList** (list) - 见 **TaskInfo** 模型定义 - **TotalCount** (int) - 刷新任务的总数 - + **Response Model** - - **UrlProgressInfo** - + + **UrlProgressInfo** + - **CreateTime** (int) - 刷新任务创建的时间。格式为Unix Timestamp - **FinishTime** (int) - 任务完成时间。格式为Unix Timestamp - **Progress** (int) - 刷新进度，单位% - **Status** (str) - 刷新任务的当前状态，枚举值：success：成功；wait：排队中；process：处理中；failure：失败； unknow：未知 - **Url** (str) - 刷新的单条url - **TaskInfo** - + **TaskInfo** + - **CreateTime** (int) - 刷新任务创建的时间。格式为Unix Timestamp - **Status** (str) - 刷新任务的当前状态，枚举值：success：成功；wait：排队中；process：处理中；failure：失败； unknow：未知 - **TaskId** (str) - 提交任务时返回的任务ID @@ -169,26 +169,26 @@ def describe_new_ucdn_refresh_cache_task(self, req=None, **kwargs): return apis.DescribeNewUcdnRefreshCacheTaskResponseSchema().loads(resp) def get_new_ucdn_domain_bandwidth(self, req=None, **kwargs): - """ GetNewUcdnDomainBandwidth - 获取域名带宽数据 + """GetNewUcdnDomainBandwidth - 获取域名带宽数据 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Type** (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度） - **Areacode** (str) - 查询带宽区域 cn代表国内 abroad代表海外 不填默认为全部区域 - **BeginTime** (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参 数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。 - **DomainId** (list) - 域名id，创建域名时生成的id。默认全部域名 - **EndTime** (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。 - + **Response** - **BandwidthList** (list) - 见 **BandwidthInfo** 模型定义 - **Traffic** (str) - 从起始时间到结束时间内的所使用的CDN总流量，单位GB - + **Response Model** - - **BandwidthInfo** - + + **BandwidthInfo** + - **CdnBandwidth** (str) - 返回值返回指定时间区间内CDN的带宽峰值，单位Mbps（如果请求参数Type为0，则Value是五分钟粒度的带宽值，如果Type为1，则Value是1小时的带宽峰值，如果Type为2，则Value是一天内的带宽峰值） - **Time** (int) - 带宽获取的时间点。格式：时间戳 @@ -200,25 +200,25 @@ def get_new_ucdn_domain_bandwidth(self, req=None, **kwargs): return apis.GetNewUcdnDomainBandwidthResponseSchema().loads(resp) def get_new_ucdn_domain_hit_rate(self, req=None, **kwargs): - """ GetNewUcdnDomainHitRate - 获取域名命中率 + """GetNewUcdnDomainHitRate - 获取域名命中率 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Type** (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度） - **Areacode** (str) - 查询带宽区域 cn代表国内 abroad代表海外，只支持国内 - **BeginTime** (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参 数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。 - **DomainId** (list) - 域名id，创建域名时生成的id。默认全部域名 - **EndTime** (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。 - + **Response** - **HitRateList** (list) - 见 **HitRateInfo** 模型定义 - + **Response Model** - - **HitRateInfo** - + + **HitRateInfo** + - **FlowHitRate** (float) - 流量命中率，单位% - **RequestHitRate** (float) - 请求数命中率，单位% - **Time** (int) - 带宽获取的时间点。格式：时间戳 @@ -231,25 +231,25 @@ def get_new_ucdn_domain_hit_rate(self, req=None, **kwargs): return apis.GetNewUcdnDomainHitRateResponseSchema().loads(resp) def get_new_ucdn_domain_http_code(self, req=None, **kwargs): - """ GetNewUcdnDomainHttpCode - 获取域名状态码监控 + """GetNewUcdnDomainHttpCode - 获取域名状态码监控 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Type** (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度） - **Areacode** (str) - 查询带宽区域 cn代表国内 abroad代表海外，只支持国内 - **BeginTime** (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参 数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。 - **DomainId** (list) - 域名id，创建域名时生成的id。默认全部域名 - **EndTime** (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。 - + **Response** - **HttpCodeDetail** (list) - 见 **HttpCodeInfo** 模型定义 - + **Response Model** - - **HttpCodeInfo** - + + **HttpCodeInfo** + - **HttpFiveXX** (int) - 5xx数量 - **HttpFourXX** (int) - 4xx数量 - **HttpOneXX** (int) - 1xx数量 @@ -265,25 +265,25 @@ def get_new_ucdn_domain_http_code(self, req=None, **kwargs): return apis.GetNewUcdnDomainHttpCodeResponseSchema().loads(resp) def get_new_ucdn_domain_http_code_v2(self, req=None, **kwargs): - """ GetNewUcdnDomainHttpCodeV2 - 获取域名详细状态码监控 + """GetNewUcdnDomainHttpCodeV2 - 获取域名详细状态码监控 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **BeginTime** (int) - (Required) 查询的起始时间，格式为Unix Timestamp。 - **EndTime** (int) - (Required) 查询的结束时间，格式为Unix Timestamp。 - **Type** (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天粒度，3表示按照一分钟粒度） - **Areacode** (str) - 查询带宽区域 cn代表国内 abroad代表海外，只支持国内 - **DomainId** (list) - 域名id，创建域名时生成的id。默认全部域名 - + **Response** - **HttpCodeV2Detail** (list) - 见 **HttpCodeV2Detail** 模型定义 - + **Response Model** - - **HttpCodeV2Detail** - + + **HttpCodeV2Detail** + - **Http100** (int) - http100数量 - **Http101** (int) - http101数量 - **Http102** (int) - http102数量 @@ -350,25 +350,25 @@ def get_new_ucdn_domain_http_code_v2(self, req=None, **kwargs): return apis.GetNewUcdnDomainHttpCodeV2ResponseSchema().loads(resp) def get_new_ucdn_domain_request_num(self, req=None, **kwargs): - """ GetNewUcdnDomainRequestNum - 获取域名请求数 + """GetNewUcdnDomainRequestNum - 获取域名请求数 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Type** (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度） - **Areacode** (str) - 查询区域 cn代表国内 abroad代表海外，只支持国内 - **BeginTime** (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参 数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。 - **DomainId** (list) - 域名id，创建域名时生成的id。默认全部域名 - **EndTime** (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。 - + **Response** - **RequestList** (list) - 见 **RequestInfo** 模型定义 - + **Response Model** - - **RequestInfo** - + + **RequestInfo** + - **CdnRequest** (float) - 返回值返回指定时间区间内的cdn收到的请求次数之和 - **OriginRequest** (float) - 返回值返回指定时间区间内的cdn回源的请求次数之和 - **Time** (int) - 带宽获取的时间点。格式：时间戳 @@ -381,30 +381,30 @@ def get_new_ucdn_domain_request_num(self, req=None, **kwargs): return apis.GetNewUcdnDomainRequestNumResponseSchema().loads(resp) def get_ucdn_domain_log(self, req=None, **kwargs): - """ GetUcdnDomainLog - 获取加速域名原始日志 + """GetUcdnDomainLog - 获取加速域名原始日志 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **BeginTime** (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。 - **DomainId** (list) - 域名ID，创建加速域名时生成。默认全部域名 - **EndTime** (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。 - **Type** (int) - 查询粒度 0=default(没有粒度) 1=按小时 2=按天 - + **Response** - **LogSet** (list) - 见 **LogSetList** 模型定义 - + **Response Model** - - **LogSetInfo** - + + **LogSetInfo** + - **AbroadLog** (list) - 国外日志url列表 - **CnLog** (list) - 国内日志url列表 - **Time** (int) - 日志时间UnixTime - **LogSetList** - + **LogSetList** + - **Domain** (str) - 域名 - **Logs** (list) - 见 **LogSetInfo** 模型定义 @@ -416,17 +416,17 @@ def get_ucdn_domain_log(self, req=None, **kwargs): return apis.GetUcdnDomainLogResponseSchema().loads(resp) def get_ucdn_domain_prefetch_enable(self, req=None, **kwargs): - """ GetUcdnDomainPrefetchEnable - 获取域名预取开启状态 + """GetUcdnDomainPrefetchEnable - 获取域名预取开启状态 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **DomainId** (str) - (Required) 域名ID，创建加速域名时生成。 - + **Response** - **Enable** (int) - 0表示该域名未开启预取，1表示该域名已开启预取 - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -435,25 +435,25 @@ def get_ucdn_domain_prefetch_enable(self, req=None, **kwargs): return apis.GetUcdnDomainPrefetchEnableResponseSchema().loads(resp) def get_ucdn_domain_request_num_v2(self, req=None, **kwargs): - """ GetUcdnDomainRequestNumV2 - 获取域名请求数 + """GetUcdnDomainRequestNumV2 - 获取域名请求数 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **BeginTime** (int) - (Required) 查询的起始时间，格式为Unix Timestamp - **EndTime** (int) - (Required) 查询的结束时间，格式为Unix Timestamp - **Type** (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度, 3=按1分钟） - **Areacode** (str) - 查询区域 cn代表国内 abroad代表海外，只支持国内 - **DomainId** (list) - 域名id，创建域名时生成的id。默认全部域名 - + **Response** - **RequestList** (list) - 见 **RequestInfo** 模型定义 - + **Response Model** - - **RequestInfo** - + + **RequestInfo** + - **CdnRequest** (float) - 返回值返回指定时间区间内的cdn收到的请求次数之和 - **OriginRequest** (float) - 返回值返回指定时间区间内的cdn回源的请求次数之和 - **Time** (int) - 带宽获取的时间点。格式：时间戳 @@ -466,24 +466,24 @@ def get_ucdn_domain_request_num_v2(self, req=None, **kwargs): return apis.GetUcdnDomainRequestNumV2ResponseSchema().loads(resp) def get_ucdn_domain_traffic(self, req=None, **kwargs): - """ GetUcdnDomainTraffic - 获取加速域名流量使用信息 + """GetUcdnDomainTraffic - 获取加速域名流量使用信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Areacode** (str) - 查询流量区域 cn代表国内 abroad代表海外，默认全部区域。 - **BeginTime** (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。 - **DomainId** (list) - 域名ID，创建加速域名时生成。默认全部域名 - **EndTime** (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。 - + **Response** - **TrafficSet** (list) - 见 **UcdnDomainTrafficSet** 模型定义 - + **Response Model** - - **UcdnDomainTrafficSet** - + + **UcdnDomainTrafficSet** + - **Time** (int) - 流量获取的时间点，格式为Unix Timestamp - **Value** (float) - 查询每日流量总值，单位：GB @@ -495,25 +495,25 @@ def get_ucdn_domain_traffic(self, req=None, **kwargs): return apis.GetUcdnDomainTrafficResponseSchema().loads(resp) def get_ucdn_pass_bandwidth(self, req=None, **kwargs): - """ GetUcdnPassBandwidth - 获取回源带宽数据（cdn回客户源站部分） + """GetUcdnPassBandwidth - 获取回源带宽数据（cdn回客户源站部分） **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Type** (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度） - **Areacode** (str) - 查询带宽区域 cn代表国内 abroad代表海外，只支持国内 - **BeginTime** (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参 数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。 - **DomainId** (list) - 域名id，创建域名时生成的id。默认全部域名 - **EndTime** (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。 - + **Response** - **BandwidthDetail** (list) - 见 **BandwidthInfoDetail** 模型定义 - + **Response Model** - - **BandwidthInfoDetail** - + + **BandwidthInfoDetail** + - **Bandwidth** (float) - 返回值带宽值数据。 - **Time** (int) - 宽获取的时间点。格式：时间戳 @@ -525,20 +525,20 @@ def get_ucdn_pass_bandwidth(self, req=None, **kwargs): return apis.GetUcdnPassBandwidthResponseSchema().loads(resp) def get_ucdn_traffic(self, req=None, **kwargs): - """ GetUcdnTraffic - 获取流量信息 + """GetUcdnTraffic - 获取流量信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + **Response** - **TrafficSet** (list) - 见 **TrafficSet** 模型定义 - + **Response Model** - - **TrafficSet** - + + **TrafficSet** + - **Areacode** (str) - 购买流量的区域, cn: 国内; abroad: 国外 - **TrafficLeft** (str) - Areacode区域内总剩余流量, 单位GB - **TrafficTotal** (str) - Areacode区域内总购买流量, 单位GB @@ -552,17 +552,17 @@ def get_ucdn_traffic(self, req=None, **kwargs): return apis.GetUcdnTrafficResponseSchema().loads(resp) def prefetch_new_ucdn_domain_cache(self, req=None, **kwargs): - """ PrefetchNewUcdnDomainCache - 提交预取任务 + """PrefetchNewUcdnDomainCache - 提交预取任务 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **UrlList** (list) - (Required) 预热URL列表，n从自然数0开始。UrlList.n字段必须以”http://域名/”开始。目录要以”/”结尾， 如刷新目录a下所有文件，格式为：http://abc.ucloud.cn/a/；如刷新文件目录a下面img.png文件， 格式为http://abc.ucloud.cn/a/img.png。请正确提交需要刷新的域名 - + **Response** - **TaskId** (str) - 本次提交url对应的任务id - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -571,18 +571,18 @@ def prefetch_new_ucdn_domain_cache(self, req=None, **kwargs): return apis.PrefetchNewUcdnDomainCacheResponseSchema().loads(resp) def refresh_new_ucdn_domain_cache(self, req=None, **kwargs): - """ RefreshNewUcdnDomainCache - 刷新缓存 + """RefreshNewUcdnDomainCache - 刷新缓存 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Type** (str) - (Required) 刷新类型，file代表文件刷新，dir 代表路径刷新 - **UrlList** (list) - (Required) 刷新多个URL列表时，一次最多提交30个。必须以”http://域名/”开始。目录要以”/”结尾， 如刷新目录a下所有文件，格式为：http://abc.ucloud.cn/a/；如刷新文件目录a下面img.png文件， 格式为http://abc.ucloud.cn/a/img.png。请正确提交需要刷新的域名 - + **Response** - **TaskId** (str) - 本次提交url对应的任务id - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -591,16 +591,16 @@ def refresh_new_ucdn_domain_cache(self, req=None, **kwargs): return apis.RefreshNewUcdnDomainCacheResponseSchema().loads(resp) def switch_ucdn_charge_type(self, req=None, **kwargs): - """ SwitchUcdnChargeType - 切换账号计费方式 + """SwitchUcdnChargeType - 切换账号计费方式 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **ChargeType** (str) - (Required) 计费方式。traffic代表按流量包计费，bandwidth按带宽付费 - + **Response** - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) diff --git a/ucloud/services/ucdn/schemas/apis.py b/ucloud/services/ucdn/schemas/apis.py index ab36d8c..201784b 100644 --- a/ucloud/services/ucdn/schemas/apis.py +++ b/ucloud/services/ucdn/schemas/apis.py @@ -14,8 +14,7 @@ class BatchDescribeNewUcdnDomainRequestSchema(schema.RequestSchema): - """ BatchDescribeNewUcdnDomain - 批量获取加速域名配置 - """ + """BatchDescribeNewUcdnDomain - 批量获取加速域名配置""" fields = { "ChannelType": fields.Str(required=False, dump_to="ChannelType"), @@ -27,8 +26,7 @@ class BatchDescribeNewUcdnDomainRequestSchema(schema.RequestSchema): class BatchDescribeNewUcdnDomainResponseSchema(schema.ResponseSchema): - """ BatchDescribeNewUcdnDomain - 批量获取加速域名配置 - """ + """BatchDescribeNewUcdnDomain - 批量获取加速域名配置""" fields = { "Arrearage": fields.List( @@ -55,8 +53,7 @@ class BatchDescribeNewUcdnDomainResponseSchema(schema.ResponseSchema): class DescribeNewUcdnPrefetchCacheTaskRequestSchema(schema.RequestSchema): - """ DescribeNewUcdnPrefetchCacheTask - 获取预取任务状态 - """ + """DescribeNewUcdnPrefetchCacheTask - 获取预取任务状态""" fields = { "BeginTime": fields.Int(required=False, dump_to="BeginTime"), @@ -70,8 +67,7 @@ class DescribeNewUcdnPrefetchCacheTaskRequestSchema(schema.RequestSchema): class DescribeNewUcdnPrefetchCacheTaskResponseSchema(schema.ResponseSchema): - """ DescribeNewUcdnPrefetchCacheTask - 获取预取任务状态 - """ + """DescribeNewUcdnPrefetchCacheTask - 获取预取任务状态""" fields = { "TaskList": fields.List( @@ -89,8 +85,7 @@ class DescribeNewUcdnPrefetchCacheTaskResponseSchema(schema.ResponseSchema): class DescribeNewUcdnRefreshCacheTaskRequestSchema(schema.RequestSchema): - """ DescribeNewUcdnRefreshCacheTask - 获取域名刷新任务状态 - """ + """DescribeNewUcdnRefreshCacheTask - 获取域名刷新任务状态""" fields = { "BeginTime": fields.Int(required=False, dump_to="BeginTime"), @@ -104,8 +99,7 @@ class DescribeNewUcdnRefreshCacheTaskRequestSchema(schema.RequestSchema): class DescribeNewUcdnRefreshCacheTaskResponseSchema(schema.ResponseSchema): - """ DescribeNewUcdnRefreshCacheTask - 获取域名刷新任务状态 - """ + """DescribeNewUcdnRefreshCacheTask - 获取域名刷新任务状态""" fields = { "TaskList": fields.List( @@ -123,8 +117,7 @@ class DescribeNewUcdnRefreshCacheTaskResponseSchema(schema.ResponseSchema): class GetNewUcdnDomainBandwidthRequestSchema(schema.RequestSchema): - """ GetNewUcdnDomainBandwidth - 获取域名带宽数据 - """ + """GetNewUcdnDomainBandwidth - 获取域名带宽数据""" fields = { "Areacode": fields.Str(required=False, dump_to="Areacode"), @@ -137,8 +130,7 @@ class GetNewUcdnDomainBandwidthRequestSchema(schema.RequestSchema): class GetNewUcdnDomainBandwidthResponseSchema(schema.ResponseSchema): - """ GetNewUcdnDomainBandwidth - 获取域名带宽数据 - """ + """GetNewUcdnDomainBandwidth - 获取域名带宽数据""" fields = { "BandwidthList": fields.List( @@ -158,8 +150,7 @@ class GetNewUcdnDomainBandwidthResponseSchema(schema.ResponseSchema): class GetNewUcdnDomainHitRateRequestSchema(schema.RequestSchema): - """ GetNewUcdnDomainHitRate - 获取域名命中率 - """ + """GetNewUcdnDomainHitRate - 获取域名命中率""" fields = { "Areacode": fields.Str(required=False, dump_to="Areacode"), @@ -172,8 +163,7 @@ class GetNewUcdnDomainHitRateRequestSchema(schema.RequestSchema): class GetNewUcdnDomainHitRateResponseSchema(schema.ResponseSchema): - """ GetNewUcdnDomainHitRate - 获取域名命中率 - """ + """GetNewUcdnDomainHitRate - 获取域名命中率""" fields = { "HitRateList": fields.List( @@ -190,8 +180,7 @@ class GetNewUcdnDomainHitRateResponseSchema(schema.ResponseSchema): class GetNewUcdnDomainHttpCodeRequestSchema(schema.RequestSchema): - """ GetNewUcdnDomainHttpCode - 获取域名状态码监控 - """ + """GetNewUcdnDomainHttpCode - 获取域名状态码监控""" fields = { "Areacode": fields.Str(required=False, dump_to="Areacode"), @@ -204,8 +193,7 @@ class GetNewUcdnDomainHttpCodeRequestSchema(schema.RequestSchema): class GetNewUcdnDomainHttpCodeResponseSchema(schema.ResponseSchema): - """ GetNewUcdnDomainHttpCode - 获取域名状态码监控 - """ + """GetNewUcdnDomainHttpCode - 获取域名状态码监控""" fields = { "HttpCodeDetail": fields.List( @@ -224,8 +212,7 @@ class GetNewUcdnDomainHttpCodeResponseSchema(schema.ResponseSchema): class GetNewUcdnDomainHttpCodeV2RequestSchema(schema.RequestSchema): - """ GetNewUcdnDomainHttpCodeV2 - 获取域名详细状态码监控 - """ + """GetNewUcdnDomainHttpCodeV2 - 获取域名详细状态码监控""" fields = { "Areacode": fields.Str(required=False, dump_to="Areacode"), @@ -238,8 +225,7 @@ class GetNewUcdnDomainHttpCodeV2RequestSchema(schema.RequestSchema): class GetNewUcdnDomainHttpCodeV2ResponseSchema(schema.ResponseSchema): - """ GetNewUcdnDomainHttpCodeV2 - 获取域名详细状态码监控 - """ + """GetNewUcdnDomainHttpCodeV2 - 获取域名详细状态码监控""" fields = { "HttpCodeV2Detail": fields.List( @@ -258,8 +244,7 @@ class GetNewUcdnDomainHttpCodeV2ResponseSchema(schema.ResponseSchema): class GetNewUcdnDomainRequestNumRequestSchema(schema.RequestSchema): - """ GetNewUcdnDomainRequestNum - 获取域名请求数 - """ + """GetNewUcdnDomainRequestNum - 获取域名请求数""" fields = { "Areacode": fields.Str(required=False, dump_to="Areacode"), @@ -272,8 +257,7 @@ class GetNewUcdnDomainRequestNumRequestSchema(schema.RequestSchema): class GetNewUcdnDomainRequestNumResponseSchema(schema.ResponseSchema): - """ GetNewUcdnDomainRequestNum - 获取域名请求数 - """ + """GetNewUcdnDomainRequestNum - 获取域名请求数""" fields = { "RequestList": fields.List( @@ -290,8 +274,7 @@ class GetNewUcdnDomainRequestNumResponseSchema(schema.ResponseSchema): class GetUcdnDomainLogRequestSchema(schema.RequestSchema): - """ GetUcdnDomainLog - 获取加速域名原始日志 - """ + """GetUcdnDomainLog - 获取加速域名原始日志""" fields = { "BeginTime": fields.Int(required=False, dump_to="BeginTime"), @@ -303,8 +286,7 @@ class GetUcdnDomainLogRequestSchema(schema.RequestSchema): class GetUcdnDomainLogResponseSchema(schema.ResponseSchema): - """ GetUcdnDomainLog - 获取加速域名原始日志 - """ + """GetUcdnDomainLog - 获取加速域名原始日志""" fields = { "LogSet": fields.List( @@ -321,8 +303,7 @@ class GetUcdnDomainLogResponseSchema(schema.ResponseSchema): class GetUcdnDomainPrefetchEnableRequestSchema(schema.RequestSchema): - """ GetUcdnDomainPrefetchEnable - 获取域名预取开启状态 - """ + """GetUcdnDomainPrefetchEnable - 获取域名预取开启状态""" fields = { "DomainId": fields.Str(required=True, dump_to="DomainId"), @@ -331,8 +312,7 @@ class GetUcdnDomainPrefetchEnableRequestSchema(schema.RequestSchema): class GetUcdnDomainPrefetchEnableResponseSchema(schema.ResponseSchema): - """ GetUcdnDomainPrefetchEnable - 获取域名预取开启状态 - """ + """GetUcdnDomainPrefetchEnable - 获取域名预取开启状态""" fields = {"Enable": fields.Int(required=False, load_from="Enable")} @@ -345,8 +325,7 @@ class GetUcdnDomainPrefetchEnableResponseSchema(schema.ResponseSchema): class GetUcdnDomainRequestNumV2RequestSchema(schema.RequestSchema): - """ GetUcdnDomainRequestNumV2 - 获取域名请求数 - """ + """GetUcdnDomainRequestNumV2 - 获取域名请求数""" fields = { "Areacode": fields.Str(required=False, dump_to="Areacode"), @@ -359,8 +338,7 @@ class GetUcdnDomainRequestNumV2RequestSchema(schema.RequestSchema): class GetUcdnDomainRequestNumV2ResponseSchema(schema.ResponseSchema): - """ GetUcdnDomainRequestNumV2 - 获取域名请求数 - """ + """GetUcdnDomainRequestNumV2 - 获取域名请求数""" fields = { "RequestList": fields.List( @@ -377,8 +355,7 @@ class GetUcdnDomainRequestNumV2ResponseSchema(schema.ResponseSchema): class GetUcdnDomainTrafficRequestSchema(schema.RequestSchema): - """ GetUcdnDomainTraffic - 获取加速域名流量使用信息 - """ + """GetUcdnDomainTraffic - 获取加速域名流量使用信息""" fields = { "Areacode": fields.Str(required=False, dump_to="Areacode"), @@ -390,8 +367,7 @@ class GetUcdnDomainTrafficRequestSchema(schema.RequestSchema): class GetUcdnDomainTrafficResponseSchema(schema.ResponseSchema): - """ GetUcdnDomainTraffic - 获取加速域名流量使用信息 - """ + """GetUcdnDomainTraffic - 获取加速域名流量使用信息""" fields = { "TrafficSet": fields.List( @@ -410,8 +386,7 @@ class GetUcdnDomainTrafficResponseSchema(schema.ResponseSchema): class GetUcdnPassBandwidthRequestSchema(schema.RequestSchema): - """ GetUcdnPassBandwidth - 获取回源带宽数据（cdn回客户源站部分） - """ + """GetUcdnPassBandwidth - 获取回源带宽数据（cdn回客户源站部分）""" fields = { "Areacode": fields.Str(required=False, dump_to="Areacode"), @@ -424,8 +399,7 @@ class GetUcdnPassBandwidthRequestSchema(schema.RequestSchema): class GetUcdnPassBandwidthResponseSchema(schema.ResponseSchema): - """ GetUcdnPassBandwidth - 获取回源带宽数据（cdn回客户源站部分） - """ + """GetUcdnPassBandwidth - 获取回源带宽数据（cdn回客户源站部分）""" fields = { "BandwidthDetail": fields.List( @@ -444,15 +418,13 @@ class GetUcdnPassBandwidthResponseSchema(schema.ResponseSchema): class GetUcdnTrafficRequestSchema(schema.RequestSchema): - """ GetUcdnTraffic - 获取流量信息 - """ + """GetUcdnTraffic - 获取流量信息""" fields = {"ProjectId": fields.Str(required=False, dump_to="ProjectId")} class GetUcdnTrafficResponseSchema(schema.ResponseSchema): - """ GetUcdnTraffic - 获取流量信息 - """ + """GetUcdnTraffic - 获取流量信息""" fields = { "TrafficSet": fields.List( @@ -469,8 +441,7 @@ class GetUcdnTrafficResponseSchema(schema.ResponseSchema): class PrefetchNewUcdnDomainCacheRequestSchema(schema.RequestSchema): - """ PrefetchNewUcdnDomainCache - 提交预取任务 - """ + """PrefetchNewUcdnDomainCache - 提交预取任务""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -479,8 +450,7 @@ class PrefetchNewUcdnDomainCacheRequestSchema(schema.RequestSchema): class PrefetchNewUcdnDomainCacheResponseSchema(schema.ResponseSchema): - """ PrefetchNewUcdnDomainCache - 提交预取任务 - """ + """PrefetchNewUcdnDomainCache - 提交预取任务""" fields = {"TaskId": fields.Str(required=False, load_from="TaskId")} @@ -493,8 +463,7 @@ class PrefetchNewUcdnDomainCacheResponseSchema(schema.ResponseSchema): class RefreshNewUcdnDomainCacheRequestSchema(schema.RequestSchema): - """ RefreshNewUcdnDomainCache - 刷新缓存 - """ + """RefreshNewUcdnDomainCache - 刷新缓存""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -504,8 +473,7 @@ class RefreshNewUcdnDomainCacheRequestSchema(schema.RequestSchema): class RefreshNewUcdnDomainCacheResponseSchema(schema.ResponseSchema): - """ RefreshNewUcdnDomainCache - 刷新缓存 - """ + """RefreshNewUcdnDomainCache - 刷新缓存""" fields = {"TaskId": fields.Str(required=False, load_from="TaskId")} @@ -518,8 +486,7 @@ class RefreshNewUcdnDomainCacheResponseSchema(schema.ResponseSchema): class SwitchUcdnChargeTypeRequestSchema(schema.RequestSchema): - """ SwitchUcdnChargeType - 切换账号计费方式 - """ + """SwitchUcdnChargeType - 切换账号计费方式""" fields = { "ChargeType": fields.Str(required=True, dump_to="ChargeType"), @@ -528,7 +495,6 @@ class SwitchUcdnChargeTypeRequestSchema(schema.RequestSchema): class SwitchUcdnChargeTypeResponseSchema(schema.ResponseSchema): - """ SwitchUcdnChargeType - 切换账号计费方式 - """ + """SwitchUcdnChargeType - 切换账号计费方式""" fields = {} diff --git a/ucloud/services/ucdn/schemas/models.py b/ucloud/services/ucdn/schemas/models.py index 3a3dad8..7bfce7b 100644 --- a/ucloud/services/ucdn/schemas/models.py +++ b/ucloud/services/ucdn/schemas/models.py @@ -5,8 +5,7 @@ class CacheConfSchema(schema.ResponseSchema): - """ CacheConf - 缓存配置 - """ + """CacheConf - 缓存配置""" fields = { "CacheBehavior": fields.Int(required=False, load_from="CacheBehavior"), @@ -27,8 +26,7 @@ class CacheConfSchema(schema.ResponseSchema): class AccessConfSchema(schema.ResponseSchema): - """ AccessConf - 访问控制 - """ + """AccessConf - 访问控制""" fields = { "IpBlacklist": fields.Str(required=False, load_from="IpBlacklist") @@ -36,8 +34,7 @@ class AccessConfSchema(schema.ResponseSchema): class DomainInfoSchema(schema.ResponseSchema): - """ DomainInfo - 域名配置 - """ + """DomainInfo - 域名配置""" fields = { "AccessConf": AccessConfSchema(), @@ -73,8 +70,7 @@ class DomainInfoSchema(schema.ResponseSchema): class UrlProgressInfoSchema(schema.ResponseSchema): - """ UrlProgressInfo - UrlProgressInfo - """ + """UrlProgressInfo - UrlProgressInfo""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -86,8 +82,7 @@ class UrlProgressInfoSchema(schema.ResponseSchema): class TaskInfoSchema(schema.ResponseSchema): - """ TaskInfo - 预取刷新的任务信息 - """ + """TaskInfo - 预取刷新的任务信息""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -99,8 +94,7 @@ class TaskInfoSchema(schema.ResponseSchema): class BandwidthInfoSchema(schema.ResponseSchema): - """ BandwidthInfo - BandwidthInfo - """ + """BandwidthInfo - BandwidthInfo""" fields = { "CdnBandwidth": fields.Str(required=False, load_from="CdnBandwidth"), @@ -109,8 +103,7 @@ class BandwidthInfoSchema(schema.ResponseSchema): class HitRateInfoSchema(schema.ResponseSchema): - """ HitRateInfo - HitRateInfo - """ + """HitRateInfo - HitRateInfo""" fields = { "FlowHitRate": fields.Float(required=False, load_from="FlowHitRate"), @@ -122,8 +115,7 @@ class HitRateInfoSchema(schema.ResponseSchema): class HttpCodeInfoSchema(schema.ResponseSchema): - """ HttpCodeInfo - HttpCodeInfo - """ + """HttpCodeInfo - HttpCodeInfo""" fields = { "HttpFiveXX": fields.Int(required=False, load_from="HttpFiveXX"), @@ -136,8 +128,7 @@ class HttpCodeInfoSchema(schema.ResponseSchema): class HttpCodeV2DetailSchema(schema.ResponseSchema): - """ HttpCodeV2Detail - HTTP状态码详细信息 - """ + """HttpCodeV2Detail - HTTP状态码详细信息""" fields = { "Http100": fields.Int(required=False, load_from="Http100"), @@ -201,8 +192,7 @@ class HttpCodeV2DetailSchema(schema.ResponseSchema): class RequestInfoSchema(schema.ResponseSchema): - """ RequestInfo - RequestInfo - """ + """RequestInfo - RequestInfo""" fields = { "CdnRequest": fields.Float(required=False, load_from="CdnRequest"), @@ -214,8 +204,7 @@ class RequestInfoSchema(schema.ResponseSchema): class LogSetInfoSchema(schema.ResponseSchema): - """ LogSetInfo - 日志信息 - """ + """LogSetInfo - 日志信息""" fields = { "AbroadLog": fields.List(fields.Str()), @@ -225,8 +214,7 @@ class LogSetInfoSchema(schema.ResponseSchema): class LogSetListSchema(schema.ResponseSchema): - """ LogSetList - 日志信息列表 - """ + """LogSetList - 日志信息列表""" fields = { "Domain": fields.Str(required=False, load_from="Domain"), @@ -235,8 +223,7 @@ class LogSetListSchema(schema.ResponseSchema): class UcdnDomainTrafficSetSchema(schema.ResponseSchema): - """ UcdnDomainTrafficSet - GetUcdnDomainTraffic - """ + """UcdnDomainTrafficSet - GetUcdnDomainTraffic""" fields = { "Time": fields.Int(required=False, load_from="Time"), @@ -245,8 +232,7 @@ class UcdnDomainTrafficSetSchema(schema.ResponseSchema): class BandwidthInfoDetailSchema(schema.ResponseSchema): - """ BandwidthInfoDetail - 带宽值信息模型(时间-带宽) - """ + """BandwidthInfoDetail - 带宽值信息模型(时间-带宽)""" fields = { "Bandwidth": fields.Float(required=True, load_from="Bandwidth"), @@ -255,8 +241,7 @@ class BandwidthInfoDetailSchema(schema.ResponseSchema): class TrafficSetSchema(schema.ResponseSchema): - """ TrafficSet - GetUcdnTraffic - """ + """TrafficSet - GetUcdnTraffic""" fields = { "Areacode": fields.Str(required=False, load_from="Areacode"), diff --git a/ucloud/services/ucloudstack/client.py b/ucloud/services/ucloudstack/client.py index ac3591d..aa4c2ff 100644 --- a/ucloud/services/ucloudstack/client.py +++ b/ucloud/services/ucloudstack/client.py @@ -12,7 +12,7 @@ def __init__(self, config, transport=None, middleware=None, logger=None): ) def allocate_eip(self, req=None, **kwargs): - """ AllocateEIP - 申请外网IP + """AllocateEIP - 申请外网IP **Request** @@ -22,13 +22,15 @@ def allocate_eip(self, req=None, **kwargs): - **Name** (str) - (Required) 名称 - **OperatorName** (str) - (Required) 线路。目前支持Bgp - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； + - **IP** (str) - 指定IP + - **IPVersion** (str) - IP版本，默认值IPv4，支持值：IPv4\\IPv6 - **Quantity** (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。 - + **Response** - **EIPID** (str) - 申请的EIP的ID - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -37,7 +39,7 @@ def allocate_eip(self, req=None, **kwargs): return apis.AllocateEIPResponseSchema().loads(resp) def attach_disk(self, req=None, **kwargs): - """ AttachDisk - 绑定硬盘 + """AttachDisk - 绑定硬盘 **Request** @@ -46,11 +48,11 @@ def attach_disk(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 绑定的资源ID - **ResourceType** (str) - (Required) 绑定的资源类型，枚举值：VM，标识虚拟机 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -58,8 +60,29 @@ def attach_disk(self, req=None, **kwargs): resp = self.invoke("AttachDisk", d, **kwargs) return apis.AttachDiskResponseSchema().loads(resp) + def attach_nic(self, req=None, **kwargs): + """AttachNIC - 绑定UCloudStack网卡 + + **Request** + + - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； + - **NICID** (str) - (Required) 网卡ID + - **ResourceID** (str) - (Required) 绑定的资源ID + - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； + + **Response** + + - **Message** (str) - 返回信息描述。 + + """ + d = {"Region": self.config.region} + req and d.update(req) + d = apis.AttachNICRequestSchema().dumps(d) + resp = self.invoke("AttachNIC", d, **kwargs) + return apis.AttachNICResponseSchema().loads(resp) + def bind_alarm_template(self, req=None, **kwargs): - """ BindAlarmTemplate - 绑定告警模板 + """BindAlarmTemplate - 绑定告警模板 **Request** @@ -68,11 +91,11 @@ def bind_alarm_template(self, req=None, **kwargs): - **ResourceIDs** (list) - (Required) 【数组】告警模板ID。调用方式举例：ResourceIDs.0=“one-id”、ResourceIDs.1=“two-id”。 - **ResourceType** (str) - (Required) 资源类型。VM：虚拟机, LB:负载均衡, NATGW：nat网关;EIP:弹性IP - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -81,7 +104,7 @@ def bind_alarm_template(self, req=None, **kwargs): return apis.BindAlarmTemplateResponseSchema().loads(resp) def bind_eip(self, req=None, **kwargs): - """ BindEIP - 绑定UCoudStack外网IP + """BindEIP - 绑定外网 IP **Request** @@ -90,11 +113,11 @@ def bind_eip(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 资源ID - **ResourceType** (str) - (Required) 资源类型。VM：虚拟机, LB:负载均衡, NATGW：nat网关 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -103,7 +126,7 @@ def bind_eip(self, req=None, **kwargs): return apis.BindEIPResponseSchema().loads(resp) def bind_physical_ip(self, req=None, **kwargs): - """ BindPhysicalIP - 绑定物理 IP ，被绑定的资源必须处于运行中或有效状态。 + """BindPhysicalIP - 绑定物理 IP ，被绑定的资源必须处于运行中或有效状态。 **Request** @@ -112,11 +135,11 @@ def bind_physical_ip(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 资源ID - **ResourceType** (str) - (Required) 资源类型。VM：虚拟机 - **Zone** (str) - (Required) 可用区。 - + **Response** - **Message** (str) - 返回描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -125,7 +148,7 @@ def bind_physical_ip(self, req=None, **kwargs): return apis.BindPhysicalIPResponseSchema().loads(resp) def bind_security_group(self, req=None, **kwargs): - """ BindSecurityGroup - 绑定安全组 + """BindSecurityGroup - 绑定安全组 **Request** @@ -133,12 +156,12 @@ def bind_security_group(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 绑定的资源ID。调用方式举例：ResourceID=“one-id”。 - **SGID** (str) - (Required) 安全组ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - - **NICID** (str) - 网卡ID - + - **NICType** (str) - 网卡类型，玫举值：WAN，外网；LAN，内网，默认为WAN + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -147,7 +170,7 @@ def bind_security_group(self, req=None, **kwargs): return apis.BindSecurityGroupResponseSchema().loads(resp) def clone_disk(self, req=None, **kwargs): - """ CloneDisk - 克隆硬盘 + """CloneDisk - 克隆硬盘 **Request** @@ -157,12 +180,12 @@ def clone_disk(self, req=None, **kwargs): - **SrcID** (str) - (Required) 源硬盘ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Quantity** (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。 - + **Response** - **DiskID** (str) - 克隆出的硬盘ID - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -171,23 +194,23 @@ def clone_disk(self, req=None, **kwargs): return apis.CloneDiskResponseSchema().loads(resp) def create_certificate(self, req=None, **kwargs): - """ CreateCertificate - 创建证书 + """CreateCertificate - 创建证书 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Certificate** (str) - (Required) 证书内容 - **CertificateType** (str) - (Required) 证书类型，枚举值["ServerCrt","CACrt"]。分别表示服务器证书和CA证书。只有在双向认证的时候才需要CA证书 - **Name** (str) - (Required) 证书名称 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **PrivateKey** (str) - 私钥内容,服务器证书必传,CA证书不用传递 - **Remark** (str) - 证书描述 - + **Response** - **CertificateID** (str) - 证书ID - **Message** (str) - 错误描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -196,7 +219,7 @@ def create_certificate(self, req=None, **kwargs): return apis.CreateCertificateResponseSchema().loads(resp) def create_custom_image(self, req=None, **kwargs): - """ CreateCustomImage - 创建自制镜像 + """CreateCustomImage - 创建自制镜像 **Request** @@ -205,12 +228,12 @@ def create_custom_image(self, req=None, **kwargs): - **VMID** (str) - (Required) 虚拟机ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **ImageDescription** (str) - 镜像描述。 - + **Response** - **ImageID** (str) - 创建的自制镜像ID - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -219,7 +242,7 @@ def create_custom_image(self, req=None, **kwargs): return apis.CreateCustomImageResponseSchema().loads(resp) def create_disk(self, req=None, **kwargs): - """ CreateDisk - 创建硬盘 + """CreateDisk - 创建硬盘 **Request** @@ -230,12 +253,12 @@ def create_disk(self, req=None, **kwargs): - **SetType** (str) - (Required) 磁盘类型。例如：Normal,SSD - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Quantity** (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。 - + **Response** - **DiskID** (str) - 创建的磁盘ID - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -244,7 +267,7 @@ def create_disk(self, req=None, **kwargs): return apis.CreateDiskResponseSchema().loads(resp) def create_lb(self, req=None, **kwargs): - """ CreateLB - 创建负载均衡 + """CreateLB - 创建负载均衡 **Request** @@ -260,12 +283,12 @@ def create_lb(self, req=None, **kwargs): - **Quantity** (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。 - **Remark** (str) - 描述。 - **SGID** (str) - 安全组ID，创建外网LB时为必需 - + **Response** - **LBID** (str) - 返回创建的负载均衡ID - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -274,7 +297,7 @@ def create_lb(self, req=None, **kwargs): return apis.CreateLBResponseSchema().loads(resp) def create_natgw(self, req=None, **kwargs): - """ CreateNATGW - 创建NAT网关 + """CreateNATGW - 创建NAT网关 **Request** @@ -289,12 +312,12 @@ def create_natgw(self, req=None, **kwargs): - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Quantity** (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。 - **Remark** (str) - 描述 - + **Response** - **Message** (str) - 返回信息描述。 - **NATGWID** (str) - 返回创建的NAT网关ID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -303,7 +326,7 @@ def create_natgw(self, req=None, **kwargs): return apis.CreateNATGWResponseSchema().loads(resp) def create_natgw_rule(self, req=None, **kwargs): - """ CreateNATGWRule - 添加NAT网关白名单 + """CreateNATGWRule - 添加NAT网关白名单 **Request** @@ -312,12 +335,12 @@ def create_natgw_rule(self, req=None, **kwargs): - **NATGWID** (str) - (Required) NAT网关ID - **NATGWType** (str) - (Required) NAT的类型。枚举值：SNAT，DNAT - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - **RuleID** (str) - 白名单ID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -325,8 +348,33 @@ def create_natgw_rule(self, req=None, **kwargs): resp = self.invoke("CreateNATGWRule", d, **kwargs) return apis.CreateNATGWRuleResponseSchema().loads(resp) + def create_nic(self, req=None, **kwargs): + """CreateNIC - 创建网卡 + + **Request** + + - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； + - **Name** (str) - (Required) 名称 + - **SubnetID** (str) - (Required) Subnet ID + - **VPCID** (str) - (Required) VPC ID + - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； + - **IP** (str) - 指定IP + - **SGID** (str) - 安全组 ID + + **Response** + + - **Message** (str) - 返回信息描述。 + - **NICID** (str) - 创建的网卡 ID + + """ + d = {"Region": self.config.region} + req and d.update(req) + d = apis.CreateNICRequestSchema().dumps(d) + resp = self.invoke("CreateNIC", d, **kwargs) + return apis.CreateNICResponseSchema().loads(resp) + def create_physical_ip(self, req=None, **kwargs): - """ CreatePhysicalIP - 创建物理 IP ，需确保平台已配置物理 IP 线路相关信息及物理网络联通性。 + """CreatePhysicalIP - 创建物理 IP ，需确保平台已配置物理 IP 线路相关信息及物理网络联通性。 **Request** @@ -335,12 +383,12 @@ def create_physical_ip(self, req=None, **kwargs): - **OperatorName** (str) - (Required) 物理IP线路 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Remark** (str) - 描述 - + **Response** - **Message** (str) - 返回信息描述 - **PhysicalIPID** (str) - 返回创建的物理IP的ID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -349,7 +397,7 @@ def create_physical_ip(self, req=None, **kwargs): return apis.CreatePhysicalIPResponseSchema().loads(resp) def create_rs(self, req=None, **kwargs): - """ CreateRS - 为负载均衡的 VServer 添加后端服务节点。 + """CreateRS - 为负载均衡的 VServer 添加后端服务节点。 **Request** @@ -360,12 +408,12 @@ def create_rs(self, req=None, **kwargs): - **VSID** (str) - (Required) VServer的ID - **Weight** (int) - (Required) 服务节点的权重 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - **RSID** (str) - 返回创建的RSID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -374,7 +422,7 @@ def create_rs(self, req=None, **kwargs): return apis.CreateRSResponseSchema().loads(resp) def create_security_group(self, req=None, **kwargs): - """ CreateSecurityGroup - 创建安全组 + """CreateSecurityGroup - 创建安全组 **Request** @@ -383,12 +431,12 @@ def create_security_group(self, req=None, **kwargs): - **Rule** (list) - (Required) 【数组】安全组规则。输入有效的规则，调用方式举例：Rule.0=“TCP|23|0.0.0.0/0|ACCEPT|HIGH|1”、Rule.1=“TCP|55|0.0.0.0/0|ACCEPT|HIGH|1” - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Remark** (str) - 描述; - + **Response** - **Message** (str) - 返回信息描述； - **SGID** (str) - 创建的安全组ID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -397,7 +445,7 @@ def create_security_group(self, req=None, **kwargs): return apis.CreateSecurityGroupResponseSchema().loads(resp) def create_security_group_rule(self, req=None, **kwargs): - """ CreateSecurityGroupRule - 创建安全组规则 + """CreateSecurityGroupRule - 创建安全组规则 **Request** @@ -405,12 +453,12 @@ def create_security_group_rule(self, req=None, **kwargs): - **Rules** (list) - (Required) 【数组】安全组规则。输入有效的规则，调用方式举例：Rule.0=“TCP|23|0.0.0.0/0|ACCEPT|HIGH|1”、Rule.1=“TCP|55|0.0.0.0/0|ACCEPT|HIGH|1” - **SGID** (str) - (Required) 安全组ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述； - **SGRuleID** (str) - 创建的安全组规则ID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -419,7 +467,7 @@ def create_security_group_rule(self, req=None, **kwargs): return apis.CreateSecurityGroupRuleResponseSchema().loads(resp) def create_snapshot(self, req=None, **kwargs): - """ CreateSnapshot - 创建硬盘快照 + """CreateSnapshot - 创建硬盘快照 **Request** @@ -428,12 +476,12 @@ def create_snapshot(self, req=None, **kwargs): - **Name** (str) - (Required) 快照名称，限制字符长度30 - **Zone** (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。 - **Remark** (str) - 描述，限制字符长度100 - + **Response** - **Message** (str) - 返回信息描述 - **SnapshotID** (str) - 创建的快照ID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -442,7 +490,7 @@ def create_snapshot(self, req=None, **kwargs): return apis.CreateSnapshotResponseSchema().loads(resp) def create_subnet(self, req=None, **kwargs): - """ CreateSubnet - 创建子网 + """CreateSubnet - 创建子网 **Request** @@ -452,12 +500,12 @@ def create_subnet(self, req=None, **kwargs): - **VPCID** (str) - (Required) 所属VPCID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Remark** (str) - 描述; - + **Response** - **Message** (str) - 返回信息描述； - **SubnetID** (str) - 创建Subnet的ID； - + """ d = {"Region": self.config.region} req and d.update(req) @@ -466,18 +514,18 @@ def create_subnet(self, req=None, **kwargs): return apis.CreateSubnetResponseSchema().loads(resp) def create_user(self, req=None, **kwargs): - """ CreateUser - 管理员添加账号 + """CreateUser - 管理员添加账号 **Request** - **PassWord** (str) - (Required) 账号密码。 - **UserEmail** (str) - (Required) 账号邮箱。 - + **Response** - **Message** (str) - 返回信息描述。 - **UserID** (int) - 账户ID - + """ d = {} req and d.update(req) @@ -486,11 +534,11 @@ def create_user(self, req=None, **kwargs): return apis.CreateUserResponseSchema().loads(resp) def create_vm_instance(self, req=None, **kwargs): - """ CreateVMInstance - 创建虚拟机 + """CreateVMInstance - 创建虚拟机 **Request** - - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； + - **Region** (str) - (Config) 地域或数据中心。枚举值：cn,表示中国； - **BootDiskSetType** (str) - (Required) 系统盘类型。枚举值：Normal，表示普通；SSD，表示SSD； - **CPU** (int) - (Required) CPU个数，如1，2，4，8，16，32，64等。 - **ChargeType** (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年； @@ -499,28 +547,28 @@ def create_vm_instance(self, req=None, **kwargs): - **Memory** (int) - (Required) 内存容量，如1024，2048，4096，8192，16384，32768，65535等。 - **Name** (str) - (Required) 虚拟机名称。可输入如：myVM。名称只能包含中英文、数字以及- _ .且1-30个字符。 - **Password** (str) - (Required) 密码。可输入如：ucloud.cn。密码长度限6-30个字符；需要同时包含两项或以上（大写字母/小写字母/数字/特殊符号)；windows不能包含用户名（administrator）中超过2个连续字符的部分。 - - **SubnetID** (str) - (Required) 子网 ID。 - - **VMType** (str) - (Required) 机型。枚举值：Normal，表示普通；SSD，表示SSD； - - **VPCID** (str) - (Required) VPC ID。 + - **SubnetID** (str) - (Required) 虚拟机所属子网 ID。 + - **VMType** (str) - (Required) 虚拟机所在宿主机的集群类型，代表不同架构、不同型号的 CPU 或硬件特征。枚举值：Normal，表示普通；SSD，表示SSD。 + - **VPCID** (str) - (Required) 虚拟机所属 VPC ID。 - **WANSGID** (str) - (Required) 外网安全组 ID。输入“有效”状态的安全组的ID。 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - - **Bandwidth** (str) - 带宽 + - **Bandwidth** (str) - 创建虚拟机同时绑定外网 IP 的带宽。 - **DataDiskSpace** (int) - 数据盘大小，单位 GB。默认值为0。范围：【0，8000】，步长10。 - **GPU** (int) - GPU 卡核心的占用个数。枚举值：【1,2,4】。GPU与CPU、内存大小关系：CPU个数>=4*GPU个数，同时内存与CPU规格匹配. - - **IPVersion** (str) - 外网IP版本，默认IPv4 - - **InternalIP** (str) - 指定内网IP。输入有效的指定内网 IP。默认为系统自动分配内网 IP。 - - **InternetIP** (str) - 指定外网IP + - **IPVersion** (str) - 创建虚拟机同时绑定外网 IP 的 IP 版本。枚举值：IPv4 & IPv6，默认为 IPv4 + - **InternalIP** (str) - 指定内网IP。输入有效的指定内网 IP，不指定时系统将自动从子网分配 IP 地址。 + - **InternetIP** (str) - 手动指定虚拟机绑定外网 IP 的地址，IP地址必须包含在网段内。 - **LANSGID** (str) - 内网安全组 ID。输入“有效”状态的安全组的ID。 - - **OperatorName** (str) - 线路 + - **OperatorName** (str) - 创建虚拟机同时绑定外网 IP 的网段，可由管理员自定义。 - **Quantity** (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。 - + **Response** - - **DiskID** (str) - 返回创建数据盘的 ID - - **EIPID** (str) - 返回创建外网IP的 ID + - **DiskID** (str) - 返回同时创建的数据盘 ID + - **EIPID** (str) - 返回同时创建的外网IP ID - **Message** (str) - 返回信息描述。 - - **VMID** (str) - 返回创建虚拟机的 ID - + - **VMID** (str) - 返回创建的虚拟机 ID + """ d = {"Region": self.config.region} req and d.update(req) @@ -529,7 +577,7 @@ def create_vm_instance(self, req=None, **kwargs): return apis.CreateVMInstanceResponseSchema().loads(resp) def create_vpc(self, req=None, **kwargs): - """ CreateVPC - 创建VPC + """CreateVPC - 创建VPC **Request** @@ -538,12 +586,12 @@ def create_vpc(self, req=None, **kwargs): - **Network** (str) - (Required) 网段。例如：10.0.0.0/16； - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Remark** (str) - 描述; - + **Response** - **Message** (str) - 返回信息描述； - **VPCID** (str) - 创建的VPCID； - + """ d = {"Region": self.config.region} req and d.update(req) @@ -552,7 +600,7 @@ def create_vpc(self, req=None, **kwargs): return apis.CreateVPCResponseSchema().loads(resp) def create_vs(self, req=None, **kwargs): - """ CreateVS - 创建负载均衡VServer + """CreateVS - 创建负载均衡VServer **Request** @@ -571,12 +619,14 @@ def create_vs(self, req=None, **kwargs): - **PersistenceType** (str) - 会话保持类型。枚举值：None:关闭；Auto:自动生成；Manual:手动生成 。当协议为 TCP 时，该值不生效，会话保持和选择的调度算法相关；当协议为 UDP 时 Auto 表示开启会话保持 。 - **SSLMode** (str) - SSL认证模式,HTTPS协议下必传,取值范围["simplex","duplex"]分别表示单向认证和双向认证。 - **ServerCertificateID** (str) - 服务器证书ID，用于证明服务器的身份，仅当 VServer监听协议为 HTTPS时有效。 - + **Response** + - **Action** (str) - 操作名称 - **Message** (str) - 返回信息描述。 + - **RetCode** (int) - 返回码 - **VSID** (str) - 返回创建的VSID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -585,7 +635,7 @@ def create_vs(self, req=None, **kwargs): return apis.CreateVSResponseSchema().loads(resp) def create_vs_policy(self, req=None, **kwargs): - """ CreateVSPolicy - 创建七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 + """CreateVSPolicy - 创建七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 **Request** @@ -596,12 +646,12 @@ def create_vs_policy(self, req=None, **kwargs): - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Domain** (str) - 内容转发规则关联的请求域名，值可为空，即代表仅匹配路径。域名和路径至少需要指定一项，且域名和路径的组合在一个 VServer 中必须唯一。 - **Path** (str) - 内容转发规则关联的请求访问路径，如 "/" 。域名和路径至少需要指定一项，且域名和路径的组合在一个 VServer 中必须唯一。 - + **Response** - **Message** (str) - 返回信息描述。 - **PolicyID** (str) - 返回创建的内容转发规则ID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -610,18 +660,18 @@ def create_vs_policy(self, req=None, **kwargs): return apis.CreateVSPolicyResponseSchema().loads(resp) def delete_certificate(self, req=None, **kwargs): - """ DeleteCertificate - 删除证书 + """DeleteCertificate - 删除证书 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **CertificateID** (str) - (Required) 证书ID - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -630,18 +680,18 @@ def delete_certificate(self, req=None, **kwargs): return apis.DeleteCertificateResponseSchema().loads(resp) def delete_custom_image(self, req=None, **kwargs): - """ DeleteCustomImage - 删除自制镜像 + """DeleteCustomImage - 删除自制镜像 **Request** - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； - **ImageID** (str) - (Required) 自制镜像ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -650,18 +700,18 @@ def delete_custom_image(self, req=None, **kwargs): return apis.DeleteCustomImageResponseSchema().loads(resp) def delete_disk(self, req=None, **kwargs): - """ DeleteDisk - 删除硬盘 + """DeleteDisk - 删除硬盘 **Request** - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； - **DiskID** (str) - (Required) 被删除的硬盘ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -670,18 +720,18 @@ def delete_disk(self, req=None, **kwargs): return apis.DeleteDiskResponseSchema().loads(resp) def delete_lb(self, req=None, **kwargs): - """ DeleteLB - 删除负载均衡 + """DeleteLB - 删除负载均衡 **Request** - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； - **LBID** (str) - (Required) 负载均衡ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -690,18 +740,18 @@ def delete_lb(self, req=None, **kwargs): return apis.DeleteLBResponseSchema().loads(resp) def delete_natgw(self, req=None, **kwargs): - """ DeleteNATGW - 删除NAT网关 + """DeleteNATGW - 删除NAT网关 **Request** - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； - **NATGWID** (str) - (Required) NAT网关ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -710,7 +760,7 @@ def delete_natgw(self, req=None, **kwargs): return apis.DeleteNATGWResponseSchema().loads(resp) def delete_natgw_rule(self, req=None, **kwargs): - """ DeleteNATGWRule - 删除NAT网关白名单 + """DeleteNATGWRule - 删除NAT网关白名单 **Request** @@ -718,11 +768,11 @@ def delete_natgw_rule(self, req=None, **kwargs): - **NATGWID** (str) - (Required) nat网关ID - **RuleID** (str) - (Required) 白名单ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -730,19 +780,39 @@ def delete_natgw_rule(self, req=None, **kwargs): resp = self.invoke("DeleteNATGWRule", d, **kwargs) return apis.DeleteNATGWRuleResponseSchema().loads(resp) + def delete_nic(self, req=None, **kwargs): + """DeleteNIC - 删除网卡 + + **Request** + + - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； + - **NICID** (str) - (Required) 被删除的网卡 ID + - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； + + **Response** + + - **Message** (str) - 返回信息描述。 + + """ + d = {"Region": self.config.region} + req and d.update(req) + d = apis.DeleteNICRequestSchema().dumps(d) + resp = self.invoke("DeleteNIC", d, **kwargs) + return apis.DeleteNICResponseSchema().loads(resp) + def delete_physical_ip(self, req=None, **kwargs): - """ DeletePhysicalIP - 删除物理IP + """DeletePhysicalIP - 删除物理IP **Request** - **Region** (str) - (Config) 地域。 - **PhysicalIPID** (str) - (Required) 物理IP的ID - **Zone** (str) - (Required) 可用区。 - + **Response** - **Message** (str) - 返回状态描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -751,7 +821,7 @@ def delete_physical_ip(self, req=None, **kwargs): return apis.DeletePhysicalIPResponseSchema().loads(resp) def delete_rs(self, req=None, **kwargs): - """ DeleteRS - 移除负载均衡的单个服务节点 + """DeleteRS - 移除负载均衡的单个服务节点 **Request** @@ -760,11 +830,11 @@ def delete_rs(self, req=None, **kwargs): - **RSID** (str) - (Required) RServer的ID - **VSID** (str) - (Required) VServer的ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -773,18 +843,18 @@ def delete_rs(self, req=None, **kwargs): return apis.DeleteRSResponseSchema().loads(resp) def delete_security_group(self, req=None, **kwargs): - """ DeleteSecurityGroup - 删除安全组 + """DeleteSecurityGroup - 删除安全组 **Request** - **Region** (str) - (Config) 地域。枚举值： cn，表示中国； - **SGID** (str) - (Required) 安全组ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述； - + """ d = {"Region": self.config.region} req and d.update(req) @@ -793,7 +863,7 @@ def delete_security_group(self, req=None, **kwargs): return apis.DeleteSecurityGroupResponseSchema().loads(resp) def delete_security_group_rule(self, req=None, **kwargs): - """ DeleteSecurityGroupRule - 删除安全组规则 + """DeleteSecurityGroupRule - 删除安全组规则 **Request** @@ -801,11 +871,11 @@ def delete_security_group_rule(self, req=None, **kwargs): - **SGID** (str) - (Required) 安全组ID - **SGRuleID** (str) - (Required) 安全组规则ID - **Zone** (str) - (Required) 可用区。 - + **Response** - **Message** (str) - 返回信息描述； - + """ d = {"Region": self.config.region} req and d.update(req) @@ -814,18 +884,18 @@ def delete_security_group_rule(self, req=None, **kwargs): return apis.DeleteSecurityGroupRuleResponseSchema().loads(resp) def delete_snapshot(self, req=None, **kwargs): - """ DeleteSnapshot - 删除快照，仅支持状态为正常的快照进行删除操作。 + """DeleteSnapshot - 删除快照，仅支持状态为正常的快照进行删除操作。 **Request** - **Region** (str) - (Config) 地域。枚举值：如 cn,表示中国。 - **SnapshotID** (str) - (Required) 快照ID - **Zone** (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。 - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -834,18 +904,18 @@ def delete_snapshot(self, req=None, **kwargs): return apis.DeleteSnapshotResponseSchema().loads(resp) def delete_subnet(self, req=None, **kwargs): - """ DeleteSubnet - 删除子网 + """DeleteSubnet - 删除子网 **Request** - **Region** (str) - (Config) 地域。 - **SubnetID** (str) - (Required) SubnetID - **Zone** (str) - (Required) 可用区。 - + **Response** - **Message** (str) - 返回信息描述； - + """ d = {"Region": self.config.region} req and d.update(req) @@ -854,18 +924,18 @@ def delete_subnet(self, req=None, **kwargs): return apis.DeleteSubnetResponseSchema().loads(resp) def delete_vm_instance(self, req=None, **kwargs): - """ DeleteVMInstance - 删除虚拟机 + """DeleteVMInstance - 删除虚拟机 **Request** - **Region** (str) - (Config) 地域。 枚举值：cn，表示中国； - **VMID** (str) - (Required) 虚拟机 ID。输入有效的虚拟机 ID。 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -874,18 +944,18 @@ def delete_vm_instance(self, req=None, **kwargs): return apis.DeleteVMInstanceResponseSchema().loads(resp) def delete_vpc(self, req=None, **kwargs): - """ DeleteVPC - 删除VPC + """DeleteVPC - 删除VPC **Request** - **Region** (str) - (Config) 地域。 - **VPCID** (str) - (Required) ID - **Zone** (str) - (Required) 可用区。 - + **Response** - **Message** (str) - 返回信息描述； - + """ d = {"Region": self.config.region} req and d.update(req) @@ -894,7 +964,7 @@ def delete_vpc(self, req=None, **kwargs): return apis.DeleteVPCResponseSchema().loads(resp) def delete_vs(self, req=None, **kwargs): - """ DeleteVS - 删除VServer + """DeleteVS - 删除VServer **Request** @@ -902,11 +972,11 @@ def delete_vs(self, req=None, **kwargs): - **LBID** (str) - (Required) VServer 监听器所属的负载均衡 ID - **VSID** (str) - (Required) 负载均衡VServer监听器ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -915,7 +985,7 @@ def delete_vs(self, req=None, **kwargs): return apis.DeleteVSResponseSchema().loads(resp) def delete_vs_policy(self, req=None, **kwargs): - """ DeleteVSPolicy - 删除七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 + """DeleteVSPolicy - 删除七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 **Request** @@ -924,11 +994,11 @@ def delete_vs_policy(self, req=None, **kwargs): - **PolicyID** (str) - (Required) 内容转发规则ID - **VSID** (str) - (Required) VServer的ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -937,35 +1007,35 @@ def delete_vs_policy(self, req=None, **kwargs): return apis.DeleteVSPolicyResponseSchema().loads(resp) def describe_certificate(self, req=None, **kwargs): - """ DescribeCertificate - 查询证书 + """DescribeCertificate - 查询证书 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **CertificateIDs** (list) - 证书ID列表 - **CertificateType** (str) - 证书类型，枚举值["ServerCrt","CACrt"]。分别表示服务器证书和CA证书。 - **Limit** (int) - 返回数据长度，默认为20，最大100 - **Offset** (int) - 列表起始位置偏移量，默认为0 - + **Response** - **Infos** (list) - 见 **CertificateInfo** 模型定义 - **Message** (str) - 返回信息描述 - **TotalCount** (int) - 证书总个数 - + **Response Model** - - **BindVSInfo** - + + **BindVSInfo** + - **LBID** (str) - LB ID - **LBName** (str) - LB名称 - **Port** (int) - VS的端口 - **Protocol** (str) - VS的协议 - **VSID** (str) - VS ID - **CertificateInfo** - + **CertificateInfo** + - **CertificateContent** (str) - 证书内容 - **CertificateID** (str) - 证书ID - **CertificateType** (str) - 证书类型，枚举值["ServerCrt","CACrt"] @@ -989,31 +1059,33 @@ def describe_certificate(self, req=None, **kwargs): return apis.DescribeCertificateResponseSchema().loads(resp) def describe_disk(self, req=None, **kwargs): - """ DescribeDisk - 获取硬盘信息 + """DescribeDisk - 获取硬盘信息 **Request** - **Region** (str) - (Config) 地域。枚举值： cn，表示中国； - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **DiskIDs** (list) - 【数组】磁盘的 ID。输入有效的 ID。调用方式举例：DiskIDs.0=“one-id”、DiskIDs.1=“two-id”。 + - **DiskType** (str) - 硬盘用途类型，默认空返回虚拟机所有硬盘，支持值：Boot（系统盘）、Data（数据盘） - **Limit** (int) - 返回数据长度，默认为20，最大100。 - **Offset** (int) - 列表起始位置偏移量，默认为0。 - + **Response** - **Infos** (list) - 见 **DiskInfo** 模型定义 - **Message** (str) - 返回信息描述。 - **TotalCount** (int) - 返回磁盘总个数。 - + **Response Model** - - **DiskInfo** - + + **DiskInfo** + - **AttachResourceID** (str) - 绑定资源ID - **ChargeType** (str) - 硬盘计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年； - **CreateTime** (int) - 创建时间。时间戳 - **DiskID** (str) - 硬盘ID - - **DiskStatus** (str) - 硬盘状态。Creating：创建中,BeingCloned：正在被克隆中,Unbound：已解绑,Unbounding：解绑中,Bounding：绑定中,Bound：已绑定,Upgrading：升级中,Deleting：删除中,Deleted：已删除,Releasing：销毁中,Released：已销毁 + - **DiskStatus** (str) - 硬盘状态。Creating：创建中,BeingCloned：正在被克隆中,Unbound：已解绑,Unbounding：解绑中,Bounding：绑定中,Bound：已绑定,Upgrading：升级中,Deleting：删除中,Deleted：已删除,Releasing：销毁中,Released：已销毁；Snapshoting（快照中）；Rollbacking（回滚中） + - **DiskType** (str) - 硬盘用途类型，Boot（系统盘）、Data（数据盘） - **ExpireTime** (int) - 过期时间。时间戳 - **Name** (str) - 名称 - **Region** (str) - 地域 @@ -1030,34 +1102,39 @@ def describe_disk(self, req=None, **kwargs): return apis.DescribeDiskResponseSchema().loads(resp) def describe_eip(self, req=None, **kwargs): - """ DescribeEIP - 获取外网IP的信息 + """DescribeEIP - 获取外网IP的信息 **Request** - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； + - **BindResourceID** (str) - 绑定资源ID，查询该资源绑定的所有 EIP - **EIPIDs** (list) - 【数组】外网的 ID。输入有效的 ID。调用方式举例：EIPIDs.0=“one-id”、EIPIDs.1=“two-id” + - **IPVersion** (str) - 版本，支持IPv4、IPv6 - **Limit** (str) - 返回数据长度，默认为20，最大100。 - **Offset** (str) - 列表起始位置偏移量，默认为0。 - + **Response** - **Infos** (list) - 见 **EIPInfo** 模型定义 - **Message** (str) - 返回信息描述 - **Totalcount** (int) - 返回现有外网IP总数 - + **Response Model** - - **EIPInfo** - + + **EIPInfo** + - **Bandwidth** (int) - 带宽大小 - **BindResourceID** (str) - 绑定资源ID - **BindResourceType** (str) - 绑定资源类型 + - **CanDefaultGW** (int) - 所处线路是否为默认路由，1代表所处线路是默认路由；默认路由的可以设置成出口 - **ChargeType** (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年； - **CreateTime** (int) - 创建时间。时间戳 - **EIPID** (str) - ID - **ExpireTime** (int) - 过期时间。时间戳 - **IP** (str) - 外网IP + - **IPVersion** (str) - IP版本,支持值：IPv4\\IPv6 + - **ISDefaultGW** (int) - 是否为默认出口，1代表该IP地址为默认出口 - **Name** (str) - 名称 - **OperatorName** (str) - 线路 - **Region** (str) - 地域 @@ -1073,7 +1150,7 @@ def describe_eip(self, req=None, **kwargs): return apis.DescribeEIPResponseSchema().loads(resp) def describe_image(self, req=None, **kwargs): - """ DescribeImage - 获取镜像信息，包括默认镜像和自制镜像。 + """DescribeImage - 获取镜像信息，包括默认镜像和自制镜像。 **Request** @@ -1083,7 +1160,7 @@ def describe_image(self, req=None, **kwargs): - **ImageType** (str) - 镜像类型。枚举值：Base(基础镜像，平台默认提供的镜像)，Custom(自制镜像，通过虚拟机导出的镜像) 。若该值为空，默认查询所有镜像。 - **Limit** (int) - 返回数据长度，默认为20，最大100。 - **Offset** (int) - 列表起始位置偏移量，默认为0。 - + **Response** - **Action** (str) - 操作名称 @@ -1091,14 +1168,14 @@ def describe_image(self, req=None, **kwargs): - **Message** (str) - 返回信息描述。 - **RetCode** (int) - 返回码 - **TotalCount** (int) - 返回镜像的总个数。 - + **Response Model** - - **ImageInfo** - + + **ImageInfo** + - **CreateTime** (int) - 创建时间。时间戳。 - **ImageID** (str) - 镜像ID - - **ImageStatus** (str) - 镜像状态。枚举类型：Making（创建中）,Available（可用）,Unavailable（不可用）,Terminating（销毁中）,Used（被使用中）,Deleting（删除中）,Deleted（已删除）, Uploading（导入中） + - **ImageStatus** (str) - 镜像状态。枚举类型：Making（创建中）,Terminating（销毁中）,Used（可用）,Deleting（删除中）,Deleted（已删除）, Uploading（导入中）, Failed（导入失败） - **ImageType** (str) - 镜像类型。枚举类型：Base(基础镜像),Custom（自制镜像）。 - **Name** (str) - 镜像名称 - **OSDistribution** (str) - 镜像系统发行版本。例如：Centos, Ubuntu, Windows等 @@ -1116,7 +1193,7 @@ def describe_image(self, req=None, **kwargs): return apis.DescribeImageResponseSchema().loads(resp) def describe_lb(self, req=None, **kwargs): - """ DescribeLB - 获取负载均衡信息 + """DescribeLB - 获取负载均衡信息 **Request** @@ -1127,17 +1204,17 @@ def describe_lb(self, req=None, **kwargs): - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **SubnetID** (str) - 子网ID - **VPCID** (str) - VPCID - + **Response** - **Infos** (list) - 见 **LBInfo** 模型定义 - **Message** (str) - 返回信息描述。 - **TotalCount** (int) - 返回负载均衡总个数。 - + **Response Model** - - **LBInfo** - + + **LBInfo** + - **AlarmTemplateID** (str) - 告警模板ID - **ChargeType** (str) - 虚拟机计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年； - **CreateTime** (int) - 创建时间，时间戳 @@ -1164,7 +1241,7 @@ def describe_lb(self, req=None, **kwargs): return apis.DescribeLBResponseSchema().loads(resp) def describe_metric(self, req=None, **kwargs): - """ DescribeMetric - 获取资源监控信息 + """DescribeMetric - 获取资源监控信息 **Request** @@ -1175,22 +1252,22 @@ def describe_metric(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 资源ID - **ResourceType** (str) - (Required) 资源类型。VM：虚拟机；EIP：弹性IP - **Zone** (str) - (Required) 可用区。枚举值：zone-01，中国； - + **Response** - **Infos** (list) - 见 **MetricInfo** 模型定义 - **Message** (str) - 返回信息描述 - **TotalCount** (int) - 返回监控信息条数 - + **Response Model** - - **MetricSet** - + + **MetricSet** + - **Timestamp** (int) - 监控时间 - **Value** (float) - 监控值 - **MetricInfo** - + **MetricInfo** + - **Infos** (list) - 见 **MetricSet** 模型定义 - **MetricName** (str) - 监控指标。虚拟机的监控指标枚举值为：BlockProcessCount，表示阻塞进程数；CPUUtilization，表示CPU使用率；DiskReadOps，表示磁盘读次数；DiskWriteOps，表示磁盘写次数；IORead，表示磁盘读吞吐；IOWrite，表示磁盘写吞吐；LoadAvg，表示平均负载1分钟；MemUsage，表示内存使用率；NetPacketIn，表示网卡入包量；NetPacketOut，表示网卡出包量；NICIn，表示网卡入带宽；NICOut，表示网卡出带宽；SpaceUsage，表示空间使用率；TCPConnectCount，表示TCP连接数； @@ -1202,7 +1279,7 @@ def describe_metric(self, req=None, **kwargs): return apis.DescribeMetricResponseSchema().loads(resp) def describe_natgw(self, req=None, **kwargs): - """ DescribeNATGW - 获取NAT网关信息 + """DescribeNATGW - 获取NAT网关信息 **Request** @@ -1211,17 +1288,17 @@ def describe_natgw(self, req=None, **kwargs): - **Limit** (int) - 返回数据长度，默认为20，最大100。 - **NATGWIDs** (list) - 【数组】NAT网关的 ID。调用方式举例：NATGWIDs.0=“one-id”、NATGWIDs.1=“two-id”。 - **Offset** (int) - 列表起始位置偏移量，默认为0。 - + **Response** - **Infos** (list) - 见 **NATGWInfo** 模型定义 - **Message** (str) - 返回信息描述。 - **TotalCount** (int) - 返回NAT网关总个数 - + **Response Model** - - **NATGWInfo** - + + **NATGWInfo** + - **AlarmTemplateID** (str) - 告警模板ID - **ChargeType** (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年； - **CreateTime** (int) - 创建时间，时间戳 @@ -1245,7 +1322,7 @@ def describe_natgw(self, req=None, **kwargs): return apis.DescribeNATGWResponseSchema().loads(resp) def describe_natgw_rule(self, req=None, **kwargs): - """ DescribeNATGWRule - 获取NAT网关白名单信息 + """DescribeNATGWRule - 获取NAT网关白名单信息 **Request** @@ -1257,17 +1334,17 @@ def describe_natgw_rule(self, req=None, **kwargs): - **Limit** (int) - 返回数据长度，默认为20，最大100。 - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **RuleIDs** (list) - 【数组】NAT网关白名单ID。调用方式举例：NATGWRules.0=“one-id”、NATGWRules.1=“two-id”。 - + **Response** - **Infos** (list) - 见 **NATGWRuleInfo** 模型定义 - **Message** (str) - 返回信息描述。 - **TotalCount** (int) - 返回NAT网关白名单资源总个数。 - + **Response Model** - - **NATGWRuleInfo** - + + **NATGWRuleInfo** + - **BindResourceID** (str) - 绑定的资源ID - **BindResourceType** (str) - 绑定资源的类型 - **CreateTime** (int) - 创建时间，时间戳。 @@ -1285,43 +1362,85 @@ def describe_natgw_rule(self, req=None, **kwargs): resp = self.invoke("DescribeNATGWRule", d, **kwargs) return apis.DescribeNATGWRuleResponseSchema().loads(resp) + def describe_nic(self, req=None, **kwargs): + """DescribeNIC - 获取网卡信息 + + **Request** + + - **Region** (str) - (Config) 地域。枚举值： cn，表示中国； + - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； + - **Limit** (int) - 返回数据长度，默认为20，最大100。 + - **NICIDs** (list) - 【数组】网卡的 ID。输入有效的 ID。调用方式举例：NICIDs.0=“one-id”、NICIDs.1=“two-id”。 + - **Offset** (int) - 列表起始位置偏移量，默认为0。 + + **Response** + + - **Infos** (list) - 见 **NICInfo** 模型定义 + - **Message** (str) - 返回信息描述。 + - **TotalCount** (int) - 返回网卡总个数。 + + **Response Model** + + **NICInfo** + + - **BindResourceID** (str) - 绑定资源ID + - **CreateTime** (int) - 创建时间。时间戳 + - **IP** (str) - IP + - **MAC** (str) - mac 地址 + - **NICID** (str) - 网卡ID + - **NICStatus** (str) - 网卡状态。枚举值。Creating：创建中,Free：未绑定,Unbounding：解绑中,Bounding：绑定中,Bound：已绑定,BindSGing：绑定安全组中,UnbindSGing：解绑安全组中,UpdateSGing：更新安全组中,Deleting：删除中,Deleted：已删除,Releasing：销毁中,Released：已销毁 + - **Name** (str) - 名称 + - **Region** (str) - 地域 + - **Remark** (str) - 备注 + - **SGID** (str) - 安全组ID + - **SubnetID** (str) - Subnet ID + - **VPCID** (str) - VPC ID + - **Zone** (str) - 可用区 + + """ + d = {"Region": self.config.region} + req and d.update(req) + d = apis.DescribeNICRequestSchema().dumps(d) + resp = self.invoke("DescribeNIC", d, **kwargs) + return apis.DescribeNICResponseSchema().loads(resp) + def describe_op_logs(self, req=None, **kwargs): - """ DescribeOPLogs - 查询操作日志 + """DescribeOPLogs - 查询操作日志 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BeginTime** (int) - (Required) 开始时间 - **EndTime** (int) - (Required) 结束时间 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **IsSuccess** (str) - 是否操作成功 - - **Limit** (int) - - - **Offset** (int) - + - **Limit** (int) - + - **Offset** (int) - - **ResourceID** (str) - 资源ID - **ResourceType** (str) - 资源类型 - + **Response** - **Infos** (list) - 见 **OPLogInfo** 模型定义 - **Message** (str) - 错误信息 - **TotalCount** (int) - 总数 - + **Response Model** - - **OPLogInfo** - + + **OPLogInfo** + - **CreateTime** (int) - 创建时间 - **IsSuccess** (str) - 是否操作成功， Yes, No - **OPLogsID** (str) - 日志ID - **OPName** (str) - API - **OPTime** (int) - 操作时间 - **OpMessage** (str) - 错误信息 - - **Region** (str) - + - **Region** (str) - - **ResourceID** (str) - 资源ID - **ResourceType** (int) - 资源类型 - **RetCode** (int) - 状态码 - **UserEmail** (str) - 账号邮箱 - - **Zone** (str) - + - **Zone** (str) - """ d = {"Region": self.config.region} @@ -1331,7 +1450,7 @@ def describe_op_logs(self, req=None, **kwargs): return apis.DescribeOPLogsResponseSchema().loads(resp) def describe_physical_ip(self, req=None, **kwargs): - """ DescribePhysicalIP - 获取物理IP信息 + """DescribePhysicalIP - 获取物理IP信息 **Request** @@ -1340,17 +1459,17 @@ def describe_physical_ip(self, req=None, **kwargs): - **Limit** (str) - 返回数据长度，默认为20，最大100。 - **Offset** (str) - 列表起始位置偏移量，默认为0。 - **PhysicalIPIDs** (list) - 【数组】物理IP的 ID。输入有效的 ID。调用方式举例：PhysicalIPIDs.0=“one-id”、PhysicalIPIDs.1=“two-id” - + **Response** - **Infos** (list) - 见 **PhysicalIPInfo** 模型定义 - **Message** (str) - 返回信息描述 - **TotalCount** (int) - 返回现有物理IP总数 - + **Response Model** - - **PhysicalIPInfo** - + + **PhysicalIPInfo** + - **BindResourceID** (str) - 绑定资源ID - **BindResourceType** (str) - 绑定资源类型 - **CreateTime** (int) - 创建时间。时间戳 @@ -1372,7 +1491,7 @@ def describe_physical_ip(self, req=None, **kwargs): return apis.DescribePhysicalIPResponseSchema().loads(resp) def describe_rs(self, req=None, **kwargs): - """ DescribeRS - 获取负载均衡服务的服务节点信息 + """DescribeRS - 获取负载均衡服务的服务节点信息 **Request** @@ -1383,17 +1502,17 @@ def describe_rs(self, req=None, **kwargs): - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **RSIDs** (list) - 【数组】RServer的 ID。调用方式举例：RSIDs.0=“one-id”、RSIDs.1=“two-id”。 - **VSID** (str) - VServer的ID - + **Response** - **Infos** (list) - 见 **RSInfo** 模型定义 - **Message** (str) - 返回信息描述。 - **TotalCount** (int) - 返回该负载均衡下VServer的总个数。 - + **Response Model** - - **RSInfo** - + + **RSInfo** + - **BindResourceID** (str) - 绑定的资源ID - **CreateTime** (int) - 创建时间，时间戳 - **IP** (str) - 服务节点的内网 IP 地址 @@ -1415,7 +1534,7 @@ def describe_rs(self, req=None, **kwargs): return apis.DescribeRSResponseSchema().loads(resp) def describe_recycled_resource(self, req=None, **kwargs): - """ DescribeRecycledResource - 查询回收站资源 + """DescribeRecycledResource - 查询回收站资源 **Request** @@ -1424,16 +1543,16 @@ def describe_recycled_resource(self, req=None, **kwargs): - **Limit** (int) - 返回数据长度，默认为20，最大100。 - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **ResourceIDs** (list) - 【数组】资源ID，输入“有效”的ID。调用方式举例：ResourceIDs.0=“one-id”、ResourceIDs.1=“two-id”。 - + **Response** - **Infos** (list) - 见 **RecycledResourceInfo** 模型定义 - **TotalCount** (int) - 返回回收站资源的总个数 - + **Response Model** - - **RecycledResourceInfo** - + + **RecycledResourceInfo** + - **CreateTime** (int) - 创建时间 - **DeleteTime** (int) - 删除时间 - **Description** (str) - 描述 @@ -1455,7 +1574,7 @@ def describe_recycled_resource(self, req=None, **kwargs): return apis.DescribeRecycledResourceResponseSchema().loads(resp) def describe_security_group(self, req=None, **kwargs): - """ DescribeSecurityGroup - 查询安全组信息 + """DescribeSecurityGroup - 查询安全组信息 **Request** @@ -1464,17 +1583,17 @@ def describe_security_group(self, req=None, **kwargs): - **Limit** (int) - 返回数据长度，默认为20，最大100。 - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **SGIDs** (list) - 【数组】安全组的 ID。输入有效的 ID。调用方式举例：SGIDs.0=“one-id”、SGIDs.1=“two-id” - + **Response** - **Infos** (list) - 见 **SGInfo** 模型定义 - **Message** (str) - 返回信息描述； - **TotalCount** (int) - 安全组的总数 - + **Response Model** - - **SGRuleInfo** - + + **SGRuleInfo** + - **DstPort** (str) - 端口号 - **IsIn** (str) - 方向。1：入，0：出 - **Priority** (str) - 优先级。HIGH:高，MEDIUM:中，LOW:低 @@ -1483,8 +1602,8 @@ def describe_security_group(self, req=None, **kwargs): - **RuleID** (str) - 规则ID - **SrcIP** (str) - IP或者掩码/段形式。10.0.0.2,10.0.10.10/16 - **SGInfo** - + **SGInfo** + - **CreateTime** (int) - 创建时间，时间戳 - **Name** (str) - 名称 - **Region** (str) - 地域 @@ -1504,24 +1623,97 @@ def describe_security_group(self, req=None, **kwargs): resp = self.invoke("DescribeSecurityGroup", d, **kwargs) return apis.DescribeSecurityGroupResponseSchema().loads(resp) + def describe_security_group_resource(self, req=None, **kwargs): + """DescribeSecurityGroupResource - 查询安全组绑定的资源信息 + + **Request** + + - **Region** (str) - (Config) 地域。枚举值： cn，表示中国； + - **SGID** (str) - (Required) 安全组ID + - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； + - **Limit** (int) - 返回数据长度，默认为20，最大100。 + - **Offset** (int) - 列表起始位置偏移量，默认为0。 + + **Response** + + - **Infos** (list) - 见 **SGResourceInfo** 模型定义 + - **Message** (str) - 返回信息描述。 + - **TotalCount** (int) - 返回资源总个数。 + + **Response Model** + + **SGResourceInfo** + + - **Name** (str) - 资源名称 + - **Region** (str) - 地域 + - **ResourceID** (str) - 资源ID + - **ResourceType** (str) - 资源类型 + - **Zone** (str) - 可用区 + + """ + d = {"Region": self.config.region} + req and d.update(req) + d = apis.DescribeSecurityGroupResourceRequestSchema().dumps(d) + resp = self.invoke("DescribeSecurityGroupResource", d, **kwargs) + return apis.DescribeSecurityGroupResourceResponseSchema().loads(resp) + + def describe_snapshot(self, req=None, **kwargs): + """DescribeSnapshot - 查询硬盘快照信息 + + **Request** + + - **Region** (str) - (Config) 地域。枚举值： cn，表示中国； + - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； + - **DiskID** (str) - 硬盘ID，输入“有效”状态的ID + - **Limit** (int) - 返回数据长度，默认为20，最大100。 + - **Offset** (int) - 列表起始位置偏移量，默认为0。 + - **SnapshotIDs** (list) - 【数组】快照ID，输入“有效”的ID。调用方式举例：SnapshotIDs.0=“one-id”、SnapshotIDs.1=“two-id”。 + + **Response** + + - **Infos** (list) - 见 **SnapshotInfo** 模型定义 + - **Message** (str) - 返回信息描述 + - **TotalCount** (int) - 返回快照总个数 + + **Response Model** + + **SnapshotInfo** + + - **CreateTime** (int) - 快照创建时间 + - **DiskID** (str) - 快照对应的硬盘 ID + - **DiskType** (str) - 硬盘类型。枚举值：Boot，表示系统盘；Data，表示数据盘； + - **Name** (str) - 快照名称 + - **Region** (str) - 地域。枚举值： cn，表示中国； + - **Remark** (str) - 描述 + - **SnapshotID** (str) - 快照ID + - **SnapshotStatus** (str) - 快照状态。枚举值：Createing，表示制作中；Normal，表示正常；RollBacking，表示回滚中；Deleting，表示删除中；Deleted，表示已删除； + - **Zone** (str) - 可用区。枚举值：zone-01，表示中国； + + """ + d = {"Region": self.config.region} + req and d.update(req) + d = apis.DescribeSnapshotRequestSchema().dumps(d) + resp = self.invoke("DescribeSnapshot", d, **kwargs) + return apis.DescribeSnapshotResponseSchema().loads(resp) + def describe_storage_type(self, req=None, **kwargs): - """ DescribeStorageType - 查询存储类型 + """DescribeStorageType - 查询存储类型 **Request** - **Region** (str) - (Config) 地域。 - **Zone** (str) - (Required) 可用区。 - + **Response** - **Infos** (list) - 见 **StorageTypeInfo** 模型定义 - **Message** (str) - 返回信息描述； - **TotalCount** (int) - 存储类型的总数 - + **Response Model** - - **StorageTypeInfo** - + + **StorageTypeInfo** + - **Region** (str) - 地域 - **SetArch** (str) - 架构 - **StorageType** (str) - 存储类型 @@ -1536,7 +1728,7 @@ def describe_storage_type(self, req=None, **kwargs): return apis.DescribeStorageTypeResponseSchema().loads(resp) def describe_subnet(self, req=None, **kwargs): - """ DescribeSubnet - 查询子网信息 + """DescribeSubnet - 查询子网信息 **Request** @@ -1546,17 +1738,17 @@ def describe_subnet(self, req=None, **kwargs): - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **SubnetIDs** (list) - 【数组】子网 ID。调用方式举例：SubnetIDs.0=“one-id”、SubnetIDs.1=“two-id” - **VPCID** (str) - VPCID - + **Response** - **Infos** (list) - 见 **SubnetInfo** 模型定义 - **Message** (str) - 返回信息描述； - **TotalCount** (int) - 子网的总数 - + **Response Model** - - **SubnetInfo** - + + **SubnetInfo** + - **CreateTime** (int) - 创建时间，时间戳 - **Name** (str) - 名称 - **Network** (str) - 网段 @@ -1575,24 +1767,24 @@ def describe_subnet(self, req=None, **kwargs): return apis.DescribeSubnetResponseSchema().loads(resp) def describe_user(self, req=None, **kwargs): - """ DescribeUser - 查询租户信息 + """DescribeUser - 查询租户信息 **Request** - **Limit** (int) - 返回数据长度，默认为20，最大100。 - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **UserIDs** (list) - 【数组】租户的 ID。输入有效的 ID。调用方式举例：UserIDs.0=123”、UserIDs.1=456 - + **Response** - **Infos** (list) - 见 **UserInfo** 模型定义 - **Message** (str) - 返回信息描述 - **TotalCount** (int) - 返回现有租户总数 - + **Response Model** - - **UserInfo** - + + **UserInfo** + - **Amount** (float) - 账户余额 - **CreateTime** (int) - 账户创建时间。时间戳 - **Email** (str) - 租户名称 @@ -1610,43 +1802,28 @@ def describe_user(self, req=None, **kwargs): return apis.DescribeUserResponseSchema().loads(resp) def describe_vm_instance(self, req=None, **kwargs): - """ DescribeVMInstance - 查询虚拟机 + """DescribeVMInstance - 查询虚拟机 **Request** - - **Region** (str) - (Config) 地域。枚举值： cn，表示中国； + - **Region** (str) - (Config) 地域或数据中心。枚举值： cn，表示中国； - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Limit** (int) - 返回数据长度，默认为20，最大100。 - - **Offset** (str) - 列表起始位置偏移量，默认为0。 + - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **SubnetID** (str) - 子网 ID。输入“有效”状态的子网 ID。 - **VMIDs** (list) - 【数组】虚拟机的 ID。输入有效的 ID。调用方式举例：PrivateIp.0=“one-id”、PrivateIp.1=“two-id”。 - **VPCID** (str) - VPC ID。输入“有效”状态的VPC ID。 - + **Response** - **Infos** (list) - 见 **VMInstanceInfo** 模型定义 - **Message** (str) - 返回信息描述 - **TotalCount** (int) - 返回虚拟机总个数 - + **Response Model** - - **VMIPInfo** - - - **IP** (str) - IP 值 - - **IPVersion** (str) - IP版本,支持值：IPv4\\IPv6 - - **InterfaceID** (str) - 网卡 ID - - **IsElastic** (str) - 是否是弹性网卡。枚举值：Y，表示是；N，表示否； - - **MAC** (str) - MAC 地址值 - - **SGID** (str) - 安全组 ID - - **SGName** (str) - 安全组名称 - - **SubnetID** (str) - 子网 ID - - **SubnetName** (str) - 子网名称 - - **Type** (str) - IP 类型。枚举值：Private，表示内网；Public，表示外网；Physical，表示物理网； - - **VPCID** (str) - VPC ID - - **VPCName** (str) - VPC 名称 - **VMDiskInfo** - + **VMDiskInfo** + - **DiskID** (str) - 磁盘 ID - **Drive** (str) - 磁盘盘符 - **IsElastic** (str) - 是否是弹性磁盘。枚举值为：Y，表示是；N，表示否； @@ -1654,8 +1831,23 @@ def describe_vm_instance(self, req=None, **kwargs): - **Size** (int) - 磁盘大小，单位 GB - **Type** (str) - 磁盘类型。枚举值：Boot，表示系统盘；Data，表示数据盘； - **VMInstanceInfo** - + **VMIPInfo** + + - **IP** (str) - IP 值 + - **IPVersion** (str) - IP版本,支持值：IPv4\\IPv6 + - **InterfaceID** (str) - 网卡 ID，IP 地址绑定的网卡 ID + - **IsElastic** (str) - 是否是弹性网卡。枚举值：Y，表示是；N，表示否； + - **MAC** (str) - MAC 地址值 + - **SGID** (str) - 安全组 ID + - **SGName** (str) - 安全组名称 + - **SubnetID** (str) - 子网 ID，IP 为外网 IP 时为空； + - **SubnetName** (str) - 子网名称，IP 为外网 IP 时为空； + - **Type** (str) - IP 类型。枚举值：Private，表示内网；Public，表示外网。 + - **VPCID** (str) - VPC ID，IP 为外网 IP 时为空； + - **VPCName** (str) - VPC 名称，IP 为外网 IP 时为空； + + **VMInstanceInfo** + - **CPU** (int) - CPU 个数 - **ChargeType** (str) - 虚拟机计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年； - **CreateTime** (int) - 虚拟机创建时间 @@ -1668,18 +1860,16 @@ def describe_vm_instance(self, req=None, **kwargs): - **OSName** (str) - 操作系统名称 - **OSType** (str) - 操作系统类型 - **Region** (str) - Region - - **RegionAlias** (str) - Region 别名 - **Remark** (str) - 备注 - **State** (str) - 虚拟机状态。枚举值：Initializing，表示初始化；Starting，表示启动中；Restarting，表示重启中；Running，表示运行；Stopping，表示关机中；Stopped，表示关机；Deleted，表示已删除；Resizing，表示修改配置中；Terminating，表示销毁中；Terminated，表示已销毁；Migrating，表示迁移中；WaitReinstall，表示等待重装系统；Reinstalling，表示重装中；Poweroffing，表示断电中；ChangeSGing，表示修改防火墙中； - **SubnetID** (str) - 子网 ID - **SubnetName** (str) - 子网 名称 - **VMID** (str) - 虚拟机 ID - - **VMType** (str) - 虚拟机类型 - - **VMTypeAlias** (str) - 虚拟机类型别名 + - **VMType** (str) - 虚拟机所在宿主机的集群类型 ID + - **VMTypeAlias** (str) - 虚拟机所在宿主机的集群类型名称 - **VPCID** (str) - VPC ID - **VPCName** (str) - VPC 名称 - **Zone** (str) - Zone - - **ZoneAlias** (str) - Zone 别名 """ d = {"Region": self.config.region} @@ -1689,23 +1879,23 @@ def describe_vm_instance(self, req=None, **kwargs): return apis.DescribeVMInstanceResponseSchema().loads(resp) def describe_vm_type(self, req=None, **kwargs): - """ DescribeVMType - 查询主机机型 + """DescribeVMType - 查询主机机型 **Request** - **Region** (str) - (Config) 地域。 - **Zone** (str) - (Required) 可用区。 - + **Response** - **Infos** (list) - 见 **VMTypeInfo** 模型定义 - **Message** (str) - 返回信息描述； - **TotalCount** (int) - 主机机型的总数 - + **Response Model** - - **VMTypeInfo** - + + **VMTypeInfo** + - **Region** (str) - 地域 - **SetArch** (str) - 架构 - **VMType** (str) - 机型 @@ -1720,7 +1910,7 @@ def describe_vm_type(self, req=None, **kwargs): return apis.DescribeVMTypeResponseSchema().loads(resp) def describe_vpc(self, req=None, **kwargs): - """ DescribeVPC - 查询VPC信息 + """DescribeVPC - 查询VPC信息 **Request** @@ -1729,17 +1919,17 @@ def describe_vpc(self, req=None, **kwargs): - **Limit** (int) - 返回数据长度，默认为20，最大100。 - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **VPCIDs** (list) - 【数组】VPC的 ID。调用方式举例：VPCIDs.0=“one-id”、VPCIDs.1=“two-id” - + **Response** - **Infos** (list) - 见 **VPCInfo** 模型定义 - **Message** (str) - 返回信息描述； - **TotalCount** (int) - VPC的总数 - + **Response Model** - - **SubnetInfo** - + + **SubnetInfo** + - **CreateTime** (int) - 创建时间，时间戳 - **Name** (str) - 名称 - **Network** (str) - 网段 @@ -1750,8 +1940,8 @@ def describe_vpc(self, req=None, **kwargs): - **UpdateTime** (int) - 更新时间，时间戳 - **Zone** (str) - 可用区 - **VPCInfo** - + **VPCInfo** + - **CreateTime** (int) - 创建时间，时间戳 - **Name** (str) - 名称 - **Network** (str) - 网段，比如10.0.0.0/16 @@ -1772,7 +1962,7 @@ def describe_vpc(self, req=None, **kwargs): return apis.DescribeVPCResponseSchema().loads(resp) def describe_vs(self, req=None, **kwargs): - """ DescribeVS - 获取负载均衡 VServer 信息 + """DescribeVS - 获取负载均衡 VServer 信息 **Request** @@ -1782,17 +1972,17 @@ def describe_vs(self, req=None, **kwargs): - **Limit** (int) - 返回数据长度，默认为20，最大100。 - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **VSIDs** (list) - 【数组】VServer的 ID。调用方式举例：VSIDs.0=“one-id”、VSIDs.1=“two-id”。 - + **Response** - **Infos** (list) - 见 **VSInfo** 模型定义 - **Message** (str) - 返回信息描述。 - **TotalCount** (int) - 返回当前负载均衡 VServer 总个数。 - + **Response Model** - - **VSPolicyInfo** - + + **VSPolicyInfo** + - **CreateTime** (int) - 创建时间，时间戳 - **Domain** (str) - 内容转发规则关联的请求域名，值可为空，即代表仅匹配路径。 - **LBID** (str) - 负载均衡ID @@ -1803,8 +1993,8 @@ def describe_vs(self, req=None, **kwargs): - **UpdateTime** (int) - 更新时间，时间戳 - **VSID** (str) - VServerID - **RSInfo** - + **RSInfo** + - **BindResourceID** (str) - 绑定的资源ID - **CreateTime** (int) - 创建时间，时间戳 - **IP** (str) - 服务节点的内网 IP 地址 @@ -1818,9 +2008,10 @@ def describe_vs(self, req=None, **kwargs): - **VSID** (str) - 服务节点所属的 VServer ID - **Weight** (int) - 服务节点的权重 - **VSInfo** - + **VSInfo** + - **AlarmTemplateID** (str) - 告警模板ID + - **CACertificateID** (str) - CA证书ID，用于验证客户端证书的签名。仅当VServer监听协议为 HTTPS 且 SSLMode 为双向认证时有效。 - **CreateTime** (int) - 创建时间，时间戳 - **Domain** (str) - HTTP 健康检查时校验请求的 HOST 字段中的域名。当健康检查类型为端口检查时，该值为空。 - **HealthcheckType** (str) - 负载均衡的健康检查类型。枚举值：Port:端口检查；Path: HTTP检查 。 @@ -1833,6 +2024,9 @@ def describe_vs(self, req=None, **kwargs): - **Protocol** (str) - 协议 - **RSHealthStatus** (str) - 健康检查状态，枚举值，Empty:全部异常,Parts:部分异常,All:正常 - **RSInfos** (list) - 见 **RSInfo** 模型定义 + - **SSLMode** (str) - SSL认证模式,取值范围["simplex","duplex"]分别表示单向认证和双向认证。 + - **Scheduler** (str) - 负载均衡的调度算法。枚举值：wrr:加权轮训；least_conn:最小连接数；hash:原地址,四层lb使用。ip_hash:七层lb使用 + - **ServerCertificateID** (str) - 服务器证书ID，用于证明服务器的身份。仅当 VServer监听协议为 HTTPS 时有效。 - **UpdateTime** (int) - 更新时间，时间戳 - **VSID** (str) - VServer的ID - **VSPolicyInfos** (list) - 见 **VSPolicyInfo** 模型定义 @@ -1846,7 +2040,7 @@ def describe_vs(self, req=None, **kwargs): return apis.DescribeVSResponseSchema().loads(resp) def describe_vs_policy(self, req=None, **kwargs): - """ DescribeVSPolicy - 获取七层负载均衡内容转发规则信息，仅当 VServer 的监听协议为 HTTP 时有效。 + """DescribeVSPolicy - 获取七层负载均衡内容转发规则信息，仅当 VServer 的监听协议为 HTTP 时有效。 **Request** @@ -1857,17 +2051,17 @@ def describe_vs_policy(self, req=None, **kwargs): - **Offset** (int) - 列表起始位置偏移量，默认为0。 - **PolicyIDs** (list) - 【数组】七层负载均衡内容转发规则的 ID。调用方式举例：PolicyIDs.0=“one-id”、PolicyIDs.1=“two-id” - **VSID** (str) - VServerID - + **Response** - **Infos** (list) - 见 **VSPolicyInfo** 模型定义 - **Message** (str) - 返回信息描述。 - **TotalCount** (int) - 返回内容转发规则的总个数。 - + **Response Model** - - **RSInfo** - + + **RSInfo** + - **BindResourceID** (str) - 绑定的资源ID - **CreateTime** (int) - 创建时间，时间戳 - **IP** (str) - 服务节点的内网 IP 地址 @@ -1881,8 +2075,8 @@ def describe_vs_policy(self, req=None, **kwargs): - **VSID** (str) - 服务节点所属的 VServer ID - **Weight** (int) - 服务节点的权重 - **VSPolicyInfo** - + **VSPolicyInfo** + - **CreateTime** (int) - 创建时间，时间戳 - **Domain** (str) - 内容转发规则关联的请求域名，值可为空，即代表仅匹配路径。 - **LBID** (str) - 负载均衡ID @@ -1901,7 +2095,7 @@ def describe_vs_policy(self, req=None, **kwargs): return apis.DescribeVSPolicyResponseSchema().loads(resp) def detach_disk(self, req=None, **kwargs): - """ DetachDisk - 解绑UClouStack硬盘 + """DetachDisk - 解绑硬盘 **Request** @@ -1909,11 +2103,11 @@ def detach_disk(self, req=None, **kwargs): - **DiskID** (str) - (Required) 硬盘ID - **ResourceID** (str) - (Required) 绑定的资源ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -1921,8 +2115,29 @@ def detach_disk(self, req=None, **kwargs): resp = self.invoke("DetachDisk", d, **kwargs) return apis.DetachDiskResponseSchema().loads(resp) + def detach_nic(self, req=None, **kwargs): + """DetachNIC - 解绑UClouStack网卡 + + **Request** + + - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； + - **NICID** (str) - (Required) 网卡ID + - **ResourceID** (str) - (Required) 绑定的资源ID + - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； + + **Response** + + - **Message** (str) - 返回信息描述。 + + """ + d = {"Region": self.config.region} + req and d.update(req) + d = apis.DetachNICRequestSchema().dumps(d) + resp = self.invoke("DetachNIC", d, **kwargs) + return apis.DetachNICResponseSchema().loads(resp) + def disable_rs(self, req=None, **kwargs): - """ DisableRS - 禁用负载均衡的单个服务节点 + """DisableRS - 禁用负载均衡的单个服务节点 **Request** @@ -1931,11 +2146,11 @@ def disable_rs(self, req=None, **kwargs): - **RSID** (str) - (Required) RServer的ID - **VSID** (str) - (Required) VServer的ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -1944,7 +2159,7 @@ def disable_rs(self, req=None, **kwargs): return apis.DisableRSResponseSchema().loads(resp) def enable_rs(self, req=None, **kwargs): - """ EnableRS - 启用负载均衡的单个服务节点 + """EnableRS - 启用负载均衡的单个服务节点 **Request** @@ -1953,11 +2168,11 @@ def enable_rs(self, req=None, **kwargs): - **RSID** (str) - (Required) RServer的ID - **VSID** (str) - (Required) VServer的ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -1966,7 +2181,7 @@ def enable_rs(self, req=None, **kwargs): return apis.EnableRSResponseSchema().loads(resp) def get_disk_price(self, req=None, **kwargs): - """ GetDiskPrice - 获取硬盘价格 + """GetDiskPrice - 获取硬盘价格 **Request** @@ -1976,16 +2191,16 @@ def get_disk_price(self, req=None, **kwargs): - **SetType** (str) - (Required) 磁盘类型 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Quantity** (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。 - + **Response** - **Infos** (list) - 见 **PriceInfo** 模型定义 - **Message** (str) - 返回信息描述。 - + **Response Model** - - **PriceInfo** - + + **PriceInfo** + - **ChargeType** (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年； - **Price** (float) - 价格 @@ -1997,7 +2212,7 @@ def get_disk_price(self, req=None, **kwargs): return apis.GetDiskPriceResponseSchema().loads(resp) def get_eip_price(self, req=None, **kwargs): - """ GetEIPPrice - 获取外网IP价格 + """GetEIPPrice - 获取外网IP价格 **Request** @@ -2007,16 +2222,16 @@ def get_eip_price(self, req=None, **kwargs): - **OpertatorName** (str) - (Required) 线路。目前支持Bgp - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Quantity** (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。 - + **Response** - **Infos** (list) - 见 **PriceInfo** 模型定义 - **Message** (str) - 返回信息描述 - + **Response Model** - - **PriceInfo** - + + **PriceInfo** + - **ChargeType** (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年； - **Price** (float) - 价格 @@ -2028,7 +2243,7 @@ def get_eip_price(self, req=None, **kwargs): return apis.GetEIPPriceResponseSchema().loads(resp) def get_vm_instance_price(self, req=None, **kwargs): - """ GetVMInstancePrice - 获取虚拟机价格 + """GetVMInstancePrice - 获取虚拟机价格 **Request** @@ -2045,16 +2260,16 @@ def get_vm_instance_price(self, req=None, **kwargs): - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **GPU** (int) - GPU 卡核心的占用个数。枚举值：【1,2,4】。GPU与CPU、内存大小关系：CPU个数>=4*GPU个数，同时内存与CPU规格匹配. - **Quantity** (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。 - + **Response** - **Infos** (list) - 见 **PriceInfo** 模型定义 - **Message** (str) - 返回信息描述。 - + **Response Model** - - **PriceInfo** - + + **PriceInfo** + - **ChargeType** (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年； - **Price** (float) - 价格 @@ -2066,7 +2281,7 @@ def get_vm_instance_price(self, req=None, **kwargs): return apis.GetVMInstancePriceResponseSchema().loads(resp) def modify_eip_bandwidth(self, req=None, **kwargs): - """ ModifyEIPBandwidth - 调整外网IP带宽 + """ModifyEIPBandwidth - 调整外网IP带宽 **Request** @@ -2074,11 +2289,11 @@ def modify_eip_bandwidth(self, req=None, **kwargs): - **Bandwidth** (int) - (Required) 调整后的带宽 - **EIPID** (str) - (Required) 外网IP的ID - **Zone** (str) - (Required) 可用区。 - + **Response** - **Message** (str) - 返回信息描述； - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2087,7 +2302,7 @@ def modify_eip_bandwidth(self, req=None, **kwargs): return apis.ModifyEIPBandwidthResponseSchema().loads(resp) def modify_name_and_remark(self, req=None, **kwargs): - """ ModifyNameAndRemark - 修改资源名称和备注 + """ModifyNameAndRemark - 修改资源名称和备注 **Request** @@ -2096,11 +2311,11 @@ def modify_name_and_remark(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 资源ID; - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Remark** (str) - 描述; - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2109,18 +2324,18 @@ def modify_name_and_remark(self, req=None, **kwargs): return apis.ModifyNameAndRemarkResponseSchema().loads(resp) def poweroff_vm_instance(self, req=None, **kwargs): - """ PoweroffVMInstance - 断电虚拟机，可能导致丢失数据甚至损坏操作系统，仅适用于虚拟机死机及级端测试场景。 + """PoweroffVMInstance - 断电虚拟机，可能导致丢失数据甚至损坏操作系统，仅适用于虚拟机死机及级端测试场景。 **Request** - **Region** (str) - (Config) 地域。枚举值：如 cn,表示中国。 - **VMID** (str) - (Required) 虚拟机ID - **Zone** (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。 - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2129,7 +2344,7 @@ def poweroff_vm_instance(self, req=None, **kwargs): return apis.PoweroffVMInstanceResponseSchema().loads(resp) def recharge(self, req=None, **kwargs): - """ Recharge - 管理员给租户充值 + """Recharge - 管理员给租户充值 **Request** @@ -2137,11 +2352,11 @@ def recharge(self, req=None, **kwargs): - **FromType** (str) - (Required) 充值来源。INPOUR_FROM_ALIPAY：支付宝，INPOUR_FROM_OFFLINE：银行转账，INPOUR_FROM_SINPAY：新浪支付，INPOUR_FROM_WECHAT_PAY：微信转账。 - **SerialNo** (str) - (Required) 充值单号。充值方式为“账户余额”时为必要参数。 - **UserID** (int) - (Required) 租户的账户ID。 - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {} req and d.update(req) @@ -2150,7 +2365,7 @@ def recharge(self, req=None, **kwargs): return apis.RechargeResponseSchema().loads(resp) def reinstall_vm_instance(self, req=None, **kwargs): - """ ReinstallVMInstance - 重装系统，关机的虚拟机才可以重装系统 + """ReinstallVMInstance - 重装系统，关机的虚拟机才可以重装系统 **Request** @@ -2158,11 +2373,11 @@ def reinstall_vm_instance(self, req=None, **kwargs): - **ImageID** (str) - (Required) 镜像ID - **VMID** (str) - (Required) 虚拟机ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2171,18 +2386,18 @@ def reinstall_vm_instance(self, req=None, **kwargs): return apis.ReinstallVMInstanceResponseSchema().loads(resp) def release_eip(self, req=None, **kwargs): - """ ReleaseEIP - 删除外网IP + """ReleaseEIP - 删除外网IP **Request** - **Region** (str) - (Config) 地域。枚举值：cn,表示中国；中国 - **EIPID** (str) - (Required) 外网IP的ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国 - + **Response** - **Message** (str) - 返回状态描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2191,7 +2406,7 @@ def release_eip(self, req=None, **kwargs): return apis.ReleaseEIPResponseSchema().loads(resp) def renew_resource(self, req=None, **kwargs): - """ RenewResource - 续费回收站资源 + """RenewResource - 续费回收站资源 **Request** @@ -2199,11 +2414,11 @@ def renew_resource(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 待续续的资源ID - **Zone** (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。 - **Quantity** (int) - 购买时长，默认为 1。按小时(Dynamic)付费的资源无需此参数，按月付费的资源传 0 时，代表购买至月末。 - + **Response** - **Message** (str) - 返回描述信息 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2212,7 +2427,7 @@ def renew_resource(self, req=None, **kwargs): return apis.RenewResourceResponseSchema().loads(resp) def reset_vm_instance_password(self, req=None, **kwargs): - """ ResetVMInstancePassword - 重置虚拟机密码，主机必须开机才可以重置密码 + """ResetVMInstancePassword - 重置虚拟机密码，主机必须开机才可以重置密码 **Request** @@ -2220,11 +2435,11 @@ def reset_vm_instance_password(self, req=None, **kwargs): - **Password** (str) - (Required) 密码 - **VMID** (str) - (Required) 虚拟机ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2233,7 +2448,7 @@ def reset_vm_instance_password(self, req=None, **kwargs): return apis.ResetVMInstancePasswordResponseSchema().loads(resp) def resize_vm_config(self, req=None, **kwargs): - """ ResizeVMConfig - 修改虚拟机配置 + """ResizeVMConfig - 修改虚拟机配置 **Request** @@ -2242,11 +2457,11 @@ def resize_vm_config(self, req=None, **kwargs): - **Memory** (int) - (Required) 内存容量，如 2048、4096、8192、16384、32768、65536、131072。 - **VMID** (str) - (Required) 虚拟机ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2255,18 +2470,18 @@ def resize_vm_config(self, req=None, **kwargs): return apis.ResizeVMConfigResponseSchema().loads(resp) def restart_vm_instance(self, req=None, **kwargs): - """ RestartVMInstance - 重启虚拟机 + """RestartVMInstance - 重启虚拟机 **Request** - **Region** (str) - (Config) 地域。枚举值：cn,表示中国； - **VMID** (str) - (Required) 虚拟机ID; - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2275,18 +2490,18 @@ def restart_vm_instance(self, req=None, **kwargs): return apis.RestartVMInstanceResponseSchema().loads(resp) def rollback_resource(self, req=None, **kwargs): - """ RollbackResource - 恢复回收站资源 + """RollbackResource - 恢复回收站资源 **Request** - **Region** (str) - (Config) 地域。枚举值：如 cn,表示中国。 - **ResourceID** (str) - (Required) 待恢复的资源ID - **Zone** (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。 - + **Response** - **Message** (str) - 返回描述信息 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2295,7 +2510,7 @@ def rollback_resource(self, req=None, **kwargs): return apis.RollbackResourceResponseSchema().loads(resp) def rollback_snapshot(self, req=None, **kwargs): - """ RollbackSnapshot - 将某个快照内的数据回滚到原云硬盘，仅支持正常状态的快照进行回滚操作，回滚时硬盘必须处于未绑定或其挂载的主机为关机状态。 + """RollbackSnapshot - 将某个快照内的数据回滚到原云硬盘，仅支持正常状态的快照进行回滚操作，回滚时硬盘必须处于未绑定或其挂载的主机为关机状态。 **Request** @@ -2303,11 +2518,11 @@ def rollback_snapshot(self, req=None, **kwargs): - **DiskID** (str) - (Required) 对应的云硬盘 ID； - **SnapshotID** (str) - (Required) 快照ID - **Zone** (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。 - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2316,18 +2531,18 @@ def rollback_snapshot(self, req=None, **kwargs): return apis.RollbackSnapshotResponseSchema().loads(resp) def start_vm_instance(self, req=None, **kwargs): - """ StartVMInstance - 开启虚拟机 + """StartVMInstance - 开启虚拟机 **Request** - **Region** (str) - (Config) 地域。枚举值：cn，表示中国； - **VMID** (str) - (Required) 虚拟机 ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2336,19 +2551,19 @@ def start_vm_instance(self, req=None, **kwargs): return apis.StartVMInstanceResponseSchema().loads(resp) def stop_vm_instance(self, req=None, **kwargs): - """ StopVMInstance - 关闭虚拟机 + """StopVMInstance - 关闭虚拟机 **Request** - **Region** (str) - (Config) 地域。枚举值：cn，表示中国； - **VMID** (str) - (Required) 虚拟机 ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述 - **VMID** (str) - 虚拟机 ID - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2357,18 +2572,18 @@ def stop_vm_instance(self, req=None, **kwargs): return apis.StopVMInstanceResponseSchema().loads(resp) def terminate_resource(self, req=None, **kwargs): - """ TerminateResource - 销毁资源 + """TerminateResource - 销毁资源 **Request** - **Region** (str) - (Config) 地域。 - **ResourceID** (str) - (Required) 资源id - **Zone** (str) - (Required) 可用区。 - + **Response** - **Message** (str) - 返回描述信息 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2377,7 +2592,7 @@ def terminate_resource(self, req=None, **kwargs): return apis.TerminateResourceResponseSchema().loads(resp) def un_bind_eip(self, req=None, **kwargs): - """ UnBindEIP - 解绑外网IP + """UnBindEIP - 解绑外网IP **Request** @@ -2386,11 +2601,11 @@ def un_bind_eip(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 资源ID - **ResourceType** (str) - (Required) 资源类型。VM：虚拟机, LB:负载均衡, NATGW：nat网关 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2399,7 +2614,7 @@ def un_bind_eip(self, req=None, **kwargs): return apis.UnBindEIPResponseSchema().loads(resp) def un_bind_security_group(self, req=None, **kwargs): - """ UnBindSecurityGroup - 解绑安全组 + """UnBindSecurityGroup - 解绑安全组 **Request** @@ -2407,11 +2622,11 @@ def un_bind_security_group(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 解绑的资源ID。调用方式举例：ResourceID=“one-id”。 - **SGID** (str) - (Required) 安全组ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2420,7 +2635,7 @@ def un_bind_security_group(self, req=None, **kwargs): return apis.UnBindSecurityGroupResponseSchema().loads(resp) def unbind_alarm_template(self, req=None, **kwargs): - """ UnbindAlarmTemplate - 解绑告警模板 + """UnbindAlarmTemplate - 解绑告警模板 **Request** @@ -2429,11 +2644,11 @@ def unbind_alarm_template(self, req=None, **kwargs): - **ResourceIDs** (list) - (Required) 【数组】资源的 ID。调用方式举例：ResourceIDs.0=“one-id”、ResourceIDs.1=“two-id”。 - **ResourceType** (str) - (Required) 资源类型。VM：虚拟机, LB:负载均衡, NATGW：nat网关;EIP:弹性网卡 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2442,7 +2657,7 @@ def unbind_alarm_template(self, req=None, **kwargs): return apis.UnbindAlarmTemplateResponseSchema().loads(resp) def unbind_physical_ip(self, req=None, **kwargs): - """ UnbindPhysicalIP - 解绑物理IP + """UnbindPhysicalIP - 解绑物理IP **Request** @@ -2451,11 +2666,11 @@ def unbind_physical_ip(self, req=None, **kwargs): - **ResourceID** (str) - (Required) 资源ID - **ResourceType** (str) - (Required) 资源类型。VM：虚拟机 - **Zone** (str) - (Required) 可用区。 - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2464,7 +2679,7 @@ def unbind_physical_ip(self, req=None, **kwargs): return apis.UnbindPhysicalIPResponseSchema().loads(resp) def update_alarm_template_rule(self, req=None, **kwargs): - """ UpdateAlarmTemplateRule - 更新告警模板规则 + """UpdateAlarmTemplateRule - 更新告警模板规则 **Request** @@ -2479,11 +2694,11 @@ def update_alarm_template_rule(self, req=None, **kwargs): - **Threshold** (str) - (Required) 告警阈值 - **TriggerCount** (str) - (Required) 连续触发次数 - **Zone** (str) - (Required) 可用区 - + **Response** - **Message** (str) - 返回描述信息 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2492,7 +2707,7 @@ def update_alarm_template_rule(self, req=None, **kwargs): return apis.UpdateAlarmTemplateRuleResponseSchema().loads(resp) def update_rs(self, req=None, **kwargs): - """ UpdateRS - 修改负载均衡的服务节点 + """UpdateRS - 修改负载均衡的服务节点 **Request** @@ -2503,11 +2718,11 @@ def update_rs(self, req=None, **kwargs): - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - **Port** (int) - 端口号 - **Weight** (int) - 权重 - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2516,19 +2731,19 @@ def update_rs(self, req=None, **kwargs): return apis.UpdateRSResponseSchema().loads(resp) def update_security_group_rule(self, req=None, **kwargs): - """ UpdateSecurityGroupRule - 修改安全组规则 + """UpdateSecurityGroupRule - 修改安全组规则 **Request** - **Region** (str) - (Config) 地域。枚举值： cn，表示中国； - - **Rules** (list) - (Required) 【数组】规则。输入有效的 规则。调用方式举例：Rules.0=“TCP|23|0.0.0.0/0|ACCEPT|HIGH|1”、Rules.1=“TCP|55|0.0.0.0/0|ACCEPT|HIGH|1” + - **Rules** (list) - (Required) 【数组】规则。输入有效的 规则。调用方式举例：Rules.0=“TCP|23|0.0.0.0/0|ACCEPT|HIGH|1|sg_rule-wefvg34f”、Rules.1=“TCP|55|0.0.0.0/0|ACCEPT|HIGH|1|sg_rule-wefvggf” - **SGID** (str) - (Required) 安全组ID - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** - **Message** (str) - 返回信息描述； - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2537,7 +2752,7 @@ def update_security_group_rule(self, req=None, **kwargs): return apis.UpdateSecurityGroupRuleResponseSchema().loads(resp) def update_vs(self, req=None, **kwargs): - """ UpdateVS - 修改负载均衡VServer + """UpdateVS - 修改负载均衡VServer **Request** @@ -2556,11 +2771,11 @@ def update_vs(self, req=None, **kwargs): - **SSLMode** (str) - SSL认证模式,HTTPS协议下必传,取值范围["simplex","duplex"]分别表示单向认证和双向认证。 - **Scheduler** (str) - 负载均衡的调度算法。枚举值：wrr:加权轮训；least_conn:最小连接数；hash:原地址,四层lb使用。ip_hash:七层lb使用 - **ServerCertificateID** (str) - 服务器证书ID，用于证明服务器的身份，仅当 VServer监听协议为 HTTPS 时有效。 - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2569,7 +2784,7 @@ def update_vs(self, req=None, **kwargs): return apis.UpdateVSResponseSchema().loads(resp) def update_vs_policy(self, req=None, **kwargs): - """ UpdateVSPolicy - 更新七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 + """UpdateVSPolicy - 更新七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 **Request** @@ -2581,11 +2796,11 @@ def update_vs_policy(self, req=None, **kwargs): - **Domain** (str) - 内容转发规则关联的请求域名，值可为空，即代表仅匹配路径。 - **Path** (str) - 内容转发规则关联的请求访问路径，如 "/" 。 - **RSIDs** (list) - 【数组】RServer的 ID。调用方式举例：RSIDs.0=“one-id”、RSIDs.1=“two-id”。 - + **Response** - **Message** (str) - 返回信息描述。 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -2594,7 +2809,7 @@ def update_vs_policy(self, req=None, **kwargs): return apis.UpdateVSPolicyResponseSchema().loads(resp) def upgrade_disk(self, req=None, **kwargs): - """ UpgradeDisk - 升级硬盘 + """UpgradeDisk - 扩容硬盘，为保证数据完整性，容量扩容前建议暂停对当前硬盘的所有文件系统读写操作，并进入操作系统进行 `umount ` 或`脱机` 操作。 **Request** @@ -2602,11 +2817,13 @@ def upgrade_disk(self, req=None, **kwargs): - **DiskID** (str) - (Required) 硬盘ID - **DiskSpace** (int) - (Required) 硬盘升级后的容量， 不能小于原硬盘容量，单位为 GB 。 - **Zone** (str) - (Required) 可用区。枚举值：zone-01，表示中国； - + **Response** + - **Action** (str) - 操作名称 - **Message** (str) - 返回信息描述。 - + - **RetCode** (int) - 返回码 + """ d = {"Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/ucloudstack/schemas/apis.py b/ucloud/services/ucloudstack/schemas/apis.py index 1453d8c..d06c383 100644 --- a/ucloud/services/ucloudstack/schemas/apis.py +++ b/ucloud/services/ucloudstack/schemas/apis.py @@ -14,12 +14,13 @@ class AllocateEIPRequestSchema(schema.RequestSchema): - """ AllocateEIP - 申请外网IP - """ + """AllocateEIP - 申请外网IP""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), "ChargeType": fields.Str(required=True, dump_to="ChargeType"), + "IP": fields.Str(required=False, dump_to="IP"), + "IPVersion": fields.Str(required=False, dump_to="IPVersion"), "Name": fields.Str(required=True, dump_to="Name"), "OperatorName": fields.Str(required=True, dump_to="OperatorName"), "Quantity": fields.Int(required=False, dump_to="Quantity"), @@ -29,8 +30,7 @@ class AllocateEIPRequestSchema(schema.RequestSchema): class AllocateEIPResponseSchema(schema.ResponseSchema): - """ AllocateEIP - 申请外网IP - """ + """AllocateEIP - 申请外网IP""" fields = { "EIPID": fields.Str(required=True, load_from="EIPID"), @@ -46,8 +46,7 @@ class AllocateEIPResponseSchema(schema.ResponseSchema): class AttachDiskRequestSchema(schema.RequestSchema): - """ AttachDisk - 绑定硬盘 - """ + """AttachDisk - 绑定硬盘""" fields = { "DiskID": fields.Str(required=True, dump_to="DiskID"), @@ -59,8 +58,31 @@ class AttachDiskRequestSchema(schema.RequestSchema): class AttachDiskResponseSchema(schema.ResponseSchema): - """ AttachDisk - 绑定硬盘 - """ + """AttachDisk - 绑定硬盘""" + + fields = {"Message": fields.Str(required=True, load_from="Message")} + + +""" +API: AttachNIC + +绑定UCloudStack网卡 +""" + + +class AttachNICRequestSchema(schema.RequestSchema): + """AttachNIC - 绑定UCloudStack网卡""" + + fields = { + "NICID": fields.Str(required=True, dump_to="NICID"), + "Region": fields.Str(required=True, dump_to="Region"), + "ResourceID": fields.Str(required=True, dump_to="ResourceID"), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class AttachNICResponseSchema(schema.ResponseSchema): + """AttachNIC - 绑定UCloudStack网卡""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -73,8 +95,7 @@ class AttachDiskResponseSchema(schema.ResponseSchema): class BindAlarmTemplateRequestSchema(schema.RequestSchema): - """ BindAlarmTemplate - 绑定告警模板 - """ + """BindAlarmTemplate - 绑定告警模板""" fields = { "AlarmTemplateID": fields.Str(required=True, dump_to="AlarmTemplateID"), @@ -86,8 +107,7 @@ class BindAlarmTemplateRequestSchema(schema.RequestSchema): class BindAlarmTemplateResponseSchema(schema.ResponseSchema): - """ BindAlarmTemplate - 绑定告警模板 - """ + """BindAlarmTemplate - 绑定告警模板""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -95,13 +115,12 @@ class BindAlarmTemplateResponseSchema(schema.ResponseSchema): """ API: BindEIP -绑定UCoudStack外网IP +绑定外网 IP """ class BindEIPRequestSchema(schema.RequestSchema): - """ BindEIP - 绑定UCoudStack外网IP - """ + """BindEIP - 绑定外网 IP""" fields = { "EIPID": fields.Str(required=True, dump_to="EIPID"), @@ -113,8 +132,7 @@ class BindEIPRequestSchema(schema.RequestSchema): class BindEIPResponseSchema(schema.ResponseSchema): - """ BindEIP - 绑定UCoudStack外网IP - """ + """BindEIP - 绑定外网 IP""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -127,8 +145,7 @@ class BindEIPResponseSchema(schema.ResponseSchema): class BindPhysicalIPRequestSchema(schema.RequestSchema): - """ BindPhysicalIP - 绑定物理 IP ，被绑定的资源必须处于运行中或有效状态。 - """ + """BindPhysicalIP - 绑定物理 IP ，被绑定的资源必须处于运行中或有效状态。""" fields = { "PhysicalIPID": fields.Str(required=True, dump_to="PhysicalIPID"), @@ -140,8 +157,7 @@ class BindPhysicalIPRequestSchema(schema.RequestSchema): class BindPhysicalIPResponseSchema(schema.ResponseSchema): - """ BindPhysicalIP - 绑定物理 IP ，被绑定的资源必须处于运行中或有效状态。 - """ + """BindPhysicalIP - 绑定物理 IP ，被绑定的资源必须处于运行中或有效状态。""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -154,11 +170,10 @@ class BindPhysicalIPResponseSchema(schema.ResponseSchema): class BindSecurityGroupRequestSchema(schema.RequestSchema): - """ BindSecurityGroup - 绑定安全组 - """ + """BindSecurityGroup - 绑定安全组""" fields = { - "NICID": fields.Str(required=False, dump_to="NICID"), + "NICType": fields.Str(required=False, dump_to="NICType"), "Region": fields.Str(required=True, dump_to="Region"), "ResourceID": fields.Str(required=True, dump_to="ResourceID"), "SGID": fields.Str(required=True, dump_to="SGID"), @@ -167,8 +182,7 @@ class BindSecurityGroupRequestSchema(schema.RequestSchema): class BindSecurityGroupResponseSchema(schema.ResponseSchema): - """ BindSecurityGroup - 绑定安全组 - """ + """BindSecurityGroup - 绑定安全组""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -181,8 +195,7 @@ class BindSecurityGroupResponseSchema(schema.ResponseSchema): class CloneDiskRequestSchema(schema.RequestSchema): - """ CloneDisk - 克隆硬盘 - """ + """CloneDisk - 克隆硬盘""" fields = { "ChargeType": fields.Str(required=True, dump_to="ChargeType"), @@ -195,8 +208,7 @@ class CloneDiskRequestSchema(schema.RequestSchema): class CloneDiskResponseSchema(schema.ResponseSchema): - """ CloneDisk - 克隆硬盘 - """ + """CloneDisk - 克隆硬盘""" fields = { "DiskID": fields.Str(required=True, load_from="DiskID"), @@ -212,8 +224,7 @@ class CloneDiskResponseSchema(schema.ResponseSchema): class CreateCertificateRequestSchema(schema.RequestSchema): - """ CreateCertificate - 创建证书 - """ + """CreateCertificate - 创建证书""" fields = { "Certificate": fields.Str(required=True, dump_to="Certificate"), @@ -227,8 +238,7 @@ class CreateCertificateRequestSchema(schema.RequestSchema): class CreateCertificateResponseSchema(schema.ResponseSchema): - """ CreateCertificate - 创建证书 - """ + """CreateCertificate - 创建证书""" fields = { "CertificateID": fields.Str(required=True, load_from="CertificateID"), @@ -244,8 +254,7 @@ class CreateCertificateResponseSchema(schema.ResponseSchema): class CreateCustomImageRequestSchema(schema.RequestSchema): - """ CreateCustomImage - 创建自制镜像 - """ + """CreateCustomImage - 创建自制镜像""" fields = { "ImageDescription": fields.Str( @@ -259,8 +268,7 @@ class CreateCustomImageRequestSchema(schema.RequestSchema): class CreateCustomImageResponseSchema(schema.ResponseSchema): - """ CreateCustomImage - 创建自制镜像 - """ + """CreateCustomImage - 创建自制镜像""" fields = { "ImageID": fields.Str(required=True, load_from="ImageID"), @@ -276,8 +284,7 @@ class CreateCustomImageResponseSchema(schema.ResponseSchema): class CreateDiskRequestSchema(schema.RequestSchema): - """ CreateDisk - 创建硬盘 - """ + """CreateDisk - 创建硬盘""" fields = { "ChargeType": fields.Str(required=True, dump_to="ChargeType"), @@ -291,8 +298,7 @@ class CreateDiskRequestSchema(schema.RequestSchema): class CreateDiskResponseSchema(schema.ResponseSchema): - """ CreateDisk - 创建硬盘 - """ + """CreateDisk - 创建硬盘""" fields = { "DiskID": fields.Str(required=True, load_from="DiskID"), @@ -308,8 +314,7 @@ class CreateDiskResponseSchema(schema.ResponseSchema): class CreateLBRequestSchema(schema.RequestSchema): - """ CreateLB - 创建负载均衡 - """ + """CreateLB - 创建负载均衡""" fields = { "ChargeType": fields.Str(required=True, dump_to="ChargeType"), @@ -328,8 +333,7 @@ class CreateLBRequestSchema(schema.RequestSchema): class CreateLBResponseSchema(schema.ResponseSchema): - """ CreateLB - 创建负载均衡 - """ + """CreateLB - 创建负载均衡""" fields = { "LBID": fields.Str(required=False, load_from="LBID"), @@ -345,8 +349,7 @@ class CreateLBResponseSchema(schema.ResponseSchema): class CreateNATGWRequestSchema(schema.RequestSchema): - """ CreateNATGW - 创建NAT网关 - """ + """CreateNATGW - 创建NAT网关""" fields = { "ChargeType": fields.Str(required=True, dump_to="ChargeType"), @@ -364,8 +367,7 @@ class CreateNATGWRequestSchema(schema.RequestSchema): class CreateNATGWResponseSchema(schema.ResponseSchema): - """ CreateNATGW - 创建NAT网关 - """ + """CreateNATGW - 创建NAT网关""" fields = { "Message": fields.Str(required=False, load_from="Message"), @@ -381,8 +383,7 @@ class CreateNATGWResponseSchema(schema.ResponseSchema): class CreateNATGWRuleRequestSchema(schema.RequestSchema): - """ CreateNATGWRule - 添加NAT网关白名单 - """ + """CreateNATGWRule - 添加NAT网关白名单""" fields = { "BindResourceID": fields.Str(required=True, dump_to="BindResourceID"), @@ -394,8 +395,7 @@ class CreateNATGWRuleRequestSchema(schema.RequestSchema): class CreateNATGWRuleResponseSchema(schema.ResponseSchema): - """ CreateNATGWRule - 添加NAT网关白名单 - """ + """CreateNATGWRule - 添加NAT网关白名单""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -403,6 +403,36 @@ class CreateNATGWRuleResponseSchema(schema.ResponseSchema): } +""" +API: CreateNIC + +创建网卡 +""" + + +class CreateNICRequestSchema(schema.RequestSchema): + """CreateNIC - 创建网卡""" + + fields = { + "IP": fields.Str(required=False, dump_to="IP"), + "Name": fields.Str(required=True, dump_to="Name"), + "Region": fields.Str(required=True, dump_to="Region"), + "SGID": fields.Str(required=False, dump_to="SGID"), + "SubnetID": fields.Str(required=True, dump_to="SubnetID"), + "VPCID": fields.Str(required=True, dump_to="VPCID"), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class CreateNICResponseSchema(schema.ResponseSchema): + """CreateNIC - 创建网卡""" + + fields = { + "Message": fields.Str(required=True, load_from="Message"), + "NICID": fields.Str(required=True, load_from="NICID"), + } + + """ API: CreatePhysicalIP @@ -411,8 +441,7 @@ class CreateNATGWRuleResponseSchema(schema.ResponseSchema): class CreatePhysicalIPRequestSchema(schema.RequestSchema): - """ CreatePhysicalIP - 创建物理 IP ，需确保平台已配置物理 IP 线路相关信息及物理网络联通性。 - """ + """CreatePhysicalIP - 创建物理 IP ，需确保平台已配置物理 IP 线路相关信息及物理网络联通性。""" fields = { "Name": fields.Str(required=True, dump_to="Name"), @@ -424,8 +453,7 @@ class CreatePhysicalIPRequestSchema(schema.RequestSchema): class CreatePhysicalIPResponseSchema(schema.ResponseSchema): - """ CreatePhysicalIP - 创建物理 IP ，需确保平台已配置物理 IP 线路相关信息及物理网络联通性。 - """ + """CreatePhysicalIP - 创建物理 IP ，需确保平台已配置物理 IP 线路相关信息及物理网络联通性。""" fields = { "Message": fields.Str(required=False, load_from="Message"), @@ -441,8 +469,7 @@ class CreatePhysicalIPResponseSchema(schema.ResponseSchema): class CreateRSRequestSchema(schema.RequestSchema): - """ CreateRS - 为负载均衡的 VServer 添加后端服务节点。 - """ + """CreateRS - 为负载均衡的 VServer 添加后端服务节点。""" fields = { "BindResourceID": fields.Str(required=True, dump_to="BindResourceID"), @@ -456,8 +483,7 @@ class CreateRSRequestSchema(schema.RequestSchema): class CreateRSResponseSchema(schema.ResponseSchema): - """ CreateRS - 为负载均衡的 VServer 添加后端服务节点。 - """ + """CreateRS - 为负载均衡的 VServer 添加后端服务节点。""" fields = { "Message": fields.Str(required=False, load_from="Message"), @@ -473,8 +499,7 @@ class CreateRSResponseSchema(schema.ResponseSchema): class CreateSecurityGroupRequestSchema(schema.RequestSchema): - """ CreateSecurityGroup - 创建安全组 - """ + """CreateSecurityGroup - 创建安全组""" fields = { "Name": fields.Str(required=True, dump_to="Name"), @@ -486,8 +511,7 @@ class CreateSecurityGroupRequestSchema(schema.RequestSchema): class CreateSecurityGroupResponseSchema(schema.ResponseSchema): - """ CreateSecurityGroup - 创建安全组 - """ + """CreateSecurityGroup - 创建安全组""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -503,8 +527,7 @@ class CreateSecurityGroupResponseSchema(schema.ResponseSchema): class CreateSecurityGroupRuleRequestSchema(schema.RequestSchema): - """ CreateSecurityGroupRule - 创建安全组规则 - """ + """CreateSecurityGroupRule - 创建安全组规则""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -515,8 +538,7 @@ class CreateSecurityGroupRuleRequestSchema(schema.RequestSchema): class CreateSecurityGroupRuleResponseSchema(schema.ResponseSchema): - """ CreateSecurityGroupRule - 创建安全组规则 - """ + """CreateSecurityGroupRule - 创建安全组规则""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -532,8 +554,7 @@ class CreateSecurityGroupRuleResponseSchema(schema.ResponseSchema): class CreateSnapshotRequestSchema(schema.RequestSchema): - """ CreateSnapshot - 创建硬盘快照 - """ + """CreateSnapshot - 创建硬盘快照""" fields = { "DiskID": fields.Str(required=True, dump_to="DiskID"), @@ -545,8 +566,7 @@ class CreateSnapshotRequestSchema(schema.RequestSchema): class CreateSnapshotResponseSchema(schema.ResponseSchema): - """ CreateSnapshot - 创建硬盘快照 - """ + """CreateSnapshot - 创建硬盘快照""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -562,8 +582,7 @@ class CreateSnapshotResponseSchema(schema.ResponseSchema): class CreateSubnetRequestSchema(schema.RequestSchema): - """ CreateSubnet - 创建子网 - """ + """CreateSubnet - 创建子网""" fields = { "Name": fields.Str(required=True, dump_to="Name"), @@ -576,8 +595,7 @@ class CreateSubnetRequestSchema(schema.RequestSchema): class CreateSubnetResponseSchema(schema.ResponseSchema): - """ CreateSubnet - 创建子网 - """ + """CreateSubnet - 创建子网""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -593,8 +611,7 @@ class CreateSubnetResponseSchema(schema.ResponseSchema): class CreateUserRequestSchema(schema.RequestSchema): - """ CreateUser - 管理员添加账号 - """ + """CreateUser - 管理员添加账号""" fields = { "PassWord": fields.Str(required=True, dump_to="PassWord"), @@ -603,8 +620,7 @@ class CreateUserRequestSchema(schema.RequestSchema): class CreateUserResponseSchema(schema.ResponseSchema): - """ CreateUser - 管理员添加账号 - """ + """CreateUser - 管理员添加账号""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -620,8 +636,7 @@ class CreateUserResponseSchema(schema.ResponseSchema): class CreateVMInstanceRequestSchema(schema.RequestSchema): - """ CreateVMInstance - 创建虚拟机 - """ + """CreateVMInstance - 创建虚拟机""" fields = { "Bandwidth": fields.Str(required=False, dump_to="Bandwidth"), @@ -651,8 +666,7 @@ class CreateVMInstanceRequestSchema(schema.RequestSchema): class CreateVMInstanceResponseSchema(schema.ResponseSchema): - """ CreateVMInstance - 创建虚拟机 - """ + """CreateVMInstance - 创建虚拟机""" fields = { "DiskID": fields.Str(required=False, load_from="DiskID"), @@ -670,8 +684,7 @@ class CreateVMInstanceResponseSchema(schema.ResponseSchema): class CreateVPCRequestSchema(schema.RequestSchema): - """ CreateVPC - 创建VPC - """ + """CreateVPC - 创建VPC""" fields = { "Name": fields.Str(required=True, dump_to="Name"), @@ -683,8 +696,7 @@ class CreateVPCRequestSchema(schema.RequestSchema): class CreateVPCResponseSchema(schema.ResponseSchema): - """ CreateVPC - 创建VPC - """ + """CreateVPC - 创建VPC""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -700,8 +712,7 @@ class CreateVPCResponseSchema(schema.ResponseSchema): class CreateVSRequestSchema(schema.RequestSchema): - """ CreateVS - 创建负载均衡VServer - """ + """CreateVS - 创建负载均衡VServer""" fields = { "CACertificateID": fields.Str( @@ -731,11 +742,12 @@ class CreateVSRequestSchema(schema.RequestSchema): class CreateVSResponseSchema(schema.ResponseSchema): - """ CreateVS - 创建负载均衡VServer - """ + """CreateVS - 创建负载均衡VServer""" fields = { + "Action": fields.Str(required=True, load_from="Action"), "Message": fields.Str(required=False, load_from="Message"), + "RetCode": fields.Int(required=True, load_from="RetCode"), "VSID": fields.Str(required=False, load_from="VSID"), } @@ -748,8 +760,7 @@ class CreateVSResponseSchema(schema.ResponseSchema): class CreateVSPolicyRequestSchema(schema.RequestSchema): - """ CreateVSPolicy - 创建七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 - """ + """CreateVSPolicy - 创建七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。""" fields = { "Domain": fields.Str(required=False, dump_to="Domain"), @@ -763,8 +774,7 @@ class CreateVSPolicyRequestSchema(schema.RequestSchema): class CreateVSPolicyResponseSchema(schema.ResponseSchema): - """ CreateVSPolicy - 创建七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 - """ + """CreateVSPolicy - 创建七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。""" fields = { "Message": fields.Str(required=False, load_from="Message"), @@ -780,8 +790,7 @@ class CreateVSPolicyResponseSchema(schema.ResponseSchema): class DeleteCertificateRequestSchema(schema.RequestSchema): - """ DeleteCertificate - 删除证书 - """ + """DeleteCertificate - 删除证书""" fields = { "CertificateID": fields.Str(required=True, dump_to="CertificateID"), @@ -791,8 +800,7 @@ class DeleteCertificateRequestSchema(schema.RequestSchema): class DeleteCertificateResponseSchema(schema.ResponseSchema): - """ DeleteCertificate - 删除证书 - """ + """DeleteCertificate - 删除证书""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -805,8 +813,7 @@ class DeleteCertificateResponseSchema(schema.ResponseSchema): class DeleteCustomImageRequestSchema(schema.RequestSchema): - """ DeleteCustomImage - 删除自制镜像 - """ + """DeleteCustomImage - 删除自制镜像""" fields = { "ImageID": fields.Str(required=True, dump_to="ImageID"), @@ -816,8 +823,7 @@ class DeleteCustomImageRequestSchema(schema.RequestSchema): class DeleteCustomImageResponseSchema(schema.ResponseSchema): - """ DeleteCustomImage - 删除自制镜像 - """ + """DeleteCustomImage - 删除自制镜像""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -830,8 +836,7 @@ class DeleteCustomImageResponseSchema(schema.ResponseSchema): class DeleteDiskRequestSchema(schema.RequestSchema): - """ DeleteDisk - 删除硬盘 - """ + """DeleteDisk - 删除硬盘""" fields = { "DiskID": fields.Str(required=True, dump_to="DiskID"), @@ -841,8 +846,7 @@ class DeleteDiskRequestSchema(schema.RequestSchema): class DeleteDiskResponseSchema(schema.ResponseSchema): - """ DeleteDisk - 删除硬盘 - """ + """DeleteDisk - 删除硬盘""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -855,8 +859,7 @@ class DeleteDiskResponseSchema(schema.ResponseSchema): class DeleteLBRequestSchema(schema.RequestSchema): - """ DeleteLB - 删除负载均衡 - """ + """DeleteLB - 删除负载均衡""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -866,8 +869,7 @@ class DeleteLBRequestSchema(schema.RequestSchema): class DeleteLBResponseSchema(schema.ResponseSchema): - """ DeleteLB - 删除负载均衡 - """ + """DeleteLB - 删除负载均衡""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -880,8 +882,7 @@ class DeleteLBResponseSchema(schema.ResponseSchema): class DeleteNATGWRequestSchema(schema.RequestSchema): - """ DeleteNATGW - 删除NAT网关 - """ + """DeleteNATGW - 删除NAT网关""" fields = { "NATGWID": fields.Str(required=True, dump_to="NATGWID"), @@ -891,8 +892,7 @@ class DeleteNATGWRequestSchema(schema.RequestSchema): class DeleteNATGWResponseSchema(schema.ResponseSchema): - """ DeleteNATGW - 删除NAT网关 - """ + """DeleteNATGW - 删除NAT网关""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -905,8 +905,7 @@ class DeleteNATGWResponseSchema(schema.ResponseSchema): class DeleteNATGWRuleRequestSchema(schema.RequestSchema): - """ DeleteNATGWRule - 删除NAT网关白名单 - """ + """DeleteNATGWRule - 删除NAT网关白名单""" fields = { "NATGWID": fields.Str(required=True, dump_to="NATGWID"), @@ -917,8 +916,30 @@ class DeleteNATGWRuleRequestSchema(schema.RequestSchema): class DeleteNATGWRuleResponseSchema(schema.ResponseSchema): - """ DeleteNATGWRule - 删除NAT网关白名单 - """ + """DeleteNATGWRule - 删除NAT网关白名单""" + + fields = {"Message": fields.Str(required=True, load_from="Message")} + + +""" +API: DeleteNIC + +删除网卡 +""" + + +class DeleteNICRequestSchema(schema.RequestSchema): + """DeleteNIC - 删除网卡""" + + fields = { + "NICID": fields.Str(required=True, dump_to="NICID"), + "Region": fields.Str(required=True, dump_to="Region"), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class DeleteNICResponseSchema(schema.ResponseSchema): + """DeleteNIC - 删除网卡""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -931,8 +952,7 @@ class DeleteNATGWRuleResponseSchema(schema.ResponseSchema): class DeletePhysicalIPRequestSchema(schema.RequestSchema): - """ DeletePhysicalIP - 删除物理IP - """ + """DeletePhysicalIP - 删除物理IP""" fields = { "PhysicalIPID": fields.Str(required=True, dump_to="PhysicalIPID"), @@ -942,8 +962,7 @@ class DeletePhysicalIPRequestSchema(schema.RequestSchema): class DeletePhysicalIPResponseSchema(schema.ResponseSchema): - """ DeletePhysicalIP - 删除物理IP - """ + """DeletePhysicalIP - 删除物理IP""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -956,8 +975,7 @@ class DeletePhysicalIPResponseSchema(schema.ResponseSchema): class DeleteRSRequestSchema(schema.RequestSchema): - """ DeleteRS - 移除负载均衡的单个服务节点 - """ + """DeleteRS - 移除负载均衡的单个服务节点""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -969,8 +987,7 @@ class DeleteRSRequestSchema(schema.RequestSchema): class DeleteRSResponseSchema(schema.ResponseSchema): - """ DeleteRS - 移除负载均衡的单个服务节点 - """ + """DeleteRS - 移除负载均衡的单个服务节点""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -983,8 +1000,7 @@ class DeleteRSResponseSchema(schema.ResponseSchema): class DeleteSecurityGroupRequestSchema(schema.RequestSchema): - """ DeleteSecurityGroup - 删除安全组 - """ + """DeleteSecurityGroup - 删除安全组""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -994,8 +1010,7 @@ class DeleteSecurityGroupRequestSchema(schema.RequestSchema): class DeleteSecurityGroupResponseSchema(schema.ResponseSchema): - """ DeleteSecurityGroup - 删除安全组 - """ + """DeleteSecurityGroup - 删除安全组""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -1008,8 +1023,7 @@ class DeleteSecurityGroupResponseSchema(schema.ResponseSchema): class DeleteSecurityGroupRuleRequestSchema(schema.RequestSchema): - """ DeleteSecurityGroupRule - 删除安全组规则 - """ + """DeleteSecurityGroupRule - 删除安全组规则""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -1020,8 +1034,7 @@ class DeleteSecurityGroupRuleRequestSchema(schema.RequestSchema): class DeleteSecurityGroupRuleResponseSchema(schema.ResponseSchema): - """ DeleteSecurityGroupRule - 删除安全组规则 - """ + """DeleteSecurityGroupRule - 删除安全组规则""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -1034,8 +1047,7 @@ class DeleteSecurityGroupRuleResponseSchema(schema.ResponseSchema): class DeleteSnapshotRequestSchema(schema.RequestSchema): - """ DeleteSnapshot - 删除快照，仅支持状态为正常的快照进行删除操作。 - """ + """DeleteSnapshot - 删除快照，仅支持状态为正常的快照进行删除操作。""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -1045,8 +1057,7 @@ class DeleteSnapshotRequestSchema(schema.RequestSchema): class DeleteSnapshotResponseSchema(schema.ResponseSchema): - """ DeleteSnapshot - 删除快照，仅支持状态为正常的快照进行删除操作。 - """ + """DeleteSnapshot - 删除快照，仅支持状态为正常的快照进行删除操作。""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -1059,8 +1070,7 @@ class DeleteSnapshotResponseSchema(schema.ResponseSchema): class DeleteSubnetRequestSchema(schema.RequestSchema): - """ DeleteSubnet - 删除子网 - """ + """DeleteSubnet - 删除子网""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -1070,8 +1080,7 @@ class DeleteSubnetRequestSchema(schema.RequestSchema): class DeleteSubnetResponseSchema(schema.ResponseSchema): - """ DeleteSubnet - 删除子网 - """ + """DeleteSubnet - 删除子网""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -1084,8 +1093,7 @@ class DeleteSubnetResponseSchema(schema.ResponseSchema): class DeleteVMInstanceRequestSchema(schema.RequestSchema): - """ DeleteVMInstance - 删除虚拟机 - """ + """DeleteVMInstance - 删除虚拟机""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -1095,8 +1103,7 @@ class DeleteVMInstanceRequestSchema(schema.RequestSchema): class DeleteVMInstanceResponseSchema(schema.ResponseSchema): - """ DeleteVMInstance - 删除虚拟机 - """ + """DeleteVMInstance - 删除虚拟机""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -1109,8 +1116,7 @@ class DeleteVMInstanceResponseSchema(schema.ResponseSchema): class DeleteVPCRequestSchema(schema.RequestSchema): - """ DeleteVPC - 删除VPC - """ + """DeleteVPC - 删除VPC""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -1120,8 +1126,7 @@ class DeleteVPCRequestSchema(schema.RequestSchema): class DeleteVPCResponseSchema(schema.ResponseSchema): - """ DeleteVPC - 删除VPC - """ + """DeleteVPC - 删除VPC""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -1134,8 +1139,7 @@ class DeleteVPCResponseSchema(schema.ResponseSchema): class DeleteVSRequestSchema(schema.RequestSchema): - """ DeleteVS - 删除VServer - """ + """DeleteVS - 删除VServer""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -1146,8 +1150,7 @@ class DeleteVSRequestSchema(schema.RequestSchema): class DeleteVSResponseSchema(schema.ResponseSchema): - """ DeleteVS - 删除VServer - """ + """DeleteVS - 删除VServer""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -1160,8 +1163,7 @@ class DeleteVSResponseSchema(schema.ResponseSchema): class DeleteVSPolicyRequestSchema(schema.RequestSchema): - """ DeleteVSPolicy - 删除七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 - """ + """DeleteVSPolicy - 删除七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -1173,8 +1175,7 @@ class DeleteVSPolicyRequestSchema(schema.RequestSchema): class DeleteVSPolicyResponseSchema(schema.ResponseSchema): - """ DeleteVSPolicy - 删除七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 - """ + """DeleteVSPolicy - 删除七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -1187,8 +1188,7 @@ class DeleteVSPolicyResponseSchema(schema.ResponseSchema): class DescribeCertificateRequestSchema(schema.RequestSchema): - """ DescribeCertificate - 查询证书 - """ + """DescribeCertificate - 查询证书""" fields = { "CertificateIDs": fields.List(fields.Str()), @@ -1203,8 +1203,7 @@ class DescribeCertificateRequestSchema(schema.RequestSchema): class DescribeCertificateResponseSchema(schema.ResponseSchema): - """ DescribeCertificate - 查询证书 - """ + """DescribeCertificate - 查询证书""" fields = { "Infos": fields.List( @@ -1223,11 +1222,11 @@ class DescribeCertificateResponseSchema(schema.ResponseSchema): class DescribeDiskRequestSchema(schema.RequestSchema): - """ DescribeDisk - 获取硬盘信息 - """ + """DescribeDisk - 获取硬盘信息""" fields = { "DiskIDs": fields.List(fields.Str()), + "DiskType": fields.Str(required=False, dump_to="DiskType"), "Limit": fields.Int(required=False, dump_to="Limit"), "Offset": fields.Int(required=False, dump_to="Offset"), "Region": fields.Str(required=True, dump_to="Region"), @@ -1236,8 +1235,7 @@ class DescribeDiskRequestSchema(schema.RequestSchema): class DescribeDiskResponseSchema(schema.ResponseSchema): - """ DescribeDisk - 获取硬盘信息 - """ + """DescribeDisk - 获取硬盘信息""" fields = { "Infos": fields.List( @@ -1256,11 +1254,12 @@ class DescribeDiskResponseSchema(schema.ResponseSchema): class DescribeEIPRequestSchema(schema.RequestSchema): - """ DescribeEIP - 获取外网IP的信息 - """ + """DescribeEIP - 获取外网IP的信息""" fields = { + "BindResourceID": fields.Str(required=False, dump_to="BindResourceID"), "EIPIDs": fields.List(fields.Str()), + "IPVersion": fields.Str(required=False, dump_to="IPVersion"), "Limit": fields.Str(required=False, dump_to="Limit"), "Offset": fields.Str(required=False, dump_to="Offset"), "Region": fields.Str(required=True, dump_to="Region"), @@ -1269,8 +1268,7 @@ class DescribeEIPRequestSchema(schema.RequestSchema): class DescribeEIPResponseSchema(schema.ResponseSchema): - """ DescribeEIP - 获取外网IP的信息 - """ + """DescribeEIP - 获取外网IP的信息""" fields = { "Infos": fields.List( @@ -1289,8 +1287,7 @@ class DescribeEIPResponseSchema(schema.ResponseSchema): class DescribeImageRequestSchema(schema.RequestSchema): - """ DescribeImage - 获取镜像信息，包括默认镜像和自制镜像。 - """ + """DescribeImage - 获取镜像信息，包括默认镜像和自制镜像。""" fields = { "ImageIDs": fields.List(fields.Str()), @@ -1303,8 +1300,7 @@ class DescribeImageRequestSchema(schema.RequestSchema): class DescribeImageResponseSchema(schema.ResponseSchema): - """ DescribeImage - 获取镜像信息，包括默认镜像和自制镜像。 - """ + """DescribeImage - 获取镜像信息，包括默认镜像和自制镜像。""" fields = { "Action": fields.Str(required=True, load_from="Action"), @@ -1325,8 +1321,7 @@ class DescribeImageResponseSchema(schema.ResponseSchema): class DescribeLBRequestSchema(schema.RequestSchema): - """ DescribeLB - 获取负载均衡信息 - """ + """DescribeLB - 获取负载均衡信息""" fields = { "LBIDs": fields.List(fields.Str()), @@ -1340,8 +1335,7 @@ class DescribeLBRequestSchema(schema.RequestSchema): class DescribeLBResponseSchema(schema.ResponseSchema): - """ DescribeLB - 获取负载均衡信息 - """ + """DescribeLB - 获取负载均衡信息""" fields = { "Infos": fields.List( @@ -1360,8 +1354,7 @@ class DescribeLBResponseSchema(schema.ResponseSchema): class DescribeMetricRequestSchema(schema.RequestSchema): - """ DescribeMetric - 获取资源监控信息 - """ + """DescribeMetric - 获取资源监控信息""" fields = { "BeginTime": fields.Str(required=True, dump_to="BeginTime"), @@ -1375,8 +1368,7 @@ class DescribeMetricRequestSchema(schema.RequestSchema): class DescribeMetricResponseSchema(schema.ResponseSchema): - """ DescribeMetric - 获取资源监控信息 - """ + """DescribeMetric - 获取资源监控信息""" fields = { "Infos": fields.List( @@ -1395,8 +1387,7 @@ class DescribeMetricResponseSchema(schema.ResponseSchema): class DescribeNATGWRequestSchema(schema.RequestSchema): - """ DescribeNATGW - 获取NAT网关信息 - """ + """DescribeNATGW - 获取NAT网关信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -1408,8 +1399,7 @@ class DescribeNATGWRequestSchema(schema.RequestSchema): class DescribeNATGWResponseSchema(schema.ResponseSchema): - """ DescribeNATGW - 获取NAT网关信息 - """ + """DescribeNATGW - 获取NAT网关信息""" fields = { "Infos": fields.List( @@ -1428,8 +1418,7 @@ class DescribeNATGWResponseSchema(schema.ResponseSchema): class DescribeNATGWRuleRequestSchema(schema.RequestSchema): - """ DescribeNATGWRule - 获取NAT网关白名单信息 - """ + """DescribeNATGWRule - 获取NAT网关白名单信息""" fields = { "BindResourceIDs": fields.List(fields.Str()), @@ -1444,8 +1433,7 @@ class DescribeNATGWRuleRequestSchema(schema.RequestSchema): class DescribeNATGWRuleResponseSchema(schema.ResponseSchema): - """ DescribeNATGWRule - 获取NAT网关白名单信息 - """ + """DescribeNATGWRule - 获取NAT网关白名单信息""" fields = { "Infos": fields.List( @@ -1456,6 +1444,37 @@ class DescribeNATGWRuleResponseSchema(schema.ResponseSchema): } +""" +API: DescribeNIC + +获取网卡信息 +""" + + +class DescribeNICRequestSchema(schema.RequestSchema): + """DescribeNIC - 获取网卡信息""" + + fields = { + "Limit": fields.Int(required=False, dump_to="Limit"), + "NICIDs": fields.List(fields.Str()), + "Offset": fields.Int(required=False, dump_to="Offset"), + "Region": fields.Str(required=True, dump_to="Region"), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class DescribeNICResponseSchema(schema.ResponseSchema): + """DescribeNIC - 获取网卡信息""" + + fields = { + "Infos": fields.List( + models.NICInfoSchema(), required=True, load_from="Infos" + ), + "Message": fields.Str(required=True, load_from="Message"), + "TotalCount": fields.Int(required=True, load_from="TotalCount"), + } + + """ API: DescribeOPLogs @@ -1464,8 +1483,7 @@ class DescribeNATGWRuleResponseSchema(schema.ResponseSchema): class DescribeOPLogsRequestSchema(schema.RequestSchema): - """ DescribeOPLogs - 查询操作日志 - """ + """DescribeOPLogs - 查询操作日志""" fields = { "BeginTime": fields.Int(required=True, dump_to="BeginTime"), @@ -1481,8 +1499,7 @@ class DescribeOPLogsRequestSchema(schema.RequestSchema): class DescribeOPLogsResponseSchema(schema.ResponseSchema): - """ DescribeOPLogs - 查询操作日志 - """ + """DescribeOPLogs - 查询操作日志""" fields = { "Infos": fields.List( @@ -1501,8 +1518,7 @@ class DescribeOPLogsResponseSchema(schema.ResponseSchema): class DescribePhysicalIPRequestSchema(schema.RequestSchema): - """ DescribePhysicalIP - 获取物理IP信息 - """ + """DescribePhysicalIP - 获取物理IP信息""" fields = { "Limit": fields.Str(required=False, dump_to="Limit"), @@ -1514,8 +1530,7 @@ class DescribePhysicalIPRequestSchema(schema.RequestSchema): class DescribePhysicalIPResponseSchema(schema.ResponseSchema): - """ DescribePhysicalIP - 获取物理IP信息 - """ + """DescribePhysicalIP - 获取物理IP信息""" fields = { "Infos": fields.List( @@ -1534,8 +1549,7 @@ class DescribePhysicalIPResponseSchema(schema.ResponseSchema): class DescribeRSRequestSchema(schema.RequestSchema): - """ DescribeRS - 获取负载均衡服务的服务节点信息 - """ + """DescribeRS - 获取负载均衡服务的服务节点信息""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -1549,8 +1563,7 @@ class DescribeRSRequestSchema(schema.RequestSchema): class DescribeRSResponseSchema(schema.ResponseSchema): - """ DescribeRS - 获取负载均衡服务的服务节点信息 - """ + """DescribeRS - 获取负载均衡服务的服务节点信息""" fields = { "Infos": fields.List( @@ -1569,8 +1582,7 @@ class DescribeRSResponseSchema(schema.ResponseSchema): class DescribeRecycledResourceRequestSchema(schema.RequestSchema): - """ DescribeRecycledResource - 查询回收站资源 - """ + """DescribeRecycledResource - 查询回收站资源""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -1582,8 +1594,7 @@ class DescribeRecycledResourceRequestSchema(schema.RequestSchema): class DescribeRecycledResourceResponseSchema(schema.ResponseSchema): - """ DescribeRecycledResource - 查询回收站资源 - """ + """DescribeRecycledResource - 查询回收站资源""" fields = { "Infos": fields.List( @@ -1603,8 +1614,7 @@ class DescribeRecycledResourceResponseSchema(schema.ResponseSchema): class DescribeSecurityGroupRequestSchema(schema.RequestSchema): - """ DescribeSecurityGroup - 查询安全组信息 - """ + """DescribeSecurityGroup - 查询安全组信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -1616,8 +1626,7 @@ class DescribeSecurityGroupRequestSchema(schema.RequestSchema): class DescribeSecurityGroupResponseSchema(schema.ResponseSchema): - """ DescribeSecurityGroup - 查询安全组信息 - """ + """DescribeSecurityGroup - 查询安全组信息""" fields = { "Infos": fields.List( @@ -1628,6 +1637,69 @@ class DescribeSecurityGroupResponseSchema(schema.ResponseSchema): } +""" +API: DescribeSecurityGroupResource + +查询安全组绑定的资源信息 +""" + + +class DescribeSecurityGroupResourceRequestSchema(schema.RequestSchema): + """DescribeSecurityGroupResource - 查询安全组绑定的资源信息""" + + fields = { + "Limit": fields.Int(required=False, dump_to="Limit"), + "Offset": fields.Int(required=False, dump_to="Offset"), + "Region": fields.Str(required=True, dump_to="Region"), + "SGID": fields.Str(required=True, dump_to="SGID"), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class DescribeSecurityGroupResourceResponseSchema(schema.ResponseSchema): + """DescribeSecurityGroupResource - 查询安全组绑定的资源信息""" + + fields = { + "Infos": fields.List( + models.SGResourceInfoSchema(), required=True, load_from="Infos" + ), + "Message": fields.Str(required=True, load_from="Message"), + "TotalCount": fields.Int(required=True, load_from="TotalCount"), + } + + +""" +API: DescribeSnapshot + +查询硬盘快照信息 +""" + + +class DescribeSnapshotRequestSchema(schema.RequestSchema): + """DescribeSnapshot - 查询硬盘快照信息""" + + fields = { + "DiskID": fields.Str(required=False, dump_to="DiskID"), + "Limit": fields.Int(required=False, dump_to="Limit"), + "Offset": fields.Int(required=False, dump_to="Offset"), + "Region": fields.Str(required=True, dump_to="Region"), + "SnapshotIDs": fields.List(fields.Str()), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class DescribeSnapshotResponseSchema(schema.ResponseSchema): + """DescribeSnapshot - 查询硬盘快照信息""" + + fields = { + "Infos": fields.List( + models.SnapshotInfoSchema(), required=True, load_from="Infos" + ), + "Message": fields.Str(required=True, load_from="Message"), + "TotalCount": fields.Int(required=True, load_from="TotalCount"), + } + + """ API: DescribeStorageType @@ -1636,8 +1708,7 @@ class DescribeSecurityGroupResponseSchema(schema.ResponseSchema): class DescribeStorageTypeRequestSchema(schema.RequestSchema): - """ DescribeStorageType - 查询存储类型 - """ + """DescribeStorageType - 查询存储类型""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -1646,8 +1717,7 @@ class DescribeStorageTypeRequestSchema(schema.RequestSchema): class DescribeStorageTypeResponseSchema(schema.ResponseSchema): - """ DescribeStorageType - 查询存储类型 - """ + """DescribeStorageType - 查询存储类型""" fields = { "Infos": fields.List( @@ -1666,8 +1736,7 @@ class DescribeStorageTypeResponseSchema(schema.ResponseSchema): class DescribeSubnetRequestSchema(schema.RequestSchema): - """ DescribeSubnet - 查询子网信息 - """ + """DescribeSubnet - 查询子网信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -1680,8 +1749,7 @@ class DescribeSubnetRequestSchema(schema.RequestSchema): class DescribeSubnetResponseSchema(schema.ResponseSchema): - """ DescribeSubnet - 查询子网信息 - """ + """DescribeSubnet - 查询子网信息""" fields = { "Infos": fields.List( @@ -1700,8 +1768,7 @@ class DescribeSubnetResponseSchema(schema.ResponseSchema): class DescribeUserRequestSchema(schema.RequestSchema): - """ DescribeUser - 查询租户信息 - """ + """DescribeUser - 查询租户信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -1711,8 +1778,7 @@ class DescribeUserRequestSchema(schema.RequestSchema): class DescribeUserResponseSchema(schema.ResponseSchema): - """ DescribeUser - 查询租户信息 - """ + """DescribeUser - 查询租户信息""" fields = { "Infos": fields.List( @@ -1731,12 +1797,11 @@ class DescribeUserResponseSchema(schema.ResponseSchema): class DescribeVMInstanceRequestSchema(schema.RequestSchema): - """ DescribeVMInstance - 查询虚拟机 - """ + """DescribeVMInstance - 查询虚拟机""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), - "Offset": fields.Str(required=False, dump_to="Offset"), + "Offset": fields.Int(required=False, dump_to="Offset"), "Region": fields.Str(required=True, dump_to="Region"), "SubnetID": fields.Str(required=False, dump_to="SubnetID"), "VMIDs": fields.List(fields.Str()), @@ -1746,8 +1811,7 @@ class DescribeVMInstanceRequestSchema(schema.RequestSchema): class DescribeVMInstanceResponseSchema(schema.ResponseSchema): - """ DescribeVMInstance - 查询虚拟机 - """ + """DescribeVMInstance - 查询虚拟机""" fields = { "Infos": fields.List( @@ -1766,8 +1830,7 @@ class DescribeVMInstanceResponseSchema(schema.ResponseSchema): class DescribeVMTypeRequestSchema(schema.RequestSchema): - """ DescribeVMType - 查询主机机型 - """ + """DescribeVMType - 查询主机机型""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -1776,8 +1839,7 @@ class DescribeVMTypeRequestSchema(schema.RequestSchema): class DescribeVMTypeResponseSchema(schema.ResponseSchema): - """ DescribeVMType - 查询主机机型 - """ + """DescribeVMType - 查询主机机型""" fields = { "Infos": fields.List( @@ -1796,8 +1858,7 @@ class DescribeVMTypeResponseSchema(schema.ResponseSchema): class DescribeVPCRequestSchema(schema.RequestSchema): - """ DescribeVPC - 查询VPC信息 - """ + """DescribeVPC - 查询VPC信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -1809,8 +1870,7 @@ class DescribeVPCRequestSchema(schema.RequestSchema): class DescribeVPCResponseSchema(schema.ResponseSchema): - """ DescribeVPC - 查询VPC信息 - """ + """DescribeVPC - 查询VPC信息""" fields = { "Infos": fields.List( @@ -1829,8 +1889,7 @@ class DescribeVPCResponseSchema(schema.ResponseSchema): class DescribeVSRequestSchema(schema.RequestSchema): - """ DescribeVS - 获取负载均衡 VServer 信息 - """ + """DescribeVS - 获取负载均衡 VServer 信息""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -1843,8 +1902,7 @@ class DescribeVSRequestSchema(schema.RequestSchema): class DescribeVSResponseSchema(schema.ResponseSchema): - """ DescribeVS - 获取负载均衡 VServer 信息 - """ + """DescribeVS - 获取负载均衡 VServer 信息""" fields = { "Infos": fields.List( @@ -1863,8 +1921,7 @@ class DescribeVSResponseSchema(schema.ResponseSchema): class DescribeVSPolicyRequestSchema(schema.RequestSchema): - """ DescribeVSPolicy - 获取七层负载均衡内容转发规则信息，仅当 VServer 的监听协议为 HTTP 时有效。 - """ + """DescribeVSPolicy - 获取七层负载均衡内容转发规则信息，仅当 VServer 的监听协议为 HTTP 时有效。""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -1878,8 +1935,7 @@ class DescribeVSPolicyRequestSchema(schema.RequestSchema): class DescribeVSPolicyResponseSchema(schema.ResponseSchema): - """ DescribeVSPolicy - 获取七层负载均衡内容转发规则信息，仅当 VServer 的监听协议为 HTTP 时有效。 - """ + """DescribeVSPolicy - 获取七层负载均衡内容转发规则信息，仅当 VServer 的监听协议为 HTTP 时有效。""" fields = { "Infos": fields.List( @@ -1893,13 +1949,12 @@ class DescribeVSPolicyResponseSchema(schema.ResponseSchema): """ API: DetachDisk -解绑UClouStack硬盘 +解绑硬盘 """ class DetachDiskRequestSchema(schema.RequestSchema): - """ DetachDisk - 解绑UClouStack硬盘 - """ + """DetachDisk - 解绑硬盘""" fields = { "DiskID": fields.Str(required=True, dump_to="DiskID"), @@ -1910,8 +1965,31 @@ class DetachDiskRequestSchema(schema.RequestSchema): class DetachDiskResponseSchema(schema.ResponseSchema): - """ DetachDisk - 解绑UClouStack硬盘 - """ + """DetachDisk - 解绑硬盘""" + + fields = {"Message": fields.Str(required=True, load_from="Message")} + + +""" +API: DetachNIC + +解绑UClouStack网卡 +""" + + +class DetachNICRequestSchema(schema.RequestSchema): + """DetachNIC - 解绑UClouStack网卡""" + + fields = { + "NICID": fields.Str(required=True, dump_to="NICID"), + "Region": fields.Str(required=True, dump_to="Region"), + "ResourceID": fields.Str(required=True, dump_to="ResourceID"), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class DetachNICResponseSchema(schema.ResponseSchema): + """DetachNIC - 解绑UClouStack网卡""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -1924,8 +2002,7 @@ class DetachDiskResponseSchema(schema.ResponseSchema): class DisableRSRequestSchema(schema.RequestSchema): - """ DisableRS - 禁用负载均衡的单个服务节点 - """ + """DisableRS - 禁用负载均衡的单个服务节点""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -1937,8 +2014,7 @@ class DisableRSRequestSchema(schema.RequestSchema): class DisableRSResponseSchema(schema.ResponseSchema): - """ DisableRS - 禁用负载均衡的单个服务节点 - """ + """DisableRS - 禁用负载均衡的单个服务节点""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -1951,8 +2027,7 @@ class DisableRSResponseSchema(schema.ResponseSchema): class EnableRSRequestSchema(schema.RequestSchema): - """ EnableRS - 启用负载均衡的单个服务节点 - """ + """EnableRS - 启用负载均衡的单个服务节点""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -1964,8 +2039,7 @@ class EnableRSRequestSchema(schema.RequestSchema): class EnableRSResponseSchema(schema.ResponseSchema): - """ EnableRS - 启用负载均衡的单个服务节点 - """ + """EnableRS - 启用负载均衡的单个服务节点""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -1978,8 +2052,7 @@ class EnableRSResponseSchema(schema.ResponseSchema): class GetDiskPriceRequestSchema(schema.RequestSchema): - """ GetDiskPrice - 获取硬盘价格 - """ + """GetDiskPrice - 获取硬盘价格""" fields = { "ChargeType": fields.Str(required=True, dump_to="ChargeType"), @@ -1992,8 +2065,7 @@ class GetDiskPriceRequestSchema(schema.RequestSchema): class GetDiskPriceResponseSchema(schema.ResponseSchema): - """ GetDiskPrice - 获取硬盘价格 - """ + """GetDiskPrice - 获取硬盘价格""" fields = { "Infos": fields.List( @@ -2011,8 +2083,7 @@ class GetDiskPriceResponseSchema(schema.ResponseSchema): class GetEIPPriceRequestSchema(schema.RequestSchema): - """ GetEIPPrice - 获取外网IP价格 - """ + """GetEIPPrice - 获取外网IP价格""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -2025,8 +2096,7 @@ class GetEIPPriceRequestSchema(schema.RequestSchema): class GetEIPPriceResponseSchema(schema.ResponseSchema): - """ GetEIPPrice - 获取外网IP价格 - """ + """GetEIPPrice - 获取外网IP价格""" fields = { "Infos": fields.List( @@ -2044,8 +2114,7 @@ class GetEIPPriceResponseSchema(schema.ResponseSchema): class GetVMInstancePriceRequestSchema(schema.RequestSchema): - """ GetVMInstancePrice - 获取虚拟机价格 - """ + """GetVMInstancePrice - 获取虚拟机价格""" fields = { "BootDiskSetType": fields.Str(required=True, dump_to="BootDiskSetType"), @@ -2065,8 +2134,7 @@ class GetVMInstancePriceRequestSchema(schema.RequestSchema): class GetVMInstancePriceResponseSchema(schema.ResponseSchema): - """ GetVMInstancePrice - 获取虚拟机价格 - """ + """GetVMInstancePrice - 获取虚拟机价格""" fields = { "Infos": fields.List( @@ -2084,8 +2152,7 @@ class GetVMInstancePriceResponseSchema(schema.ResponseSchema): class ModifyEIPBandwidthRequestSchema(schema.RequestSchema): - """ ModifyEIPBandwidth - 调整外网IP带宽 - """ + """ModifyEIPBandwidth - 调整外网IP带宽""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -2096,8 +2163,7 @@ class ModifyEIPBandwidthRequestSchema(schema.RequestSchema): class ModifyEIPBandwidthResponseSchema(schema.ResponseSchema): - """ ModifyEIPBandwidth - 调整外网IP带宽 - """ + """ModifyEIPBandwidth - 调整外网IP带宽""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2110,8 +2176,7 @@ class ModifyEIPBandwidthResponseSchema(schema.ResponseSchema): class ModifyNameAndRemarkRequestSchema(schema.RequestSchema): - """ ModifyNameAndRemark - 修改资源名称和备注 - """ + """ModifyNameAndRemark - 修改资源名称和备注""" fields = { "Name": fields.Str(required=True, dump_to="Name"), @@ -2123,8 +2188,7 @@ class ModifyNameAndRemarkRequestSchema(schema.RequestSchema): class ModifyNameAndRemarkResponseSchema(schema.ResponseSchema): - """ ModifyNameAndRemark - 修改资源名称和备注 - """ + """ModifyNameAndRemark - 修改资源名称和备注""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2137,8 +2201,7 @@ class ModifyNameAndRemarkResponseSchema(schema.ResponseSchema): class PoweroffVMInstanceRequestSchema(schema.RequestSchema): - """ PoweroffVMInstance - 断电虚拟机，可能导致丢失数据甚至损坏操作系统，仅适用于虚拟机死机及级端测试场景。 - """ + """PoweroffVMInstance - 断电虚拟机，可能导致丢失数据甚至损坏操作系统，仅适用于虚拟机死机及级端测试场景。""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -2148,8 +2211,7 @@ class PoweroffVMInstanceRequestSchema(schema.RequestSchema): class PoweroffVMInstanceResponseSchema(schema.ResponseSchema): - """ PoweroffVMInstance - 断电虚拟机，可能导致丢失数据甚至损坏操作系统，仅适用于虚拟机死机及级端测试场景。 - """ + """PoweroffVMInstance - 断电虚拟机，可能导致丢失数据甚至损坏操作系统，仅适用于虚拟机死机及级端测试场景。""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2162,8 +2224,7 @@ class PoweroffVMInstanceResponseSchema(schema.ResponseSchema): class RechargeRequestSchema(schema.RequestSchema): - """ Recharge - 管理员给租户充值 - """ + """Recharge - 管理员给租户充值""" fields = { "Amount": fields.Int(required=True, dump_to="Amount"), @@ -2174,8 +2235,7 @@ class RechargeRequestSchema(schema.RequestSchema): class RechargeResponseSchema(schema.ResponseSchema): - """ Recharge - 管理员给租户充值 - """ + """Recharge - 管理员给租户充值""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2188,8 +2248,7 @@ class RechargeResponseSchema(schema.ResponseSchema): class ReinstallVMInstanceRequestSchema(schema.RequestSchema): - """ ReinstallVMInstance - 重装系统，关机的虚拟机才可以重装系统 - """ + """ReinstallVMInstance - 重装系统，关机的虚拟机才可以重装系统""" fields = { "ImageID": fields.Str(required=True, dump_to="ImageID"), @@ -2200,8 +2259,7 @@ class ReinstallVMInstanceRequestSchema(schema.RequestSchema): class ReinstallVMInstanceResponseSchema(schema.ResponseSchema): - """ ReinstallVMInstance - 重装系统，关机的虚拟机才可以重装系统 - """ + """ReinstallVMInstance - 重装系统，关机的虚拟机才可以重装系统""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2214,8 +2272,7 @@ class ReinstallVMInstanceResponseSchema(schema.ResponseSchema): class ReleaseEIPRequestSchema(schema.RequestSchema): - """ ReleaseEIP - 删除外网IP - """ + """ReleaseEIP - 删除外网IP""" fields = { "EIPID": fields.Str(required=True, dump_to="EIPID"), @@ -2225,8 +2282,7 @@ class ReleaseEIPRequestSchema(schema.RequestSchema): class ReleaseEIPResponseSchema(schema.ResponseSchema): - """ ReleaseEIP - 删除外网IP - """ + """ReleaseEIP - 删除外网IP""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2239,8 +2295,7 @@ class ReleaseEIPResponseSchema(schema.ResponseSchema): class RenewResourceRequestSchema(schema.RequestSchema): - """ RenewResource - 续费回收站资源 - """ + """RenewResource - 续费回收站资源""" fields = { "Quantity": fields.Int(required=False, dump_to="Quantity"), @@ -2251,8 +2306,7 @@ class RenewResourceRequestSchema(schema.RequestSchema): class RenewResourceResponseSchema(schema.ResponseSchema): - """ RenewResource - 续费回收站资源 - """ + """RenewResource - 续费回收站资源""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -2265,8 +2319,7 @@ class RenewResourceResponseSchema(schema.ResponseSchema): class ResetVMInstancePasswordRequestSchema(schema.RequestSchema): - """ ResetVMInstancePassword - 重置虚拟机密码，主机必须开机才可以重置密码 - """ + """ResetVMInstancePassword - 重置虚拟机密码，主机必须开机才可以重置密码""" fields = { "Password": fields.Str(required=True, dump_to="Password"), @@ -2277,8 +2330,7 @@ class ResetVMInstancePasswordRequestSchema(schema.RequestSchema): class ResetVMInstancePasswordResponseSchema(schema.ResponseSchema): - """ ResetVMInstancePassword - 重置虚拟机密码，主机必须开机才可以重置密码 - """ + """ResetVMInstancePassword - 重置虚拟机密码，主机必须开机才可以重置密码""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2291,8 +2343,7 @@ class ResetVMInstancePasswordResponseSchema(schema.ResponseSchema): class ResizeVMConfigRequestSchema(schema.RequestSchema): - """ ResizeVMConfig - 修改虚拟机配置 - """ + """ResizeVMConfig - 修改虚拟机配置""" fields = { "CPU": fields.Int(required=True, dump_to="CPU"), @@ -2304,8 +2355,7 @@ class ResizeVMConfigRequestSchema(schema.RequestSchema): class ResizeVMConfigResponseSchema(schema.ResponseSchema): - """ ResizeVMConfig - 修改虚拟机配置 - """ + """ResizeVMConfig - 修改虚拟机配置""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2318,8 +2368,7 @@ class ResizeVMConfigResponseSchema(schema.ResponseSchema): class RestartVMInstanceRequestSchema(schema.RequestSchema): - """ RestartVMInstance - 重启虚拟机 - """ + """RestartVMInstance - 重启虚拟机""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -2329,8 +2378,7 @@ class RestartVMInstanceRequestSchema(schema.RequestSchema): class RestartVMInstanceResponseSchema(schema.ResponseSchema): - """ RestartVMInstance - 重启虚拟机 - """ + """RestartVMInstance - 重启虚拟机""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2343,8 +2391,7 @@ class RestartVMInstanceResponseSchema(schema.ResponseSchema): class RollbackResourceRequestSchema(schema.RequestSchema): - """ RollbackResource - 恢复回收站资源 - """ + """RollbackResource - 恢复回收站资源""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -2354,8 +2401,7 @@ class RollbackResourceRequestSchema(schema.RequestSchema): class RollbackResourceResponseSchema(schema.ResponseSchema): - """ RollbackResource - 恢复回收站资源 - """ + """RollbackResource - 恢复回收站资源""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -2368,8 +2414,7 @@ class RollbackResourceResponseSchema(schema.ResponseSchema): class RollbackSnapshotRequestSchema(schema.RequestSchema): - """ RollbackSnapshot - 将某个快照内的数据回滚到原云硬盘，仅支持正常状态的快照进行回滚操作，回滚时硬盘必须处于未绑定或其挂载的主机为关机状态。 - """ + """RollbackSnapshot - 将某个快照内的数据回滚到原云硬盘，仅支持正常状态的快照进行回滚操作，回滚时硬盘必须处于未绑定或其挂载的主机为关机状态。""" fields = { "DiskID": fields.Str(required=True, dump_to="DiskID"), @@ -2380,8 +2425,7 @@ class RollbackSnapshotRequestSchema(schema.RequestSchema): class RollbackSnapshotResponseSchema(schema.ResponseSchema): - """ RollbackSnapshot - 将某个快照内的数据回滚到原云硬盘，仅支持正常状态的快照进行回滚操作，回滚时硬盘必须处于未绑定或其挂载的主机为关机状态。 - """ + """RollbackSnapshot - 将某个快照内的数据回滚到原云硬盘，仅支持正常状态的快照进行回滚操作，回滚时硬盘必须处于未绑定或其挂载的主机为关机状态。""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2394,8 +2438,7 @@ class RollbackSnapshotResponseSchema(schema.ResponseSchema): class StartVMInstanceRequestSchema(schema.RequestSchema): - """ StartVMInstance - 开启虚拟机 - """ + """StartVMInstance - 开启虚拟机""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -2405,8 +2448,7 @@ class StartVMInstanceRequestSchema(schema.RequestSchema): class StartVMInstanceResponseSchema(schema.ResponseSchema): - """ StartVMInstance - 开启虚拟机 - """ + """StartVMInstance - 开启虚拟机""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -2419,8 +2461,7 @@ class StartVMInstanceResponseSchema(schema.ResponseSchema): class StopVMInstanceRequestSchema(schema.RequestSchema): - """ StopVMInstance - 关闭虚拟机 - """ + """StopVMInstance - 关闭虚拟机""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -2430,8 +2471,7 @@ class StopVMInstanceRequestSchema(schema.RequestSchema): class StopVMInstanceResponseSchema(schema.ResponseSchema): - """ StopVMInstance - 关闭虚拟机 - """ + """StopVMInstance - 关闭虚拟机""" fields = { "Message": fields.Str(required=False, load_from="Message"), @@ -2447,8 +2487,7 @@ class StopVMInstanceResponseSchema(schema.ResponseSchema): class TerminateResourceRequestSchema(schema.RequestSchema): - """ TerminateResource - 销毁资源 - """ + """TerminateResource - 销毁资源""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -2458,8 +2497,7 @@ class TerminateResourceRequestSchema(schema.RequestSchema): class TerminateResourceResponseSchema(schema.ResponseSchema): - """ TerminateResource - 销毁资源 - """ + """TerminateResource - 销毁资源""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -2472,8 +2510,7 @@ class TerminateResourceResponseSchema(schema.ResponseSchema): class UnBindEIPRequestSchema(schema.RequestSchema): - """ UnBindEIP - 解绑外网IP - """ + """UnBindEIP - 解绑外网IP""" fields = { "EIPID": fields.Str(required=True, dump_to="EIPID"), @@ -2485,8 +2522,7 @@ class UnBindEIPRequestSchema(schema.RequestSchema): class UnBindEIPResponseSchema(schema.ResponseSchema): - """ UnBindEIP - 解绑外网IP - """ + """UnBindEIP - 解绑外网IP""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2499,8 +2535,7 @@ class UnBindEIPResponseSchema(schema.ResponseSchema): class UnBindSecurityGroupRequestSchema(schema.RequestSchema): - """ UnBindSecurityGroup - 解绑安全组 - """ + """UnBindSecurityGroup - 解绑安全组""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -2511,8 +2546,7 @@ class UnBindSecurityGroupRequestSchema(schema.RequestSchema): class UnBindSecurityGroupResponseSchema(schema.ResponseSchema): - """ UnBindSecurityGroup - 解绑安全组 - """ + """UnBindSecurityGroup - 解绑安全组""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2525,8 +2559,7 @@ class UnBindSecurityGroupResponseSchema(schema.ResponseSchema): class UnbindAlarmTemplateRequestSchema(schema.RequestSchema): - """ UnbindAlarmTemplate - 解绑告警模板 - """ + """UnbindAlarmTemplate - 解绑告警模板""" fields = { "AlarmTemplateID": fields.Str(required=True, dump_to="AlarmTemplateID"), @@ -2538,8 +2571,7 @@ class UnbindAlarmTemplateRequestSchema(schema.RequestSchema): class UnbindAlarmTemplateResponseSchema(schema.ResponseSchema): - """ UnbindAlarmTemplate - 解绑告警模板 - """ + """UnbindAlarmTemplate - 解绑告警模板""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2552,8 +2584,7 @@ class UnbindAlarmTemplateResponseSchema(schema.ResponseSchema): class UnbindPhysicalIPRequestSchema(schema.RequestSchema): - """ UnbindPhysicalIP - 解绑物理IP - """ + """UnbindPhysicalIP - 解绑物理IP""" fields = { "PhysicalIPID": fields.Str(required=True, dump_to="PhysicalIPID"), @@ -2565,8 +2596,7 @@ class UnbindPhysicalIPRequestSchema(schema.RequestSchema): class UnbindPhysicalIPResponseSchema(schema.ResponseSchema): - """ UnbindPhysicalIP - 解绑物理IP - """ + """UnbindPhysicalIP - 解绑物理IP""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2579,8 +2609,7 @@ class UnbindPhysicalIPResponseSchema(schema.ResponseSchema): class UpdateAlarmTemplateRuleRequestSchema(schema.RequestSchema): - """ UpdateAlarmTemplateRule - 更新告警模板规则 - """ + """UpdateAlarmTemplateRule - 更新告警模板规则""" fields = { "AlarmStrategy": fields.Str(required=True, dump_to="AlarmStrategy"), @@ -2600,8 +2629,7 @@ class UpdateAlarmTemplateRuleRequestSchema(schema.RequestSchema): class UpdateAlarmTemplateRuleResponseSchema(schema.ResponseSchema): - """ UpdateAlarmTemplateRule - 更新告警模板规则 - """ + """UpdateAlarmTemplateRule - 更新告警模板规则""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2614,8 +2642,7 @@ class UpdateAlarmTemplateRuleResponseSchema(schema.ResponseSchema): class UpdateRSRequestSchema(schema.RequestSchema): - """ UpdateRS - 修改负载均衡的服务节点 - """ + """UpdateRS - 修改负载均衡的服务节点""" fields = { "LBID": fields.Str(required=True, dump_to="LBID"), @@ -2629,8 +2656,7 @@ class UpdateRSRequestSchema(schema.RequestSchema): class UpdateRSResponseSchema(schema.ResponseSchema): - """ UpdateRS - 修改负载均衡的服务节点 - """ + """UpdateRS - 修改负载均衡的服务节点""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -2643,8 +2669,7 @@ class UpdateRSResponseSchema(schema.ResponseSchema): class UpdateSecurityGroupRuleRequestSchema(schema.RequestSchema): - """ UpdateSecurityGroupRule - 修改安全组规则 - """ + """UpdateSecurityGroupRule - 修改安全组规则""" fields = { "Region": fields.Str(required=True, dump_to="Region"), @@ -2655,8 +2680,7 @@ class UpdateSecurityGroupRuleRequestSchema(schema.RequestSchema): class UpdateSecurityGroupRuleResponseSchema(schema.ResponseSchema): - """ UpdateSecurityGroupRule - 修改安全组规则 - """ + """UpdateSecurityGroupRule - 修改安全组规则""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -2669,8 +2693,7 @@ class UpdateSecurityGroupRuleResponseSchema(schema.ResponseSchema): class UpdateVSRequestSchema(schema.RequestSchema): - """ UpdateVS - 修改负载均衡VServer - """ + """UpdateVS - 修改负载均衡VServer""" fields = { "CACertificateID": fields.Str( @@ -2702,8 +2725,7 @@ class UpdateVSRequestSchema(schema.RequestSchema): class UpdateVSResponseSchema(schema.ResponseSchema): - """ UpdateVS - 修改负载均衡VServer - """ + """UpdateVS - 修改负载均衡VServer""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -2716,8 +2738,7 @@ class UpdateVSResponseSchema(schema.ResponseSchema): class UpdateVSPolicyRequestSchema(schema.RequestSchema): - """ UpdateVSPolicy - 更新七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 - """ + """UpdateVSPolicy - 更新七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。""" fields = { "Domain": fields.Str(required=False, dump_to="Domain"), @@ -2732,8 +2753,7 @@ class UpdateVSPolicyRequestSchema(schema.RequestSchema): class UpdateVSPolicyResponseSchema(schema.ResponseSchema): - """ UpdateVSPolicy - 更新七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。 - """ + """UpdateVSPolicy - 更新七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -2741,13 +2761,12 @@ class UpdateVSPolicyResponseSchema(schema.ResponseSchema): """ API: UpgradeDisk -升级硬盘 +扩容硬盘，为保证数据完整性，容量扩容前建议暂停对当前硬盘的所有文件系统读写操作，并进入操作系统进行 `umount ` 或`脱机` 操作。 """ class UpgradeDiskRequestSchema(schema.RequestSchema): - """ UpgradeDisk - 升级硬盘 - """ + """UpgradeDisk - 扩容硬盘，为保证数据完整性，容量扩容前建议暂停对当前硬盘的所有文件系统读写操作，并进入操作系统进行 `umount ` 或`脱机` 操作。""" fields = { "DiskID": fields.Str(required=True, dump_to="DiskID"), @@ -2758,7 +2777,10 @@ class UpgradeDiskRequestSchema(schema.RequestSchema): class UpgradeDiskResponseSchema(schema.ResponseSchema): - """ UpgradeDisk - 升级硬盘 - """ + """UpgradeDisk - 扩容硬盘，为保证数据完整性，容量扩容前建议暂停对当前硬盘的所有文件系统读写操作，并进入操作系统进行 `umount ` 或`脱机` 操作。""" - fields = {"Message": fields.Str(required=True, load_from="Message")} + fields = { + "Action": fields.Str(required=True, load_from="Action"), + "Message": fields.Str(required=True, load_from="Message"), + "RetCode": fields.Int(required=True, load_from="RetCode"), + } diff --git a/ucloud/services/ucloudstack/schemas/models.py b/ucloud/services/ucloudstack/schemas/models.py index fe8964f..90c5edb 100644 --- a/ucloud/services/ucloudstack/schemas/models.py +++ b/ucloud/services/ucloudstack/schemas/models.py @@ -5,8 +5,7 @@ class BindVSInfoSchema(schema.ResponseSchema): - """ BindVSInfo - 证书绑定的vs信息 - """ + """BindVSInfo - 证书绑定的vs信息""" fields = { "LBID": fields.Str(required=False, load_from="LBID"), @@ -18,8 +17,7 @@ class BindVSInfoSchema(schema.ResponseSchema): class CertificateInfoSchema(schema.ResponseSchema): - """ CertificateInfo - 证书信息 - """ + """CertificateInfo - 证书信息""" fields = { "CertificateContent": fields.Str( @@ -44,30 +42,29 @@ class CertificateInfoSchema(schema.ResponseSchema): class DiskInfoSchema(schema.ResponseSchema): - """ DiskInfo - 磁盘信息 - """ + """DiskInfo - 磁盘信息""" fields = { "AttachResourceID": fields.Str( - required=False, load_from="AttachResourceID" + required=True, load_from="AttachResourceID" ), - "ChargeType": fields.Str(required=False, load_from="ChargeType"), - "CreateTime": fields.Int(required=False, load_from="CreateTime"), - "DiskID": fields.Str(required=False, load_from="DiskID"), - "DiskStatus": fields.Str(required=False, load_from="DiskStatus"), - "ExpireTime": fields.Int(required=False, load_from="ExpireTime"), - "Name": fields.Str(required=False, load_from="Name"), - "Region": fields.Str(required=False, load_from="Region"), + "ChargeType": fields.Str(required=True, load_from="ChargeType"), + "CreateTime": fields.Int(required=True, load_from="CreateTime"), + "DiskID": fields.Str(required=True, load_from="DiskID"), + "DiskStatus": fields.Str(required=True, load_from="DiskStatus"), + "DiskType": fields.Str(required=True, load_from="DiskType"), + "ExpireTime": fields.Int(required=True, load_from="ExpireTime"), + "Name": fields.Str(required=True, load_from="Name"), + "Region": fields.Str(required=True, load_from="Region"), "Remark": fields.Str(required=False, load_from="Remark"), - "SetType": fields.Str(required=False, load_from="SetType"), - "Size": fields.Int(required=False, load_from="Size"), - "Zone": fields.Str(required=False, load_from="Zone"), + "SetType": fields.Str(required=True, load_from="SetType"), + "Size": fields.Int(required=True, load_from="Size"), + "Zone": fields.Str(required=True, load_from="Zone"), } class EIPInfoSchema(schema.ResponseSchema): - """ EIPInfo - 外网IP信息 - """ + """EIPInfo - 外网IP信息""" fields = { "Bandwidth": fields.Int(required=False, load_from="Bandwidth"), @@ -77,11 +74,14 @@ class EIPInfoSchema(schema.ResponseSchema): "BindResourceType": fields.Str( required=False, load_from="BindResourceType" ), + "CanDefaultGW": fields.Int(required=False, load_from="CanDefaultGW"), "ChargeType": fields.Str(required=False, load_from="ChargeType"), "CreateTime": fields.Int(required=False, load_from="CreateTime"), "EIPID": fields.Str(required=False, load_from="EIPID"), "ExpireTime": fields.Int(required=False, load_from="ExpireTime"), "IP": fields.Str(required=False, load_from="IP"), + "IPVersion": fields.Str(required=False, load_from="IPVersion"), + "ISDefaultGW": fields.Int(required=False, load_from="ISDefaultGW"), "Name": fields.Str(required=False, load_from="Name"), "OperatorName": fields.Str(required=False, load_from="OperatorName"), "Region": fields.Str(required=False, load_from="Region"), @@ -92,8 +92,7 @@ class EIPInfoSchema(schema.ResponseSchema): class ImageInfoSchema(schema.ResponseSchema): - """ ImageInfo - 镜像信息 - """ + """ImageInfo - 镜像信息""" fields = { "CreateTime": fields.Int(required=True, load_from="CreateTime"), @@ -111,8 +110,7 @@ class ImageInfoSchema(schema.ResponseSchema): class LBInfoSchema(schema.ResponseSchema): - """ LBInfo - 负载均衡信息 - """ + """LBInfo - 负载均衡信息""" fields = { "AlarmTemplateID": fields.Str( @@ -138,8 +136,7 @@ class LBInfoSchema(schema.ResponseSchema): class MetricSetSchema(schema.ResponseSchema): - """ MetricSet - 监控值 - """ + """MetricSet - 监控值""" fields = { "Timestamp": fields.Int(required=False, load_from="Timestamp"), @@ -148,8 +145,7 @@ class MetricSetSchema(schema.ResponseSchema): class MetricInfoSchema(schema.ResponseSchema): - """ MetricInfo - 监控信息 - """ + """MetricInfo - 监控信息""" fields = { "Infos": fields.List(MetricSetSchema()), @@ -158,8 +154,7 @@ class MetricInfoSchema(schema.ResponseSchema): class NATGWInfoSchema(schema.ResponseSchema): - """ NATGWInfo - NAT网关信息 - """ + """NATGWInfo - NAT网关信息""" fields = { "AlarmTemplateID": fields.Str( @@ -182,8 +177,7 @@ class NATGWInfoSchema(schema.ResponseSchema): class NATGWRuleInfoSchema(schema.ResponseSchema): - """ NATGWRuleInfo - NAT网关关联的白名单资源信息 - """ + """NATGWRuleInfo - NAT网关关联的白名单资源信息""" fields = { "BindResourceID": fields.Str(required=True, load_from="BindResourceID"), @@ -200,9 +194,28 @@ class NATGWRuleInfoSchema(schema.ResponseSchema): } +class NICInfoSchema(schema.ResponseSchema): + """NICInfo - 网卡信息""" + + fields = { + "BindResourceID": fields.Str(required=True, load_from="BindResourceID"), + "CreateTime": fields.Int(required=True, load_from="CreateTime"), + "IP": fields.Str(required=True, load_from="IP"), + "MAC": fields.Str(required=True, load_from="MAC"), + "NICID": fields.Str(required=True, load_from="NICID"), + "NICStatus": fields.Str(required=True, load_from="NICStatus"), + "Name": fields.Str(required=True, load_from="Name"), + "Region": fields.Str(required=True, load_from="Region"), + "Remark": fields.Str(required=True, load_from="Remark"), + "SGID": fields.Str(required=True, load_from="SGID"), + "SubnetID": fields.Str(required=True, load_from="SubnetID"), + "VPCID": fields.Str(required=True, load_from="VPCID"), + "Zone": fields.Str(required=True, load_from="Zone"), + } + + class OPLogInfoSchema(schema.ResponseSchema): - """ OPLogInfo - 操作日志 - """ + """OPLogInfo - 操作日志""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -221,8 +234,7 @@ class OPLogInfoSchema(schema.ResponseSchema): class PhysicalIPInfoSchema(schema.ResponseSchema): - """ PhysicalIPInfo - 物理IP信息 - """ + """PhysicalIPInfo - 物理IP信息""" fields = { "BindResourceID": fields.Str(required=True, load_from="BindResourceID"), @@ -243,8 +255,7 @@ class PhysicalIPInfoSchema(schema.ResponseSchema): class RSInfoSchema(schema.ResponseSchema): - """ RSInfo - 转发规则关联的服务节点信息 - """ + """RSInfo - 转发规则关联的服务节点信息""" fields = { "BindResourceID": fields.Str(required=True, load_from="BindResourceID"), @@ -263,8 +274,7 @@ class RSInfoSchema(schema.ResponseSchema): class RecycledResourceInfoSchema(schema.ResponseSchema): - """ RecycledResourceInfo - 回收站资源信息 - """ + """RecycledResourceInfo - 回收站资源信息""" fields = { "CreateTime": fields.Int(required=True, load_from="CreateTime"), @@ -287,8 +297,7 @@ class RecycledResourceInfoSchema(schema.ResponseSchema): class SGRuleInfoSchema(schema.ResponseSchema): - """ SGRuleInfo - 安全组规则信息 - """ + """SGRuleInfo - 安全组规则信息""" fields = { "DstPort": fields.Str(required=False, load_from="DstPort"), @@ -302,8 +311,7 @@ class SGRuleInfoSchema(schema.ResponseSchema): class SGInfoSchema(schema.ResponseSchema): - """ SGInfo - 安全组信息 - """ + """SGInfo - 安全组信息""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -320,9 +328,38 @@ class SGInfoSchema(schema.ResponseSchema): } +class SGResourceInfoSchema(schema.ResponseSchema): + """SGResourceInfo - 安全组绑定的资源信息""" + + fields = { + "Name": fields.Str(required=True, load_from="Name"), + "Region": fields.Str(required=True, load_from="Region"), + "ResourceID": fields.Str(required=True, load_from="ResourceID"), + "ResourceType": fields.Str(required=True, load_from="ResourceType"), + "Zone": fields.Str(required=True, load_from="Zone"), + } + + +class SnapshotInfoSchema(schema.ResponseSchema): + """SnapshotInfo - 快照的详细信息""" + + fields = { + "CreateTime": fields.Int(required=False, load_from="CreateTime"), + "DiskID": fields.Str(required=False, load_from="DiskID"), + "DiskType": fields.Str(required=False, load_from="DiskType"), + "Name": fields.Str(required=False, load_from="Name"), + "Region": fields.Str(required=False, load_from="Region"), + "Remark": fields.Str(required=False, load_from="Remark"), + "SnapshotID": fields.Str(required=False, load_from="SnapshotID"), + "SnapshotStatus": fields.Str( + required=False, load_from="SnapshotStatus" + ), + "Zone": fields.Str(required=False, load_from="Zone"), + } + + class StorageTypeInfoSchema(schema.ResponseSchema): - """ StorageTypeInfo - 存储类型信息 - """ + """StorageTypeInfo - 存储类型信息""" fields = { "Region": fields.Str(required=True, load_from="Region"), @@ -336,8 +373,7 @@ class StorageTypeInfoSchema(schema.ResponseSchema): class SubnetInfoSchema(schema.ResponseSchema): - """ SubnetInfo - 子网信息 - """ + """SubnetInfo - 子网信息""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -353,8 +389,7 @@ class SubnetInfoSchema(schema.ResponseSchema): class UserInfoSchema(schema.ResponseSchema): - """ UserInfo - 租户信息 - """ + """UserInfo - 租户信息""" fields = { "Amount": fields.Float(required=False, load_from="Amount"), @@ -369,8 +404,7 @@ class UserInfoSchema(schema.ResponseSchema): class VMDiskInfoSchema(schema.ResponseSchema): - """ VMDiskInfo - UCloudStack虚拟机磁盘信息 - """ + """VMDiskInfo - 虚拟机磁盘信息""" fields = { "DiskID": fields.Str(required=False, load_from="DiskID"), @@ -383,8 +417,7 @@ class VMDiskInfoSchema(schema.ResponseSchema): class VMIPInfoSchema(schema.ResponseSchema): - """ VMIPInfo - UCloudStack虚拟机IP信息 - """ + """VMIPInfo - 虚拟机IP信息""" fields = { "IP": fields.Str(required=False, load_from="IP"), @@ -403,8 +436,7 @@ class VMIPInfoSchema(schema.ResponseSchema): class VMInstanceInfoSchema(schema.ResponseSchema): - """ VMInstanceInfo - UCloudStack虚拟机信息 - """ + """VMInstanceInfo - UCloudStack虚拟机信息""" fields = { "CPU": fields.Int(required=False, load_from="CPU"), @@ -419,7 +451,6 @@ class VMInstanceInfoSchema(schema.ResponseSchema): "OSName": fields.Str(required=False, load_from="OSName"), "OSType": fields.Str(required=False, load_from="OSType"), "Region": fields.Str(required=False, load_from="Region"), - "RegionAlias": fields.Str(required=False, load_from="RegionAlias"), "Remark": fields.Str(required=False, load_from="Remark"), "State": fields.Str(required=False, load_from="State"), "SubnetID": fields.Str(required=False, load_from="SubnetID"), @@ -430,13 +461,11 @@ class VMInstanceInfoSchema(schema.ResponseSchema): "VPCID": fields.Str(required=False, load_from="VPCID"), "VPCName": fields.Str(required=False, load_from="VPCName"), "Zone": fields.Str(required=False, load_from="Zone"), - "ZoneAlias": fields.Str(required=False, load_from="ZoneAlias"), } class VMTypeInfoSchema(schema.ResponseSchema): - """ VMTypeInfo - 主机机型信息 - """ + """VMTypeInfo - 主机机型信息""" fields = { "Region": fields.Str(required=True, load_from="Region"), @@ -448,8 +477,7 @@ class VMTypeInfoSchema(schema.ResponseSchema): class VPCInfoSchema(schema.ResponseSchema): - """ VPCInfo - VPC信息 - """ + """VPCInfo - VPC信息""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -467,8 +495,7 @@ class VPCInfoSchema(schema.ResponseSchema): class VSPolicyInfoSchema(schema.ResponseSchema): - """ VSPolicyInfo - 内容转发规则信息 - """ + """VSPolicyInfo - 内容转发规则信息""" fields = { "CreateTime": fields.Int(required=True, load_from="CreateTime"), @@ -484,13 +511,15 @@ class VSPolicyInfoSchema(schema.ResponseSchema): class VSInfoSchema(schema.ResponseSchema): - """ VSInfo - RServer信息 - """ + """VSInfo - VServer信息""" fields = { "AlarmTemplateID": fields.Str( required=True, load_from="AlarmTemplateID" ), + "CACertificateID": fields.Str( + required=False, load_from="CACertificateID" + ), "CreateTime": fields.Int(required=True, load_from="CreateTime"), "Domain": fields.Str(required=False, load_from="Domain"), "HealthcheckType": fields.Str( @@ -511,6 +540,11 @@ class VSInfoSchema(schema.ResponseSchema): "Protocol": fields.Str(required=True, load_from="Protocol"), "RSHealthStatus": fields.Str(required=True, load_from="RSHealthStatus"), "RSInfos": fields.List(RSInfoSchema()), + "SSLMode": fields.Str(required=False, load_from="SSLMode"), + "Scheduler": fields.Str(required=True, load_from="Scheduler"), + "ServerCertificateID": fields.Str( + required=False, load_from="ServerCertificateID" + ), "UpdateTime": fields.Int(required=True, load_from="UpdateTime"), "VSID": fields.Str(required=True, load_from="VSID"), "VSPolicyInfos": fields.List(VSPolicyInfoSchema()), @@ -519,8 +553,7 @@ class VSInfoSchema(schema.ResponseSchema): class PriceInfoSchema(schema.ResponseSchema): - """ PriceInfo - 价格信息 - """ + """PriceInfo - 价格信息""" fields = { "ChargeType": fields.Str(required=True, load_from="ChargeType"), diff --git a/ucloud/services/udb/client.py b/ucloud/services/udb/client.py index 03b1c62..efdf488 100644 --- a/ucloud/services/udb/client.py +++ b/ucloud/services/udb/client.py @@ -10,23 +10,23 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(UDBClient, self).__init__(config, transport, middleware, logger) def backup_udb_instance(self, req=None, **kwargs): - """ BackupUDBInstance - 备份UDB实例 + """BackupUDBInstance - 备份UDB实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupName** (str) - (Required) 备份名称 - **DBId** (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取 - **BackupMethod** (str) - 使用的备份方式。（快照备份即物理备份。注意只有SSD版本的mysql实例支持设置为snapshot） - **Blacklist** (str) - 备份黑名单列表，以 ; 分隔。注意：只有逻辑备份下备份黑名单才生效，快照备份备份黑名单下无效 - **ForceBackup** (bool) - true表示逻辑备份时是使用 --force 参数，false表示不使用 --force 参数。物理备份此参数无效。 - **UseBlacklist** (bool) - 是否使用黑名单备份，默认false - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -36,20 +36,20 @@ def backup_udb_instance(self, req=None, **kwargs): return apis.BackupUDBInstanceResponseSchema().loads(resp) def backup_udb_instance_binlog(self, req=None, **kwargs): - """ BackupUDBInstanceBinlog - 备份UDB指定时间段的binlog列表 + """BackupUDBInstanceBinlog - 备份UDB指定时间段的binlog列表 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupFile** (str) - (Required) 需要备份文件,可通过DescribeUDBInstanceBinlog获得 如果要传入多个文件名，以空格键分割,用单引号包含. - **DBId** (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取 - **BackupName** (str) - DB备份文件名称 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -58,19 +58,19 @@ def backup_udb_instance_binlog(self, req=None, **kwargs): return apis.BackupUDBInstanceBinlogResponseSchema().loads(resp) def backup_udb_instance_error_log(self, req=None, **kwargs): - """ BackupUDBInstanceErrorLog - 备份UDB指定时间段的errorlog + """BackupUDBInstanceErrorLog - 备份UDB指定时间段的errorlog **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupName** (str) - (Required) 备份名称 - **DBId** (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -79,20 +79,20 @@ def backup_udb_instance_error_log(self, req=None, **kwargs): return apis.BackupUDBInstanceErrorLogResponseSchema().loads(resp) def backup_udb_instance_slow_log(self, req=None, **kwargs): - """ BackupUDBInstanceSlowLog - 备份UDB指定时间段的slowlog分析结果 + """BackupUDBInstanceSlowLog - 备份UDB指定时间段的slowlog分析结果 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupName** (str) - (Required) 备份文件名称 - **BeginTime** (int) - (Required) 过滤条件:起始时间(时间戳) - **DBId** (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取 - **EndTime** (int) - (Required) 过滤条件:结束时间(时间戳) - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -101,19 +101,19 @@ def backup_udb_instance_slow_log(self, req=None, **kwargs): return apis.BackupUDBInstanceSlowLogResponseSchema().loads(resp) def check_recover_udb_instance(self, req=None, **kwargs): - """ CheckRecoverUDBInstance - 核查db是否可以使用回档功能 + """CheckRecoverUDBInstance - 核查db是否可以使用回档功能 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **SrcDBId** (str) - (Required) 源实例的Id(只支持普通版DB不支持高可用) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **LastestTime** (int) - 核查成功返回值为可以回档到的最近时刻,核查失败不返回 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -122,18 +122,18 @@ def check_recover_udb_instance(self, req=None, **kwargs): return apis.CheckRecoverUDBInstanceResponseSchema().loads(resp) def check_udb_instance_to_ha_allowance(self, req=None, **kwargs): - """ CheckUDBInstanceToHAAllowance - 核查db是否可以升级为高可用 + """CheckUDBInstanceToHAAllowance - 核查db是否可以升级为高可用 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取 - + **Response** - **Allowance** (str) - Yes ，No ，Yes即可以升级，No为不可以升级 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -142,20 +142,20 @@ def check_udb_instance_to_ha_allowance(self, req=None, **kwargs): return apis.CheckUDBInstanceToHAAllowanceResponseSchema().loads(resp) def clear_udb_log(self, req=None, **kwargs): - """ ClearUDBLog - 清除UDB实例的log + """ClearUDBLog - 清除UDB实例的log **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) DB实例的id,该值可以通过DescribeUDBInstance获取 - **LogType** (int) - (Required) 日志类型，10-error（暂不支持）、20-slow（暂不支持 ）、30-binlog - **BeforeTime** (int) - 删除时间点(至少前一天)之前log，采用时间戳(秒)，默认当 前时间点前一天 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -164,12 +164,12 @@ def clear_udb_log(self, req=None, **kwargs): return apis.ClearUDBLogResponseSchema().loads(resp) def create_udb_instance(self, req=None, **kwargs): - """ CreateUDBInstance - 创建UDB实例（包括创建mysql master节点、mongodb primary/configsvr节点和从备份恢复实例） + """CreateUDBInstance - 创建UDB实例（包括创建mysql master节点、mongodb primary/configsvr节点和从备份恢复实例） **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **AdminPassword** (str) - (Required) 管理员密码 - **DBTypeId** (str) - (Required) DB类型id，mysql/mongodb/postgesql按版本细分 1：mysql-5.1，2：mysql-5.5，3：percona-5.5，4：mysql-5.6，5：percona-5.6，6：mysql-5.7，7：percona-5.7，8：mariadb-10.0，9：mongodb-2.4，10：mongodb-2.6，11：mongodb-3.0，12：mongodb-3.2,13：postgresql-9.4，14：postgresql-9.6，14：postgresql-10.4 - **DiskSpace** (int) - (Required) 磁盘空间(GB), 暂时支持20G - 3000G @@ -177,13 +177,13 @@ def create_udb_instance(self, req=None, **kwargs): - **Name** (str) - (Required) 实例名称，至少6位 - **ParamGroupId** (int) - (Required) DB实例使用的配置参数组id - **Port** (int) - (Required) 端口号，mysql默认3306，mongodb默认27017，postgresql默认5432 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **AdminUser** (str) - 管理员帐户名，默认root - **BackupCount** (int) - 备份策略，每周备份数量，默认7次 - **BackupDuration** (int) - 备份策略，备份时间间隔，单位小时计，默认24小时 - **BackupId** (int) - 备份id，如果指定，则表明从备份恢复实例 - **BackupTime** (int) - 备份策略，备份开始时间，单位小时计，默认1点 - - **BackupZone** (str) - 跨可用区高可用备库所在可用区，参见 `可用区列表 `_ + - **BackupZone** (str) - 跨可用区高可用备库所在可用区，参见 `可用区列表 `_ - **CPU** (int) - cpu核数 - **ChargeType** (str) - Year， Month， Dynamic，Trial，默认: Month - **ClusterRole** (str) - 当DB类型(DBTypeId)为mongodb时，需要指定mongo的角色，可选值为configsrv (配置节点)，shardsrv (数据节点) @@ -199,11 +199,11 @@ def create_udb_instance(self, req=None, **kwargs): - **UDBCId** (str) - 专区ID信息（如果这个参数存在这说明是在专区中创建DB） - **UseSSD** (bool) - 是否使用SSD，默认为false。目前主要可用区、海外机房、新机房只提供SSD资源，非SSD资源不再提供。 - **VPCId** (str) - VPC的ID - + **Response** - **DBId** (str) - BD实例id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -213,12 +213,12 @@ def create_udb_instance(self, req=None, **kwargs): return apis.CreateUDBInstanceResponseSchema().loads(resp) def create_udb_instance_by_recovery(self, req=None, **kwargs): - """ CreateUDBInstanceByRecovery - 创建db，将新创建的db恢复到指定db某个指定时间点 + """CreateUDBInstanceByRecovery - 创建db，将新创建的db恢复到指定db某个指定时间点 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 实例名称，至少6位 - **RecoveryTime** (int) - (Required) 恢复到某个时间点的时间戳(UTC时间格式，默认单位秒) - **SrcDBId** (str) - (Required) 源实例的Id @@ -229,12 +229,12 @@ def create_udb_instance_by_recovery(self, req=None, **kwargs): - **UDBCId** (str) - 专区的Id - **UseSSD** (bool) - 指定是否是否使用SSD，默认使用主库的配置 - **VPCId** (str) - VPC的ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DBId** (str) - db实例id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -244,23 +244,23 @@ def create_udb_instance_by_recovery(self, req=None, **kwargs): return apis.CreateUDBInstanceByRecoveryResponseSchema().loads(resp) def create_udb_param_group(self, req=None, **kwargs): - """ CreateUDBParamGroup - 从已有配置文件创建新配置文件 + """CreateUDBParamGroup - 从已有配置文件创建新配置文件 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBTypeId** (str) - (Required) DB类型id，mysql/mongodb/postgesql按版本细分 1：mysql-5.1，2：mysql-5.5，3：percona-5.5，4：mysql-5.6，5：percona-5.6，6：mysql-5.7，7：percona-5.7，8：mariadb-10.0，9：mongodb-2.4，10：mongodb-2.6，11：mongodb-3.0，12：mongodb-3.2,13：postgresql-9.4，14：postgresql-9.6 - **Description** (str) - (Required) 参数组描述 - **GroupName** (str) - (Required) 新配置参数组名称 - **SrcGroupId** (int) - (Required) 源参数组id - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **RegionFlag** (bool) - 是否是地域级别的配置文件，默认是false - + **Response** - **GroupId** (int) - 新配置参数组id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -270,24 +270,24 @@ def create_udb_param_group(self, req=None, **kwargs): return apis.CreateUDBParamGroupResponseSchema().loads(resp) def create_udb_replication_instance(self, req=None, **kwargs): - """ CreateUDBReplicationInstance - 创建MongoDB的副本节点（包括仲裁） + """CreateUDBReplicationInstance - 创建MongoDB的副本节点（包括仲裁） **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 实例名称，至少6位 - **SrcId** (str) - (Required) primary节点的DBId,该值可以通过DescribeUDBInstance获取 - **CouponId** (str) - 使用的代金券id - **IsArbiter** (bool) - 是否是仲裁节点，默认false，仲裁节点按最小机型创建 - **Port** (int) - 端口号，默认27017，取值范围3306至65535。 - **UseSSD** (bool) - 是否使用SSD，默认不使用 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DBId** (str) - 创建从节点的DBId - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -297,12 +297,12 @@ def create_udb_replication_instance(self, req=None, **kwargs): return apis.CreateUDBReplicationInstanceResponseSchema().loads(resp) def create_udb_route_instance(self, req=None, **kwargs): - """ CreateUDBRouteInstance - 创建mongos实例 + """CreateUDBRouteInstance - 创建mongos实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ConfigsvrId** (list) - (Required) 配置服务器的dbid，允许一个或者三个。 - **DBTypeId** (str) - (Required) DB类型id，mongodb按版本细分有1：mongodb-2.4，2：mongodb-2.6,3：mongodb-3.0，4：mongodb-3.2 - **DiskSpace** (int) - (Required) 磁盘空间(GB), 暂时支持20G - 500G @@ -314,12 +314,12 @@ def create_udb_route_instance(self, req=None, **kwargs): - **CouponId** (str) - 使用的代金券id - **Quantity** (int) - 购买时长，默认值1 - **UseSSD** (bool) - 是否使用SSD，默认为false - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DBId** (str) - db实例id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -329,12 +329,12 @@ def create_udb_route_instance(self, req=None, **kwargs): return apis.CreateUDBRouteInstanceResponseSchema().loads(resp) def create_udb_slave(self, req=None, **kwargs): - """ CreateUDBSlave - 创建UDB实例的slave + """CreateUDBSlave - 创建UDB实例的slave **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 实例名称，至少6位 - **SrcId** (str) - (Required) master实例的DBId,该值可以通过DescribeUDBInstance获取 - **CouponId** (str) - 使用的代金券id @@ -346,12 +346,12 @@ def create_udb_slave(self, req=None, **kwargs): - **Port** (int) - 端口号，mysql默认3306 - **SSDType** (str) - SSD类型，可选值为"SATA"、"PCI-E"，如果UseSSD为true ，则必选 - **UseSSD** (bool) - 是否使用SSD，默认为false - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DBId** (str) - 创建slave的DBId - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -361,19 +361,19 @@ def create_udb_slave(self, req=None, **kwargs): return apis.CreateUDBSlaveResponseSchema().loads(resp) def delete_udb_backup(self, req=None, **kwargs): - """ DeleteUDBBackup - 删除UDB实例备份 + """DeleteUDBBackup - 删除UDB实例备份 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupId** (int) - (Required) 备份id，可通过DescribeUDBBackup获得 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **BackupZone** (str) - 跨可用区高可用备库所在可用区，参见［可用区列表］ - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -382,19 +382,19 @@ def delete_udb_backup(self, req=None, **kwargs): return apis.DeleteUDBBackupResponseSchema().loads(resp) def delete_udb_instance(self, req=None, **kwargs): - """ DeleteUDBInstance - 删除UDB实例 + """DeleteUDBInstance - 删除UDB实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) DB实例的id,该值可以通过DescribeUDBInstance获取 - **UDBCId** (str) - 专区ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -403,19 +403,19 @@ def delete_udb_instance(self, req=None, **kwargs): return apis.DeleteUDBInstanceResponseSchema().loads(resp) def delete_udb_log_package(self, req=None, **kwargs): - """ DeleteUDBLogPackage - 删除UDB日志包 + """DeleteUDBLogPackage - 删除UDB日志包 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupId** (int) - (Required) 日志包id，可通过DescribeUDBLogPackage获得 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **BackupZone** (str) - 跨可用区高可用备库所在可用区 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -424,19 +424,19 @@ def delete_udb_log_package(self, req=None, **kwargs): return apis.DeleteUDBLogPackageResponseSchema().loads(resp) def delete_udb_param_group(self, req=None, **kwargs): - """ DeleteUDBParamGroup - 删除配置参数组 + """DeleteUDBParamGroup - 删除配置参数组 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (int) - (Required) 参数组id,可通过DescribeUDBParamGroup获取 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **RegionFlag** (bool) - 是否属于地域级别 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -445,12 +445,12 @@ def delete_udb_param_group(self, req=None, **kwargs): return apis.DeleteUDBParamGroupResponseSchema().loads(resp) def describe_udb_backup(self, req=None, **kwargs): - """ DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区，填代表单可用区 + """DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区，填代表单可用区 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - (Required) 分页显示的条目数，列表操作则指定 - **Offset** (int) - (Required) 分页显示的起始偏移，列表操作则指定 - **BackupId** (int) - 如果填了BackupId, 那么只拉取这个备份的记录 @@ -459,17 +459,17 @@ def describe_udb_backup(self, req=None, **kwargs): - **ClassType** (str) - 如果未指定GroupId，则可选是否选取特定DB类型的配置(sql, nosql, postgresql, sqlserver) - **DBId** (str) - DB实例Id，如果指定，则只获取该db的备份信息 该值可以通过DescribeUDBInstance获取 - **EndTime** (int) - 过滤条件:结束时间(Unix时间戳) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 见 **UDBBackupSet** 模型定义 - **TotalCount** (int) - 满足条件备份总数，如果指定dbid，则是该db备份总数 - + **Response Model** - - **UDBBackupSet** - + + **UDBBackupSet** + - **BackupEndTime** (int) - 备份完成时间(Unix时间戳) - **BackupId** (int) - 备份id - **BackupName** (str) - 备份名称 @@ -491,19 +491,19 @@ def describe_udb_backup(self, req=None, **kwargs): return apis.DescribeUDBBackupResponseSchema().loads(resp) def describe_udb_backup_blacklist(self, req=None, **kwargs): - """ DescribeUDBBackupBlacklist - 获取UDB实例的备份黑名单 + """DescribeUDBBackupBlacklist - 获取UDB实例的备份黑名单 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **Blacklist** (str) - DB的黑名单列表, db.%为指定库 dbname.tablename为指定表 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -512,20 +512,20 @@ def describe_udb_backup_blacklist(self, req=None, **kwargs): return apis.DescribeUDBBackupBlacklistResponseSchema().loads(resp) def describe_udb_binlog_backup_url(self, req=None, **kwargs): - """ DescribeUDBBinlogBackupURL - 获取UDB的Binlog备份地址 + """DescribeUDBBinlogBackupURL - 获取UDB的Binlog备份地址 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupId** (int) - (Required) DB实例binlog备份ID，可以从DescribeUDBLogPackage结果当中获得 - **DBId** (str) - (Required) DB实例Id - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **BackupPath** (str) - DB实例备份文件的公网地址 - **InnerBackupPath** (str) - DB实例备份文件的内网地址 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -534,12 +534,12 @@ def describe_udb_binlog_backup_url(self, req=None, **kwargs): return apis.DescribeUDBBinlogBackupURLResponseSchema().loads(resp) def describe_udb_instance(self, req=None, **kwargs): - """ DescribeUDBInstance - 获取UDB实例信息，支持两类操作：（1）指定DBId用于获取该db的信息；（2）指定ClassType、Offset、Limit用于列表操作，查询某一个类型db。 + """DescribeUDBInstance - 获取UDB实例信息，支持两类操作：（1）指定DBId用于获取该db的信息；（2）指定ClassType、Offset、Limit用于列表操作，查询某一个类型db。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ClassType** (str) - DB种类，如果是列表操作，则需要指定,不区分大小写，其取值如下：mysql: SQL；mongo: NOSQL；postgresql: postgresql - **DBId** (str) - DB实例id，如果指定则获取单个db实例的描述，否则为列表操作。 指定DBId时无需填写ClassType、Offset、Limit - **IncludeSlaves** (bool) - 当只获取这个特定DBId的信息时，如果有该选项，那么把这个DBId实例的所有从库信息一起拉取并返回 @@ -547,17 +547,17 @@ def describe_udb_instance(self, req=None, **kwargs): - **Limit** (int) - 分页显示数量，列表操作时必填 - **Offset** (int) - 分页显示起始偏移位置，列表操作时必填 - **UDBCId** (str) - IsInUDBC为True,UDBCId为空，说明查看整个可用区的专区的db，如果UDBId不为空则只查看此专区下面的db - - **Zone** (str) - 可用区，不填时默认全部可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区，不填时默认全部可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 见 **UDBInstanceSet** 模型定义 - **TotalCount** (int) - 用户db组的数量，对于 mysql: 主从结对数量，没有slave，则只有master mongodb: 副本集数量 - + **Response Model** - - **UDBSlaveInstanceSet** - + + **UDBSlaveInstanceSet** + - **AdminUser** (str) - 管理员帐户名，默认root - **BackupBeginTime** (int) - 备份策略，不可修改，开始时间，单位小时计，默认3点 - **BackupBlacklist** (str) - 备份策略，备份黑名单，mongodb则不适用 @@ -595,8 +595,8 @@ def describe_udb_instance(self, req=None, **kwargs): - **VirtualIPMac** (str) - DB实例虚ip的mac地址 - **Zone** (str) - 可用区 - **UDBInstanceSet** - + **UDBInstanceSet** + - **AdminUser** (str) - 管理员帐户名，默认root - **BackupBeginTime** (int) - 备份策略，不可修改，开始时间，单位小时计，默认3点 - **BackupBlacklist** (str) - 备份策略，备份黑名单，mongodb则不适用 @@ -644,22 +644,22 @@ def describe_udb_instance(self, req=None, **kwargs): return apis.DescribeUDBInstanceResponseSchema().loads(resp) def describe_udb_instance_backup_state(self, req=None, **kwargs): - """ DescribeUDBInstanceBackupState - 获取UDB实例备份状态 + """DescribeUDBInstanceBackupState - 获取UDB实例备份状态 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupId** (int) - (Required) 备份记录ID - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **BackupZone** (str) - 跨可用区高可用备库所在可用区，参见［可用区列表］ - + **Response** - - **BackupEndTime** (int) - - - **BackupSize** (int) - + - **BackupEndTime** (int) - + - **BackupSize** (int) - - **State** (str) - 备份状态 0 Backuping // 备份中 1 Success // 备份成功 2 Failed // 备份失败 3 Expired // 备份过期 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -668,21 +668,21 @@ def describe_udb_instance_backup_state(self, req=None, **kwargs): return apis.DescribeUDBInstanceBackupStateResponseSchema().loads(resp) def describe_udb_instance_backup_url(self, req=None, **kwargs): - """ DescribeUDBInstanceBackupURL - 获取UDB备份下载地址 + """DescribeUDBInstanceBackupURL - 获取UDB备份下载地址 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupId** (int) - (Required) DB实例备份ID,该值可以通过DescribeUDBBackup获取 - **DBId** (str) - (Required) DB实例Id,该值可通过DescribeUDBInstance获取 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **BackupPath** (str) - DB实例备份文件公网的地址 - **InnerBackupPath** (str) - DB实例备份文件内网的地址 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -691,25 +691,25 @@ def describe_udb_instance_backup_url(self, req=None, **kwargs): return apis.DescribeUDBInstanceBackupURLResponseSchema().loads(resp) def describe_udb_instance_binlog(self, req=None, **kwargs): - """ DescribeUDBInstanceBinlog - 获取UDB指定时间段的binlog列表 + """DescribeUDBInstanceBinlog - 获取UDB指定时间段的binlog列表 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BeginTime** (int) - (Required) 过滤条件:起始时间(时间戳) - **DBId** (str) - (Required) DB实例Id - **EndTime** (int) - (Required) 过滤条件:结束时间(时间戳) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 见 **UDBInstanceBinlogSet** 模型定义 - + **Response Model** - - **UDBInstanceBinlogSet** - + + **UDBInstanceBinlogSet** + - **BeginTime** (int) - Binlog文件生成时间(时间戳) - **EndTime** (int) - Binlog文件结束时间(时间戳) - **Name** (str) - Binlog文件名 @@ -723,21 +723,21 @@ def describe_udb_instance_binlog(self, req=None, **kwargs): return apis.DescribeUDBInstanceBinlogResponseSchema().loads(resp) def describe_udb_instance_binlog_backup_state(self, req=None, **kwargs): - """ DescribeUDBInstanceBinlogBackupState - 获取udb实例备份状态 + """DescribeUDBInstanceBinlogBackupState - 获取udb实例备份状态 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupId** (int) - (Required) 备份记录ID - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **BackupZone** (str) - 跨可用区高可用备库所在可用区 - + **Response** - **BackupSize** (int) - 备份文件大小(字节) - **State** (str) - 备份状态 0 Backuping // 备份中 1 Success // 备份成功 2 Failed // 备份失败 3 Expired // 备份过期 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -748,30 +748,30 @@ def describe_udb_instance_binlog_backup_state(self, req=None, **kwargs): ) def describe_udb_instance_price(self, req=None, **kwargs): - """ DescribeUDBInstancePrice - 获取UDB实例价格信息 + """DescribeUDBInstancePrice - 获取UDB实例价格信息 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBTypeId** (str) - (Required) UDB实例的DB版本字符串 - **DiskSpace** (int) - (Required) 磁盘空间(GB),暂时支持20(GB) - 3000(GB), 输入不带单位 - **MemoryLimit** (int) - (Required) 内存限制(MB)，单位为MB.目前支持：1000-96000 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - Year，按年付费； Month，按月付费 Dynamic，按需付费（需开启权限) Trial，试用（需开启权限）默认为月付 - **Count** (int) - 购买DB实例数量,最大数量为10台, 默认为1台 - **InstanceMode** (str) - 实例的部署类型。可选值为：Normal: 普通单点实例，Slave: 从库实例,HA: 高可用部署实例，默认是Normal - **Quantity** (int) - DB购买多少个"计费时间单位"，默认值为1。比如：买2个月，Quantity就是2。如果计费单位是“按月”，并且Quantity为0，表示“购买到月底” - **SSDType** (str) - SSD类型，可选值为"SATA"、"PCI-E"，如果UseSSD为true ，则必填 - **UseSSD** (str) - 是否使用SSD，只能填true或false，默认为false - + **Response** - **DataSet** (list) - 见 **UDBInstancePriceSet** 模型定义 - + **Response Model** - - **UDBInstancePriceSet** - + + **UDBInstancePriceSet** + - **ChargeType** (str) - Year， Month， Dynamic，Trial - **Price** (int) - 价格，单位为分 @@ -783,19 +783,19 @@ def describe_udb_instance_price(self, req=None, **kwargs): return apis.DescribeUDBInstancePriceResponseSchema().loads(resp) def describe_udb_instance_state(self, req=None, **kwargs): - """ DescribeUDBInstanceState - 获取UDB实例状态 + """DescribeUDBInstanceState - 获取UDB实例状态 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **State** (str) - DB状态标记 Init：初始化中；Fail：安装失败； Starting：启动中； Running ： 运行 ；Shutdown：关闭中； Shutoff ：已关闭； Delete：已删除； Upgrading：升级中； Promoting： 提升为独库进行中； Recovering： 恢复中； Recover fail：恢复失败。 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -804,23 +804,23 @@ def describe_udb_instance_state(self, req=None, **kwargs): return apis.DescribeUDBInstanceStateResponseSchema().loads(resp) def describe_udb_instance_upgrade_price(self, req=None, **kwargs): - """ DescribeUDBInstanceUpgradePrice - 获取UDB实例升降级价格信息 + """DescribeUDBInstanceUpgradePrice - 获取UDB实例升降级价格信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id - **DiskSpace** (int) - (Required) 磁盘空间(GB), 暂时支持20G - 500G - **MemoryLimit** (int) - (Required) 内存限制(MB) - **SSDType** (str) - SSD类型，可选值为"SATA"、"PCI-E"，如果UseSSD为true ，则必选 - **UseSSD** (bool) - 是否使用SSD，默认为false - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **Price** (int) - 价格，单位为分 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -829,20 +829,20 @@ def describe_udb_instance_upgrade_price(self, req=None, **kwargs): return apis.DescribeUDBInstanceUpgradePriceResponseSchema().loads(resp) def describe_udb_log_backup_url(self, req=None, **kwargs): - """ DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址 + """DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupId** (int) - (Required) DB实例备份ID - **DBId** (str) - (Required) DB实例Id - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **BackupPath** (str) - 备份外网URL - **UsernetPath** (str) - 备份用户网URL - + """ d = {"Region": self.config.region} req and d.update(req) @@ -851,12 +851,12 @@ def describe_udb_log_backup_url(self, req=None, **kwargs): return apis.DescribeUDBLogBackupURLResponseSchema().loads(resp) def describe_udb_log_package(self, req=None, **kwargs): - """ DescribeUDBLogPackage - 列表UDB实例binlog或slowlog或errorlog备份信息 + """DescribeUDBLogPackage - 列表UDB实例binlog或slowlog或errorlog备份信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - (Required) 分页显示的条目数，列表操作则指定 - **Offset** (int) - (Required) 分页显示的起始偏移，列表操作则指定 - **BeginTime** (int) - 过滤条件:起始时间(时间戳) @@ -864,17 +864,17 @@ def describe_udb_log_package(self, req=None, **kwargs): - **EndTime** (int) - 过滤条件:结束时间(时间戳) - **Type** (int) - 需要列出的备份文件类型，每种文件的值如下 2 : BINLOG\\_BACKUP 3 : SLOW\\_QUERY\\_BACKUP 4 : ERRORLOG\\_BACKUP - **Types** (list) - Types作为Type的补充，支持多值传入，可以获取多个类型的日志记录，如：Types.0=2&Types.1=3 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 见 **LogPackageDataSet** 模型定义 - **TotalCount** (int) - 备份总数，如果指定dbid，则是该db备份总数 - + **Response Model** - - **LogPackageDataSet** - + + **LogPackageDataSet** + - **BackupId** (int) - 备份id - **BackupName** (str) - 备份名称 - **BackupSize** (int) - 备份文件大小 @@ -894,29 +894,29 @@ def describe_udb_log_package(self, req=None, **kwargs): return apis.DescribeUDBLogPackageResponseSchema().loads(resp) def describe_udb_param_group(self, req=None, **kwargs): - """ DescribeUDBParamGroup - 获取参数组详细参数信息 + """DescribeUDBParamGroup - 获取参数组详细参数信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - (Required) 分页显示的条目数，列表操作则指定 - **Offset** (int) - (Required) 分页显示的起始偏移，列表操作则指定 - **ClassType** (str) - 如果未指定GroupId，则可选是否选取特定DB类型的配置(sql, nosql, postgresql, sqlserver) - **GroupId** (int) - 参数组id，如果指定则获取描述，否则是列表操作，需要 指定Offset/Limit - **IsInUDBC** (bool) - 是否选取专区中配置 - **RegionFlag** (bool) - 当请求没有填写Zone时，如果指定为true，表示只拉取跨可用区的相关配置文件，否则，拉取所有机房的配置文件（包括每个单可用区和跨可用区） - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 见 **UDBParamGroupSet** 模型定义 - **TotalCount** (int) - 参数组总数，列表操作时才会有该参数 - + **Response Model** - - **UDBParamMemberSet** - + + **UDBParamMemberSet** + - **AllowedVal** (str) - 允许的值(根据参数类型，用分隔符表示) - **ApplyType** (int) - 参数值应用类型,取值范围为{0,10,20}，各值代表 意义为0-unknown、10-static、20-dynamic - **FormatType** (int) - 允许值的格式类型，取值范围为{0,10,20}，意义分 别为PVFT_UNKOWN=0,PVFT_RANGE=10, PVFT_ENUM=20 @@ -925,16 +925,16 @@ def describe_udb_param_group(self, req=None, **kwargs): - **Value** (str) - 参数值 - **ValueType** (int) - 参数值应用类型，取值范围为{0,10,20,30},各值 代表意义为 0-unknown、10-int、20-string、 30-bool - **UDBParamGroupSet** - + **UDBParamGroupSet** + - **DBTypeId** (str) - DB类型id，mysql/mongodb按版本细分各有一个id 目前id的取值范围为[1,7],数值对应的版本如下 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6 7：percona-5.6 - **Description** (str) - 参数组描述 - **GroupId** (int) - 参数组id - **GroupName** (str) - 参数组名称 - **Modifiable** (bool) - 参数组是否可修改 - **ParamMember** (list) - 见 **UDBParamMemberSet** 模型定义 - - **RegionFlag** (bool) - - - **Zone** (str) - + - **RegionFlag** (bool) - + - **Zone** (str) - """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} @@ -944,27 +944,27 @@ def describe_udb_param_group(self, req=None, **kwargs): return apis.DescribeUDBParamGroupResponseSchema().loads(resp) def describe_udb_type(self, req=None, **kwargs): - """ DescribeUDBType - 获取UDB支持的类型信息 + """DescribeUDBType - 获取UDB支持的类型信息 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - - **BackupZone** (str) - 跨可用区高可用DB的备库所在区域，仅当该可用区支持跨可用区高可用时填入。参见 `可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **BackupZone** (str) - 跨可用区高可用DB的备库所在区域，仅当该可用区支持跨可用区高可用时填入。参见 `可用区列表 `_ - **DBClusterType** (str) - DB实例类型，如mysql，sqlserver，mongo，postgresql - **DiskType** (str) - 返回支持某种磁盘类型的DB类型。如果没传，则表示任何磁盘类型均可。 - **InstanceMode** (str) - 返回支持某种实例类型的DB类型。如果没传，则表示任何实例类型均可。normal:单点,ha:高可用,sharded_cluster:分片集群 - + **Response** - **Action** (str) - 操作名称 - **DataSet** (list) - 见 **UDBTypeSet** 模型定义 - **RetCode** (int) - 返回码 - + **Response Model** - - **UDBTypeSet** - + + **UDBTypeSet** + - **DBTypeId** (str) - DB类型id，mysql/mongodb按版本细分各有一个id, 目前id的取值范围为[1,7],数值对应的版本如下： 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6， 7：percona-5.6 """ @@ -975,19 +975,19 @@ def describe_udb_type(self, req=None, **kwargs): return apis.DescribeUDBTypeResponseSchema().loads(resp) def edit_udb_backup_blacklist(self, req=None, **kwargs): - """ EditUDBBackupBlacklist - 编辑UDB实例的备份黑名单 + """EditUDBBackupBlacklist - 编辑UDB实例的备份黑名单 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Blacklist** (str) - (Required) 黑名单，规范示例,指定库mysql.%;test.%; 指定表city.address; - **DBId** (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -996,19 +996,19 @@ def edit_udb_backup_blacklist(self, req=None, **kwargs): return apis.EditUDBBackupBlacklistResponseSchema().loads(resp) def fetch_udb_instance_earliest_recover_time(self, req=None, **kwargs): - """ FetchUDBInstanceEarliestRecoverTime - 获取UDB最早可回档的时间点 + """FetchUDBInstanceEarliestRecoverTime - 获取UDB最早可回档的时间点 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) DB实例Id - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **EarliestTime** (int) - 获取最早可回档时间点 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1019,19 +1019,19 @@ def fetch_udb_instance_earliest_recover_time(self, req=None, **kwargs): ) def modify_udb_instance_name(self, req=None, **kwargs): - """ ModifyUDBInstanceName - 重命名UDB实例 + """ModifyUDBInstanceName - 重命名UDB实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取 - **Name** (str) - (Required) 实例的新名字, 长度要求为6~63位 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1040,20 +1040,20 @@ def modify_udb_instance_name(self, req=None, **kwargs): return apis.ModifyUDBInstanceNameResponseSchema().loads(resp) def modify_udb_instance_password(self, req=None, **kwargs): - """ ModifyUDBInstancePassword - 修改DB实例的管理员密码 + """ModifyUDBInstancePassword - 修改DB实例的管理员密码 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的ID,该值可以通过DescribeUDBInstance获取 - **Password** (str) - (Required) 实例的新密码 - **AccountName** (str) - sqlserver帐号，仅在sqlserver的情况下填该参数 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1062,17 +1062,17 @@ def modify_udb_instance_password(self, req=None, **kwargs): return apis.ModifyUDBInstancePasswordResponseSchema().loads(resp) def promote_udb_instance_to_ha(self, req=None, **kwargs): - """ PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本) + """PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本) **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1081,19 +1081,19 @@ def promote_udb_instance_to_ha(self, req=None, **kwargs): return apis.PromoteUDBInstanceToHAResponseSchema().loads(resp) def promote_udb_slave(self, req=None, **kwargs): - """ PromoteUDBSlave - 从库提升为独立库 + """PromoteUDBSlave - 从库提升为独立库 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取 - **IsForce** (bool) - 是否强制(如果从库落后可能会禁止提升)，默认false 如果落后情况下，强制提升丢失数据 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1102,12 +1102,12 @@ def promote_udb_slave(self, req=None, **kwargs): return apis.PromoteUDBSlaveResponseSchema().loads(resp) def resize_udb_instance(self, req=None, **kwargs): - """ ResizeUDBInstance - 修改（升级和降级）UDB实例的配置，包括内存和磁盘的配置，对于内存升级无需关闭实例，其他场景需要事先关闭实例。两套参数可以配置升降机：1.配置UseSSD和SSDType 2.配置InstanceType，不需要配置InstanceMode。这两套第二套参数的优先级更高 + """ResizeUDBInstance - 修改（升级和降级）UDB实例的配置，包括内存和磁盘的配置，对于内存升级无需关闭实例，其他场景需要事先关闭实例。两套参数可以配置升降机：1.配置UseSSD和SSDType 2.配置InstanceType，不需要配置InstanceMode。这两套第二套参数的优先级更高 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id - **DiskSpace** (int) - (Required) 磁盘空间(GB), 暂时支持20G-3000G - **MemoryLimit** (int) - (Required) 内存限制(MB)，目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/ 12000M/16000M/ 24000M/32000M/ 48000M/64000M/96000M。 @@ -1118,11 +1118,11 @@ def resize_udb_instance(self, req=None, **kwargs): - **StartAfterUpgrade** (bool) - DB关闭状态下升降级，升降级后是否启动DB，默认为false - **UDBCId** (str) - 专区的ID，如果有值表示专区中的DB配置升降级 - **UseSSD** (bool) - 是否使用SSD，默认为false - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1131,18 +1131,18 @@ def resize_udb_instance(self, req=None, **kwargs): return apis.ResizeUDBInstanceResponseSchema().loads(resp) def restart_udb_instance(self, req=None, **kwargs): - """ RestartUDBInstance - 重启UDB实例 + """RestartUDBInstance - 重启UDB实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1151,18 +1151,18 @@ def restart_udb_instance(self, req=None, **kwargs): return apis.RestartUDBInstanceResponseSchema().loads(resp) def start_udb_instance(self, req=None, **kwargs): - """ StartUDBInstance - 启动UDB实例 + """StartUDBInstance - 启动UDB实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1171,19 +1171,19 @@ def start_udb_instance(self, req=None, **kwargs): return apis.StartUDBInstanceResponseSchema().loads(resp) def stop_udb_instance(self, req=None, **kwargs): - """ StopUDBInstance - 关闭UDB实例 + """StopUDBInstance - 关闭UDB实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取 - **ForceToKill** (bool) - 是否使用强制手段关闭DB，默认是false - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1192,21 +1192,21 @@ def stop_udb_instance(self, req=None, **kwargs): return apis.StopUDBInstanceResponseSchema().loads(resp) def switch_udb_instance_to_ha(self, req=None, **kwargs): - """ SwitchUDBInstanceToHA - 普通UDB切换为高可用，原db状态为WaitForSwitch时，调用该api + """SwitchUDBInstanceToHA - 普通UDB切换为高可用，原db状态为WaitForSwitch时，调用该api **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取 - **ChargeType** (str) - Year， Month， Dynamic，Trial，不填则按现在单点计费执行 - **Quantity** (str) - 购买时长，需要和 ChargeType 搭配使用，否则使用单点计费策略的值 - **Tag** (str) - 业务组 - + **Response** - **DBId** (str) - 切换后高可用db实例的Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1215,22 +1215,22 @@ def switch_udb_instance_to_ha(self, req=None, **kwargs): return apis.SwitchUDBInstanceToHAResponseSchema().loads(resp) def update_udb_instance_backup_strategy(self, req=None, **kwargs): - """ UpdateUDBInstanceBackupStrategy - 修改UDB自动备份策略 + """UpdateUDBInstanceBackupStrategy - 修改UDB自动备份策略 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DBId** (str) - (Required) 主节点的Id - **BackupDate** (str) - 备份时期标记位。共7位，每一位为一周中一天的备份情况，0表示关闭当天备份，1表示打开当天备份。最右边的一位为星期天的备份开关，其余从右到左依次为星期一到星期六的备份配置开关，每周必须至少设置两天备份。例如：1100000表示打开星期六和星期五的备份功能 - **BackupMethod** (str) - 选择默认的备份方式，可选 snapshot 表示使用快照/物理备份，填 logic 表示使用逻辑备份。需要同时设置BackupDate字段。（注意现在只有SSD 版本的 MySQL实例支持物理备份） - **BackupTime** (int) - 备份的整点时间，范围[0,23] - **ForceDump** (bool) - 当导出某些数据遇到问题后，是否强制导出其他剩余数据默认是false需要同时设置BackupDate字段 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1239,20 +1239,20 @@ def update_udb_instance_backup_strategy(self, req=None, **kwargs): return apis.UpdateUDBInstanceBackupStrategyResponseSchema().loads(resp) def update_udb_instance_slave_backup_switch(self, req=None, **kwargs): - """ UpdateUDBInstanceSlaveBackupSwitch - 开启或者关闭UDB从库备份 + """UpdateUDBInstanceSlaveBackupSwitch - 开启或者关闭UDB从库备份 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupSwitch** (int) - (Required) 从库的备份开关，范围[0,1],0表示从库备份功能关闭,1 表示从库备份开关打开。 - **MasterDBId** (str) - (Required) 主库的Id - **SlaveDBId** (str) - 从库的Id,如果从库备份开关设定为打开，则必须赋值。 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1263,23 +1263,23 @@ def update_udb_instance_slave_backup_switch(self, req=None, **kwargs): ) def update_udb_param_group(self, req=None, **kwargs): - """ UpdateUDBParamGroup - 更新UDB配置参数项 + """UpdateUDBParamGroup - 更新UDB配置参数项 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (int) - (Required) 配置参数组id，使用DescribeUDBParamGroup获得 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **Description** (str) - 配置文件的描述，不传时认为不修改 - **Key** (str) - 参数名称（与Value配合使用） - **Name** (str) - 配置文件的名字，不传时认为不修改名字，传了则不能为空 - **RegionFlag** (bool) - 该配置文件是否是地域级别配置文件，默认是false - **Value** (str) - 参数值（与Key配合使用） - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -1288,24 +1288,24 @@ def update_udb_param_group(self, req=None, **kwargs): return apis.UpdateUDBParamGroupResponseSchema().loads(resp) def upload_udb_param_group(self, req=None, **kwargs): - """ UploadUDBParamGroup - 导入UDB配置 + """UploadUDBParamGroup - 导入UDB配置 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Content** (str) - (Required) 配置内容，导入的配置内容采用base64编码 - **DBTypeId** (str) - (Required) DB类型id，DB类型id，mysql/mongodb/postgesql按版本细分 1：mysql-5.1，2：mysql-5.5，3：percona-5.5，4：mysql-5.6，5：percona-5.6，6：mysql-5.7，7：percona-5.7，8：mariadb-10.0，9：mongodb-2.4，10：mongodb-2.6，11：mongodb-3.0，12：mongodb-3.2,13：postgresql-9.4，14：postgresql-9.6 - **Description** (str) - (Required) 参数组描述 - **GroupName** (str) - (Required) 配置参数组名称 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ParamGroupTypeId** (int) - 配置文件子类型 0-未知, 1-Shardsvr-MMAPv1, 2-Shardsvr-WiredTiger, 3-Configsvr-MMAPv1, 4-Configsvr-WiredTiger, 5-Mongos - **RegionFlag** (bool) - 该配置文件是否是地域级别配置文件，默认是false - + **Response** - **GroupId** (int) - 配置参数组id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/udb/schemas/apis.py b/ucloud/services/udb/schemas/apis.py index 77989f9..462f5ce 100644 --- a/ucloud/services/udb/schemas/apis.py +++ b/ucloud/services/udb/schemas/apis.py @@ -14,8 +14,7 @@ class BackupUDBInstanceRequestSchema(schema.RequestSchema): - """ BackupUDBInstance - 备份UDB实例 - """ + """BackupUDBInstance - 备份UDB实例""" fields = { "BackupMethod": fields.Str(required=False, dump_to="BackupMethod"), @@ -31,8 +30,7 @@ class BackupUDBInstanceRequestSchema(schema.RequestSchema): class BackupUDBInstanceResponseSchema(schema.ResponseSchema): - """ BackupUDBInstance - 备份UDB实例 - """ + """BackupUDBInstance - 备份UDB实例""" fields = {} @@ -45,8 +43,7 @@ class BackupUDBInstanceResponseSchema(schema.ResponseSchema): class BackupUDBInstanceBinlogRequestSchema(schema.RequestSchema): - """ BackupUDBInstanceBinlog - 备份UDB指定时间段的binlog列表 - """ + """BackupUDBInstanceBinlog - 备份UDB指定时间段的binlog列表""" fields = { "BackupFile": fields.Str(required=True, dump_to="BackupFile"), @@ -59,8 +56,7 @@ class BackupUDBInstanceBinlogRequestSchema(schema.RequestSchema): class BackupUDBInstanceBinlogResponseSchema(schema.ResponseSchema): - """ BackupUDBInstanceBinlog - 备份UDB指定时间段的binlog列表 - """ + """BackupUDBInstanceBinlog - 备份UDB指定时间段的binlog列表""" fields = {} @@ -73,8 +69,7 @@ class BackupUDBInstanceBinlogResponseSchema(schema.ResponseSchema): class BackupUDBInstanceErrorLogRequestSchema(schema.RequestSchema): - """ BackupUDBInstanceErrorLog - 备份UDB指定时间段的errorlog - """ + """BackupUDBInstanceErrorLog - 备份UDB指定时间段的errorlog""" fields = { "BackupName": fields.Str(required=True, dump_to="BackupName"), @@ -86,8 +81,7 @@ class BackupUDBInstanceErrorLogRequestSchema(schema.RequestSchema): class BackupUDBInstanceErrorLogResponseSchema(schema.ResponseSchema): - """ BackupUDBInstanceErrorLog - 备份UDB指定时间段的errorlog - """ + """BackupUDBInstanceErrorLog - 备份UDB指定时间段的errorlog""" fields = {} @@ -100,8 +94,7 @@ class BackupUDBInstanceErrorLogResponseSchema(schema.ResponseSchema): class BackupUDBInstanceSlowLogRequestSchema(schema.RequestSchema): - """ BackupUDBInstanceSlowLog - 备份UDB指定时间段的slowlog分析结果 - """ + """BackupUDBInstanceSlowLog - 备份UDB指定时间段的slowlog分析结果""" fields = { "BackupName": fields.Str(required=True, dump_to="BackupName"), @@ -114,8 +107,7 @@ class BackupUDBInstanceSlowLogRequestSchema(schema.RequestSchema): class BackupUDBInstanceSlowLogResponseSchema(schema.ResponseSchema): - """ BackupUDBInstanceSlowLog - 备份UDB指定时间段的slowlog分析结果 - """ + """BackupUDBInstanceSlowLog - 备份UDB指定时间段的slowlog分析结果""" fields = {} @@ -128,8 +120,7 @@ class BackupUDBInstanceSlowLogResponseSchema(schema.ResponseSchema): class CheckRecoverUDBInstanceRequestSchema(schema.RequestSchema): - """ CheckRecoverUDBInstance - 核查db是否可以使用回档功能 - """ + """CheckRecoverUDBInstance - 核查db是否可以使用回档功能""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -140,8 +131,7 @@ class CheckRecoverUDBInstanceRequestSchema(schema.RequestSchema): class CheckRecoverUDBInstanceResponseSchema(schema.ResponseSchema): - """ CheckRecoverUDBInstance - 核查db是否可以使用回档功能 - """ + """CheckRecoverUDBInstance - 核查db是否可以使用回档功能""" fields = { "LastestTime": fields.Int(required=False, load_from="LastestTime") @@ -156,8 +146,7 @@ class CheckRecoverUDBInstanceResponseSchema(schema.ResponseSchema): class CheckUDBInstanceToHAAllowanceRequestSchema(schema.RequestSchema): - """ CheckUDBInstanceToHAAllowance - 核查db是否可以升级为高可用 - """ + """CheckUDBInstanceToHAAllowance - 核查db是否可以升级为高可用""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -167,8 +156,7 @@ class CheckUDBInstanceToHAAllowanceRequestSchema(schema.RequestSchema): class CheckUDBInstanceToHAAllowanceResponseSchema(schema.ResponseSchema): - """ CheckUDBInstanceToHAAllowance - 核查db是否可以升级为高可用 - """ + """CheckUDBInstanceToHAAllowance - 核查db是否可以升级为高可用""" fields = {"Allowance": fields.Str(required=False, load_from="Allowance")} @@ -181,8 +169,7 @@ class CheckUDBInstanceToHAAllowanceResponseSchema(schema.ResponseSchema): class ClearUDBLogRequestSchema(schema.RequestSchema): - """ ClearUDBLog - 清除UDB实例的log - """ + """ClearUDBLog - 清除UDB实例的log""" fields = { "BeforeTime": fields.Int(required=False, dump_to="BeforeTime"), @@ -195,8 +182,7 @@ class ClearUDBLogRequestSchema(schema.RequestSchema): class ClearUDBLogResponseSchema(schema.ResponseSchema): - """ ClearUDBLog - 清除UDB实例的log - """ + """ClearUDBLog - 清除UDB实例的log""" fields = {} @@ -209,8 +195,7 @@ class ClearUDBLogResponseSchema(schema.ResponseSchema): class CreateUDBInstanceRequestSchema(schema.RequestSchema): - """ CreateUDBInstance - 创建UDB实例（包括创建mysql master节点、mongodb primary/configsvr节点和从备份恢复实例） - """ + """CreateUDBInstance - 创建UDB实例（包括创建mysql master节点、mongodb primary/configsvr节点和从备份恢复实例）""" fields = { "AdminPassword": fields.Str(required=True, dump_to="AdminPassword"), @@ -250,8 +235,7 @@ class CreateUDBInstanceRequestSchema(schema.RequestSchema): class CreateUDBInstanceResponseSchema(schema.ResponseSchema): - """ CreateUDBInstance - 创建UDB实例（包括创建mysql master节点、mongodb primary/configsvr节点和从备份恢复实例） - """ + """CreateUDBInstance - 创建UDB实例（包括创建mysql master节点、mongodb primary/configsvr节点和从备份恢复实例）""" fields = {"DBId": fields.Str(required=False, load_from="DBId")} @@ -264,8 +248,7 @@ class CreateUDBInstanceResponseSchema(schema.ResponseSchema): class CreateUDBInstanceByRecoveryRequestSchema(schema.RequestSchema): - """ CreateUDBInstanceByRecovery - 创建db，将新创建的db恢复到指定db某个指定时间点 - """ + """CreateUDBInstanceByRecovery - 创建db，将新创建的db恢复到指定db某个指定时间点""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -285,8 +268,7 @@ class CreateUDBInstanceByRecoveryRequestSchema(schema.RequestSchema): class CreateUDBInstanceByRecoveryResponseSchema(schema.ResponseSchema): - """ CreateUDBInstanceByRecovery - 创建db，将新创建的db恢复到指定db某个指定时间点 - """ + """CreateUDBInstanceByRecovery - 创建db，将新创建的db恢复到指定db某个指定时间点""" fields = {"DBId": fields.Str(required=False, load_from="DBId")} @@ -299,8 +281,7 @@ class CreateUDBInstanceByRecoveryResponseSchema(schema.ResponseSchema): class CreateUDBParamGroupRequestSchema(schema.RequestSchema): - """ CreateUDBParamGroup - 从已有配置文件创建新配置文件 - """ + """CreateUDBParamGroup - 从已有配置文件创建新配置文件""" fields = { "DBTypeId": fields.Str(required=True, dump_to="DBTypeId"), @@ -315,8 +296,7 @@ class CreateUDBParamGroupRequestSchema(schema.RequestSchema): class CreateUDBParamGroupResponseSchema(schema.ResponseSchema): - """ CreateUDBParamGroup - 从已有配置文件创建新配置文件 - """ + """CreateUDBParamGroup - 从已有配置文件创建新配置文件""" fields = {"GroupId": fields.Int(required=False, load_from="GroupId")} @@ -329,8 +309,7 @@ class CreateUDBParamGroupResponseSchema(schema.ResponseSchema): class CreateUDBReplicationInstanceRequestSchema(schema.RequestSchema): - """ CreateUDBReplicationInstance - 创建MongoDB的副本节点（包括仲裁） - """ + """CreateUDBReplicationInstance - 创建MongoDB的副本节点（包括仲裁）""" fields = { "CouponId": fields.Str(required=False, dump_to="CouponId"), @@ -346,8 +325,7 @@ class CreateUDBReplicationInstanceRequestSchema(schema.RequestSchema): class CreateUDBReplicationInstanceResponseSchema(schema.ResponseSchema): - """ CreateUDBReplicationInstance - 创建MongoDB的副本节点（包括仲裁） - """ + """CreateUDBReplicationInstance - 创建MongoDB的副本节点（包括仲裁）""" fields = {"DBId": fields.Str(required=False, load_from="DBId")} @@ -360,8 +338,7 @@ class CreateUDBReplicationInstanceResponseSchema(schema.ResponseSchema): class CreateUDBRouteInstanceRequestSchema(schema.RequestSchema): - """ CreateUDBRouteInstance - 创建mongos实例 - """ + """CreateUDBRouteInstance - 创建mongos实例""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -382,8 +359,7 @@ class CreateUDBRouteInstanceRequestSchema(schema.RequestSchema): class CreateUDBRouteInstanceResponseSchema(schema.ResponseSchema): - """ CreateUDBRouteInstance - 创建mongos实例 - """ + """CreateUDBRouteInstance - 创建mongos实例""" fields = {"DBId": fields.Str(required=False, load_from="DBId")} @@ -396,8 +372,7 @@ class CreateUDBRouteInstanceResponseSchema(schema.ResponseSchema): class CreateUDBSlaveRequestSchema(schema.RequestSchema): - """ CreateUDBSlave - 创建UDB实例的slave - """ + """CreateUDBSlave - 创建UDB实例的slave""" fields = { "CouponId": fields.Str(required=False, dump_to="CouponId"), @@ -418,8 +393,7 @@ class CreateUDBSlaveRequestSchema(schema.RequestSchema): class CreateUDBSlaveResponseSchema(schema.ResponseSchema): - """ CreateUDBSlave - 创建UDB实例的slave - """ + """CreateUDBSlave - 创建UDB实例的slave""" fields = {"DBId": fields.Str(required=False, load_from="DBId")} @@ -432,8 +406,7 @@ class CreateUDBSlaveResponseSchema(schema.ResponseSchema): class DeleteUDBBackupRequestSchema(schema.RequestSchema): - """ DeleteUDBBackup - 删除UDB实例备份 - """ + """DeleteUDBBackup - 删除UDB实例备份""" fields = { "BackupId": fields.Int(required=True, dump_to="BackupId"), @@ -445,8 +418,7 @@ class DeleteUDBBackupRequestSchema(schema.RequestSchema): class DeleteUDBBackupResponseSchema(schema.ResponseSchema): - """ DeleteUDBBackup - 删除UDB实例备份 - """ + """DeleteUDBBackup - 删除UDB实例备份""" fields = {} @@ -459,8 +431,7 @@ class DeleteUDBBackupResponseSchema(schema.ResponseSchema): class DeleteUDBInstanceRequestSchema(schema.RequestSchema): - """ DeleteUDBInstance - 删除UDB实例 - """ + """DeleteUDBInstance - 删除UDB实例""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -472,8 +443,7 @@ class DeleteUDBInstanceRequestSchema(schema.RequestSchema): class DeleteUDBInstanceResponseSchema(schema.ResponseSchema): - """ DeleteUDBInstance - 删除UDB实例 - """ + """DeleteUDBInstance - 删除UDB实例""" fields = {} @@ -486,8 +456,7 @@ class DeleteUDBInstanceResponseSchema(schema.ResponseSchema): class DeleteUDBLogPackageRequestSchema(schema.RequestSchema): - """ DeleteUDBLogPackage - 删除UDB日志包 - """ + """DeleteUDBLogPackage - 删除UDB日志包""" fields = { "BackupId": fields.Int(required=True, dump_to="BackupId"), @@ -499,8 +468,7 @@ class DeleteUDBLogPackageRequestSchema(schema.RequestSchema): class DeleteUDBLogPackageResponseSchema(schema.ResponseSchema): - """ DeleteUDBLogPackage - 删除UDB日志包 - """ + """DeleteUDBLogPackage - 删除UDB日志包""" fields = {} @@ -513,8 +481,7 @@ class DeleteUDBLogPackageResponseSchema(schema.ResponseSchema): class DeleteUDBParamGroupRequestSchema(schema.RequestSchema): - """ DeleteUDBParamGroup - 删除配置参数组 - """ + """DeleteUDBParamGroup - 删除配置参数组""" fields = { "GroupId": fields.Int(required=True, dump_to="GroupId"), @@ -526,8 +493,7 @@ class DeleteUDBParamGroupRequestSchema(schema.RequestSchema): class DeleteUDBParamGroupResponseSchema(schema.ResponseSchema): - """ DeleteUDBParamGroup - 删除配置参数组 - """ + """DeleteUDBParamGroup - 删除配置参数组""" fields = {} @@ -540,8 +506,7 @@ class DeleteUDBParamGroupResponseSchema(schema.ResponseSchema): class DescribeUDBBackupRequestSchema(schema.RequestSchema): - """ DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区，填代表单可用区 - """ + """DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区，填代表单可用区""" fields = { "BackupId": fields.Int(required=False, dump_to="BackupId"), @@ -559,8 +524,7 @@ class DescribeUDBBackupRequestSchema(schema.RequestSchema): class DescribeUDBBackupResponseSchema(schema.ResponseSchema): - """ DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区，填代表单可用区 - """ + """DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区，填代表单可用区""" fields = { "DataSet": fields.List( @@ -578,8 +542,7 @@ class DescribeUDBBackupResponseSchema(schema.ResponseSchema): class DescribeUDBBackupBlacklistRequestSchema(schema.RequestSchema): - """ DescribeUDBBackupBlacklist - 获取UDB实例的备份黑名单 - """ + """DescribeUDBBackupBlacklist - 获取UDB实例的备份黑名单""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -590,8 +553,7 @@ class DescribeUDBBackupBlacklistRequestSchema(schema.RequestSchema): class DescribeUDBBackupBlacklistResponseSchema(schema.ResponseSchema): - """ DescribeUDBBackupBlacklist - 获取UDB实例的备份黑名单 - """ + """DescribeUDBBackupBlacklist - 获取UDB实例的备份黑名单""" fields = {"Blacklist": fields.Str(required=False, load_from="Blacklist")} @@ -604,8 +566,7 @@ class DescribeUDBBackupBlacklistResponseSchema(schema.ResponseSchema): class DescribeUDBBinlogBackupURLRequestSchema(schema.RequestSchema): - """ DescribeUDBBinlogBackupURL - 获取UDB的Binlog备份地址 - """ + """DescribeUDBBinlogBackupURL - 获取UDB的Binlog备份地址""" fields = { "BackupId": fields.Int(required=True, dump_to="BackupId"), @@ -616,8 +577,7 @@ class DescribeUDBBinlogBackupURLRequestSchema(schema.RequestSchema): class DescribeUDBBinlogBackupURLResponseSchema(schema.ResponseSchema): - """ DescribeUDBBinlogBackupURL - 获取UDB的Binlog备份地址 - """ + """DescribeUDBBinlogBackupURL - 获取UDB的Binlog备份地址""" fields = { "BackupPath": fields.Str(required=False, load_from="BackupPath"), @@ -635,8 +595,7 @@ class DescribeUDBBinlogBackupURLResponseSchema(schema.ResponseSchema): class DescribeUDBInstanceRequestSchema(schema.RequestSchema): - """ DescribeUDBInstance - 获取UDB实例信息，支持两类操作：（1）指定DBId用于获取该db的信息；（2）指定ClassType、Offset、Limit用于列表操作，查询某一个类型db。 - """ + """DescribeUDBInstance - 获取UDB实例信息，支持两类操作：（1）指定DBId用于获取该db的信息；（2）指定ClassType、Offset、Limit用于列表操作，查询某一个类型db。""" fields = { "ClassType": fields.Str(required=False, dump_to="ClassType"), @@ -653,8 +612,7 @@ class DescribeUDBInstanceRequestSchema(schema.RequestSchema): class DescribeUDBInstanceResponseSchema(schema.ResponseSchema): - """ DescribeUDBInstance - 获取UDB实例信息，支持两类操作：（1）指定DBId用于获取该db的信息；（2）指定ClassType、Offset、Limit用于列表操作，查询某一个类型db。 - """ + """DescribeUDBInstance - 获取UDB实例信息，支持两类操作：（1）指定DBId用于获取该db的信息；（2）指定ClassType、Offset、Limit用于列表操作，查询某一个类型db。""" fields = { "DataSet": fields.List( @@ -672,8 +630,7 @@ class DescribeUDBInstanceResponseSchema(schema.ResponseSchema): class DescribeUDBInstanceBackupStateRequestSchema(schema.RequestSchema): - """ DescribeUDBInstanceBackupState - 获取UDB实例备份状态 - """ + """DescribeUDBInstanceBackupState - 获取UDB实例备份状态""" fields = { "BackupId": fields.Int(required=True, dump_to="BackupId"), @@ -685,8 +642,7 @@ class DescribeUDBInstanceBackupStateRequestSchema(schema.RequestSchema): class DescribeUDBInstanceBackupStateResponseSchema(schema.ResponseSchema): - """ DescribeUDBInstanceBackupState - 获取UDB实例备份状态 - """ + """DescribeUDBInstanceBackupState - 获取UDB实例备份状态""" fields = { "BackupEndTime": fields.Int(required=False, load_from="BackupEndTime"), @@ -703,8 +659,7 @@ class DescribeUDBInstanceBackupStateResponseSchema(schema.ResponseSchema): class DescribeUDBInstanceBackupURLRequestSchema(schema.RequestSchema): - """ DescribeUDBInstanceBackupURL - 获取UDB备份下载地址 - """ + """DescribeUDBInstanceBackupURL - 获取UDB备份下载地址""" fields = { "BackupId": fields.Int(required=True, dump_to="BackupId"), @@ -716,8 +671,7 @@ class DescribeUDBInstanceBackupURLRequestSchema(schema.RequestSchema): class DescribeUDBInstanceBackupURLResponseSchema(schema.ResponseSchema): - """ DescribeUDBInstanceBackupURL - 获取UDB备份下载地址 - """ + """DescribeUDBInstanceBackupURL - 获取UDB备份下载地址""" fields = { "BackupPath": fields.Str(required=False, load_from="BackupPath"), @@ -735,8 +689,7 @@ class DescribeUDBInstanceBackupURLResponseSchema(schema.ResponseSchema): class DescribeUDBInstanceBinlogRequestSchema(schema.RequestSchema): - """ DescribeUDBInstanceBinlog - 获取UDB指定时间段的binlog列表 - """ + """DescribeUDBInstanceBinlog - 获取UDB指定时间段的binlog列表""" fields = { "BeginTime": fields.Int(required=True, dump_to="BeginTime"), @@ -749,8 +702,7 @@ class DescribeUDBInstanceBinlogRequestSchema(schema.RequestSchema): class DescribeUDBInstanceBinlogResponseSchema(schema.ResponseSchema): - """ DescribeUDBInstanceBinlog - 获取UDB指定时间段的binlog列表 - """ + """DescribeUDBInstanceBinlog - 获取UDB指定时间段的binlog列表""" fields = { "DataSet": fields.List( @@ -769,8 +721,7 @@ class DescribeUDBInstanceBinlogResponseSchema(schema.ResponseSchema): class DescribeUDBInstanceBinlogBackupStateRequestSchema(schema.RequestSchema): - """ DescribeUDBInstanceBinlogBackupState - 获取udb实例备份状态 - """ + """DescribeUDBInstanceBinlogBackupState - 获取udb实例备份状态""" fields = { "BackupId": fields.Int(required=True, dump_to="BackupId"), @@ -782,8 +733,7 @@ class DescribeUDBInstanceBinlogBackupStateRequestSchema(schema.RequestSchema): class DescribeUDBInstanceBinlogBackupStateResponseSchema(schema.ResponseSchema): - """ DescribeUDBInstanceBinlogBackupState - 获取udb实例备份状态 - """ + """DescribeUDBInstanceBinlogBackupState - 获取udb实例备份状态""" fields = { "BackupSize": fields.Int(required=False, load_from="BackupSize"), @@ -799,8 +749,7 @@ class DescribeUDBInstanceBinlogBackupStateResponseSchema(schema.ResponseSchema): class DescribeUDBInstancePriceRequestSchema(schema.RequestSchema): - """ DescribeUDBInstancePrice - 获取UDB实例价格信息 - """ + """DescribeUDBInstancePrice - 获取UDB实例价格信息""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -818,8 +767,7 @@ class DescribeUDBInstancePriceRequestSchema(schema.RequestSchema): class DescribeUDBInstancePriceResponseSchema(schema.ResponseSchema): - """ DescribeUDBInstancePrice - 获取UDB实例价格信息 - """ + """DescribeUDBInstancePrice - 获取UDB实例价格信息""" fields = { "DataSet": fields.List( @@ -838,8 +786,7 @@ class DescribeUDBInstancePriceResponseSchema(schema.ResponseSchema): class DescribeUDBInstanceStateRequestSchema(schema.RequestSchema): - """ DescribeUDBInstanceState - 获取UDB实例状态 - """ + """DescribeUDBInstanceState - 获取UDB实例状态""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -850,8 +797,7 @@ class DescribeUDBInstanceStateRequestSchema(schema.RequestSchema): class DescribeUDBInstanceStateResponseSchema(schema.ResponseSchema): - """ DescribeUDBInstanceState - 获取UDB实例状态 - """ + """DescribeUDBInstanceState - 获取UDB实例状态""" fields = {"State": fields.Str(required=False, load_from="State")} @@ -864,8 +810,7 @@ class DescribeUDBInstanceStateResponseSchema(schema.ResponseSchema): class DescribeUDBInstanceUpgradePriceRequestSchema(schema.RequestSchema): - """ DescribeUDBInstanceUpgradePrice - 获取UDB实例升降级价格信息 - """ + """DescribeUDBInstanceUpgradePrice - 获取UDB实例升降级价格信息""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -880,8 +825,7 @@ class DescribeUDBInstanceUpgradePriceRequestSchema(schema.RequestSchema): class DescribeUDBInstanceUpgradePriceResponseSchema(schema.ResponseSchema): - """ DescribeUDBInstanceUpgradePrice - 获取UDB实例升降级价格信息 - """ + """DescribeUDBInstanceUpgradePrice - 获取UDB实例升降级价格信息""" fields = {"Price": fields.Int(required=False, load_from="Price")} @@ -894,8 +838,7 @@ class DescribeUDBInstanceUpgradePriceResponseSchema(schema.ResponseSchema): class DescribeUDBLogBackupURLRequestSchema(schema.RequestSchema): - """ DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址 - """ + """DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址""" fields = { "BackupId": fields.Int(required=True, dump_to="BackupId"), @@ -906,8 +849,7 @@ class DescribeUDBLogBackupURLRequestSchema(schema.RequestSchema): class DescribeUDBLogBackupURLResponseSchema(schema.ResponseSchema): - """ DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址 - """ + """DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址""" fields = { "BackupPath": fields.Str(required=False, load_from="BackupPath"), @@ -923,8 +865,7 @@ class DescribeUDBLogBackupURLResponseSchema(schema.ResponseSchema): class DescribeUDBLogPackageRequestSchema(schema.RequestSchema): - """ DescribeUDBLogPackage - 列表UDB实例binlog或slowlog或errorlog备份信息 - """ + """DescribeUDBLogPackage - 列表UDB实例binlog或slowlog或errorlog备份信息""" fields = { "BeginTime": fields.Int(required=False, dump_to="BeginTime"), @@ -941,8 +882,7 @@ class DescribeUDBLogPackageRequestSchema(schema.RequestSchema): class DescribeUDBLogPackageResponseSchema(schema.ResponseSchema): - """ DescribeUDBLogPackage - 列表UDB实例binlog或slowlog或errorlog备份信息 - """ + """DescribeUDBLogPackage - 列表UDB实例binlog或slowlog或errorlog备份信息""" fields = { "DataSet": fields.List( @@ -962,8 +902,7 @@ class DescribeUDBLogPackageResponseSchema(schema.ResponseSchema): class DescribeUDBParamGroupRequestSchema(schema.RequestSchema): - """ DescribeUDBParamGroup - 获取参数组详细参数信息 - """ + """DescribeUDBParamGroup - 获取参数组详细参数信息""" fields = { "ClassType": fields.Str(required=False, dump_to="ClassType"), @@ -979,8 +918,7 @@ class DescribeUDBParamGroupRequestSchema(schema.RequestSchema): class DescribeUDBParamGroupResponseSchema(schema.ResponseSchema): - """ DescribeUDBParamGroup - 获取参数组详细参数信息 - """ + """DescribeUDBParamGroup - 获取参数组详细参数信息""" fields = { "DataSet": fields.List( @@ -998,8 +936,7 @@ class DescribeUDBParamGroupResponseSchema(schema.ResponseSchema): class DescribeUDBTypeRequestSchema(schema.RequestSchema): - """ DescribeUDBType - 获取UDB支持的类型信息 - """ + """DescribeUDBType - 获取UDB支持的类型信息""" fields = { "BackupZone": fields.Str(required=False, dump_to="BackupZone"), @@ -1012,8 +949,7 @@ class DescribeUDBTypeRequestSchema(schema.RequestSchema): class DescribeUDBTypeResponseSchema(schema.ResponseSchema): - """ DescribeUDBType - 获取UDB支持的类型信息 - """ + """DescribeUDBType - 获取UDB支持的类型信息""" fields = { "Action": fields.Str(required=True, load_from="Action"), @@ -1032,8 +968,7 @@ class DescribeUDBTypeResponseSchema(schema.ResponseSchema): class EditUDBBackupBlacklistRequestSchema(schema.RequestSchema): - """ EditUDBBackupBlacklist - 编辑UDB实例的备份黑名单 - """ + """EditUDBBackupBlacklist - 编辑UDB实例的备份黑名单""" fields = { "Blacklist": fields.Str(required=True, dump_to="Blacklist"), @@ -1045,8 +980,7 @@ class EditUDBBackupBlacklistRequestSchema(schema.RequestSchema): class EditUDBBackupBlacklistResponseSchema(schema.ResponseSchema): - """ EditUDBBackupBlacklist - 编辑UDB实例的备份黑名单 - """ + """EditUDBBackupBlacklist - 编辑UDB实例的备份黑名单""" fields = {} @@ -1059,8 +993,7 @@ class EditUDBBackupBlacklistResponseSchema(schema.ResponseSchema): class FetchUDBInstanceEarliestRecoverTimeRequestSchema(schema.RequestSchema): - """ FetchUDBInstanceEarliestRecoverTime - 获取UDB最早可回档的时间点 - """ + """FetchUDBInstanceEarliestRecoverTime - 获取UDB最早可回档的时间点""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -1071,8 +1004,7 @@ class FetchUDBInstanceEarliestRecoverTimeRequestSchema(schema.RequestSchema): class FetchUDBInstanceEarliestRecoverTimeResponseSchema(schema.ResponseSchema): - """ FetchUDBInstanceEarliestRecoverTime - 获取UDB最早可回档的时间点 - """ + """FetchUDBInstanceEarliestRecoverTime - 获取UDB最早可回档的时间点""" fields = { "EarliestTime": fields.Int(required=False, load_from="EarliestTime") @@ -1087,8 +1019,7 @@ class FetchUDBInstanceEarliestRecoverTimeResponseSchema(schema.ResponseSchema): class ModifyUDBInstanceNameRequestSchema(schema.RequestSchema): - """ ModifyUDBInstanceName - 重命名UDB实例 - """ + """ModifyUDBInstanceName - 重命名UDB实例""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -1100,8 +1031,7 @@ class ModifyUDBInstanceNameRequestSchema(schema.RequestSchema): class ModifyUDBInstanceNameResponseSchema(schema.ResponseSchema): - """ ModifyUDBInstanceName - 重命名UDB实例 - """ + """ModifyUDBInstanceName - 重命名UDB实例""" fields = {} @@ -1114,8 +1044,7 @@ class ModifyUDBInstanceNameResponseSchema(schema.ResponseSchema): class ModifyUDBInstancePasswordRequestSchema(schema.RequestSchema): - """ ModifyUDBInstancePassword - 修改DB实例的管理员密码 - """ + """ModifyUDBInstancePassword - 修改DB实例的管理员密码""" fields = { "AccountName": fields.Str(required=False, dump_to="AccountName"), @@ -1128,8 +1057,7 @@ class ModifyUDBInstancePasswordRequestSchema(schema.RequestSchema): class ModifyUDBInstancePasswordResponseSchema(schema.ResponseSchema): - """ ModifyUDBInstancePassword - 修改DB实例的管理员密码 - """ + """ModifyUDBInstancePassword - 修改DB实例的管理员密码""" fields = {} @@ -1142,8 +1070,7 @@ class ModifyUDBInstancePasswordResponseSchema(schema.ResponseSchema): class PromoteUDBInstanceToHARequestSchema(schema.RequestSchema): - """ PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本) - """ + """PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本)""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -1153,8 +1080,7 @@ class PromoteUDBInstanceToHARequestSchema(schema.RequestSchema): class PromoteUDBInstanceToHAResponseSchema(schema.ResponseSchema): - """ PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本) - """ + """PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本)""" fields = {} @@ -1167,8 +1093,7 @@ class PromoteUDBInstanceToHAResponseSchema(schema.ResponseSchema): class PromoteUDBSlaveRequestSchema(schema.RequestSchema): - """ PromoteUDBSlave - 从库提升为独立库 - """ + """PromoteUDBSlave - 从库提升为独立库""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -1180,8 +1105,7 @@ class PromoteUDBSlaveRequestSchema(schema.RequestSchema): class PromoteUDBSlaveResponseSchema(schema.ResponseSchema): - """ PromoteUDBSlave - 从库提升为独立库 - """ + """PromoteUDBSlave - 从库提升为独立库""" fields = {} @@ -1194,8 +1118,7 @@ class PromoteUDBSlaveResponseSchema(schema.ResponseSchema): class ResizeUDBInstanceRequestSchema(schema.RequestSchema): - """ ResizeUDBInstance - 修改（升级和降级）UDB实例的配置，包括内存和磁盘的配置，对于内存升级无需关闭实例，其他场景需要事先关闭实例。两套参数可以配置升降机：1.配置UseSSD和SSDType 2.配置InstanceType，不需要配置InstanceMode。这两套第二套参数的优先级更高 - """ + """ResizeUDBInstance - 修改（升级和降级）UDB实例的配置，包括内存和磁盘的配置，对于内存升级无需关闭实例，其他场景需要事先关闭实例。两套参数可以配置升降机：1.配置UseSSD和SSDType 2.配置InstanceType，不需要配置InstanceMode。这两套第二套参数的优先级更高""" fields = { "CouponId": fields.Str(required=False, dump_to="CouponId"), @@ -1217,8 +1140,7 @@ class ResizeUDBInstanceRequestSchema(schema.RequestSchema): class ResizeUDBInstanceResponseSchema(schema.ResponseSchema): - """ ResizeUDBInstance - 修改（升级和降级）UDB实例的配置，包括内存和磁盘的配置，对于内存升级无需关闭实例，其他场景需要事先关闭实例。两套参数可以配置升降机：1.配置UseSSD和SSDType 2.配置InstanceType，不需要配置InstanceMode。这两套第二套参数的优先级更高 - """ + """ResizeUDBInstance - 修改（升级和降级）UDB实例的配置，包括内存和磁盘的配置，对于内存升级无需关闭实例，其他场景需要事先关闭实例。两套参数可以配置升降机：1.配置UseSSD和SSDType 2.配置InstanceType，不需要配置InstanceMode。这两套第二套参数的优先级更高""" fields = {} @@ -1231,8 +1153,7 @@ class ResizeUDBInstanceResponseSchema(schema.ResponseSchema): class RestartUDBInstanceRequestSchema(schema.RequestSchema): - """ RestartUDBInstance - 重启UDB实例 - """ + """RestartUDBInstance - 重启UDB实例""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -1243,8 +1164,7 @@ class RestartUDBInstanceRequestSchema(schema.RequestSchema): class RestartUDBInstanceResponseSchema(schema.ResponseSchema): - """ RestartUDBInstance - 重启UDB实例 - """ + """RestartUDBInstance - 重启UDB实例""" fields = {} @@ -1257,8 +1177,7 @@ class RestartUDBInstanceResponseSchema(schema.ResponseSchema): class StartUDBInstanceRequestSchema(schema.RequestSchema): - """ StartUDBInstance - 启动UDB实例 - """ + """StartUDBInstance - 启动UDB实例""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -1269,8 +1188,7 @@ class StartUDBInstanceRequestSchema(schema.RequestSchema): class StartUDBInstanceResponseSchema(schema.ResponseSchema): - """ StartUDBInstance - 启动UDB实例 - """ + """StartUDBInstance - 启动UDB实例""" fields = {} @@ -1283,8 +1201,7 @@ class StartUDBInstanceResponseSchema(schema.ResponseSchema): class StopUDBInstanceRequestSchema(schema.RequestSchema): - """ StopUDBInstance - 关闭UDB实例 - """ + """StopUDBInstance - 关闭UDB实例""" fields = { "DBId": fields.Str(required=True, dump_to="DBId"), @@ -1296,8 +1213,7 @@ class StopUDBInstanceRequestSchema(schema.RequestSchema): class StopUDBInstanceResponseSchema(schema.ResponseSchema): - """ StopUDBInstance - 关闭UDB实例 - """ + """StopUDBInstance - 关闭UDB实例""" fields = {} @@ -1310,8 +1226,7 @@ class StopUDBInstanceResponseSchema(schema.ResponseSchema): class SwitchUDBInstanceToHARequestSchema(schema.RequestSchema): - """ SwitchUDBInstanceToHA - 普通UDB切换为高可用，原db状态为WaitForSwitch时，调用该api - """ + """SwitchUDBInstanceToHA - 普通UDB切换为高可用，原db状态为WaitForSwitch时，调用该api""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -1324,8 +1239,7 @@ class SwitchUDBInstanceToHARequestSchema(schema.RequestSchema): class SwitchUDBInstanceToHAResponseSchema(schema.ResponseSchema): - """ SwitchUDBInstanceToHA - 普通UDB切换为高可用，原db状态为WaitForSwitch时，调用该api - """ + """SwitchUDBInstanceToHA - 普通UDB切换为高可用，原db状态为WaitForSwitch时，调用该api""" fields = {"DBId": fields.Str(required=False, load_from="DBId")} @@ -1338,8 +1252,7 @@ class SwitchUDBInstanceToHAResponseSchema(schema.ResponseSchema): class UpdateUDBInstanceBackupStrategyRequestSchema(schema.RequestSchema): - """ UpdateUDBInstanceBackupStrategy - 修改UDB自动备份策略 - """ + """UpdateUDBInstanceBackupStrategy - 修改UDB自动备份策略""" fields = { "BackupDate": fields.Str(required=False, dump_to="BackupDate"), @@ -1354,8 +1267,7 @@ class UpdateUDBInstanceBackupStrategyRequestSchema(schema.RequestSchema): class UpdateUDBInstanceBackupStrategyResponseSchema(schema.ResponseSchema): - """ UpdateUDBInstanceBackupStrategy - 修改UDB自动备份策略 - """ + """UpdateUDBInstanceBackupStrategy - 修改UDB自动备份策略""" fields = {} @@ -1368,8 +1280,7 @@ class UpdateUDBInstanceBackupStrategyResponseSchema(schema.ResponseSchema): class UpdateUDBInstanceSlaveBackupSwitchRequestSchema(schema.RequestSchema): - """ UpdateUDBInstanceSlaveBackupSwitch - 开启或者关闭UDB从库备份 - """ + """UpdateUDBInstanceSlaveBackupSwitch - 开启或者关闭UDB从库备份""" fields = { "BackupSwitch": fields.Int(required=True, dump_to="BackupSwitch"), @@ -1382,8 +1293,7 @@ class UpdateUDBInstanceSlaveBackupSwitchRequestSchema(schema.RequestSchema): class UpdateUDBInstanceSlaveBackupSwitchResponseSchema(schema.ResponseSchema): - """ UpdateUDBInstanceSlaveBackupSwitch - 开启或者关闭UDB从库备份 - """ + """UpdateUDBInstanceSlaveBackupSwitch - 开启或者关闭UDB从库备份""" fields = {} @@ -1396,8 +1306,7 @@ class UpdateUDBInstanceSlaveBackupSwitchResponseSchema(schema.ResponseSchema): class UpdateUDBParamGroupRequestSchema(schema.RequestSchema): - """ UpdateUDBParamGroup - 更新UDB配置参数项 - """ + """UpdateUDBParamGroup - 更新UDB配置参数项""" fields = { "Description": fields.Str(required=False, dump_to="Description"), @@ -1413,8 +1322,7 @@ class UpdateUDBParamGroupRequestSchema(schema.RequestSchema): class UpdateUDBParamGroupResponseSchema(schema.ResponseSchema): - """ UpdateUDBParamGroup - 更新UDB配置参数项 - """ + """UpdateUDBParamGroup - 更新UDB配置参数项""" fields = {} @@ -1427,8 +1335,7 @@ class UpdateUDBParamGroupResponseSchema(schema.ResponseSchema): class UploadUDBParamGroupRequestSchema(schema.RequestSchema): - """ UploadUDBParamGroup - 导入UDB配置 - """ + """UploadUDBParamGroup - 导入UDB配置""" fields = { "Content": fields.Str(required=True, dump_to="Content"), @@ -1446,7 +1353,6 @@ class UploadUDBParamGroupRequestSchema(schema.RequestSchema): class UploadUDBParamGroupResponseSchema(schema.ResponseSchema): - """ UploadUDBParamGroup - 导入UDB配置 - """ + """UploadUDBParamGroup - 导入UDB配置""" fields = {"GroupId": fields.Int(required=False, load_from="GroupId")} diff --git a/ucloud/services/udb/schemas/models.py b/ucloud/services/udb/schemas/models.py index 9bdea0b..3f0dfb4 100644 --- a/ucloud/services/udb/schemas/models.py +++ b/ucloud/services/udb/schemas/models.py @@ -5,8 +5,7 @@ class UDBBackupSetSchema(schema.ResponseSchema): - """ UDBBackupSet - DescribeUDBBackup - """ + """UDBBackupSet - DescribeUDBBackup""" fields = { "BackupEndTime": fields.Int(required=False, load_from="BackupEndTime"), @@ -25,8 +24,7 @@ class UDBBackupSetSchema(schema.ResponseSchema): class UDBSlaveInstanceSetSchema(schema.ResponseSchema): - """ UDBSlaveInstanceSet - DescribeUDBSlaveInstance - """ + """UDBSlaveInstanceSet - DescribeUDBSlaveInstance""" fields = { "AdminUser": fields.Str(required=False, load_from="AdminUser"), @@ -79,8 +77,7 @@ class UDBSlaveInstanceSetSchema(schema.ResponseSchema): class UDBInstanceSetSchema(schema.ResponseSchema): - """ UDBInstanceSet - DescribeUDBInstance - """ + """UDBInstanceSet - DescribeUDBInstance""" fields = { "AdminUser": fields.Str(required=False, load_from="AdminUser"), @@ -135,8 +132,7 @@ class UDBInstanceSetSchema(schema.ResponseSchema): class UDBInstanceBinlogSetSchema(schema.ResponseSchema): - """ UDBInstanceBinlogSet - DescribeUDBInstanceBinlog - """ + """UDBInstanceBinlogSet - DescribeUDBInstanceBinlog""" fields = { "BeginTime": fields.Int(required=False, load_from="BeginTime"), @@ -147,8 +143,7 @@ class UDBInstanceBinlogSetSchema(schema.ResponseSchema): class UDBInstancePriceSetSchema(schema.ResponseSchema): - """ UDBInstancePriceSet - DescribeUDBInstancePrice - """ + """UDBInstancePriceSet - DescribeUDBInstancePrice""" fields = { "ChargeType": fields.Str(required=False, load_from="ChargeType"), @@ -157,8 +152,7 @@ class UDBInstancePriceSetSchema(schema.ResponseSchema): class LogPackageDataSetSchema(schema.ResponseSchema): - """ LogPackageDataSet - DescribeUDBLogPackage - """ + """LogPackageDataSet - DescribeUDBLogPackage""" fields = { "BackupId": fields.Int(required=False, load_from="BackupId"), @@ -175,8 +169,7 @@ class LogPackageDataSetSchema(schema.ResponseSchema): class UDBParamMemberSetSchema(schema.ResponseSchema): - """ UDBParamMemberSet - DescribeUDBParamGroup - """ + """UDBParamMemberSet - DescribeUDBParamGroup""" fields = { "AllowedVal": fields.Str(required=False, load_from="AllowedVal"), @@ -190,8 +183,7 @@ class UDBParamMemberSetSchema(schema.ResponseSchema): class UDBParamGroupSetSchema(schema.ResponseSchema): - """ UDBParamGroupSet - DescribeUDBParamGroup - """ + """UDBParamGroupSet - DescribeUDBParamGroup""" fields = { "DBTypeId": fields.Str(required=False, load_from="DBTypeId"), @@ -206,7 +198,6 @@ class UDBParamGroupSetSchema(schema.ResponseSchema): class UDBTypeSetSchema(schema.ResponseSchema): - """ UDBTypeSet - DescribeUDBType - """ + """UDBTypeSet - DescribeUDBType""" fields = {"DBTypeId": fields.Str(required=False, load_from="DBTypeId")} diff --git a/ucloud/services/udisk/client.py b/ucloud/services/udisk/client.py index 8b836d4..d0c1d06 100644 --- a/ucloud/services/udisk/client.py +++ b/ucloud/services/udisk/client.py @@ -10,22 +10,22 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(UDiskClient, self).__init__(config, transport, middleware, logger) def attach_udisk(self, req=None, **kwargs): - """ AttachUDisk - 将一个可用的UDisk挂载到某台主机上，当UDisk挂载成功后，还需要在主机内部进行文件系统操作 + """AttachUDisk - 将一个可用的UDisk挂载到某台主机上，当UDisk挂载成功后，还需要在主机内部进行文件系统操作 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **UDiskId** (str) - (Required) 需要挂载的UDisk实例ID. - **UHostId** (str) - (Required) UHost实例ID - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **MultiAttach** (str) - 是否允许多点挂载（Yes: 允许多点挂载， No: 不允许多点挂载， 不填默认Yes ） - + **Response** - **UDiskId** (str) - 挂载的UDisk实例ID - **UHostId** (str) - 挂载的UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -34,25 +34,25 @@ def attach_udisk(self, req=None, **kwargs): return apis.AttachUDiskResponseSchema().loads(resp) def clone_udisk(self, req=None, **kwargs): - """ CloneUDisk - 从UDisk创建UDisk克隆 + """CloneUDisk - 从UDisk创建UDisk克隆 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 实例名称 - **SourceId** (str) - (Required) 克隆父Disk的Id - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - Year , Month, Dynamic，Postpay 默认: Dynamic - **Comment** (str) - Disk注释 - **CouponId** (str) - 使用的代金券id - **Quantity** (int) - 购买时长 默认: 1 - **UDataArkMode** (str) - 方舟是否开启，"Yes":开启，"No":关闭；默认为"No" - + **Response** - **UDiskId** (list) - 创建UDisk Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -62,26 +62,26 @@ def clone_udisk(self, req=None, **kwargs): return apis.CloneUDiskResponseSchema().loads(resp) def clone_udisk_snapshot(self, req=None, **kwargs): - """ CloneUDiskSnapshot - 从快照创建UDisk克隆 + """CloneUDiskSnapshot - 从快照创建UDisk克隆 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 实例名称 - **Size** (int) - (Required) 购买UDisk大小,单位:GB,范围[1~2000], 权限位控制可达8T,若需要请申请开通相关权限。 - **SourceId** (str) - (Required) 克隆父Snapshot的Id - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - Year , Month, Dynamic，Postpay 默认: Dynamic - **Comment** (str) - Disk注释 - **CouponId** (str) - 使用的代金券id - **Quantity** (int) - 购买时长 默认: 1 - **UDataArkMode** (str) - 是否开启数据方舟 默认:No - + **Response** - **UDiskId** (list) - 创建UDisk Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -91,15 +91,15 @@ def clone_udisk_snapshot(self, req=None, **kwargs): return apis.CloneUDiskSnapshotResponseSchema().loads(resp) def create_udisk(self, req=None, **kwargs): - """ CreateUDisk - 创建UDisk磁盘 + """CreateUDisk - 创建UDisk磁盘 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 实例名称 - **Size** (int) - (Required) 购买UDisk大小,单位:GB,普通盘: 范围[1~2000], 权限位控制可达8T,若需要请申请开通相关权限;SSD盘： 范围[1~4000]。 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - Year , Month, Dynamic, Postpay, Trial 默认: Dynamic - **CmkId** (str) - 加密需要的cmk id，UKmsMode为Yes时，必填 - **CouponId** (str) - 使用的代金券id @@ -108,11 +108,11 @@ def create_udisk(self, req=None, **kwargs): - **Tag** (str) - 业务组 默认：Default - **UDataArkMode** (str) - 是否开启数据方舟 - **UKmsMode** (str) - 是否加密。Yes：加密，No：不加密，默认值（No） - + **Response** - **UDiskId** (list) - UDisk实例Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -122,23 +122,23 @@ def create_udisk(self, req=None, **kwargs): return apis.CreateUDiskResponseSchema().loads(resp) def create_udisk_snapshot(self, req=None, **kwargs): - """ CreateUDiskSnapshot - 创建snapshot快照 + """CreateUDiskSnapshot - 创建snapshot快照 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 快照名称 - **UDiskId** (str) - (Required) 快照的UDisk的Id - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - Year , Month, Dynamic 默认: Dynamic - **Comment** (str) - 快照描述 - **Quantity** (int) - 购买时长 默认: 1 - + **Response** - **SnapshotId** (list) - 快照Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -148,18 +148,18 @@ def create_udisk_snapshot(self, req=None, **kwargs): return apis.CreateUDiskSnapshotResponseSchema().loads(resp) def delete_udisk(self, req=None, **kwargs): - """ DeleteUDisk - 删除UDisk + """DeleteUDisk - 删除UDisk **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **UDiskId** (str) - (Required) 要删除的UDisk的Id - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -168,19 +168,19 @@ def delete_udisk(self, req=None, **kwargs): return apis.DeleteUDiskResponseSchema().loads(resp) def delete_udisk_snapshot(self, req=None, **kwargs): - """ DeleteUDiskSnapshot - 删除Snapshot + """DeleteUDiskSnapshot - 删除Snapshot **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **SnapshotId** (str) - 快照Id(填写后不能填写UDisk Id) - **UDiskId** (str) - UDisk Id,删除该盘所创建出来的所有快照(填写后不能填写SnapshotId) - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -189,29 +189,29 @@ def delete_udisk_snapshot(self, req=None, **kwargs): return apis.DeleteUDiskSnapshotResponseSchema().loads(resp) def describe_udisk(self, req=None, **kwargs): - """ DescribeUDisk - 获取UDisk实例 + """DescribeUDisk - 获取UDisk实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DiskType** (str) - ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:"CLOUD_NORMAL",IsBoot:"False"； 普通系统盘：DiskType:"CLOUD_NORMAL",IsBoot:"True"；SSD数据盘：DiskType:"CLOUD_SSD",IsBoot:"False"；SSD系统盘：DiskType:"CLOUD_SSD",IsBoot:"True"；RSSD数据盘：DiskType:"CLOUD_RSSD",IsBoot:"False"；为空拉取所有。ProtocolVersion字段为0或没有该字段时，可设为以下几个值:普通数据盘：DataDisk；普通系统盘；SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk；为空拉取所有。 - **IsBoot** (str) - ProtocolVersion字段为1且DiskType不为空时，必须设置，设置规则请参照DiskType；ProtocolVersion字段为1且DiskType为空时，该字段无效。ProtocolVersion字段为0或没有该字段时，该字段无效。 - **Limit** (int) - 返回数据长度, 默认为20 - **Offset** (int) - 数据偏移量, 默认为0 - **ProtocolVersion** (int) - 请求协议版本，建议升级为1，为1时DiskType与UHost磁盘类型定义一致；默认为0 - **UDiskId** (str) - UDisk Id(留空返回全部) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 见 **UDiskDataSet** 模型定义 - **TotalCount** (int) - 根据过滤条件得到的总数 - + **Response Model** - - **UDiskDataSet** - + + **UDiskDataSet** + - **ArkSwitchEnable** (int) - 是否支持开启方舟，1支持 ，0不支持 - **ChargeType** (str) - Year,Month,Dynamic,Trial,Postpay - **CloneEnable** (int) - 是否支持克隆，1支持 ，0不支持 @@ -249,27 +249,27 @@ def describe_udisk(self, req=None, **kwargs): return apis.DescribeUDiskResponseSchema().loads(resp) def describe_udisk_price(self, req=None, **kwargs): - """ DescribeUDiskPrice - 获取UDisk实例价格信息 + """DescribeUDiskPrice - 获取UDisk实例价格信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 购买UDisk大小,单位:GB,范围[1~1000] - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - Year， Month， Dynamic，Trial，默认: Dynamic - **DiskType** (str) - UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），SystemDisk（普通系统盘），SSDSystemDisk（SSD系统盘），RSSDDataDisk（RSSD数据盘），默认值（DataDisk） - **Quantity** (int) - 购买UDisk的时长，默认值为1 - **UDataArkMode** (str) - 是否打开数据方舟, 打开"Yes",关闭"No", 默认关闭 - + **Response** - **DataSet** (list) - 见 **UDiskPriceDataSet** 模型定义 - + **Response Model** - - **UDiskPriceDataSet** - + + **UDiskPriceDataSet** + - **ChargeName** (str) - "UDataArk","UDisk" - **ChargeType** (str) - Year， Month， Dynamic，Trial - **OriginalPrice** (int) - 用户折后价 @@ -283,27 +283,27 @@ def describe_udisk_price(self, req=None, **kwargs): return apis.DescribeUDiskPriceResponseSchema().loads(resp) def describe_udisk_snapshot(self, req=None, **kwargs): - """ DescribeUDiskSnapshot - 获取UDisk快照 + """DescribeUDiskSnapshot - 获取UDisk快照 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - 返回数据长度, 默认为20 - **Offset** (int) - 数据偏移量, 默认为0 - **SnapshotId** (str) - 快照id，SnapshotId , UDiskId 同时传SnapshotId优先 - **UDiskId** (str) - UDiskId,返回该盘所做快照.(必须同时传Zone) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 见 **UDiskSnapshotSet** 模型定义 - **TotalCount** (int) - 根据过滤条件得到的总数 - + **Response Model** - - **UDiskSnapshotSet** - + + **UDiskSnapshotSet** + - **CmkId** (str) - 该快照的cmk id - **CmkIdAlias** (str) - cmk id 别名 - **CmkIdStatus** (str) - 该快照cmk的状态, Enabled(正常)，Disabled(失效)，Deleted(删除)，NoCmkId(非加密盘) @@ -331,23 +331,23 @@ def describe_udisk_snapshot(self, req=None, **kwargs): return apis.DescribeUDiskSnapshotResponseSchema().loads(resp) def describe_udisk_upgrade_price(self, req=None, **kwargs): - """ DescribeUDiskUpgradePrice - 获取UDisk升级价格信息 + """DescribeUDiskUpgradePrice - 获取UDisk升级价格信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 购买UDisk大小,单位:GB,范围[1~2000], 权限位控制可达8T,若需要请申请开通相关权限。 - **SourceId** (str) - (Required) 升级目标UDisk ID - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **DiskType** (str) - 磁盘类型，SSDDataDisk:ssd数据盘,DataDisk:普通数据盘,SystemDisk:普通系统盘,SSDSystemDisk:ssd系统盘。默认为DataDisk - **UDataArkMode** (str) - 是否打开数据方舟, 打开"Yes",关闭"No", 默认关闭 - + **Response** - **OriginalPrice** (int) - 用户折后价 - **Price** (int) - 价格 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -356,21 +356,21 @@ def describe_udisk_upgrade_price(self, req=None, **kwargs): return apis.DescribeUDiskUpgradePriceResponseSchema().loads(resp) def detach_udisk(self, req=None, **kwargs): - """ DetachUDisk - 卸载某个已经挂载在指定UHost实例上的UDisk + """DetachUDisk - 卸载某个已经挂载在指定UHost实例上的UDisk **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **UDiskId** (str) - (Required) 需要卸载的UDisk实例ID - **UHostId** (str) - (Required) UHost实例ID - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + **Response** - **UDiskId** (str) - 卸载的UDisk实例ID - **UHostId** (str) - 卸载的UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -379,19 +379,19 @@ def detach_udisk(self, req=None, **kwargs): return apis.DetachUDiskResponseSchema().loads(resp) def rename_udisk(self, req=None, **kwargs): - """ RenameUDisk - 重命名UDisk + """RenameUDisk - 重命名UDisk **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **UDiskId** (str) - (Required) 重命名的UDisk的Id - **UDiskName** (str) - (Required) 重命名UDisk的name - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -400,20 +400,20 @@ def rename_udisk(self, req=None, **kwargs): return apis.RenameUDiskResponseSchema().loads(resp) def resize_udisk(self, req=None, **kwargs): - """ ResizeUDisk - 调整UDisk容量 + """ResizeUDisk - 调整UDisk容量 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 调整后大小, 单位:GB, 范围[1~2000],权限位控制可达8000,若需要请申请开通相关权限。 - **UDiskId** (str) - (Required) UDisk Id - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **CouponId** (str) - 使用的代金券id - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -422,20 +422,20 @@ def resize_udisk(self, req=None, **kwargs): return apis.ResizeUDiskResponseSchema().loads(resp) def restore_udisk(self, req=None, **kwargs): - """ RestoreUDisk - 从备份恢复数据至UDisk + """RestoreUDisk - 从备份恢复数据至UDisk **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **UDiskId** (str) - (Required) 需要恢复的盘id - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **SnapshotId** (str) - 从指定的快照恢复 - **SnapshotTime** (int) - 指定从方舟恢复的备份时间点 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -444,19 +444,19 @@ def restore_udisk(self, req=None, **kwargs): return apis.RestoreUDiskResponseSchema().loads(resp) def set_udisk__udataark_mode(self, req=None, **kwargs): - """ SetUDiskUDataArkMode - 设置UDisk数据方舟的状态 + """SetUDiskUDataArkMode - 设置UDisk数据方舟的状态 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **UDataArkMode** (str) - (Required) 是否开启数据方舟，开启:"Yes", 不支持:"No" - **UDiskId** (str) - (Required) 需要设置数据方舟的UDisk的Id - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/udisk/schemas/apis.py b/ucloud/services/udisk/schemas/apis.py index 522eb6a..438aa5c 100644 --- a/ucloud/services/udisk/schemas/apis.py +++ b/ucloud/services/udisk/schemas/apis.py @@ -14,8 +14,7 @@ class AttachUDiskRequestSchema(schema.RequestSchema): - """ AttachUDisk - 将一个可用的UDisk挂载到某台主机上，当UDisk挂载成功后，还需要在主机内部进行文件系统操作 - """ + """AttachUDisk - 将一个可用的UDisk挂载到某台主机上，当UDisk挂载成功后，还需要在主机内部进行文件系统操作""" fields = { "MultiAttach": fields.Str(required=False, dump_to="MultiAttach"), @@ -28,8 +27,7 @@ class AttachUDiskRequestSchema(schema.RequestSchema): class AttachUDiskResponseSchema(schema.ResponseSchema): - """ AttachUDisk - 将一个可用的UDisk挂载到某台主机上，当UDisk挂载成功后，还需要在主机内部进行文件系统操作 - """ + """AttachUDisk - 将一个可用的UDisk挂载到某台主机上，当UDisk挂载成功后，还需要在主机内部进行文件系统操作""" fields = { "UDiskId": fields.Str(required=False, load_from="UDiskId"), @@ -45,8 +43,7 @@ class AttachUDiskResponseSchema(schema.ResponseSchema): class CloneUDiskRequestSchema(schema.RequestSchema): - """ CloneUDisk - 从UDisk创建UDisk克隆 - """ + """CloneUDisk - 从UDisk创建UDisk克隆""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -63,8 +60,7 @@ class CloneUDiskRequestSchema(schema.RequestSchema): class CloneUDiskResponseSchema(schema.ResponseSchema): - """ CloneUDisk - 从UDisk创建UDisk克隆 - """ + """CloneUDisk - 从UDisk创建UDisk克隆""" fields = { "UDiskId": fields.List( @@ -81,8 +77,7 @@ class CloneUDiskResponseSchema(schema.ResponseSchema): class CloneUDiskSnapshotRequestSchema(schema.RequestSchema): - """ CloneUDiskSnapshot - 从快照创建UDisk克隆 - """ + """CloneUDiskSnapshot - 从快照创建UDisk克隆""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -100,8 +95,7 @@ class CloneUDiskSnapshotRequestSchema(schema.RequestSchema): class CloneUDiskSnapshotResponseSchema(schema.ResponseSchema): - """ CloneUDiskSnapshot - 从快照创建UDisk克隆 - """ + """CloneUDiskSnapshot - 从快照创建UDisk克隆""" fields = { "UDiskId": fields.List( @@ -118,8 +112,7 @@ class CloneUDiskSnapshotResponseSchema(schema.ResponseSchema): class CreateUDiskRequestSchema(schema.RequestSchema): - """ CreateUDisk - 创建UDisk磁盘 - """ + """CreateUDisk - 创建UDisk磁盘""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -139,8 +132,7 @@ class CreateUDiskRequestSchema(schema.RequestSchema): class CreateUDiskResponseSchema(schema.ResponseSchema): - """ CreateUDisk - 创建UDisk磁盘 - """ + """CreateUDisk - 创建UDisk磁盘""" fields = { "UDiskId": fields.List( @@ -157,8 +149,7 @@ class CreateUDiskResponseSchema(schema.ResponseSchema): class CreateUDiskSnapshotRequestSchema(schema.RequestSchema): - """ CreateUDiskSnapshot - 创建snapshot快照 - """ + """CreateUDiskSnapshot - 创建snapshot快照""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -173,8 +164,7 @@ class CreateUDiskSnapshotRequestSchema(schema.RequestSchema): class CreateUDiskSnapshotResponseSchema(schema.ResponseSchema): - """ CreateUDiskSnapshot - 创建snapshot快照 - """ + """CreateUDiskSnapshot - 创建snapshot快照""" fields = { "SnapshotId": fields.List( @@ -191,8 +181,7 @@ class CreateUDiskSnapshotResponseSchema(schema.ResponseSchema): class DeleteUDiskRequestSchema(schema.RequestSchema): - """ DeleteUDisk - 删除UDisk - """ + """DeleteUDisk - 删除UDisk""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -203,8 +192,7 @@ class DeleteUDiskRequestSchema(schema.RequestSchema): class DeleteUDiskResponseSchema(schema.ResponseSchema): - """ DeleteUDisk - 删除UDisk - """ + """DeleteUDisk - 删除UDisk""" fields = {} @@ -217,8 +205,7 @@ class DeleteUDiskResponseSchema(schema.ResponseSchema): class DeleteUDiskSnapshotRequestSchema(schema.RequestSchema): - """ DeleteUDiskSnapshot - 删除Snapshot - """ + """DeleteUDiskSnapshot - 删除Snapshot""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -230,8 +217,7 @@ class DeleteUDiskSnapshotRequestSchema(schema.RequestSchema): class DeleteUDiskSnapshotResponseSchema(schema.ResponseSchema): - """ DeleteUDiskSnapshot - 删除Snapshot - """ + """DeleteUDiskSnapshot - 删除Snapshot""" fields = {} @@ -244,8 +230,7 @@ class DeleteUDiskSnapshotResponseSchema(schema.ResponseSchema): class DescribeUDiskRequestSchema(schema.RequestSchema): - """ DescribeUDisk - 获取UDisk实例 - """ + """DescribeUDisk - 获取UDisk实例""" fields = { "DiskType": fields.Str(required=False, dump_to="DiskType"), @@ -263,8 +248,7 @@ class DescribeUDiskRequestSchema(schema.RequestSchema): class DescribeUDiskResponseSchema(schema.ResponseSchema): - """ DescribeUDisk - 获取UDisk实例 - """ + """DescribeUDisk - 获取UDisk实例""" fields = { "DataSet": fields.List( @@ -282,8 +266,7 @@ class DescribeUDiskResponseSchema(schema.ResponseSchema): class DescribeUDiskPriceRequestSchema(schema.RequestSchema): - """ DescribeUDiskPrice - 获取UDisk实例价格信息 - """ + """DescribeUDiskPrice - 获取UDisk实例价格信息""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -298,8 +281,7 @@ class DescribeUDiskPriceRequestSchema(schema.RequestSchema): class DescribeUDiskPriceResponseSchema(schema.ResponseSchema): - """ DescribeUDiskPrice - 获取UDisk实例价格信息 - """ + """DescribeUDiskPrice - 获取UDisk实例价格信息""" fields = { "DataSet": fields.List( @@ -318,8 +300,7 @@ class DescribeUDiskPriceResponseSchema(schema.ResponseSchema): class DescribeUDiskSnapshotRequestSchema(schema.RequestSchema): - """ DescribeUDiskSnapshot - 获取UDisk快照 - """ + """DescribeUDiskSnapshot - 获取UDisk快照""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -333,8 +314,7 @@ class DescribeUDiskSnapshotRequestSchema(schema.RequestSchema): class DescribeUDiskSnapshotResponseSchema(schema.ResponseSchema): - """ DescribeUDiskSnapshot - 获取UDisk快照 - """ + """DescribeUDiskSnapshot - 获取UDisk快照""" fields = { "DataSet": fields.List( @@ -352,8 +332,7 @@ class DescribeUDiskSnapshotResponseSchema(schema.ResponseSchema): class DescribeUDiskUpgradePriceRequestSchema(schema.RequestSchema): - """ DescribeUDiskUpgradePrice - 获取UDisk升级价格信息 - """ + """DescribeUDiskUpgradePrice - 获取UDisk升级价格信息""" fields = { "DiskType": fields.Str(required=False, dump_to="DiskType"), @@ -367,8 +346,7 @@ class DescribeUDiskUpgradePriceRequestSchema(schema.RequestSchema): class DescribeUDiskUpgradePriceResponseSchema(schema.ResponseSchema): - """ DescribeUDiskUpgradePrice - 获取UDisk升级价格信息 - """ + """DescribeUDiskUpgradePrice - 获取UDisk升级价格信息""" fields = { "OriginalPrice": fields.Int(required=False, load_from="OriginalPrice"), @@ -384,8 +362,7 @@ class DescribeUDiskUpgradePriceResponseSchema(schema.ResponseSchema): class DetachUDiskRequestSchema(schema.RequestSchema): - """ DetachUDisk - 卸载某个已经挂载在指定UHost实例上的UDisk - """ + """DetachUDisk - 卸载某个已经挂载在指定UHost实例上的UDisk""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -397,8 +374,7 @@ class DetachUDiskRequestSchema(schema.RequestSchema): class DetachUDiskResponseSchema(schema.ResponseSchema): - """ DetachUDisk - 卸载某个已经挂载在指定UHost实例上的UDisk - """ + """DetachUDisk - 卸载某个已经挂载在指定UHost实例上的UDisk""" fields = { "UDiskId": fields.Str(required=False, load_from="UDiskId"), @@ -414,8 +390,7 @@ class DetachUDiskResponseSchema(schema.ResponseSchema): class RenameUDiskRequestSchema(schema.RequestSchema): - """ RenameUDisk - 重命名UDisk - """ + """RenameUDisk - 重命名UDisk""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -427,8 +402,7 @@ class RenameUDiskRequestSchema(schema.RequestSchema): class RenameUDiskResponseSchema(schema.ResponseSchema): - """ RenameUDisk - 重命名UDisk - """ + """RenameUDisk - 重命名UDisk""" fields = {} @@ -441,8 +415,7 @@ class RenameUDiskResponseSchema(schema.ResponseSchema): class ResizeUDiskRequestSchema(schema.RequestSchema): - """ ResizeUDisk - 调整UDisk容量 - """ + """ResizeUDisk - 调整UDisk容量""" fields = { "CouponId": fields.Str(required=False, dump_to="CouponId"), @@ -455,8 +428,7 @@ class ResizeUDiskRequestSchema(schema.RequestSchema): class ResizeUDiskResponseSchema(schema.ResponseSchema): - """ ResizeUDisk - 调整UDisk容量 - """ + """ResizeUDisk - 调整UDisk容量""" fields = {} @@ -469,8 +441,7 @@ class ResizeUDiskResponseSchema(schema.ResponseSchema): class RestoreUDiskRequestSchema(schema.RequestSchema): - """ RestoreUDisk - 从备份恢复数据至UDisk - """ + """RestoreUDisk - 从备份恢复数据至UDisk""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -483,8 +454,7 @@ class RestoreUDiskRequestSchema(schema.RequestSchema): class RestoreUDiskResponseSchema(schema.ResponseSchema): - """ RestoreUDisk - 从备份恢复数据至UDisk - """ + """RestoreUDisk - 从备份恢复数据至UDisk""" fields = {} @@ -497,8 +467,7 @@ class RestoreUDiskResponseSchema(schema.ResponseSchema): class SetUDiskUDataArkModeRequestSchema(schema.RequestSchema): - """ SetUDiskUDataArkMode - 设置UDisk数据方舟的状态 - """ + """SetUDiskUDataArkMode - 设置UDisk数据方舟的状态""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -510,7 +479,6 @@ class SetUDiskUDataArkModeRequestSchema(schema.RequestSchema): class SetUDiskUDataArkModeResponseSchema(schema.ResponseSchema): - """ SetUDiskUDataArkMode - 设置UDisk数据方舟的状态 - """ + """SetUDiskUDataArkMode - 设置UDisk数据方舟的状态""" fields = {} diff --git a/ucloud/services/udisk/schemas/models.py b/ucloud/services/udisk/schemas/models.py index d0675af..100c816 100644 --- a/ucloud/services/udisk/schemas/models.py +++ b/ucloud/services/udisk/schemas/models.py @@ -5,8 +5,7 @@ class UDiskDataSetSchema(schema.ResponseSchema): - """ UDiskDataSet - DescribeUDisk - """ + """UDiskDataSet - DescribeUDisk""" fields = { "ArkSwitchEnable": fields.Int( @@ -43,8 +42,7 @@ class UDiskDataSetSchema(schema.ResponseSchema): class UDiskPriceDataSetSchema(schema.ResponseSchema): - """ UDiskPriceDataSet - DescribeUDiskPrice - """ + """UDiskPriceDataSet - DescribeUDiskPrice""" fields = { "ChargeName": fields.Str(required=False, load_from="ChargeName"), @@ -55,8 +53,7 @@ class UDiskPriceDataSetSchema(schema.ResponseSchema): class UDiskSnapshotSetSchema(schema.ResponseSchema): - """ UDiskSnapshotSet - DescribeUDiskSnapshot - """ + """UDiskSnapshotSet - DescribeUDiskSnapshot""" fields = { "CmkId": fields.Str(required=False, load_from="CmkId"), diff --git a/ucloud/services/udpn/client.py b/ucloud/services/udpn/client.py index 769c40b..aa8eaf8 100644 --- a/ucloud/services/udpn/client.py +++ b/ucloud/services/udpn/client.py @@ -10,23 +10,23 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(UDPNClient, self).__init__(config, transport, middleware, logger) def allocate_udpn(self, req=None, **kwargs): - """ AllocateUDPN - 分配一条 UDPN 专线 + """AllocateUDPN - 分配一条 UDPN 专线 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Bandwidth** (int) - (Required) 带宽 - **Peer1** (str) - (Required) 专线可用区1，支持地域：北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 洛杉矶：us-la， 华盛顿：us-ws， 东京：jpn-tky - **Peer2** (str) - (Required) 专线可用区2，支持地域：北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 洛杉矶：us-la， 华盛顿：us-ws， 东京：jpn-tky - **ChargeType** (str) - 计费类型，枚举值为： Year，按年付费； Month，按月付费； Dynamic，按需付费 - **CouponId** (str) - 代金劵 - **Quantity** (int) - 计费时长，默认 1 - + **Response** - **UDPNId** (str) - 资源名称 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -36,25 +36,25 @@ def allocate_udpn(self, req=None, **kwargs): return apis.AllocateUDPNResponseSchema().loads(resp) def describe_udpn(self, req=None, **kwargs): - """ DescribeUDPN - 描述 UDPN + """DescribeUDPN - 描述 UDPN **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - 返回数据长度，默认为 20 - **Offset** (int) - 列表起始位置偏移量，默认为 0 - **UDPNId** (str) - 申请到的 UDPN 资源 ID。若为空，则查询该用户在机房所有的专线信息。非默认项目资源，需填写ProjectId - + **Response** - **DataSet** (list) - 见 **UDPNData** 模型定义 - **TotalCount** (int) - 查询到的总数量 - + **Response Model** - - **UDPNData** - + + **UDPNData** + - **Bandwidth** (int) - 带宽 - **ChargeType** (str) - 计费类型 - **CreateTime** (int) - unix 时间戳 创建时间 @@ -71,22 +71,22 @@ def describe_udpn(self, req=None, **kwargs): return apis.DescribeUDPNResponseSchema().loads(resp) def get_udpn_line_list(self, req=None, **kwargs): - """ GetUDPNLineList - 获取当前支持的专线线路列表 + """GetUDPNLineList - 获取当前支持的专线线路列表 **Request** - - **ProjectId** (str) - (Config) - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - + - **ProjectId** (str) - (Config) + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + **Response** - **DataSet** (list) - 见 **UDPNLineSet** 模型定义 - **TotalCount** (int) - DataSet中的元素个数 - + **Response Model** - - **UDPNLineSet** - + + **UDPNLineSet** + - **BandwidthUpperLimit** (int) - 线路带宽上限,单位 M - **LocalRegion** (str) - 支持UDPN的地域之一，北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 华盛顿：us-ws, 洛杉矶：us-la， 东京：jpn-tky - **RemoteRegion** (str) - 支持UDPN的地域之一，北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 华盛顿：us-ws, 洛杉矶：us-la， 东京：jpn-tky @@ -99,22 +99,22 @@ def get_udpn_line_list(self, req=None, **kwargs): return apis.GetUDPNLineListResponseSchema().loads(resp) def get_udpn_price(self, req=None, **kwargs): - """ GetUDPNPrice - 获取 UDPN 价格 + """GetUDPNPrice - 获取 UDPN 价格 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Bandwidth** (int) - (Required) 带宽信息 - **Peer1** (str) - (Required) 专线可用区1，支持地域：北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 洛杉矶：us-la， 华盛顿：us-ws， 东京：jpn-tky - **Peer2** (str) - (Required) 专线可用区2，支持地域：北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 洛杉矶：us-la， 华盛顿：us-ws， 东京：jpn-tky - **ChargeType** (str) - 计费类型 - **Quantity** (int) - 购买时长 - + **Response** - **Price** (float) - 专线价格 - **PurchaseValue** (int) - 资源有效期 unix 时间戳 - + """ d = {"Region": self.config.region} req and d.update(req) @@ -123,19 +123,19 @@ def get_udpn_price(self, req=None, **kwargs): return apis.GetUDPNPriceResponseSchema().loads(resp) def get_udpn_upgrade_price(self, req=None, **kwargs): - """ GetUDPNUpgradePrice - 获取专线升级价格 + """GetUDPNUpgradePrice - 获取专线升级价格 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Bandwidth** (int) - (Required) 带宽 - **UDPNId** (str) - (Required) 专线带宽资源 Id - + **Response** - **Price** (float) - 升级后的价格 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -144,19 +144,19 @@ def get_udpn_upgrade_price(self, req=None, **kwargs): return apis.GetUDPNUpgradePriceResponseSchema().loads(resp) def modify_udpn_bandwidth(self, req=None, **kwargs): - """ ModifyUDPNBandwidth - 修改带宽值 + """ModifyUDPNBandwidth - 修改带宽值 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Bandwidth** (int) - (Required) 调整后专线带宽, 单位为Mbps，取值范围为大于等于2且小于等于1000([2-1000])的整数 - **UDPNId** (str) - (Required) UDPN Id - **CouponId** (str) - 代金劵 ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -165,17 +165,17 @@ def modify_udpn_bandwidth(self, req=None, **kwargs): return apis.ModifyUDPNBandwidthResponseSchema().loads(resp) def release_udpn(self, req=None, **kwargs): - """ ReleaseUDPN - 释放 UDPN + """ReleaseUDPN - 释放 UDPN **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **UDPNId** (str) - (Required) UDPN 资源 Id - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/udpn/schemas/apis.py b/ucloud/services/udpn/schemas/apis.py index 5c5332e..aac8277 100644 --- a/ucloud/services/udpn/schemas/apis.py +++ b/ucloud/services/udpn/schemas/apis.py @@ -14,8 +14,7 @@ class AllocateUDPNRequestSchema(schema.RequestSchema): - """ AllocateUDPN - 分配一条 UDPN 专线 - """ + """AllocateUDPN - 分配一条 UDPN 专线""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -30,8 +29,7 @@ class AllocateUDPNRequestSchema(schema.RequestSchema): class AllocateUDPNResponseSchema(schema.ResponseSchema): - """ AllocateUDPN - 分配一条 UDPN 专线 - """ + """AllocateUDPN - 分配一条 UDPN 专线""" fields = {"UDPNId": fields.Str(required=True, load_from="UDPNId")} @@ -44,8 +42,7 @@ class AllocateUDPNResponseSchema(schema.ResponseSchema): class DescribeUDPNRequestSchema(schema.RequestSchema): - """ DescribeUDPN - 描述 UDPN - """ + """DescribeUDPN - 描述 UDPN""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -57,8 +54,7 @@ class DescribeUDPNRequestSchema(schema.RequestSchema): class DescribeUDPNResponseSchema(schema.ResponseSchema): - """ DescribeUDPN - 描述 UDPN - """ + """DescribeUDPN - 描述 UDPN""" fields = { "DataSet": fields.List( @@ -76,8 +72,7 @@ class DescribeUDPNResponseSchema(schema.ResponseSchema): class GetUDPNLineListRequestSchema(schema.RequestSchema): - """ GetUDPNLineList - 获取当前支持的专线线路列表 - """ + """GetUDPNLineList - 获取当前支持的专线线路列表""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -86,8 +81,7 @@ class GetUDPNLineListRequestSchema(schema.RequestSchema): class GetUDPNLineListResponseSchema(schema.ResponseSchema): - """ GetUDPNLineList - 获取当前支持的专线线路列表 - """ + """GetUDPNLineList - 获取当前支持的专线线路列表""" fields = { "DataSet": fields.List( @@ -105,8 +99,7 @@ class GetUDPNLineListResponseSchema(schema.ResponseSchema): class GetUDPNPriceRequestSchema(schema.RequestSchema): - """ GetUDPNPrice - 获取 UDPN 价格 - """ + """GetUDPNPrice - 获取 UDPN 价格""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -119,8 +112,7 @@ class GetUDPNPriceRequestSchema(schema.RequestSchema): class GetUDPNPriceResponseSchema(schema.ResponseSchema): - """ GetUDPNPrice - 获取 UDPN 价格 - """ + """GetUDPNPrice - 获取 UDPN 价格""" fields = { "Price": fields.Float(required=True, load_from="Price"), @@ -136,8 +128,7 @@ class GetUDPNPriceResponseSchema(schema.ResponseSchema): class GetUDPNUpgradePriceRequestSchema(schema.RequestSchema): - """ GetUDPNUpgradePrice - 获取专线升级价格 - """ + """GetUDPNUpgradePrice - 获取专线升级价格""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -148,8 +139,7 @@ class GetUDPNUpgradePriceRequestSchema(schema.RequestSchema): class GetUDPNUpgradePriceResponseSchema(schema.ResponseSchema): - """ GetUDPNUpgradePrice - 获取专线升级价格 - """ + """GetUDPNUpgradePrice - 获取专线升级价格""" fields = {"Price": fields.Float(required=True, load_from="Price")} @@ -162,8 +152,7 @@ class GetUDPNUpgradePriceResponseSchema(schema.ResponseSchema): class ModifyUDPNBandwidthRequestSchema(schema.RequestSchema): - """ ModifyUDPNBandwidth - 修改带宽值 - """ + """ModifyUDPNBandwidth - 修改带宽值""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -175,8 +164,7 @@ class ModifyUDPNBandwidthRequestSchema(schema.RequestSchema): class ModifyUDPNBandwidthResponseSchema(schema.ResponseSchema): - """ ModifyUDPNBandwidth - 修改带宽值 - """ + """ModifyUDPNBandwidth - 修改带宽值""" fields = {} @@ -189,8 +177,7 @@ class ModifyUDPNBandwidthResponseSchema(schema.ResponseSchema): class ReleaseUDPNRequestSchema(schema.RequestSchema): - """ ReleaseUDPN - 释放 UDPN - """ + """ReleaseUDPN - 释放 UDPN""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -200,7 +187,6 @@ class ReleaseUDPNRequestSchema(schema.RequestSchema): class ReleaseUDPNResponseSchema(schema.ResponseSchema): - """ ReleaseUDPN - 释放 UDPN - """ + """ReleaseUDPN - 释放 UDPN""" fields = {} diff --git a/ucloud/services/udpn/schemas/models.py b/ucloud/services/udpn/schemas/models.py index 5d3a9d7..96f92f8 100644 --- a/ucloud/services/udpn/schemas/models.py +++ b/ucloud/services/udpn/schemas/models.py @@ -5,8 +5,7 @@ class UDPNDataSchema(schema.ResponseSchema): - """ UDPNData - UDPN 详细信息 - """ + """UDPNData - UDPN 详细信息""" fields = { "Bandwidth": fields.Int(required=True, load_from="Bandwidth"), @@ -20,8 +19,7 @@ class UDPNDataSchema(schema.ResponseSchema): class UDPNLineSetSchema(schema.ResponseSchema): - """ UDPNLineSet - GetUDPNLineList - """ + """UDPNLineSet - GetUDPNLineList""" fields = { "BandwidthUpperLimit": fields.Int( diff --git a/ucloud/services/ufs/client.py b/ucloud/services/ufs/client.py index 03529de..1223471 100644 --- a/ucloud/services/ufs/client.py +++ b/ucloud/services/ufs/client.py @@ -10,12 +10,12 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(UFSClient, self).__init__(config, transport, middleware, logger) def create_ufs_volume(self, req=None, **kwargs): - """ CreateUFSVolume - 创建文件系统 + """CreateUFSVolume - 创建文件系统 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ProtocolType** (str) - (Required) 文件系统协议，枚举值，NFSv3表示NFS V3协议，NFSv4表示NFS V4协议 - **Size** (int) - (Required) 文件系统大小，单位为GB，最大不超过20T，香港容量型必须为100的整数倍，Size最小为500GB，北京，上海，广州的容量型必须为1024的整数倍，Size最小为1024GB。性能型文件系统Size最小为100GB - **StorageType** (str) - (Required) 文件系统存储类型，枚举值，Basic表示容量型，Advanced表示性能型 @@ -25,13 +25,13 @@ def create_ufs_volume(self, req=None, **kwargs): - **Remark** (str) - 备注 - **Tag** (str) - 文件系统所属业务组 - **VolumeName** (str) - 文件系统名称 - + **Response** - **VolumeId** (str) - 文件系统ID - **VolumeName** (str) - 文件系统名称 - **VolumeStatus** (str) - 文件系统挂载点状态 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -41,25 +41,25 @@ def create_ufs_volume(self, req=None, **kwargs): return apis.CreateUFSVolumeResponseSchema().loads(resp) def describe_ufs_volume_2(self, req=None, **kwargs): - """ DescribeUFSVolume2 - 获取文件系统列表 + """DescribeUFSVolume2 - 获取文件系统列表 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - 文件列表长度 - **Offset** (int) - 文件列表起始 - **VolumeId** (str) - 文件系统ID - + **Response** - **DataSet** (list) - 见 **UFSVolumeInfo2** 模型定义 - **TotalCount** (int) - 文件系统总数 - + **Response Model** - - **UFSVolumeInfo2** - + + **UFSVolumeInfo2** + - **CreateTime** (int) - 文件系统创建时间（unix时间戳） - **ExpiredTime** (int) - 文件系统过期时间（unix时间戳） - **IsExpired** (str) - 是否过期 @@ -82,18 +82,18 @@ def describe_ufs_volume_2(self, req=None, **kwargs): return apis.DescribeUFSVolume2ResponseSchema().loads(resp) def extend_ufs_volume(self, req=None, **kwargs): - """ ExtendUFSVolume - 文件系统扩容 + """ExtendUFSVolume - 文件系统扩容 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 文件系统大小，单位为GB，最大不超过20T，香港容量型必须为100的整数倍，Size最小为500GB，北京，上海，广州的容量型必须为1024的整数倍，Size最小为1024GB。性能型文件系统Size最小为100GB - **VolumeId** (str) - (Required) 文件系统ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -102,17 +102,17 @@ def extend_ufs_volume(self, req=None, **kwargs): return apis.ExtendUFSVolumeResponseSchema().loads(resp) def remove_ufs_volume(self, req=None, **kwargs): - """ RemoveUFSVolume - 删除UFS文件系统 + """RemoveUFSVolume - 删除UFS文件系统 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **VolumeId** (str) - (Required) 文件系统ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/ufs/schemas/apis.py b/ucloud/services/ufs/schemas/apis.py index 99be471..a9d78c9 100644 --- a/ucloud/services/ufs/schemas/apis.py +++ b/ucloud/services/ufs/schemas/apis.py @@ -14,8 +14,7 @@ class CreateUFSVolumeRequestSchema(schema.RequestSchema): - """ CreateUFSVolume - 创建文件系统 - """ + """CreateUFSVolume - 创建文件系统""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -33,8 +32,7 @@ class CreateUFSVolumeRequestSchema(schema.RequestSchema): class CreateUFSVolumeResponseSchema(schema.ResponseSchema): - """ CreateUFSVolume - 创建文件系统 - """ + """CreateUFSVolume - 创建文件系统""" fields = { "VolumeId": fields.Str(required=True, load_from="VolumeId"), @@ -51,8 +49,7 @@ class CreateUFSVolumeResponseSchema(schema.ResponseSchema): class DescribeUFSVolume2RequestSchema(schema.RequestSchema): - """ DescribeUFSVolume2 - 获取文件系统列表 - """ + """DescribeUFSVolume2 - 获取文件系统列表""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -64,8 +61,7 @@ class DescribeUFSVolume2RequestSchema(schema.RequestSchema): class DescribeUFSVolume2ResponseSchema(schema.ResponseSchema): - """ DescribeUFSVolume2 - 获取文件系统列表 - """ + """DescribeUFSVolume2 - 获取文件系统列表""" fields = { "DataSet": fields.List( @@ -83,8 +79,7 @@ class DescribeUFSVolume2ResponseSchema(schema.ResponseSchema): class ExtendUFSVolumeRequestSchema(schema.RequestSchema): - """ ExtendUFSVolume - 文件系统扩容 - """ + """ExtendUFSVolume - 文件系统扩容""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -95,8 +90,7 @@ class ExtendUFSVolumeRequestSchema(schema.RequestSchema): class ExtendUFSVolumeResponseSchema(schema.ResponseSchema): - """ ExtendUFSVolume - 文件系统扩容 - """ + """ExtendUFSVolume - 文件系统扩容""" fields = {} @@ -109,8 +103,7 @@ class ExtendUFSVolumeResponseSchema(schema.ResponseSchema): class RemoveUFSVolumeRequestSchema(schema.RequestSchema): - """ RemoveUFSVolume - 删除UFS文件系统 - """ + """RemoveUFSVolume - 删除UFS文件系统""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -120,7 +113,6 @@ class RemoveUFSVolumeRequestSchema(schema.RequestSchema): class RemoveUFSVolumeResponseSchema(schema.ResponseSchema): - """ RemoveUFSVolume - 删除UFS文件系统 - """ + """RemoveUFSVolume - 删除UFS文件系统""" fields = {} diff --git a/ucloud/services/ufs/schemas/models.py b/ucloud/services/ufs/schemas/models.py index 39ea2ab..9843e14 100644 --- a/ucloud/services/ufs/schemas/models.py +++ b/ucloud/services/ufs/schemas/models.py @@ -5,8 +5,7 @@ class UFSVolumeInfo2Schema(schema.ResponseSchema): - """ UFSVolumeInfo2 - 文件系统信息 - """ + """UFSVolumeInfo2 - 文件系统信息""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), diff --git a/ucloud/services/uhost/client.py b/ucloud/services/uhost/client.py index a4edbd7..bfa83c4 100644 --- a/ucloud/services/uhost/client.py +++ b/ucloud/services/uhost/client.py @@ -10,23 +10,23 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(UHostClient, self).__init__(config, transport, middleware, logger) def copy_custom_image(self, req=None, **kwargs): - """ CopyCustomImage - 复制自制镜像 + """CopyCustomImage - 复制自制镜像 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **SourceImageId** (str) - (Required) 源镜像Id, 参见 DescribeImage - **TargetProjectId** (str) - (Required) 目标项目Id, 参见 GetProjectList - **TargetImageDescription** (str) - 目标镜像描述 - **TargetImageName** (str) - 目标镜像名称 - **TargetRegion** (str) - 目标地域，不跨地域不用填 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **TargetImageId** (str) - 目标镜像Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -36,21 +36,21 @@ def copy_custom_image(self, req=None, **kwargs): return apis.CopyCustomImageResponseSchema().loads(resp) def create_custom_image(self, req=None, **kwargs): - """ CreateCustomImage - 从指定UHost实例，生成自定义镜像。 + """CreateCustomImage - 从指定UHost实例，生成自定义镜像。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ImageName** (str) - (Required) 镜像名称 - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - **ImageDescription** (str) - 镜像描述 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **ImageId** (str) - 镜像Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -60,16 +60,16 @@ def create_custom_image(self, req=None, **kwargs): return apis.CreateCustomImageResponseSchema().loads(resp) def create_uhost_instance(self, req=None, **kwargs): - """ CreateUHostInstance - 创建UHost实例。 + """CreateUHostInstance - 创建UHost实例。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ImageId** (str) - (Required) 镜像ID。 请通过 `DescribeImage `_ 获取 - **LoginMode** (str) - (Required) 主机登陆模式。密码（默认选项）: Password。 - **Password** (str) - (Required) UHost密码。请遵照 `字段规范 `_ 设定密码。密码需使用base64进行编码，举例如下：# echo -n Password1 | base64UGFzc3dvcmQx。 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **AlarmTemplateId** (int) - 告警模板id，如果传了告警模板id，且告警模板id正确，则绑定告警模板。绑定告警模板失败只会在后台有日志，不会影响创建主机流程，也不会在前端报错。 - **BootDiskSpace** (int) - 【待废弃，不建议调用】系统盘大小。 单位：GB， 范围[20,100]， 步长：10 - **CPU** (int) - 虚拟CPU核数。可选参数：1-64（具体机型与CPU的对应关系参照控制台）。默认值: 4。 @@ -108,22 +108,22 @@ def create_uhost_instance(self, req=None, **kwargs): - **UserData** (str) - 【即将支持】用户自定义数据。当镜像支持Cloud-init Feature时可填写此字段。注意：1、总数据量大小不超多16K；2、使用base64编码 - **UserDataScript** (str) - 【暂不支持】cloudinit方式下，用户初始化脚本 - **VPCId** (str) - VPC ID。默认为当前地域的默认VPC。 - + **Response** - **IPs** (list) - 【批量创建不会返回】IP信息 - **UHostIds** (list) - UHost实例Id集合 - + **Request Model** - - **CreateUHostInstanceParamNetworkInterfaceEIPGlobalSSH** - + + **CreateUHostInstanceParamNetworkInterfaceEIPGlobalSSH** + - **Area** (str) - 填写支持SSH访问IP的地区名称，如“洛杉矶”，“新加坡”，“香港”，“东京”，“华盛顿”，“法兰克福”。Area和AreaCode两者必填其中之一。 - **AreaCode** (str) - GlobalSSH的地区编码，格式为区域航空港国际通用代码。Area和AreaCode两者必填其中之一。 - **Port** (int) - SSH端口，1-65535且不能使用80，443端口 - **CreateUHostInstanceParamNetworkInterfaceEIP** - + **CreateUHostInstanceParamNetworkInterfaceEIP** + - **Bandwidth** (int) - 【若绑定EIP，此参数必填】弹性IP的外网带宽, 单位为Mbps. 共享带宽模式必须指定0M带宽, 非共享带宽模式必须指定非0Mbps带宽. 各地域非共享带宽的带宽范围如下： 流量计费[1-300]，带宽计费[1-800] - **CouponId** (str) - 当前EIP代金券id。请通过DescribeCoupon接口查询，或登录用户中心查看。 - **GlobalSSH** (dict) - 见 **CreateUHostInstanceParamNetworkInterfaceEIPGlobalSSH** 模型定义 @@ -131,14 +131,14 @@ def create_uhost_instance(self, req=None, **kwargs): - **PayMode** (str) - 弹性IP的计费模式. 枚举值: "Traffic", 流量计费; "Bandwidth", 带宽计费; "ShareBandwidth",共享带宽模式. "Free":免费带宽模式.默认为 "Bandwidth". - **ShareBandwidthId** (str) - 绑定的共享带宽Id，仅当PayMode为ShareBandwidth时有效 - **CreateUHostInstanceParamNetworkInterfaceIPv6** - + **CreateUHostInstanceParamNetworkInterfaceIPv6** + - **Adress** (str) - 第N个网卡对应的IPv6地址，默认不分配IPv6，“Auto”自动分配，不为空的其他字符串为实际要分配的IPv6地址 - **ShareBandwidthId** (str) - 第N块网卡中IPv6对应的共享带宽id，默认不带外网 - **CreateUHostInstanceParamDisks** - - - **BackupType** (str) - 磁盘备份方案。枚举值：\\ > NONE，无备份 \\ > DATAARK，数据方舟 \\ 当前磁盘支持的备份模式参考 `磁盘类型 `_ + **CreateUHostInstanceParamDisks** + + - **BackupType** (str) - 磁盘备份方案。枚举值：\\ > NONE，无备份 \\ > DATAARK，数据方舟 \\ 当前磁盘支持的备份模式参考 `磁盘类型 `_ - **CouponId** (str) - 云盘代金券id。不适用于系统盘/本地盘。请通过DescribeCoupon接口查询，或登录用户中心查看 - **Encrypted** (bool) - 【功能仅部分可用区开放，详询技术支持】磁盘是否加密。加密：true, 不加密: false加密必须传入对应的的KmsKeyId - **IsBoot** (str) - 是否是系统盘。枚举值：\\ > True，是系统盘 \\ > False，是数据盘（默认）。Disks数组中有且只能有一块盘是系统盘。 @@ -146,8 +146,8 @@ def create_uhost_instance(self, req=None, **kwargs): - **Size** (int) - 磁盘大小，单位GB，必须是10GB的整数倍。请参考 `磁盘类型 `_ 。 - **Type** (str) - 磁盘类型。请参考 `磁盘类型 `_ 。 - **CreateUHostInstanceParamNetworkInterface** - + **CreateUHostInstanceParamNetworkInterface** + - **EIP** (dict) - 见 **CreateUHostInstanceParamNetworkInterfaceEIP** 模型定义 - **IPv6** (dict) - 见 **CreateUHostInstanceParamNetworkInterfaceIPv6** 模型定义 @@ -160,29 +160,29 @@ def create_uhost_instance(self, req=None, **kwargs): return apis.CreateUHostInstanceResponseSchema().loads(resp) def describe_image(self, req=None, **kwargs): - """ DescribeImage - 获取指定数据中心镜像列表，用户可通过指定操作系统类型，镜像Id进行过滤。 + """DescribeImage - 获取指定数据中心镜像列表，用户可通过指定操作系统类型，镜像Id进行过滤。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ImageId** (str) - 镜像Id - **ImageType** (str) - 镜像类型。标准镜像：Base，镜像市场：Business， 自定义镜像：Custom，默认返回所有类型 - **Limit** (int) - 返回数据长度，默认为20 - **Offset** (int) - 列表起始位置偏移量，默认为0 - **OsType** (str) - 操作系统类型：Linux， Windows 默认返回所有类型 - **PriceSet** (int) - 是否返回价格：1返回，0不返回；默认不返回 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **ImageSet** (list) - 见 **UHostImageSet** 模型定义 - **TotalCount** (int) - 满足条件的镜像总数 - + **Response Model** - - **UHostImageSet** - + + **UHostImageSet** + - **CreateTime** (int) - 创建时间，格式为Unix时间戳 - **Features** (list) - 特殊状态标识， 目前包含NetEnhnced（网络增强1.0）, NetEnhanced_Ultra]（网络增强2.0）,HotPlug(热升级),CloudInit - **FuncType** (str) - 行业镜像类型（仅行业镜像将返回这个值） @@ -198,7 +198,7 @@ def describe_image(self, req=None, **kwargs): - **OsType** (str) - 操作系统类型：Liunx，Windows - **State** (str) - 镜像状态， 可用：Available，制作中：Making， 不可用：Unavailable - **Vendor** (str) - 供应商（仅行业镜像将返回这个值） - - **Zone** (str) - 可用区，参见 `可用区列表 `_ + - **Zone** (str) - 可用区，参见 `可用区列表 `_ """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} @@ -208,29 +208,29 @@ def describe_image(self, req=None, **kwargs): return apis.DescribeImageResponseSchema().loads(resp) def describe_isolation_group(self, req=None, **kwargs): - """ DescribeIsolationGroup - 查询硬件隔离组列表。 + """DescribeIsolationGroup - 查询硬件隔离组列表。 **Request** - **ProjectId** (str) - (Config) 项目id - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - 待查的硬件隔离组id - **Limit** (int) - 返回数据长度，默认为20，最大100 - **Offset** (int) - 列表起始位置偏移量，默认为0 - + **Response** - **IsolationGroupSet** (list) - 见 **IsolationGroup** 模型定义 - + **Response Model** - - **SpreadInfo** - + + **SpreadInfo** + - **UHostCount** (int) - 可用区中硬件隔离组中云主机的数量，不超过7。 - **Zone** (str) - 可用区信息 - **IsolationGroup** - + **IsolationGroup** + - **GroupId** (str) - 硬件隔离组id - **GroupName** (str) - 硬件隔离组名称 - **Remark** (str) - 备注 @@ -244,12 +244,12 @@ def describe_isolation_group(self, req=None, **kwargs): return apis.DescribeIsolationGroupResponseSchema().loads(resp) def describe_uhost_instance(self, req=None, **kwargs): - """ DescribeUHostInstance - 获取主机或主机列表信息，并可根据数据中心，主机ID等参数进行过滤。 + """DescribeUHostInstance - 获取主机或主机列表信息，并可根据数据中心，主机ID等参数进行过滤。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **IsolationGroup** (str) - 硬件隔离组id。通过硬件隔离组筛选主机。 - **LifeCycle** (int) - 1：普通云主机；2：抢占型云主机；如不传此参数，默认全部获取 - **Limit** (int) - 返回数据长度，默认为20，最大100 @@ -258,19 +258,19 @@ def describe_uhost_instance(self, req=None, **kwargs): - **Tag** (str) - 要查询的业务组名称 - **UHostIds** (list) - 【数组】UHost主机的资源ID，例如UHostIds.0代表希望获取信息 的主机1，UHostIds.1代表主机2。 如果不传入，则返回当前Region 所有符合条件的UHost实例。 - **VPCId** (str) - vpc id。通过VPC筛选主机。北京一地域无效。 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **Action** (str) - 操作名称 - **RetCode** (int) - 返回码 - **TotalCount** (int) - UHostInstance总数 - **UHostSet** (list) - 见 **UHostInstanceSet** 模型定义 - + **Response Model** - - **UHostDiskSet** - + + **UHostDiskSet** + - **BackupType** (str) - 备份方案。若开通了数据方舟，则为DataArk - **DiskId** (str) - 磁盘ID - **DiskType** (str) - 磁盘类型。请参考 `磁盘类型 `_ 。 @@ -281,8 +281,8 @@ def describe_uhost_instance(self, req=None, **kwargs): - **Size** (int) - 磁盘大小，单位: GB - **Type** (str) - 【建议不再使用】磁盘类型。系统盘: Boot，数据盘: Data,网络盘：Udisk - **UHostIPSet** - + **UHostIPSet** + - **Bandwidth** (int) - IP对应的带宽, 单位: Mb (内网IP不显示带宽信息) - **Default** (str) - 【暂未支持】是否为默认网卡。True: 是默认网卡；其他值：不是。 - **IP** (str) - IP地址 @@ -293,8 +293,8 @@ def describe_uhost_instance(self, req=None, **kwargs): - **VPCId** (str) - IP地址对应的VPC ID。（北京一不支持，字段返回为空） - **Weight** (int) - 当前EIP的权重。权重最大的为当前的出口IP。 - **UHostInstanceSet** - + **UHostInstanceSet** + - **AutoRenew** (str) - 是否自动续费，自动续费：“Yes”，不自动续费：“No” - **BasicImageId** (str) - 基础镜像ID（指当前自定义镜像的来源镜像） - **BasicImageName** (str) - 基础镜像名称（指当前自定义镜像的来源镜像） @@ -327,7 +327,7 @@ def describe_uhost_instance(self, req=None, **kwargs): - **TotalDiskSpace** (int) - 总的数据盘存储空间。 - **UHostId** (str) - UHost实例ID - **UHostType** (str) - 【建议不再使用】云主机机型（旧）。参考 `云主机机型说明 `_ 。 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ + - **Zone** (str) - 可用区。参见 `可用区列表 `_ """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} @@ -337,24 +337,24 @@ def describe_uhost_instance(self, req=None, **kwargs): return apis.DescribeUHostInstanceResponseSchema().loads(resp) def describe_uhost_instance_snapshot(self, req=None, **kwargs): - """ DescribeUHostInstanceSnapshot - 获取已经存在的UHost实例的存储快照列表。 + """DescribeUHostInstanceSnapshot - 获取已经存在的UHost实例的存储快照列表。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **SnapshotSet** (list) - 见 **UHostSnapshotSet** 模型定义 - **UhostId** (str) - UHost实例ID - + **Response Model** - - **UHostSnapshotSet** - + + **UHostSnapshotSet** + - **SnapshotName** (str) - 快照名称 - **SnapshotState** (str) - 快照状态, 制作中:Capturing 制作成功:Success 制作失败:Fail - **SnapshotTime** (str) - 快照制作时间 @@ -367,23 +367,23 @@ def describe_uhost_instance_snapshot(self, req=None, **kwargs): return apis.DescribeUHostInstanceSnapshotResponseSchema().loads(resp) def describe_uhost_tags(self, req=None, **kwargs): - """ DescribeUHostTags - 获取指定数据中心的业务组列表。 + """DescribeUHostTags - 获取指定数据中心的业务组列表。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **TagSet** (list) - 见 **UHostTagSet** 模型定义 - **TotalCount** (int) - 已有主机的业务组总个数 - + **Response Model** - - **UHostTagSet** - + + **UHostTagSet** + - **Tag** (str) - 业务组名称 - **TotalCount** (int) - 该业务组中包含的主机个数 - **Zone** (str) - 可用区 @@ -396,12 +396,12 @@ def describe_uhost_tags(self, req=None, **kwargs): return apis.DescribeUHostTagsResponseSchema().loads(resp) def get_uhost_instance_price(self, req=None, **kwargs): - """ GetUHostInstancePrice - 根据UHost实例配置，获取UHost实例的价格。 + """GetUHostInstancePrice - 根据UHost实例配置，获取UHost实例的价格。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **CPU** (int) - (Required) CPU核数。可选参数：1-64。可选范围参照控制台。默认值: 4 - **Count** (int) - (Required) 购买台数，范围[1,5] - **ImageId** (str) - (Required) 镜像Id，可通过 `DescribeImage `_ 获取镜像ID @@ -418,25 +418,25 @@ def get_uhost_instance_price(self, req=None, **kwargs): - **StorageType** (str) - 【待废弃】磁盘类型，同时设定系统盘和数据盘， 枚举值为：LocalDisk，本地磁盘; UDisk，云硬盘; 默认为LocalDisk 仅部分可用区支持云硬盘方式的主机存储方式，具体请查询控制台。 - **TimemachineFeature** (str) - 【待废弃】方舟机型。No，Yes。默认是No。 - **UHostType** (str) - 【待废弃】云主机机型（V1版本概念）。参考 `云主机机型说明 `_ 。 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **PriceSet** (list) - 见 **UHostPriceSet** 模型定义 - + **Request Model** - - **GetUHostInstancePriceParamDisks** - - - **BackupType** (str) - 磁盘备份方案。枚举值：\\ > NONE，无备份 \\ > DATAARK，数据方舟 \\ 当前磁盘支持的备份模式参考 `磁盘类型 `_ + + **GetUHostInstancePriceParamDisks** + + - **BackupType** (str) - 磁盘备份方案。枚举值：\\ > NONE，无备份 \\ > DATAARK，数据方舟 \\ 当前磁盘支持的备份模式参考 `磁盘类型 `_ - **IsBoot** (str) - 是否是系统盘。枚举值：\\ > True，是系统盘 \\ > False，是数据盘（默认）。Disks数组中有且只能有一块盘是系统盘。 - **Size** (int) - 磁盘大小，单位GB。请参考 `磁盘类型 `_ 。 - **Type** (str) - 磁盘类型。请参考 `磁盘类型 `_ 。 **Response Model** - - **UHostPriceSet** - + + **UHostPriceSet** + - **ChargeType** (str) - 计费类型。Year，Month，Dynamic - **Price** (float) - 价格，单位: 元，保留小数点后两位有效数字 @@ -448,22 +448,22 @@ def get_uhost_instance_price(self, req=None, **kwargs): return apis.GetUHostInstancePriceResponseSchema().loads(resp) def get_uhost_instance_vnc_info(self, req=None, **kwargs): - """ GetUHostInstanceVncInfo - 获取指定UHost实例的管理VNC配置详细信息。 + """GetUHostInstanceVncInfo - 获取指定UHost实例的管理VNC配置详细信息。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - **VncIP** (str) - Vnc登录IP - **VncPassword** (str) - Vnc 登录密码 - **VncPort** (int) - Vnc登录端口 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -472,12 +472,12 @@ def get_uhost_instance_vnc_info(self, req=None, **kwargs): return apis.GetUHostInstanceVncInfoResponseSchema().loads(resp) def get_uhost_upgrade_price(self, req=None, **kwargs): - """ GetUHostUpgradePrice - 获取UHost实例升级配置的价格。可选配置范围请参考 `云主机机型说明 `_ 。 + """GetUHostUpgradePrice - 获取UHost实例升级配置的价格。可选配置范围请参考 `云主机机型说明 `_ 。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **UHostId** (str) - (Required) UHost实例ID。 参见 `DescribeUHostInstance `_ 。 - **BootDiskSpace** (int) - 【待废弃】系统大小，单位: GB，范围[20,100]，步长: 10。 - **CPU** (int) - 虚拟CPU核数。可选参数：1-64（可选范围参考控制台）。默认值为当前实例的CPU核数。 @@ -486,12 +486,12 @@ def get_uhost_upgrade_price(self, req=None, **kwargs): - **Memory** (int) - 内存大小。单位：MB。范围 ：[1024, 262144]，取值为1024的倍数（可选范围参考控制台）。默认值为当前实例的内存大小。 - **NetCapValue** (int) - 网卡升降级（1，表示升级，2表示降级，0表示不变） - **TimemachineFeature** (str) - 方舟机型。No，Yes。默认是No。 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **Price** (float) - 规格调整差价。精确到小数点后2位。 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -500,12 +500,12 @@ def get_uhost_upgrade_price(self, req=None, **kwargs): return apis.GetUHostUpgradePriceResponseSchema().loads(resp) def import_custom_image(self, req=None, **kwargs): - """ ImportCustomImage - 把UFile的镜像文件导入到UHost，生成自定义镜像 + """ImportCustomImage - 把UFile的镜像文件导入到UHost，生成自定义镜像 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Auth** (bool) - (Required) 是否授权。必须填true - **Format** (str) - (Required) 镜像格式，可选RAW、VHD、VMDK、qcow2 - **ImageName** (str) - (Required) 镜像名称 @@ -513,11 +513,11 @@ def import_custom_image(self, req=None, **kwargs): - **OsType** (str) - (Required) 操作系统平台，比如CentOS、Ubuntu、Windows、RedHat等，请参考控制台的镜像版本；若导入控制台上没有的操作系统，参数为Other - **UFileUrl** (str) - (Required) UFile私有空间地址 - **ImageDescription** (str) - 镜像描述 - + **Response** - **ImageId** (str) - 镜像Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -527,20 +527,20 @@ def import_custom_image(self, req=None, **kwargs): return apis.ImportCustomImageResponseSchema().loads(resp) def modify_uhost_instance_name(self, req=None, **kwargs): - """ ModifyUHostInstanceName - 修改指定UHost实例名称，需要给出数据中心，UHostId，及新的实例名称。 + """ModifyUHostInstanceName - 修改指定UHost实例名称，需要给出数据中心，UHostId，及新的实例名称。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - **Name** (str) - UHost实例名称 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -549,20 +549,20 @@ def modify_uhost_instance_name(self, req=None, **kwargs): return apis.ModifyUHostInstanceNameResponseSchema().loads(resp) def modify_uhost_instance_remark(self, req=None, **kwargs): - """ ModifyUHostInstanceRemark - 修改指定UHost实例备注信息。 + """ModifyUHostInstanceRemark - 修改指定UHost实例备注信息。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - **Remark** (str) - 备注 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -571,20 +571,20 @@ def modify_uhost_instance_remark(self, req=None, **kwargs): return apis.ModifyUHostInstanceRemarkResponseSchema().loads(resp) def modify_uhost_instance_tag(self, req=None, **kwargs): - """ ModifyUHostInstanceTag - 修改指定UHost实例业务组标识。 + """ModifyUHostInstanceTag - 修改指定UHost实例业务组标识。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - **Tag** (str) - 业务组名称 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -593,19 +593,19 @@ def modify_uhost_instance_tag(self, req=None, **kwargs): return apis.ModifyUHostInstanceTagResponseSchema().loads(resp) def poweroff_uhost_instance(self, req=None, **kwargs): - """ PoweroffUHostInstance - 直接关闭UHost实例电源，无需等待实例正常关闭。 + """PoweroffUHostInstance - 直接关闭UHost实例电源，无需等待实例正常关闭。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -614,20 +614,20 @@ def poweroff_uhost_instance(self, req=None, **kwargs): return apis.PoweroffUHostInstanceResponseSchema().loads(resp) def reboot_uhost_instance(self, req=None, **kwargs): - """ RebootUHostInstance - 重新启动UHost实例，需要指定数据中心及UHostID两个参数的值。 + """RebootUHostInstance - 重新启动UHost实例，需要指定数据中心及UHostID两个参数的值。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - **DiskPassword** (str) - 加密盘密码 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -636,24 +636,24 @@ def reboot_uhost_instance(self, req=None, **kwargs): return apis.RebootUHostInstanceResponseSchema().loads(resp) def reinstall_uhost_instance(self, req=None, **kwargs): - """ ReinstallUHostInstance - 重新安装指定UHost实例的操作系统 + """ReinstallUHostInstance - 重新安装指定UHost实例的操作系统 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例资源ID 参见 `DescribeUHostInstance `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例资源ID 参见 `DescribeUHostInstance `_ - **DNSServers** (list) - 针对非私有子网主机，可自定义DNS。n可为0-2 - - **ImageId** (str) - 镜像Id，默认使用原镜像 参见 `DescribeImage `_ + - **ImageId** (str) - 镜像Id，默认使用原镜像 参见 `DescribeImage `_ - **Password** (str) - 如果创建UHost实例时LoginMode为Password，则必须填写，如果LoginMode为KeyPair，不需要填写 （密码格式使用BASE64编码；LoginMode不可变更） - **ReserveDisk** (str) - 是否保留数据盘，保留：Yes，不报留：No， 默认：Yes - **ResourceType** (int) - 云灾备指明191 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例资源ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -662,20 +662,20 @@ def reinstall_uhost_instance(self, req=None, **kwargs): return apis.ReinstallUHostInstanceResponseSchema().loads(resp) def reset_uhost_instance_password(self, req=None, **kwargs): - """ ResetUHostInstancePassword - 重置UHost实例的管理员密码。 + """ResetUHostInstancePassword - 重置UHost实例的管理员密码。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Password** (str) - (Required) UHost新密码（密码格式使用BASE64编码） - **UHostId** (str) - (Required) UHost实例ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -684,21 +684,21 @@ def reset_uhost_instance_password(self, req=None, **kwargs): return apis.ResetUHostInstancePasswordResponseSchema().loads(resp) def resize_attached_disk(self, req=None, **kwargs): - """ ResizeAttachedDisk - 修改挂载的磁盘大小，包含系统盘和数据盘 + """ResizeAttachedDisk - 修改挂载的磁盘大小，包含系统盘和数据盘 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **DiskId** (str) - (Required) 磁盘ID。参见 `DescribeUHostInstance `_ 返回值中的DiskSet。 - **DiskSpace** (int) - (Required) 磁盘大小，单位GB，步长为10。取值范围需大于当前磁盘大小，最大值请参考 `磁盘类型 `_ 。 - **UHostId** (str) - (Required) UHost实例ID。 参见 `DescribeUHostInstance `_ 。 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + **Response** - **DiskId** (str) - 改配成功的磁盘id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -707,24 +707,24 @@ def resize_attached_disk(self, req=None, **kwargs): return apis.ResizeAttachedDiskResponseSchema().loads(resp) def resize_uhost_instance(self, req=None, **kwargs): - """ ResizeUHostInstance - 修改指定UHost实例的资源配置，如CPU核心数，内存容量大小，磁盘空间大小,网络增强等。 + """ResizeUHostInstance - 修改指定UHost实例的资源配置，如CPU核心数，内存容量大小，磁盘空间大小,网络增强等。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - **BootDiskSpace** (int) - 系统盘大小，单位：GB，范围[20,100]，步长：10，系统盘不支持缩容，因此不允许输入比当前实例系统盘小的值 - **CPU** (int) - 虚拟CPU核数，单位：个，范围：[1,16]，最小值为1，其他值是2的倍数，默认值为当前实例的CPU核数（*windows CPU>=2） - **DiskSpace** (int) - 数据盘大小，单位：GB，范围[10,1000]； SSD机型，单位：GB，范围[100,500]；步长：10，默认值为当前实例的数据盘大小，数据盘不支持缩容，因此不允许输入比当前实例数据盘大小的值 - **Memory** (int) - 内存大小，单位：MB，范围[2048,65536]，步长：2048，默认值为当前实例的内存大小（BGP-C数据中心最小支持1024，限Linux系统） - **NetCapValue** (int) - 网卡升降级（1，表示升级，2表示降级，0表示不变） - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -733,20 +733,20 @@ def resize_uhost_instance(self, req=None, **kwargs): return apis.ResizeUHostInstanceResponseSchema().loads(resp) def start_uhost_instance(self, req=None, **kwargs): - """ StartUHostInstance - 启动处于关闭状态的UHost实例，需要指定数据中心及UHostID两个参数的值。 + """StartUHostInstance - 启动处于关闭状态的UHost实例，需要指定数据中心及UHostID两个参数的值。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - **DiskPassword** (str) - 加密盘密码 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -755,19 +755,19 @@ def start_uhost_instance(self, req=None, **kwargs): return apis.StartUHostInstanceResponseSchema().loads(resp) def stop_uhost_instance(self, req=None, **kwargs): - """ StopUHostInstance - 指停止处于运行状态的UHost实例，需指定数据中心及UhostID。 + """StopUHostInstance - 指停止处于运行状态的UHost实例，需指定数据中心及UhostID。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost实例ID 参见 `DescribeUHostInstance `_ + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **UhostId** (str) - UHost实例ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -776,19 +776,19 @@ def stop_uhost_instance(self, req=None, **kwargs): return apis.StopUHostInstanceResponseSchema().loads(resp) def terminate_custom_image(self, req=None, **kwargs): - """ TerminateCustomImage - 删除用户自定义镜像 + """TerminateCustomImage - 删除用户自定义镜像 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **ImageId** (str) - (Required) 自制镜像ID 参见 `DescribeImage `_ - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ImageId** (str) - (Required) 自制镜像ID 参见 `DescribeImage `_ + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **ImageId** (str) - 自制镜像Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -797,23 +797,23 @@ def terminate_custom_image(self, req=None, **kwargs): return apis.TerminateCustomImageResponseSchema().loads(resp) def terminate_uhost_instance(self, req=None, **kwargs): - """ TerminateUHostInstance - 删除指定数据中心的UHost实例。 + """TerminateUHostInstance - 删除指定数据中心的UHost实例。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **UHostId** (str) - (Required) UHost资源Id 参见 `DescribeUHostInstance `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UHostId** (str) - (Required) UHost资源Id 参见 `DescribeUHostInstance `_ - **Destroy** (int) - 是否直接删除，0表示按照原来的逻辑（有回收站权限，则进入回收站），1表示直接删除 - **ReleaseEIP** (bool) - 是否释放绑定的EIP。true: 解绑EIP后，并释放；其他值或不填：解绑EIP。 - **ReleaseUDisk** (bool) - 是否删除挂载的数据盘。true删除，其他不删除。 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **InRecycle** (str) - 放入回收站:"Yes", 彻底删除：“No” - **UHostId** (str) - UHost 实例 Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -822,19 +822,19 @@ def terminate_uhost_instance(self, req=None, **kwargs): return apis.TerminateUHostInstanceResponseSchema().loads(resp) def upgrade_to_ark_uhost_instance(self, req=None, **kwargs): - """ UpgradeToArkUHostInstance - 普通升级为方舟机型 + """UpgradeToArkUHostInstance - 普通升级为方舟机型 **Request** - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **UHostIds** (list) - (Required) UHost主机的资源ID，例如UHostIds.0代表希望升级的主机1，UHostIds.1代表主机2。 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **CouponId** (str) - 代金券ID 请参考DescribeCoupon接口 - + **Response** - **UHostSet** (list) - UHost主机的资源ID数组 - + """ d = {"Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/uhost/schemas/apis.py b/ucloud/services/uhost/schemas/apis.py index d01adc7..d26c9bf 100644 --- a/ucloud/services/uhost/schemas/apis.py +++ b/ucloud/services/uhost/schemas/apis.py @@ -14,8 +14,7 @@ class CopyCustomImageRequestSchema(schema.RequestSchema): - """ CopyCustomImage - 复制自制镜像 - """ + """CopyCustomImage - 复制自制镜像""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -34,8 +33,7 @@ class CopyCustomImageRequestSchema(schema.RequestSchema): class CopyCustomImageResponseSchema(schema.ResponseSchema): - """ CopyCustomImage - 复制自制镜像 - """ + """CopyCustomImage - 复制自制镜像""" fields = { "TargetImageId": fields.Str(required=False, load_from="TargetImageId") @@ -50,8 +48,7 @@ class CopyCustomImageResponseSchema(schema.ResponseSchema): class CreateCustomImageRequestSchema(schema.RequestSchema): - """ CreateCustomImage - 从指定UHost实例，生成自定义镜像。 - """ + """CreateCustomImage - 从指定UHost实例，生成自定义镜像。""" fields = { "ImageDescription": fields.Str( @@ -66,8 +63,7 @@ class CreateCustomImageRequestSchema(schema.RequestSchema): class CreateCustomImageResponseSchema(schema.ResponseSchema): - """ CreateCustomImage - 从指定UHost实例，生成自定义镜像。 - """ + """CreateCustomImage - 从指定UHost实例，生成自定义镜像。""" fields = {"ImageId": fields.Str(required=False, load_from="ImageId")} @@ -82,8 +78,7 @@ class CreateCustomImageResponseSchema(schema.ResponseSchema): class CreateUHostInstanceParamNetworkInterfaceEIPGlobalSSHSchema( schema.RequestSchema ): - """ CreateUHostInstanceParamNetworkInterfaceEIPGlobalSSH - - """ + """CreateUHostInstanceParamNetworkInterfaceEIPGlobalSSH -""" fields = { "Area": fields.Str(required=False, dump_to="Area"), @@ -93,8 +88,7 @@ class CreateUHostInstanceParamNetworkInterfaceEIPGlobalSSHSchema( class CreateUHostInstanceParamNetworkInterfaceIPv6Schema(schema.RequestSchema): - """ CreateUHostInstanceParamNetworkInterfaceIPv6 - - """ + """CreateUHostInstanceParamNetworkInterfaceIPv6 -""" fields = { "Adress": fields.Str(required=False, dump_to="Adress"), @@ -105,8 +99,7 @@ class CreateUHostInstanceParamNetworkInterfaceIPv6Schema(schema.RequestSchema): class CreateUHostInstanceParamNetworkInterfaceEIPSchema(schema.RequestSchema): - """ CreateUHostInstanceParamNetworkInterfaceEIP - - """ + """CreateUHostInstanceParamNetworkInterfaceEIP -""" fields = { "Bandwidth": fields.Int(required=False, dump_to="Bandwidth"), @@ -123,8 +116,7 @@ class CreateUHostInstanceParamNetworkInterfaceEIPSchema(schema.RequestSchema): class CreateUHostInstanceParamNetworkInterfaceSchema(schema.RequestSchema): - """ CreateUHostInstanceParamNetworkInterface - - """ + """CreateUHostInstanceParamNetworkInterface -""" fields = { "EIP": CreateUHostInstanceParamNetworkInterfaceEIPSchema( @@ -137,8 +129,7 @@ class CreateUHostInstanceParamNetworkInterfaceSchema(schema.RequestSchema): class CreateUHostInstanceParamDisksSchema(schema.RequestSchema): - """ CreateUHostInstanceParamDisks - - """ + """CreateUHostInstanceParamDisks -""" fields = { "BackupType": fields.Str(required=False, dump_to="BackupType"), @@ -152,8 +143,7 @@ class CreateUHostInstanceParamDisksSchema(schema.RequestSchema): class CreateUHostInstanceRequestSchema(schema.RequestSchema): - """ CreateUHostInstance - 创建UHost实例。 - """ + """CreateUHostInstance - 创建UHost实例。""" fields = { "AlarmTemplateId": fields.Int( @@ -214,8 +204,7 @@ class CreateUHostInstanceRequestSchema(schema.RequestSchema): class CreateUHostInstanceResponseSchema(schema.ResponseSchema): - """ CreateUHostInstance - 创建UHost实例。 - """ + """CreateUHostInstance - 创建UHost实例。""" fields = { "IPs": fields.List(fields.Str(), required=False, load_from="IPs"), @@ -233,8 +222,7 @@ class CreateUHostInstanceResponseSchema(schema.ResponseSchema): class DescribeImageRequestSchema(schema.RequestSchema): - """ DescribeImage - 获取指定数据中心镜像列表，用户可通过指定操作系统类型，镜像Id进行过滤。 - """ + """DescribeImage - 获取指定数据中心镜像列表，用户可通过指定操作系统类型，镜像Id进行过滤。""" fields = { "ImageId": fields.Str(required=False, dump_to="ImageId"), @@ -250,8 +238,7 @@ class DescribeImageRequestSchema(schema.RequestSchema): class DescribeImageResponseSchema(schema.ResponseSchema): - """ DescribeImage - 获取指定数据中心镜像列表，用户可通过指定操作系统类型，镜像Id进行过滤。 - """ + """DescribeImage - 获取指定数据中心镜像列表，用户可通过指定操作系统类型，镜像Id进行过滤。""" fields = { "ImageSet": fields.List( @@ -269,8 +256,7 @@ class DescribeImageResponseSchema(schema.ResponseSchema): class DescribeIsolationGroupRequestSchema(schema.RequestSchema): - """ DescribeIsolationGroup - 查询硬件隔离组列表。 - """ + """DescribeIsolationGroup - 查询硬件隔离组列表。""" fields = { "GroupId": fields.Str(required=False, dump_to="GroupId"), @@ -282,8 +268,7 @@ class DescribeIsolationGroupRequestSchema(schema.RequestSchema): class DescribeIsolationGroupResponseSchema(schema.ResponseSchema): - """ DescribeIsolationGroup - 查询硬件隔离组列表。 - """ + """DescribeIsolationGroup - 查询硬件隔离组列表。""" fields = { "IsolationGroupSet": fields.List( @@ -302,8 +287,7 @@ class DescribeIsolationGroupResponseSchema(schema.ResponseSchema): class DescribeUHostInstanceRequestSchema(schema.RequestSchema): - """ DescribeUHostInstance - 获取主机或主机列表信息，并可根据数据中心，主机ID等参数进行过滤。 - """ + """DescribeUHostInstance - 获取主机或主机列表信息，并可根据数据中心，主机ID等参数进行过滤。""" fields = { "IsolationGroup": fields.Str(required=False, dump_to="IsolationGroup"), @@ -321,8 +305,7 @@ class DescribeUHostInstanceRequestSchema(schema.RequestSchema): class DescribeUHostInstanceResponseSchema(schema.ResponseSchema): - """ DescribeUHostInstance - 获取主机或主机列表信息，并可根据数据中心，主机ID等参数进行过滤。 - """ + """DescribeUHostInstance - 获取主机或主机列表信息，并可根据数据中心，主机ID等参数进行过滤。""" fields = { "Action": fields.Str(required=True, load_from="Action"), @@ -344,8 +327,7 @@ class DescribeUHostInstanceResponseSchema(schema.ResponseSchema): class DescribeUHostInstanceSnapshotRequestSchema(schema.RequestSchema): - """ DescribeUHostInstanceSnapshot - 获取已经存在的UHost实例的存储快照列表。 - """ + """DescribeUHostInstanceSnapshot - 获取已经存在的UHost实例的存储快照列表。""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -356,8 +338,7 @@ class DescribeUHostInstanceSnapshotRequestSchema(schema.RequestSchema): class DescribeUHostInstanceSnapshotResponseSchema(schema.ResponseSchema): - """ DescribeUHostInstanceSnapshot - 获取已经存在的UHost实例的存储快照列表。 - """ + """DescribeUHostInstanceSnapshot - 获取已经存在的UHost实例的存储快照列表。""" fields = { "SnapshotSet": fields.List( @@ -377,8 +358,7 @@ class DescribeUHostInstanceSnapshotResponseSchema(schema.ResponseSchema): class DescribeUHostTagsRequestSchema(schema.RequestSchema): - """ DescribeUHostTags - 获取指定数据中心的业务组列表。 - """ + """DescribeUHostTags - 获取指定数据中心的业务组列表。""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -388,8 +368,7 @@ class DescribeUHostTagsRequestSchema(schema.RequestSchema): class DescribeUHostTagsResponseSchema(schema.ResponseSchema): - """ DescribeUHostTags - 获取指定数据中心的业务组列表。 - """ + """DescribeUHostTags - 获取指定数据中心的业务组列表。""" fields = { "TagSet": fields.List( @@ -407,8 +386,7 @@ class DescribeUHostTagsResponseSchema(schema.ResponseSchema): class GetUHostInstancePriceParamDisksSchema(schema.RequestSchema): - """ GetUHostInstancePriceParamDisks - - """ + """GetUHostInstancePriceParamDisks -""" fields = { "BackupType": fields.Str(required=False, dump_to="BackupType"), @@ -419,8 +397,7 @@ class GetUHostInstancePriceParamDisksSchema(schema.RequestSchema): class GetUHostInstancePriceRequestSchema(schema.RequestSchema): - """ GetUHostInstancePrice - 根据UHost实例配置，获取UHost实例的价格。 - """ + """GetUHostInstancePrice - 根据UHost实例配置，获取UHost实例的价格。""" fields = { "CPU": fields.Int(required=True, dump_to="CPU"), @@ -448,8 +425,7 @@ class GetUHostInstancePriceRequestSchema(schema.RequestSchema): class GetUHostInstancePriceResponseSchema(schema.ResponseSchema): - """ GetUHostInstancePrice - 根据UHost实例配置，获取UHost实例的价格。 - """ + """GetUHostInstancePrice - 根据UHost实例配置，获取UHost实例的价格。""" fields = { "PriceSet": fields.List( @@ -466,8 +442,7 @@ class GetUHostInstancePriceResponseSchema(schema.ResponseSchema): class GetUHostInstanceVncInfoRequestSchema(schema.RequestSchema): - """ GetUHostInstanceVncInfo - 获取指定UHost实例的管理VNC配置详细信息。 - """ + """GetUHostInstanceVncInfo - 获取指定UHost实例的管理VNC配置详细信息。""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -478,8 +453,7 @@ class GetUHostInstanceVncInfoRequestSchema(schema.RequestSchema): class GetUHostInstanceVncInfoResponseSchema(schema.ResponseSchema): - """ GetUHostInstanceVncInfo - 获取指定UHost实例的管理VNC配置详细信息。 - """ + """GetUHostInstanceVncInfo - 获取指定UHost实例的管理VNC配置详细信息。""" fields = { "UhostId": fields.Str(required=False, load_from="UhostId"), @@ -497,8 +471,7 @@ class GetUHostInstanceVncInfoResponseSchema(schema.ResponseSchema): class GetUHostUpgradePriceRequestSchema(schema.RequestSchema): - """ GetUHostUpgradePrice - 获取UHost实例升级配置的价格。可选配置范围请参考[[api:uhost-api:uhost_type|云主机机型说明]]。 - """ + """GetUHostUpgradePrice - 获取UHost实例升级配置的价格。可选配置范围请参考[[api:uhost-api:uhost_type|云主机机型说明]]。""" fields = { "BootDiskSpace": fields.Int(required=False, dump_to="BootDiskSpace"), @@ -518,8 +491,7 @@ class GetUHostUpgradePriceRequestSchema(schema.RequestSchema): class GetUHostUpgradePriceResponseSchema(schema.ResponseSchema): - """ GetUHostUpgradePrice - 获取UHost实例升级配置的价格。可选配置范围请参考[[api:uhost-api:uhost_type|云主机机型说明]]。 - """ + """GetUHostUpgradePrice - 获取UHost实例升级配置的价格。可选配置范围请参考[[api:uhost-api:uhost_type|云主机机型说明]]。""" fields = {"Price": fields.Float(required=False, load_from="Price")} @@ -532,8 +504,7 @@ class GetUHostUpgradePriceResponseSchema(schema.ResponseSchema): class ImportCustomImageRequestSchema(schema.RequestSchema): - """ ImportCustomImage - 把UFile的镜像文件导入到UHost，生成自定义镜像 - """ + """ImportCustomImage - 把UFile的镜像文件导入到UHost，生成自定义镜像""" fields = { "Auth": fields.Bool(required=True, dump_to="Auth"), @@ -551,8 +522,7 @@ class ImportCustomImageRequestSchema(schema.RequestSchema): class ImportCustomImageResponseSchema(schema.ResponseSchema): - """ ImportCustomImage - 把UFile的镜像文件导入到UHost，生成自定义镜像 - """ + """ImportCustomImage - 把UFile的镜像文件导入到UHost，生成自定义镜像""" fields = {"ImageId": fields.Str(required=False, load_from="ImageId")} @@ -565,8 +535,7 @@ class ImportCustomImageResponseSchema(schema.ResponseSchema): class ModifyUHostInstanceNameRequestSchema(schema.RequestSchema): - """ ModifyUHostInstanceName - 修改指定UHost实例名称，需要给出数据中心，UHostId，及新的实例名称。 - """ + """ModifyUHostInstanceName - 修改指定UHost实例名称，需要给出数据中心，UHostId，及新的实例名称。""" fields = { "Name": fields.Str(required=False, dump_to="Name"), @@ -578,8 +547,7 @@ class ModifyUHostInstanceNameRequestSchema(schema.RequestSchema): class ModifyUHostInstanceNameResponseSchema(schema.ResponseSchema): - """ ModifyUHostInstanceName - 修改指定UHost实例名称，需要给出数据中心，UHostId，及新的实例名称。 - """ + """ModifyUHostInstanceName - 修改指定UHost实例名称，需要给出数据中心，UHostId，及新的实例名称。""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -592,8 +560,7 @@ class ModifyUHostInstanceNameResponseSchema(schema.ResponseSchema): class ModifyUHostInstanceRemarkRequestSchema(schema.RequestSchema): - """ ModifyUHostInstanceRemark - 修改指定UHost实例备注信息。 - """ + """ModifyUHostInstanceRemark - 修改指定UHost实例备注信息。""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -605,8 +572,7 @@ class ModifyUHostInstanceRemarkRequestSchema(schema.RequestSchema): class ModifyUHostInstanceRemarkResponseSchema(schema.ResponseSchema): - """ ModifyUHostInstanceRemark - 修改指定UHost实例备注信息。 - """ + """ModifyUHostInstanceRemark - 修改指定UHost实例备注信息。""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -619,8 +585,7 @@ class ModifyUHostInstanceRemarkResponseSchema(schema.ResponseSchema): class ModifyUHostInstanceTagRequestSchema(schema.RequestSchema): - """ ModifyUHostInstanceTag - 修改指定UHost实例业务组标识。 - """ + """ModifyUHostInstanceTag - 修改指定UHost实例业务组标识。""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -632,8 +597,7 @@ class ModifyUHostInstanceTagRequestSchema(schema.RequestSchema): class ModifyUHostInstanceTagResponseSchema(schema.ResponseSchema): - """ ModifyUHostInstanceTag - 修改指定UHost实例业务组标识。 - """ + """ModifyUHostInstanceTag - 修改指定UHost实例业务组标识。""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -646,8 +610,7 @@ class ModifyUHostInstanceTagResponseSchema(schema.ResponseSchema): class PoweroffUHostInstanceRequestSchema(schema.RequestSchema): - """ PoweroffUHostInstance - 直接关闭UHost实例电源，无需等待实例正常关闭。 - """ + """PoweroffUHostInstance - 直接关闭UHost实例电源，无需等待实例正常关闭。""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -658,8 +621,7 @@ class PoweroffUHostInstanceRequestSchema(schema.RequestSchema): class PoweroffUHostInstanceResponseSchema(schema.ResponseSchema): - """ PoweroffUHostInstance - 直接关闭UHost实例电源，无需等待实例正常关闭。 - """ + """PoweroffUHostInstance - 直接关闭UHost实例电源，无需等待实例正常关闭。""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -672,8 +634,7 @@ class PoweroffUHostInstanceResponseSchema(schema.ResponseSchema): class RebootUHostInstanceRequestSchema(schema.RequestSchema): - """ RebootUHostInstance - 重新启动UHost实例，需要指定数据中心及UHostID两个参数的值。 - """ + """RebootUHostInstance - 重新启动UHost实例，需要指定数据中心及UHostID两个参数的值。""" fields = { "DiskPassword": fields.Str(required=False, dump_to="DiskPassword"), @@ -685,8 +646,7 @@ class RebootUHostInstanceRequestSchema(schema.RequestSchema): class RebootUHostInstanceResponseSchema(schema.ResponseSchema): - """ RebootUHostInstance - 重新启动UHost实例，需要指定数据中心及UHostID两个参数的值。 - """ + """RebootUHostInstance - 重新启动UHost实例，需要指定数据中心及UHostID两个参数的值。""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -699,8 +659,7 @@ class RebootUHostInstanceResponseSchema(schema.ResponseSchema): class ReinstallUHostInstanceRequestSchema(schema.RequestSchema): - """ ReinstallUHostInstance - 重新安装指定UHost实例的操作系统 - """ + """ReinstallUHostInstance - 重新安装指定UHost实例的操作系统""" fields = { "DNSServers": fields.List(fields.Str()), @@ -716,8 +675,7 @@ class ReinstallUHostInstanceRequestSchema(schema.RequestSchema): class ReinstallUHostInstanceResponseSchema(schema.ResponseSchema): - """ ReinstallUHostInstance - 重新安装指定UHost实例的操作系统 - """ + """ReinstallUHostInstance - 重新安装指定UHost实例的操作系统""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -730,8 +688,7 @@ class ReinstallUHostInstanceResponseSchema(schema.ResponseSchema): class ResetUHostInstancePasswordRequestSchema(schema.RequestSchema): - """ ResetUHostInstancePassword - 重置UHost实例的管理员密码。 - """ + """ResetUHostInstancePassword - 重置UHost实例的管理员密码。""" fields = { "Password": fields.Base64(required=True, dump_to="Password"), @@ -743,8 +700,7 @@ class ResetUHostInstancePasswordRequestSchema(schema.RequestSchema): class ResetUHostInstancePasswordResponseSchema(schema.ResponseSchema): - """ ResetUHostInstancePassword - 重置UHost实例的管理员密码。 - """ + """ResetUHostInstancePassword - 重置UHost实例的管理员密码。""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -757,8 +713,7 @@ class ResetUHostInstancePasswordResponseSchema(schema.ResponseSchema): class ResizeAttachedDiskRequestSchema(schema.RequestSchema): - """ ResizeAttachedDisk - 修改挂载的磁盘大小，包含系统盘和数据盘 - """ + """ResizeAttachedDisk - 修改挂载的磁盘大小，包含系统盘和数据盘""" fields = { "DiskId": fields.Str(required=True, dump_to="DiskId"), @@ -771,8 +726,7 @@ class ResizeAttachedDiskRequestSchema(schema.RequestSchema): class ResizeAttachedDiskResponseSchema(schema.ResponseSchema): - """ ResizeAttachedDisk - 修改挂载的磁盘大小，包含系统盘和数据盘 - """ + """ResizeAttachedDisk - 修改挂载的磁盘大小，包含系统盘和数据盘""" fields = {"DiskId": fields.Str(required=False, load_from="DiskId")} @@ -785,8 +739,7 @@ class ResizeAttachedDiskResponseSchema(schema.ResponseSchema): class ResizeUHostInstanceRequestSchema(schema.RequestSchema): - """ ResizeUHostInstance - 修改指定UHost实例的资源配置，如CPU核心数，内存容量大小，磁盘空间大小,网络增强等。 - """ + """ResizeUHostInstance - 修改指定UHost实例的资源配置，如CPU核心数，内存容量大小，磁盘空间大小,网络增强等。""" fields = { "BootDiskSpace": fields.Int(required=False, dump_to="BootDiskSpace"), @@ -802,8 +755,7 @@ class ResizeUHostInstanceRequestSchema(schema.RequestSchema): class ResizeUHostInstanceResponseSchema(schema.ResponseSchema): - """ ResizeUHostInstance - 修改指定UHost实例的资源配置，如CPU核心数，内存容量大小，磁盘空间大小,网络增强等。 - """ + """ResizeUHostInstance - 修改指定UHost实例的资源配置，如CPU核心数，内存容量大小，磁盘空间大小,网络增强等。""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -816,8 +768,7 @@ class ResizeUHostInstanceResponseSchema(schema.ResponseSchema): class StartUHostInstanceRequestSchema(schema.RequestSchema): - """ StartUHostInstance - 启动处于关闭状态的UHost实例，需要指定数据中心及UHostID两个参数的值。 - """ + """StartUHostInstance - 启动处于关闭状态的UHost实例，需要指定数据中心及UHostID两个参数的值。""" fields = { "DiskPassword": fields.Str(required=False, dump_to="DiskPassword"), @@ -829,8 +780,7 @@ class StartUHostInstanceRequestSchema(schema.RequestSchema): class StartUHostInstanceResponseSchema(schema.ResponseSchema): - """ StartUHostInstance - 启动处于关闭状态的UHost实例，需要指定数据中心及UHostID两个参数的值。 - """ + """StartUHostInstance - 启动处于关闭状态的UHost实例，需要指定数据中心及UHostID两个参数的值。""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -843,8 +793,7 @@ class StartUHostInstanceResponseSchema(schema.ResponseSchema): class StopUHostInstanceRequestSchema(schema.RequestSchema): - """ StopUHostInstance - 指停止处于运行状态的UHost实例，需指定数据中心及UhostID。 - """ + """StopUHostInstance - 指停止处于运行状态的UHost实例，需指定数据中心及UhostID。""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -855,8 +804,7 @@ class StopUHostInstanceRequestSchema(schema.RequestSchema): class StopUHostInstanceResponseSchema(schema.ResponseSchema): - """ StopUHostInstance - 指停止处于运行状态的UHost实例，需指定数据中心及UhostID。 - """ + """StopUHostInstance - 指停止处于运行状态的UHost实例，需指定数据中心及UhostID。""" fields = {"UhostId": fields.Str(required=False, load_from="UhostId")} @@ -869,8 +817,7 @@ class StopUHostInstanceResponseSchema(schema.ResponseSchema): class TerminateCustomImageRequestSchema(schema.RequestSchema): - """ TerminateCustomImage - 删除用户自定义镜像 - """ + """TerminateCustomImage - 删除用户自定义镜像""" fields = { "ImageId": fields.Str(required=True, dump_to="ImageId"), @@ -881,8 +828,7 @@ class TerminateCustomImageRequestSchema(schema.RequestSchema): class TerminateCustomImageResponseSchema(schema.ResponseSchema): - """ TerminateCustomImage - 删除用户自定义镜像 - """ + """TerminateCustomImage - 删除用户自定义镜像""" fields = {"ImageId": fields.Str(required=False, load_from="ImageId")} @@ -895,8 +841,7 @@ class TerminateCustomImageResponseSchema(schema.ResponseSchema): class TerminateUHostInstanceRequestSchema(schema.RequestSchema): - """ TerminateUHostInstance - 删除指定数据中心的UHost实例。 - """ + """TerminateUHostInstance - 删除指定数据中心的UHost实例。""" fields = { "Destroy": fields.Int(required=False, dump_to="Destroy"), @@ -910,8 +855,7 @@ class TerminateUHostInstanceRequestSchema(schema.RequestSchema): class TerminateUHostInstanceResponseSchema(schema.ResponseSchema): - """ TerminateUHostInstance - 删除指定数据中心的UHost实例。 - """ + """TerminateUHostInstance - 删除指定数据中心的UHost实例。""" fields = { "InRecycle": fields.Str(required=True, load_from="InRecycle"), @@ -927,8 +871,7 @@ class TerminateUHostInstanceResponseSchema(schema.ResponseSchema): class UpgradeToArkUHostInstanceRequestSchema(schema.RequestSchema): - """ UpgradeToArkUHostInstance - 普通升级为方舟机型 - """ + """UpgradeToArkUHostInstance - 普通升级为方舟机型""" fields = { "CouponId": fields.Str(required=False, dump_to="CouponId"), @@ -939,8 +882,7 @@ class UpgradeToArkUHostInstanceRequestSchema(schema.RequestSchema): class UpgradeToArkUHostInstanceResponseSchema(schema.ResponseSchema): - """ UpgradeToArkUHostInstance - 普通升级为方舟机型 - """ + """UpgradeToArkUHostInstance - 普通升级为方舟机型""" fields = { "UHostSet": fields.List( diff --git a/ucloud/services/uhost/schemas/models.py b/ucloud/services/uhost/schemas/models.py index 342d45c..23cef51 100644 --- a/ucloud/services/uhost/schemas/models.py +++ b/ucloud/services/uhost/schemas/models.py @@ -5,8 +5,7 @@ class UHostImageSetSchema(schema.ResponseSchema): - """ UHostImageSet - DescribeImage - """ + """UHostImageSet - DescribeImage""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -33,8 +32,7 @@ class UHostImageSetSchema(schema.ResponseSchema): class SpreadInfoSchema(schema.ResponseSchema): - """ SpreadInfo - 每个可用区中硬件隔离组信息 - """ + """SpreadInfo - 每个可用区中硬件隔离组信息""" fields = { "UHostCount": fields.Int(required=False, load_from="UHostCount"), @@ -43,8 +41,7 @@ class SpreadInfoSchema(schema.ResponseSchema): class IsolationGroupSchema(schema.ResponseSchema): - """ IsolationGroup - 硬件隔离组信息 - """ + """IsolationGroup - 硬件隔离组信息""" fields = { "GroupId": fields.Str(required=False, load_from="GroupId"), @@ -55,8 +52,7 @@ class IsolationGroupSchema(schema.ResponseSchema): class UHostDiskSetSchema(schema.ResponseSchema): - """ UHostDiskSet - DescribeUHostInstance - """ + """UHostDiskSet - DescribeUHostInstance""" fields = { "BackupType": fields.Str(required=False, load_from="BackupType"), @@ -72,8 +68,7 @@ class UHostDiskSetSchema(schema.ResponseSchema): class UHostIPSetSchema(schema.ResponseSchema): - """ UHostIPSet - DescribeUHostInstance - """ + """UHostIPSet - DescribeUHostInstance""" fields = { "Bandwidth": fields.Int(required=False, load_from="Bandwidth"), @@ -89,8 +84,7 @@ class UHostIPSetSchema(schema.ResponseSchema): class UHostInstanceSetSchema(schema.ResponseSchema): - """ UHostInstanceSet - DescribeUHostInstance - """ + """UHostInstanceSet - DescribeUHostInstance""" fields = { "AutoRenew": fields.Str(required=False, load_from="AutoRenew"), @@ -140,8 +134,7 @@ class UHostInstanceSetSchema(schema.ResponseSchema): class UHostSnapshotSetSchema(schema.ResponseSchema): - """ UHostSnapshotSet - DescribeUHostInstanceSnapshot - """ + """UHostSnapshotSet - DescribeUHostInstanceSnapshot""" fields = { "SnapshotName": fields.Str(required=False, load_from="SnapshotName"), @@ -151,8 +144,7 @@ class UHostSnapshotSetSchema(schema.ResponseSchema): class UHostTagSetSchema(schema.ResponseSchema): - """ UHostTagSet - DescribeUHostTags - """ + """UHostTagSet - DescribeUHostTags""" fields = { "Tag": fields.Str(required=False, load_from="Tag"), @@ -162,8 +154,7 @@ class UHostTagSetSchema(schema.ResponseSchema): class UHostPriceSetSchema(schema.ResponseSchema): - """ UHostPriceSet - 主机价格 - """ + """UHostPriceSet - 主机价格""" fields = { "ChargeType": fields.Str(required=True, load_from="ChargeType"), diff --git a/ucloud/services/uhub/client.py b/ucloud/services/uhub/client.py index 78aa3bd..dfeba85 100644 --- a/ucloud/services/uhub/client.py +++ b/ucloud/services/uhub/client.py @@ -10,19 +10,19 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(UHubClient, self).__init__(config, transport, middleware, logger) def create_repo(self, req=None, **kwargs): - """ CreateRepo - 创建镜像仓库 + """CreateRepo - 创建镜像仓库 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **RepoName** (str) - (Required) 仓库名称，不可修改 - **Description** (str) - 仓库备注 - **IsShared** (bool) - 镜像仓库是否公开，公开为true、不公开为false;默认为false - + **Response** - **Message** (str) - 有错误时返回内容 - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -32,16 +32,16 @@ def create_repo(self, req=None, **kwargs): return apis.CreateRepoResponseSchema().loads(resp) def delete_repo(self, req=None, **kwargs): - """ DeleteRepo - 删除镜像仓库 + """DeleteRepo - 删除镜像仓库 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **RepoName** (str) - (Required) 镜像仓库名称 - + **Response** - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -50,18 +50,18 @@ def delete_repo(self, req=None, **kwargs): return apis.DeleteRepoResponseSchema().loads(resp) def delete_repo_image(self, req=None, **kwargs): - """ DeleteRepoImage - 删除镜像 + """DeleteRepoImage - 删除镜像 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **ImageName** (str) - (Required) 镜像名称 - **RepoName** (str) - (Required) 镜像仓库名称 - **TagName** (str) - 不指定tag则删除全部tag - + **Response** - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -70,26 +70,26 @@ def delete_repo_image(self, req=None, **kwargs): return apis.DeleteRepoImageResponseSchema().loads(resp) def get_image_tag(self, req=None, **kwargs): - """ GetImageTag - 获取镜像tag + """GetImageTag - 获取镜像tag **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **ImageName** (str) - (Required) 镜像名称 - **RepoName** (str) - (Required) 镜像仓库名称 - **Limit** (int) - 每次获取数量，默认为20 - **Offset** (int) - 偏移量，默认0 - **TagName** (str) - 默认不写，如果填写，代表查询该tag，否则查全部tag - + **Response** - **TagSet** (list) - 见 **TagSet** 模型定义 - **TotalCount** (int) - tag总数 - + **Response Model** - - **TagSet** - + + **TagSet** + - **TagName** (str) - Tag名称 - **UpdateTime** (str) - 镜像更新时间 @@ -101,24 +101,24 @@ def get_image_tag(self, req=None, **kwargs): return apis.GetImageTagResponseSchema().loads(resp) def get_repo(self, req=None, **kwargs): - """ GetRepo - 获取镜像仓库 + """GetRepo - 获取镜像仓库 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Limit** (int) - 数量，默认20 - **Offset** (int) - 偏移量，默认0 - **Type** (str) - private私有仓库，public公共仓库，默认public - + **Response** - **RepoSet** (list) - 见 **RepoSet** 模型定义 - **TotalCount** (int) - 总的仓库数量 - + **Response Model** - - **RepoSet** - + + **RepoSet** + - **CreateTime** (str) - 仓库创建时间 - **Description** (str) - 镜像仓库描述 - **IsOutSide** (str) - 镜像仓库是否外网可以访问，可以为ture,不可以为false @@ -134,24 +134,24 @@ def get_repo(self, req=None, **kwargs): return apis.GetRepoResponseSchema().loads(resp) def get_repo_image(self, req=None, **kwargs): - """ GetRepoImage - 获取镜像仓库下的镜像 + """GetRepoImage - 获取镜像仓库下的镜像 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **RepoName** (str) - (Required) 镜像仓库名称 - **Limit** (int) - 显示数量，默认为20 - **Offset** (int) - 偏移量，默认0 - + **Response** - **ImageSet** (list) - 见 **ImageSet** 模型定义 - - **TotalCount** (int) - - + - **TotalCount** (int) - + **Response Model** - - **ImageSet** - + + **ImageSet** + - **CreateTime** (str) - 创建时间 - **ImageName** (str) - 镜像名称 - **LatestTag** (str) - 最新push的Tag @@ -167,19 +167,19 @@ def get_repo_image(self, req=None, **kwargs): return apis.GetRepoImageResponseSchema().loads(resp) def update_repo(self, req=None, **kwargs): - """ UpdateRepo - 更新镜像仓库 + """UpdateRepo - 更新镜像仓库 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **RepoName** (str) - (Required) 镜像仓库名称，不可修改 - **Description** (str) - 备注 - **IsShared** (str) - false设置为私有；true设置为公有。默认false - + **Response** - **Message** (str) - 错误的时候返回 - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) diff --git a/ucloud/services/uhub/schemas/apis.py b/ucloud/services/uhub/schemas/apis.py index c77f1aa..6f3e640 100644 --- a/ucloud/services/uhub/schemas/apis.py +++ b/ucloud/services/uhub/schemas/apis.py @@ -14,8 +14,7 @@ class CreateRepoRequestSchema(schema.RequestSchema): - """ CreateRepo - 创建镜像仓库 - """ + """CreateRepo - 创建镜像仓库""" fields = { "Description": fields.Str(required=False, dump_to="Description"), @@ -26,8 +25,7 @@ class CreateRepoRequestSchema(schema.RequestSchema): class CreateRepoResponseSchema(schema.ResponseSchema): - """ CreateRepo - 创建镜像仓库 - """ + """CreateRepo - 创建镜像仓库""" fields = {"Message": fields.Str(required=False, load_from="Message")} @@ -40,8 +38,7 @@ class CreateRepoResponseSchema(schema.ResponseSchema): class DeleteRepoRequestSchema(schema.RequestSchema): - """ DeleteRepo - 删除镜像仓库 - """ + """DeleteRepo - 删除镜像仓库""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -50,8 +47,7 @@ class DeleteRepoRequestSchema(schema.RequestSchema): class DeleteRepoResponseSchema(schema.ResponseSchema): - """ DeleteRepo - 删除镜像仓库 - """ + """DeleteRepo - 删除镜像仓库""" fields = {} @@ -64,8 +60,7 @@ class DeleteRepoResponseSchema(schema.ResponseSchema): class DeleteRepoImageRequestSchema(schema.RequestSchema): - """ DeleteRepoImage - 删除镜像 - """ + """DeleteRepoImage - 删除镜像""" fields = { "ImageName": fields.Str(required=True, dump_to="ImageName"), @@ -76,8 +71,7 @@ class DeleteRepoImageRequestSchema(schema.RequestSchema): class DeleteRepoImageResponseSchema(schema.ResponseSchema): - """ DeleteRepoImage - 删除镜像 - """ + """DeleteRepoImage - 删除镜像""" fields = {} @@ -90,8 +84,7 @@ class DeleteRepoImageResponseSchema(schema.ResponseSchema): class GetImageTagRequestSchema(schema.RequestSchema): - """ GetImageTag - 获取镜像tag - """ + """GetImageTag - 获取镜像tag""" fields = { "ImageName": fields.Str(required=True, dump_to="ImageName"), @@ -104,8 +97,7 @@ class GetImageTagRequestSchema(schema.RequestSchema): class GetImageTagResponseSchema(schema.ResponseSchema): - """ GetImageTag - 获取镜像tag - """ + """GetImageTag - 获取镜像tag""" fields = { "TagSet": fields.List( @@ -123,8 +115,7 @@ class GetImageTagResponseSchema(schema.ResponseSchema): class GetRepoRequestSchema(schema.RequestSchema): - """ GetRepo - 获取镜像仓库 - """ + """GetRepo - 获取镜像仓库""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -135,8 +126,7 @@ class GetRepoRequestSchema(schema.RequestSchema): class GetRepoResponseSchema(schema.ResponseSchema): - """ GetRepo - 获取镜像仓库 - """ + """GetRepo - 获取镜像仓库""" fields = { "RepoSet": fields.List( @@ -154,8 +144,7 @@ class GetRepoResponseSchema(schema.ResponseSchema): class GetRepoImageRequestSchema(schema.RequestSchema): - """ GetRepoImage - 获取镜像仓库下的镜像 - """ + """GetRepoImage - 获取镜像仓库下的镜像""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -166,8 +155,7 @@ class GetRepoImageRequestSchema(schema.RequestSchema): class GetRepoImageResponseSchema(schema.ResponseSchema): - """ GetRepoImage - 获取镜像仓库下的镜像 - """ + """GetRepoImage - 获取镜像仓库下的镜像""" fields = { "ImageSet": fields.List( @@ -185,8 +173,7 @@ class GetRepoImageResponseSchema(schema.ResponseSchema): class UpdateRepoRequestSchema(schema.RequestSchema): - """ UpdateRepo - 更新镜像仓库 - """ + """UpdateRepo - 更新镜像仓库""" fields = { "Description": fields.Str(required=False, dump_to="Description"), @@ -197,7 +184,6 @@ class UpdateRepoRequestSchema(schema.RequestSchema): class UpdateRepoResponseSchema(schema.ResponseSchema): - """ UpdateRepo - 更新镜像仓库 - """ + """UpdateRepo - 更新镜像仓库""" fields = {"Message": fields.Str(required=False, load_from="Message")} diff --git a/ucloud/services/uhub/schemas/models.py b/ucloud/services/uhub/schemas/models.py index db49eea..f717762 100644 --- a/ucloud/services/uhub/schemas/models.py +++ b/ucloud/services/uhub/schemas/models.py @@ -5,8 +5,7 @@ class TagSetSchema(schema.ResponseSchema): - """ TagSet - Tag详细信息 - """ + """TagSet - Tag详细信息""" fields = { "TagName": fields.Str(required=True, load_from="TagName"), @@ -15,8 +14,7 @@ class TagSetSchema(schema.ResponseSchema): class RepoSetSchema(schema.ResponseSchema): - """ RepoSet - 镜像仓库 - """ + """RepoSet - 镜像仓库""" fields = { "CreateTime": fields.Str(required=True, load_from="CreateTime"), @@ -29,8 +27,7 @@ class RepoSetSchema(schema.ResponseSchema): class ImageSetSchema(schema.ResponseSchema): - """ ImageSet - 镜像信息 - """ + """ImageSet - 镜像信息""" fields = { "CreateTime": fields.Str(required=True, load_from="CreateTime"), diff --git a/ucloud/services/ulb/client.py b/ucloud/services/ulb/client.py index 9ff8d0f..63c7102 100644 --- a/ucloud/services/ulb/client.py +++ b/ucloud/services/ulb/client.py @@ -10,12 +10,12 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(ULBClient, self).__init__(config, transport, middleware, logger) def allocate_backend(self, req=None, **kwargs): - """ AllocateBackend - 添加ULB后端资源实例 + """AllocateBackend - 添加ULB后端资源实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ResourceId** (str) - (Required) 所添加的后端资源的资源ID - **ResourceType** (str) - (Required) 所添加的后端资源的类型，枚举值：UHost -> 云主机；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器，默认值为“UHost” - **ULBId** (str) - (Required) 负载均衡实例的ID @@ -23,11 +23,11 @@ def allocate_backend(self, req=None, **kwargs): - **Enabled** (int) - 后端实例状态开关，枚举值： 1：启用； 0：禁用 默认为启用 - **Port** (int) - 所添加的后端资源服务端口，取值范围[1-65535]，默认80 - **Weight** (int) - 所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1 - + **Response** - **BackendId** (str) - 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关），可用于 UpdateBackendAttribute/UpdateBackendAttributeBatch/ReleaseBackend - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -36,25 +36,25 @@ def allocate_backend(self, req=None, **kwargs): return apis.AllocateBackendResponseSchema().loads(resp) def allocate_backend_batch(self, req=None, **kwargs): - """ AllocateBackendBatch - 批量添加VServer后端节点 + """AllocateBackendBatch - 批量添加VServer后端节点 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Backends** (list) - (Required) 用| 分割字段，格式：ResourceId| ResourceType| Port| Enabled|IP| Weight。ResourceId:所添加的后端资源的资源ID；ResourceType:所添加的后端资源的类型，枚举值：UHost -> 云主机；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器，默认值为“UHost”；Port:所添加的后端资源服务端口，取值范围[1-65535]；Enabled:后端实例状态开关，枚举值： 1：启用； 0：禁用；IP:后端资源内网ip；Weight：所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1 - **ULBId** (str) - (Required) 负载均衡实例的ID - **VServerId** (str) - (Required) VServer实例的ID - - **ApiVersion** (int) - - + - **ApiVersion** (int) - + **Response** - **BackendSet** (list) - 见 **BackendSet** 模型定义 - + **Response Model** - - **BackendSet** - + + **BackendSet** + - **BackendId** (str) - rs的资源ID - **ResourceId** (str) - rs对应的UHost ID @@ -66,19 +66,19 @@ def allocate_backend_batch(self, req=None, **kwargs): return apis.AllocateBackendBatchResponseSchema().loads(resp) def bind_ssl(self, req=None, **kwargs): - """ BindSSL - 将SSL证书绑定到VServer + """BindSSL - 将SSL证书绑定到VServer **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **SSLId** (str) - (Required) SSL证书的Id - **ULBId** (str) - (Required) 所绑定ULB实例ID - **VServerId** (str) - (Required) 所绑定VServer实例ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -87,22 +87,22 @@ def bind_ssl(self, req=None, **kwargs): return apis.BindSSLResponseSchema().loads(resp) def create_policy(self, req=None, **kwargs): - """ CreatePolicy - 创建VServer内容转发策略 + """CreatePolicy - 创建VServer内容转发策略 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackendId** (list) - (Required) 内容转发策略应用的后端资源实例的ID，来源于 AllocateBackend 返回的 BackendId - **Match** (str) - (Required) 内容转发匹配字段 - **ULBId** (str) - (Required) 需要添加内容转发策略的负载均衡实例ID - **VServerId** (str) - (Required) 需要添加内容转发策略的VServer实例ID - **Type** (str) - 内容转发匹配字段的类型 - + **Response** - **PolicyId** (str) - 内容转发策略ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -112,23 +112,23 @@ def create_policy(self, req=None, **kwargs): return apis.CreatePolicyResponseSchema().loads(resp) def create_ssl(self, req=None, **kwargs): - """ CreateSSL - 创建SSL证书，可以把整个 Pem 证书内容传过来，或者把证书、私钥、CA证书分别传过来 + """CreateSSL - 创建SSL证书，可以把整个 Pem 证书内容传过来，或者把证书、私钥、CA证书分别传过来 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **SSLName** (str) - (Required) SSL证书的名字，默认值为空 - **CaCert** (str) - CA证书 - **PrivateKey** (str) - 加密证书的私钥 - **SSLContent** (str) - SSL证书的完整内容，包括用户证书、加密证书的私钥、CA证书 - **SSLType** (str) - 所添加的SSL证书类型，目前只支持Pem格式 - **UserCert** (str) - 用户的证书 - + **Response** - **SSLId** (str) - SSL证书的Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -138,12 +138,12 @@ def create_ssl(self, req=None, **kwargs): return apis.CreateSSLResponseSchema().loads(resp) def create_ulb(self, req=None, **kwargs): - """ CreateULB - 创建负载均衡实例，可以选择内网或者外网 + """CreateULB - 创建负载均衡实例，可以选择内网或者外网 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BusinessId** (str) - ULB 所属的业务组ID，如果不传则使用默认的业务组 - **ChargeType** (str) - 付费方式 - **IPVersion** (str) - ULB ip类型，枚举值：IPv6 / IPv4 （内部测试，暂未对外开放） @@ -156,11 +156,11 @@ def create_ulb(self, req=None, **kwargs): - **Tag** (str) - 业务组 - **ULBName** (str) - 负载均衡的名字，默认值为“ULB” - **VPCId** (str) - ULB所在的VPC的ID, 如果不传则使用默认的VPC - + **Response** - **ULBId** (str) - 负载均衡实例的Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -170,12 +170,12 @@ def create_ulb(self, req=None, **kwargs): return apis.CreateULBResponseSchema().loads(resp) def create_vserver(self, req=None, **kwargs): - """ CreateVServer - 创建VServer实例，定义监听的协议和端口以及负载均衡算法 + """CreateVServer - 创建VServer实例，定义监听的协议和端口以及负载均衡算法 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ULBId** (str) - (Required) 负载均衡实例ID - **ClientTimeout** (int) - ListenType为RequestProxy时表示空闲连接的回收时间，单位：秒，取值范围：时(0，86400]，默认值为60；ListenType为PacketsTransmit时表示连接保持的时间，单位：秒，取值范围：[60，900]，0 表示禁用连接保持 - **Domain** (str) - 根据MonitorType确认； 当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查域名 @@ -188,11 +188,11 @@ def create_vserver(self, req=None, **kwargs): - **PersistenceType** (str) - VServer会话保持方式，默认关闭会话保持。枚举值：None -> 关闭；ServerInsert -> 自动生成KEY；UserDefined -> 用户自定义KEY。 - **Protocol** (str) - VServer实例的协议，请求代理模式下有 HTTP、HTTPS、TCP，报文转发下有 TCP，UDP。默认为“HTTP" - **VServerName** (str) - VServer实例名称，默认为"VServer" - + **Response** - **VServerId** (str) - VServer实例的Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -202,19 +202,19 @@ def create_vserver(self, req=None, **kwargs): return apis.CreateVServerResponseSchema().loads(resp) def delete_policy(self, req=None, **kwargs): - """ DeletePolicy - 删除内容转发策略 + """DeletePolicy - 删除内容转发策略 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **PolicyId** (str) - (Required) 内容转发策略ID - **GroupId** (str) - 内容转发策略组ID - **VServerId** (str) - VServer 资源ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -223,17 +223,17 @@ def delete_policy(self, req=None, **kwargs): return apis.DeletePolicyResponseSchema().loads(resp) def delete_ssl(self, req=None, **kwargs): - """ DeleteSSL - 删除SSL证书 + """DeleteSSL - 删除SSL证书 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **SSLId** (str) - (Required) SSL证书的ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -242,18 +242,18 @@ def delete_ssl(self, req=None, **kwargs): return apis.DeleteSSLResponseSchema().loads(resp) def delete_ulb(self, req=None, **kwargs): - """ DeleteULB - 删除负载均衡实例 + """DeleteULB - 删除负载均衡实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ULBId** (str) - (Required) 负载均衡实例的ID - **ReleaseEip** (bool) - 删除ulb时是否释放绑定的EIP，false标识只解绑EIP，true表示会释放绑定的EIP，默认是false - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -262,18 +262,18 @@ def delete_ulb(self, req=None, **kwargs): return apis.DeleteULBResponseSchema().loads(resp) def delete_vserver(self, req=None, **kwargs): - """ DeleteVServer - 删除VServer实例 + """DeleteVServer - 删除VServer实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ULBId** (str) - (Required) 负载均衡实例的ID - **VServerId** (str) - (Required) VServer实例的ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -282,26 +282,26 @@ def delete_vserver(self, req=None, **kwargs): return apis.DeleteVServerResponseSchema().loads(resp) def describe_ssl(self, req=None, **kwargs): - """ DescribeSSL - 获取SSL证书信息 + """DescribeSSL - 获取SSL证书信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - 数据分页值，默认为20 - **Offset** (int) - 数据偏移量，默认值为0 - **SSLId** (str) - SSL证书的Id - + **Response** - **DataSet** (list) - 见 **ULBSSLSet** 模型定义 - **TotalCount** (int) - 满足条件的SSL证书总数 - + **Response Model** - - **ULBSSLSet** - - - **HashValue** (str) - + + **ULBSSLSet** + + - **HashValue** (str) - - **SSLId** (str) - SSL证书的Id - **SSLName** (str) - SSL证书的名字 @@ -313,36 +313,36 @@ def describe_ssl(self, req=None, **kwargs): return apis.DescribeSSLResponseSchema().loads(resp) def describe_ulb(self, req=None, **kwargs): - """ DescribeULB - 获取ULB详细信息 + """DescribeULB - 获取ULB详细信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BusinessId** (str) - ULB所属的业务组ID - **Limit** (int) - 数据分页值，默认为20 - **Offset** (int) - 数据偏移量，默认为0 - **SubnetId** (str) - ULB所属的子网ID - **ULBId** (str) - 负载均衡实例的Id。 若指定则返回指定的负载均衡实例的信息； 若不指定则返回当前数据中心中所有的负载均衡实例的信息 - **VPCId** (str) - ULB所属的VPC - + **Response** - **DataSet** (list) - 见 **ULBSet** 模型定义 - **TotalCount** (int) - 满足条件的ULB总数 - + **Response Model** - - **PolicyBackendSet** - + + **PolicyBackendSet** + - **BackendId** (str) - 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关 - **ObjectId** (str) - 后端资源的对象ID - **Port** (int) - 所添加的后端资源服务端口 - **PrivateIP** (str) - 后端资源的内网IP - **ResourceName** (str) - 后端资源的实例名称 - **ULBPolicySet** - + **ULBPolicySet** + - **BackendSet** (list) - 见 **PolicyBackendSet** 模型定义 - **Match** (str) - 内容转发匹配字段;默认内容转发类型下为空。 - **PolicyId** (str) - 内容转发Id，默认内容转发类型下为空。 @@ -352,8 +352,8 @@ def describe_ulb(self, req=None, **kwargs): - **Type** (str) - 内容转发匹配字段的类型，枚举值：Domain -> 域名；Path -> 路径； 默认内容转发类型下为空 - **VServerId** (str) - 所属VServerId - **ULBBackendSet** - + **ULBBackendSet** + - **BackendId** (str) - 后端资源实例的Id - **Enabled** (int) - 后端提供服务的实例启用与否，枚举值：0 禁用 1 启用 - **Port** (int) - 后端提供服务的端口 @@ -366,16 +366,16 @@ def describe_ulb(self, req=None, **kwargs): - **SubResourceName** (str) - 资源绑定的虚拟网卡实例的资源名称 - **SubResourceType** (str) - 资源绑定的虚拟网卡实例的类型 - **SubnetId** (str) - 后端提供服务的资源所在的子网的ID - - **Weight** (int) - + - **Weight** (int) - + + **ULBSSLSet** - **ULBSSLSet** - - - **HashValue** (str) - + - **HashValue** (str) - - **SSLId** (str) - SSL证书的Id - **SSLName** (str) - SSL证书的名字 - **ULBVServerSet** - + **ULBVServerSet** + - **BackendSet** (list) - 见 **ULBBackendSet** 模型定义 - **ClientTimeout** (int) - 空闲连接的回收时间，单位：秒。 - **Domain** (str) - 根据MonitorType确认； 当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查域名 @@ -393,16 +393,16 @@ def describe_ulb(self, req=None, **kwargs): - **VServerId** (str) - VServer实例的Id - **VServerName** (str) - VServer实例的名字 - **ULBIPSet** - + **ULBIPSet** + - **Bandwidth** (int) - 弹性IP的带宽值（暂未对外开放） - **BandwidthType** (int) - 弹性IP的带宽类型，枚举值：1 表示是共享带宽，0 普通带宽类型（暂未对外开放） - **EIP** (str) - 弹性IP地址 - **EIPId** (str) - 弹性IP的ID - **OperatorName** (str) - 弹性IP的运营商信息，枚举值为： Bgp：BGP IP International：国际IP - **ULBSet** - + **ULBSet** + - **Bandwidth** (int) - 带宽 - **BandwidthType** (int) - 带宽类型，枚举值为： 0，非共享带宽； 1，共享带宽 - **BusinessId** (str) - ULB 所属的业务组ID @@ -429,40 +429,40 @@ def describe_ulb(self, req=None, **kwargs): return apis.DescribeULBResponseSchema().loads(resp) def describe_vserver(self, req=None, **kwargs): - """ DescribeVServer - 获取ULB下的VServer的详细信息 + """DescribeVServer - 获取ULB下的VServer的详细信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ULBId** (str) - (Required) 负载均衡实例的Id - **Limit** (int) - 数据分页值 - **Offset** (int) - 数据偏移量 - **VServerId** (str) - VServer实例的Id；若指定则返回指定的VServer实例的信息； 若不指定则返回当前负载均衡实例下所有VServer的信息 - + **Response** - **DataSet** (list) - 见 **ULBVServerSet** 模型定义 - **TotalCount** (int) - 满足条件的VServer总数 - + **Response Model** - - **PolicyBackendSet** - + + **PolicyBackendSet** + - **BackendId** (str) - 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关 - **ObjectId** (str) - 后端资源的对象ID - **Port** (int) - 所添加的后端资源服务端口 - **PrivateIP** (str) - 后端资源的内网IP - **ResourceName** (str) - 后端资源的实例名称 - **ULBSSLSet** - - - **HashValue** (str) - + **ULBSSLSet** + + - **HashValue** (str) - - **SSLId** (str) - SSL证书的Id - **SSLName** (str) - SSL证书的名字 - **ULBPolicySet** - + **ULBPolicySet** + - **BackendSet** (list) - 见 **PolicyBackendSet** 模型定义 - **Match** (str) - 内容转发匹配字段;默认内容转发类型下为空。 - **PolicyId** (str) - 内容转发Id，默认内容转发类型下为空。 @@ -472,8 +472,8 @@ def describe_vserver(self, req=None, **kwargs): - **Type** (str) - 内容转发匹配字段的类型，枚举值：Domain -> 域名；Path -> 路径； 默认内容转发类型下为空 - **VServerId** (str) - 所属VServerId - **ULBBackendSet** - + **ULBBackendSet** + - **BackendId** (str) - 后端资源实例的Id - **Enabled** (int) - 后端提供服务的实例启用与否，枚举值：0 禁用 1 启用 - **Port** (int) - 后端提供服务的端口 @@ -486,10 +486,10 @@ def describe_vserver(self, req=None, **kwargs): - **SubResourceName** (str) - 资源绑定的虚拟网卡实例的资源名称 - **SubResourceType** (str) - 资源绑定的虚拟网卡实例的类型 - **SubnetId** (str) - 后端提供服务的资源所在的子网的ID - - **Weight** (int) - + - **Weight** (int) - + + **ULBVServerSet** - **ULBVServerSet** - - **BackendSet** (list) - 见 **ULBBackendSet** 模型定义 - **ClientTimeout** (int) - 空闲连接的回收时间，单位：秒。 - **Domain** (str) - 根据MonitorType确认； 当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查域名 @@ -515,18 +515,18 @@ def describe_vserver(self, req=None, **kwargs): return apis.DescribeVServerResponseSchema().loads(resp) def release_backend(self, req=None, **kwargs): - """ ReleaseBackend - 从VServer释放后端资源实例 + """ReleaseBackend - 从VServer释放后端资源实例 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackendId** (str) - (Required) 后端资源实例的ID(ULB后端ID，非资源自身ID) - **ULBId** (str) - (Required) 负载均衡实例的ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -535,19 +535,19 @@ def release_backend(self, req=None, **kwargs): return apis.ReleaseBackendResponseSchema().loads(resp) def unbind_ssl(self, req=None, **kwargs): - """ UnbindSSL - 从VServer解绑SSL证书 + """UnbindSSL - 从VServer解绑SSL证书 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **SSLId** (str) - (Required) SSL证书的Id - **ULBId** (str) - (Required) 所绑定ULB实例ID - **VServerId** (str) - (Required) 所绑定VServer实例ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -556,21 +556,21 @@ def unbind_ssl(self, req=None, **kwargs): return apis.UnbindSSLResponseSchema().loads(resp) def update_backend_attribute(self, req=None, **kwargs): - """ UpdateBackendAttribute - 更新ULB后端资源实例(服务节点)属性 + """UpdateBackendAttribute - 更新ULB后端资源实例(服务节点)属性 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackendId** (str) - (Required) 后端资源实例的ID(ULB后端ID，非资源自身ID) - **ULBId** (str) - (Required) 负载均衡资源ID - **Enabled** (int) - 后端实例状态开关 - **Port** (int) - 后端资源服务端口，取值范围[1-65535] - **Weight** (int) - 所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -579,23 +579,23 @@ def update_backend_attribute(self, req=None, **kwargs): return apis.UpdateBackendAttributeResponseSchema().loads(resp) def update_policy(self, req=None, **kwargs): - """ UpdatePolicy - 更新内容转发规则，包括转发规则后的服务节点 + """UpdatePolicy - 更新内容转发规则，包括转发规则后的服务节点 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackendId** (list) - (Required) 内容转发策略应用的后端资源实例的ID，来源于 AllocateBackend 返回的 BackendId - **Match** (str) - (Required) 内容转发匹配字段 - **PolicyId** (str) - (Required) 转发规则的ID - **ULBId** (str) - (Required) 需要添加内容转发策略的负载均衡实例ID - **VServerId** (str) - (Required) 需要添加内容转发策略的VServer实例ID - **Type** (str) - 内容转发匹配字段的类型 - + **Response** - **PolicyId** (str) - 转发规则的ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -604,20 +604,20 @@ def update_policy(self, req=None, **kwargs): return apis.UpdatePolicyResponseSchema().loads(resp) def update_ulb_attribute(self, req=None, **kwargs): - """ UpdateULBAttribute - 更新ULB名字业务组备注等属性字段 + """UpdateULBAttribute - 更新ULB名字业务组备注等属性字段 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ULBId** (str) - (Required) ULB资源ID - **Name** (str) - 名字 - **Remark** (str) - 备注 - **Tag** (str) - 业务 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -626,12 +626,12 @@ def update_ulb_attribute(self, req=None, **kwargs): return apis.UpdateULBAttributeResponseSchema().loads(resp) def update_vserver_attribute(self, req=None, **kwargs): - """ UpdateVServerAttribute - 更新VServer实例属性 + """UpdateVServerAttribute - 更新VServer实例属性 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ULBId** (str) - (Required) 负载均衡实例ID - **VServerId** (str) - (Required) VServer实例ID - **ClientTimeout** (int) - 请求代理的VServer下表示空闲连接的回收时间，单位：秒，取值范围：时(0，86400]，默认值为60；报文转发的VServer下表示回话保持的时间，单位：秒，取值范围：[60，900]，0 表示禁用连接保持 @@ -643,10 +643,10 @@ def update_vserver_attribute(self, req=None, **kwargs): - **PersistenceType** (str) - VServer会话保持模式，若无此字段则不做修改。枚举值：None：关闭；ServerInsert：自动生成KEY；UserDefined：用户自定义KEY。 - **Protocol** (str) - VServer协议类型，请求代理只支持修改为 HTTP/HTTPS，报文转发VServer只支持修改为 TCP/UDP - **VServerName** (str) - VServer实例名称，若无此字段则不做修改 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/ulb/schemas/apis.py b/ucloud/services/ulb/schemas/apis.py index 6c2e57d..d98aff7 100644 --- a/ucloud/services/ulb/schemas/apis.py +++ b/ucloud/services/ulb/schemas/apis.py @@ -14,8 +14,7 @@ class AllocateBackendRequestSchema(schema.RequestSchema): - """ AllocateBackend - 添加ULB后端资源实例 - """ + """AllocateBackend - 添加ULB后端资源实例""" fields = { "Enabled": fields.Int(required=False, dump_to="Enabled"), @@ -31,8 +30,7 @@ class AllocateBackendRequestSchema(schema.RequestSchema): class AllocateBackendResponseSchema(schema.ResponseSchema): - """ AllocateBackend - 添加ULB后端资源实例 - """ + """AllocateBackend - 添加ULB后端资源实例""" fields = {"BackendId": fields.Str(required=False, load_from="BackendId")} @@ -45,8 +43,7 @@ class AllocateBackendResponseSchema(schema.ResponseSchema): class AllocateBackendBatchRequestSchema(schema.RequestSchema): - """ AllocateBackendBatch - 批量添加VServer后端节点 - """ + """AllocateBackendBatch - 批量添加VServer后端节点""" fields = { "ApiVersion": fields.Int(required=False, dump_to="ApiVersion"), @@ -59,8 +56,7 @@ class AllocateBackendBatchRequestSchema(schema.RequestSchema): class AllocateBackendBatchResponseSchema(schema.ResponseSchema): - """ AllocateBackendBatch - 批量添加VServer后端节点 - """ + """AllocateBackendBatch - 批量添加VServer后端节点""" fields = { "BackendSet": fields.List( @@ -77,8 +73,7 @@ class AllocateBackendBatchResponseSchema(schema.ResponseSchema): class BindSSLRequestSchema(schema.RequestSchema): - """ BindSSL - 将SSL证书绑定到VServer - """ + """BindSSL - 将SSL证书绑定到VServer""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -90,8 +85,7 @@ class BindSSLRequestSchema(schema.RequestSchema): class BindSSLResponseSchema(schema.ResponseSchema): - """ BindSSL - 将SSL证书绑定到VServer - """ + """BindSSL - 将SSL证书绑定到VServer""" fields = {} @@ -104,8 +98,7 @@ class BindSSLResponseSchema(schema.ResponseSchema): class CreatePolicyRequestSchema(schema.RequestSchema): - """ CreatePolicy - 创建VServer内容转发策略 - """ + """CreatePolicy - 创建VServer内容转发策略""" fields = { "BackendId": fields.List(fields.Str()), @@ -119,8 +112,7 @@ class CreatePolicyRequestSchema(schema.RequestSchema): class CreatePolicyResponseSchema(schema.ResponseSchema): - """ CreatePolicy - 创建VServer内容转发策略 - """ + """CreatePolicy - 创建VServer内容转发策略""" fields = {"PolicyId": fields.Str(required=False, load_from="PolicyId")} @@ -133,8 +125,7 @@ class CreatePolicyResponseSchema(schema.ResponseSchema): class CreateSSLRequestSchema(schema.RequestSchema): - """ CreateSSL - 创建SSL证书，可以把整个 Pem 证书内容传过来，或者把证书、私钥、CA证书分别传过来 - """ + """CreateSSL - 创建SSL证书，可以把整个 Pem 证书内容传过来，或者把证书、私钥、CA证书分别传过来""" fields = { "CaCert": fields.Str(required=False, dump_to="CaCert"), @@ -149,8 +140,7 @@ class CreateSSLRequestSchema(schema.RequestSchema): class CreateSSLResponseSchema(schema.ResponseSchema): - """ CreateSSL - 创建SSL证书，可以把整个 Pem 证书内容传过来，或者把证书、私钥、CA证书分别传过来 - """ + """CreateSSL - 创建SSL证书，可以把整个 Pem 证书内容传过来，或者把证书、私钥、CA证书分别传过来""" fields = {"SSLId": fields.Str(required=False, load_from="SSLId")} @@ -163,8 +153,7 @@ class CreateSSLResponseSchema(schema.ResponseSchema): class CreateULBRequestSchema(schema.RequestSchema): - """ CreateULB - 创建负载均衡实例，可以选择内网或者外网 - """ + """CreateULB - 创建负载均衡实例，可以选择内网或者外网""" fields = { "BusinessId": fields.Str(required=False, dump_to="BusinessId"), @@ -185,8 +174,7 @@ class CreateULBRequestSchema(schema.RequestSchema): class CreateULBResponseSchema(schema.ResponseSchema): - """ CreateULB - 创建负载均衡实例，可以选择内网或者外网 - """ + """CreateULB - 创建负载均衡实例，可以选择内网或者外网""" fields = {"ULBId": fields.Str(required=False, load_from="ULBId")} @@ -199,8 +187,7 @@ class CreateULBResponseSchema(schema.ResponseSchema): class CreateVServerRequestSchema(schema.RequestSchema): - """ CreateVServer - 创建VServer实例，定义监听的协议和端口以及负载均衡算法 - """ + """CreateVServer - 创建VServer实例，定义监听的协议和端口以及负载均衡算法""" fields = { "ClientTimeout": fields.Int(required=False, dump_to="ClientTimeout"), @@ -225,8 +212,7 @@ class CreateVServerRequestSchema(schema.RequestSchema): class CreateVServerResponseSchema(schema.ResponseSchema): - """ CreateVServer - 创建VServer实例，定义监听的协议和端口以及负载均衡算法 - """ + """CreateVServer - 创建VServer实例，定义监听的协议和端口以及负载均衡算法""" fields = {"VServerId": fields.Str(required=False, load_from="VServerId")} @@ -239,8 +225,7 @@ class CreateVServerResponseSchema(schema.ResponseSchema): class DeletePolicyRequestSchema(schema.RequestSchema): - """ DeletePolicy - 删除内容转发策略 - """ + """DeletePolicy - 删除内容转发策略""" fields = { "GroupId": fields.Str(required=False, dump_to="GroupId"), @@ -252,8 +237,7 @@ class DeletePolicyRequestSchema(schema.RequestSchema): class DeletePolicyResponseSchema(schema.ResponseSchema): - """ DeletePolicy - 删除内容转发策略 - """ + """DeletePolicy - 删除内容转发策略""" fields = {} @@ -266,8 +250,7 @@ class DeletePolicyResponseSchema(schema.ResponseSchema): class DeleteSSLRequestSchema(schema.RequestSchema): - """ DeleteSSL - 删除SSL证书 - """ + """DeleteSSL - 删除SSL证书""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -277,8 +260,7 @@ class DeleteSSLRequestSchema(schema.RequestSchema): class DeleteSSLResponseSchema(schema.ResponseSchema): - """ DeleteSSL - 删除SSL证书 - """ + """DeleteSSL - 删除SSL证书""" fields = {} @@ -291,8 +273,7 @@ class DeleteSSLResponseSchema(schema.ResponseSchema): class DeleteULBRequestSchema(schema.RequestSchema): - """ DeleteULB - 删除负载均衡实例 - """ + """DeleteULB - 删除负载均衡实例""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -303,8 +284,7 @@ class DeleteULBRequestSchema(schema.RequestSchema): class DeleteULBResponseSchema(schema.ResponseSchema): - """ DeleteULB - 删除负载均衡实例 - """ + """DeleteULB - 删除负载均衡实例""" fields = {} @@ -317,8 +297,7 @@ class DeleteULBResponseSchema(schema.ResponseSchema): class DeleteVServerRequestSchema(schema.RequestSchema): - """ DeleteVServer - 删除VServer实例 - """ + """DeleteVServer - 删除VServer实例""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -329,8 +308,7 @@ class DeleteVServerRequestSchema(schema.RequestSchema): class DeleteVServerResponseSchema(schema.ResponseSchema): - """ DeleteVServer - 删除VServer实例 - """ + """DeleteVServer - 删除VServer实例""" fields = {} @@ -343,8 +321,7 @@ class DeleteVServerResponseSchema(schema.ResponseSchema): class DescribeSSLRequestSchema(schema.RequestSchema): - """ DescribeSSL - 获取SSL证书信息 - """ + """DescribeSSL - 获取SSL证书信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -356,8 +333,7 @@ class DescribeSSLRequestSchema(schema.RequestSchema): class DescribeSSLResponseSchema(schema.ResponseSchema): - """ DescribeSSL - 获取SSL证书信息 - """ + """DescribeSSL - 获取SSL证书信息""" fields = { "DataSet": fields.List( @@ -375,8 +351,7 @@ class DescribeSSLResponseSchema(schema.ResponseSchema): class DescribeULBRequestSchema(schema.RequestSchema): - """ DescribeULB - 获取ULB详细信息 - """ + """DescribeULB - 获取ULB详细信息""" fields = { "BusinessId": fields.Str(required=False, dump_to="BusinessId"), @@ -391,8 +366,7 @@ class DescribeULBRequestSchema(schema.RequestSchema): class DescribeULBResponseSchema(schema.ResponseSchema): - """ DescribeULB - 获取ULB详细信息 - """ + """DescribeULB - 获取ULB详细信息""" fields = { "DataSet": fields.List( @@ -410,8 +384,7 @@ class DescribeULBResponseSchema(schema.ResponseSchema): class DescribeVServerRequestSchema(schema.RequestSchema): - """ DescribeVServer - 获取ULB下的VServer的详细信息 - """ + """DescribeVServer - 获取ULB下的VServer的详细信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -424,8 +397,7 @@ class DescribeVServerRequestSchema(schema.RequestSchema): class DescribeVServerResponseSchema(schema.ResponseSchema): - """ DescribeVServer - 获取ULB下的VServer的详细信息 - """ + """DescribeVServer - 获取ULB下的VServer的详细信息""" fields = { "DataSet": fields.List( @@ -443,8 +415,7 @@ class DescribeVServerResponseSchema(schema.ResponseSchema): class ReleaseBackendRequestSchema(schema.RequestSchema): - """ ReleaseBackend - 从VServer释放后端资源实例 - """ + """ReleaseBackend - 从VServer释放后端资源实例""" fields = { "BackendId": fields.Str(required=True, dump_to="BackendId"), @@ -455,8 +426,7 @@ class ReleaseBackendRequestSchema(schema.RequestSchema): class ReleaseBackendResponseSchema(schema.ResponseSchema): - """ ReleaseBackend - 从VServer释放后端资源实例 - """ + """ReleaseBackend - 从VServer释放后端资源实例""" fields = {} @@ -469,8 +439,7 @@ class ReleaseBackendResponseSchema(schema.ResponseSchema): class UnbindSSLRequestSchema(schema.RequestSchema): - """ UnbindSSL - 从VServer解绑SSL证书 - """ + """UnbindSSL - 从VServer解绑SSL证书""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -482,8 +451,7 @@ class UnbindSSLRequestSchema(schema.RequestSchema): class UnbindSSLResponseSchema(schema.ResponseSchema): - """ UnbindSSL - 从VServer解绑SSL证书 - """ + """UnbindSSL - 从VServer解绑SSL证书""" fields = {} @@ -496,8 +464,7 @@ class UnbindSSLResponseSchema(schema.ResponseSchema): class UpdateBackendAttributeRequestSchema(schema.RequestSchema): - """ UpdateBackendAttribute - 更新ULB后端资源实例(服务节点)属性 - """ + """UpdateBackendAttribute - 更新ULB后端资源实例(服务节点)属性""" fields = { "BackendId": fields.Str(required=True, dump_to="BackendId"), @@ -511,8 +478,7 @@ class UpdateBackendAttributeRequestSchema(schema.RequestSchema): class UpdateBackendAttributeResponseSchema(schema.ResponseSchema): - """ UpdateBackendAttribute - 更新ULB后端资源实例(服务节点)属性 - """ + """UpdateBackendAttribute - 更新ULB后端资源实例(服务节点)属性""" fields = {} @@ -525,8 +491,7 @@ class UpdateBackendAttributeResponseSchema(schema.ResponseSchema): class UpdatePolicyRequestSchema(schema.RequestSchema): - """ UpdatePolicy - 更新内容转发规则，包括转发规则后的服务节点 - """ + """UpdatePolicy - 更新内容转发规则，包括转发规则后的服务节点""" fields = { "BackendId": fields.List(fields.Str()), @@ -541,8 +506,7 @@ class UpdatePolicyRequestSchema(schema.RequestSchema): class UpdatePolicyResponseSchema(schema.ResponseSchema): - """ UpdatePolicy - 更新内容转发规则，包括转发规则后的服务节点 - """ + """UpdatePolicy - 更新内容转发规则，包括转发规则后的服务节点""" fields = {"PolicyId": fields.Str(required=False, load_from="PolicyId")} @@ -555,8 +519,7 @@ class UpdatePolicyResponseSchema(schema.ResponseSchema): class UpdateULBAttributeRequestSchema(schema.RequestSchema): - """ UpdateULBAttribute - 更新ULB名字业务组备注等属性字段 - """ + """UpdateULBAttribute - 更新ULB名字业务组备注等属性字段""" fields = { "Name": fields.Str(required=False, dump_to="Name"), @@ -569,8 +532,7 @@ class UpdateULBAttributeRequestSchema(schema.RequestSchema): class UpdateULBAttributeResponseSchema(schema.ResponseSchema): - """ UpdateULBAttribute - 更新ULB名字业务组备注等属性字段 - """ + """UpdateULBAttribute - 更新ULB名字业务组备注等属性字段""" fields = {} @@ -583,8 +545,7 @@ class UpdateULBAttributeResponseSchema(schema.ResponseSchema): class UpdateVServerAttributeRequestSchema(schema.RequestSchema): - """ UpdateVServerAttribute - 更新VServer实例属性 - """ + """UpdateVServerAttribute - 更新VServer实例属性""" fields = { "ClientTimeout": fields.Int(required=False, dump_to="ClientTimeout"), @@ -608,7 +569,6 @@ class UpdateVServerAttributeRequestSchema(schema.RequestSchema): class UpdateVServerAttributeResponseSchema(schema.ResponseSchema): - """ UpdateVServerAttribute - 更新VServer实例属性 - """ + """UpdateVServerAttribute - 更新VServer实例属性""" fields = {} diff --git a/ucloud/services/ulb/schemas/models.py b/ucloud/services/ulb/schemas/models.py index 7a07165..fed742a 100644 --- a/ucloud/services/ulb/schemas/models.py +++ b/ucloud/services/ulb/schemas/models.py @@ -5,8 +5,7 @@ class BackendSetSchema(schema.ResponseSchema): - """ BackendSet - ulb添加rs时返回的信息 - """ + """BackendSet - ulb添加rs时返回的信息""" fields = { "BackendId": fields.Str(required=True, load_from="BackendId"), @@ -15,8 +14,7 @@ class BackendSetSchema(schema.ResponseSchema): class ULBSSLSetSchema(schema.ResponseSchema): - """ ULBSSLSet - DescribeULB - """ + """ULBSSLSet - DescribeULB""" fields = { "HashValue": fields.Str(required=False, load_from="HashValue"), @@ -26,8 +24,7 @@ class ULBSSLSetSchema(schema.ResponseSchema): class PolicyBackendSetSchema(schema.ResponseSchema): - """ PolicyBackendSet - 内容转发下rs详细信息 - """ + """PolicyBackendSet - 内容转发下rs详细信息""" fields = { "BackendId": fields.Str(required=False, load_from="BackendId"), @@ -39,8 +36,7 @@ class PolicyBackendSetSchema(schema.ResponseSchema): class ULBBackendSetSchema(schema.ResponseSchema): - """ ULBBackendSet - DescribeULB - """ + """ULBBackendSet - DescribeULB""" fields = { "BackendId": fields.Str(required=False, load_from="BackendId"), @@ -64,8 +60,7 @@ class ULBBackendSetSchema(schema.ResponseSchema): class ULBPolicySetSchema(schema.ResponseSchema): - """ ULBPolicySet - 内容转发详细列表 - """ + """ULBPolicySet - 内容转发详细列表""" fields = { "BackendSet": fields.List(PolicyBackendSetSchema()), @@ -82,8 +77,7 @@ class ULBPolicySetSchema(schema.ResponseSchema): class ULBVServerSetSchema(schema.ResponseSchema): - """ ULBVServerSet - DescribeULB - """ + """ULBVServerSet - DescribeULB""" fields = { "BackendSet": fields.List(ULBBackendSetSchema()), @@ -110,8 +104,7 @@ class ULBVServerSetSchema(schema.ResponseSchema): class ULBIPSetSchema(schema.ResponseSchema): - """ ULBIPSet - DescribeULB - """ + """ULBIPSet - DescribeULB""" fields = { "Bandwidth": fields.Int(required=False, load_from="Bandwidth"), @@ -123,8 +116,7 @@ class ULBIPSetSchema(schema.ResponseSchema): class ULBSetSchema(schema.ResponseSchema): - """ ULBSet - DescribeULB - """ + """ULBSet - DescribeULB""" fields = { "Bandwidth": fields.Int(required=False, load_from="Bandwidth"), diff --git a/ucloud/services/umem/client.py b/ucloud/services/umem/client.py index 5f824ba..8f241b7 100644 --- a/ucloud/services/umem/client.py +++ b/ucloud/services/umem/client.py @@ -10,12 +10,12 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(UMemClient, self).__init__(config, transport, middleware, logger) def create_umem_space(self, req=None, **kwargs): - """ CreateUMemSpace - 创建UMem内存空间 + """CreateUMemSpace - 创建UMem内存空间 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 空间名称,长度(6<=size<=63) - **Size** (int) - (Required) 内存大小, 单位:GB, 范围[1~1024] - **ChargeType** (str) - Year , Month, Dynamic, Trial 默认: Month @@ -23,16 +23,16 @@ def create_umem_space(self, req=None, **kwargs): - **Password** (str) - URedis密码。请遵照 `字段规范 `_ 设定密码。密码需使用base64进行编码，举例如下：# echo -n Password1 | base64UGFzc3dvcmQx。 - **Protocol** (str) - 协议:memcache, redis (默认redis).注意:redis无single类型 - **Quantity** (int) - 购买时长 默认: 1 - - **SubnetId** (str) - - - **Tag** (str) - + - **SubnetId** (str) - + - **Tag** (str) - - **Type** (str) - 空间类型:single(无热备),double(热备)(默认: double) - - **VPCId** (str) - - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **VPCId** (str) - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **SpaceId** (str) - 创建内存空间ID列表 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -42,29 +42,29 @@ def create_umem_space(self, req=None, **kwargs): return apis.CreateUMemSpaceResponseSchema().loads(resp) def create_umem_cache_group(self, req=None, **kwargs): - """ CreateUMemcacheGroup - 创建单机Memcache + """CreateUMemcacheGroup - 创建单机Memcache **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 请求创建组的名称 范围[6-60] - **ChargeType** (str) - 计费模式，Year , Month, Dynamic 默认: Month - **ConfigId** (str) - 配置ID,目前仅支持默认配置id 默认配置id:"9a891891-c245-4b66-bce8-67e59430d67c" - **CouponId** (str) - 代金券ID - - **Protocol** (str) - + - **Protocol** (str) - - **Quantity** (int) - 购买时长，默认为1 - **Size** (int) - 每个节点的内存大小,单位GB,默认1GB 目前仅支持1/2/4/8/16/32这几档 - - **SubnetId** (str) - + - **SubnetId** (str) - - **Tag** (str) - 业务组 默认：Default - - **VPCId** (str) - + - **VPCId** (str) - - **Version** (str) - Memcache版本信息,默认为1.4.31 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **GroupId** (str) - 创建的组ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -74,15 +74,15 @@ def create_umem_cache_group(self, req=None, **kwargs): return apis.CreateUMemcacheGroupResponseSchema().loads(resp) def create_uredis_group(self, req=None, **kwargs): - """ CreateURedisGroup - 创建主备redis + """CreateURedisGroup - 创建主备redis **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **HighAvailability** (str) - (Required) 是否开启高可用,enable或disable - **Name** (str) - (Required) 请求创建组的名称 (范围[6-63],只能包含英文、数字以及符号-和_) - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **AutoBackup** (str) - 是否自动备份,enable或disable，默认disable - **BackupId** (str) - 有此项代表从备份中创建，无代表正常创建 - **BackupTime** (int) - 自动备份开始时间,范围[0-23],默认3点 @@ -94,15 +94,15 @@ def create_uredis_group(self, req=None, **kwargs): - **Quantity** (int) - 购买时长，默认为1 - **Size** (int) - 每个节点的内存大小,单位GB,默认1GB,目前仅支持1/2/4/8/16/32,六种 - **SlaveZone** (str) - 跨机房URedis，slave所在可用区（必须和Zone在同一Region，且不可相同） - - **SubnetId** (str) - + - **SubnetId** (str) - - **Tag** (str) - 业务组名称 - - **VPCId** (str) - + - **VPCId** (str) - - **Version** (str) - Redis版本信息(详见DescribeURedisVersion返回结果),默认版本3.0 - + **Response** - **GroupId** (str) - 创建的组ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -112,18 +112,18 @@ def create_uredis_group(self, req=None, **kwargs): return apis.CreateURedisGroupResponseSchema().loads(resp) def delete_umem_space(self, req=None, **kwargs): - """ DeleteUMemSpace - 删除UMem内存空间 + """DeleteUMemSpace - 删除UMem内存空间 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **SpaceId** (str) - (Required) UMem内存空间ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -132,18 +132,18 @@ def delete_umem_space(self, req=None, **kwargs): return apis.DeleteUMemSpaceResponseSchema().loads(resp) def delete_umem_cache_group(self, req=None, **kwargs): - """ DeleteUMemcacheGroup - 删除单机Memcache + """DeleteUMemcacheGroup - 删除单机Memcache **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - (Required) 组ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -152,17 +152,17 @@ def delete_umem_cache_group(self, req=None, **kwargs): return apis.DeleteUMemcacheGroupResponseSchema().loads(resp) def delete_uredis_group(self, req=None, **kwargs): - """ DeleteURedisGroup - 删除主备redis + """DeleteURedisGroup - 删除主备redis **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - (Required) 组ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -171,27 +171,27 @@ def delete_uredis_group(self, req=None, **kwargs): return apis.DeleteURedisGroupResponseSchema().loads(resp) def describe_umem_price(self, req=None, **kwargs): - """ DescribeUMemPrice - 获取UMem实例价格信息 + """DescribeUMemPrice - 获取UMem实例价格信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 购买umem大小,单位:GB,范围[1~1024] - **Type** (str) - (Required) 空间类型:single(无热备),double(热备)(默认: double) - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - Year， Month， Dynamic，Trial 如果不指定，则一次性获取三种计费 - **Quantity** (int) - 购买UMem的时长，默认值为1 - - **RegionFlag** (bool) - - + - **RegionFlag** (bool) - + **Response** - **DataSet** (list) - 见 **UMemPriceSet** 模型定义 - + **Response Model** - - **UMemPriceSet** - + + **UMemPriceSet** + - **ChargeType** (str) - Year， Month， Dynamic，Trial - **OriginalPrice** (int) - 原价 - **Price** (int) - 现价，单位: 元，保留小数点后两位有效数字 @@ -204,31 +204,31 @@ def describe_umem_price(self, req=None, **kwargs): return apis.DescribeUMemPriceResponseSchema().loads(resp) def describe_umem_space(self, req=None, **kwargs): - """ DescribeUMemSpace - 获取UMem内存空间列表 + """DescribeUMemSpace - 获取UMem内存空间列表 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - 返回数据长度, 默认为20 - **Offset** (int) - 数据偏移量, 默认为0 - **SpaceId** (str) - 内存空间ID (无ID，则获取所有) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 见 **UMemSpaceSet** 模型定义 - **TotalCount** (int) - 根据过滤条件得到的总数 - + **Response Model** - - **UMemSpaceAddressSet** - + + **UMemSpaceAddressSet** + - **IP** (str) - UMem实例访问IP - **Port** (int) - UMem实例访问Port - **UMemSpaceSet** - + **UMemSpaceSet** + - **Address** (list) - 见 **UMemSpaceAddressSet** 模型定义 - **ChargeType** (str) - Year, Month, Dynamic, Trial - **CreateTime** (int) - 创建时间 @@ -239,12 +239,12 @@ def describe_umem_space(self, req=None, **kwargs): - **Size** (int) - 容量单位GB - **SpaceId** (str) - 内存空间ID - **State** (str) - Starting:创建中 Running:运行中 Fail:失败 - - **SubnetId** (str) - - - **Tag** (str) - + - **SubnetId** (str) - + - **Tag** (str) - - **Type** (str) - 空间类型:single(无热备),double(热备) - **UsedSize** (int) - 使用量单位MB - - **VPCId** (str) - - - **Zone** (str) - 可用区，参见 `可用区列表 `_ + - **VPCId** (str) - + - **Zone** (str) - 可用区，参见 `可用区列表 `_ """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} @@ -254,26 +254,26 @@ def describe_umem_space(self, req=None, **kwargs): return apis.DescribeUMemSpaceResponseSchema().loads(resp) def describe_umem_upgrade_price(self, req=None, **kwargs): - """ DescribeUMemUpgradePrice - 获取UMem升级价格信息 + """DescribeUMemUpgradePrice - 获取UMem升级价格信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 购买UMem大小,单位:GB - **SpaceId** (str) - (Required) 需要升级的空间的SpaceId - **Type** (str) - (Required) 空间类型:single(无热备),double(热备)(默认: double) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (dict) - 见 **PriceDataSet** 模型定义 - **Price** (int) - 价格(兼容老版本) - + **Response Model** - - **PriceDataSet** - + + **PriceDataSet** + - **CustomPrice** (int) - 用户折后价 - **PurchaseValue** (int) - 资源有效期 - **TotalPrice** (int) - 升降级资源的价格 @@ -286,26 +286,26 @@ def describe_umem_upgrade_price(self, req=None, **kwargs): return apis.DescribeUMemUpgradePriceResponseSchema().loads(resp) def describe_umem_cache_group(self, req=None, **kwargs): - """ DescribeUMemcacheGroup - 显示Memcache + """DescribeUMemcacheGroup - 显示Memcache **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - 组的ID,如果指定则获取描述，否则为列表操 作,需指定Offset/Limit - **Limit** (int) - 分页显示的条目数, 默认值为20 - **Offset** (int) - 分页显示的起始偏移, 默认值为0 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 见 **UMemcacheGroupSet** 模型定义 - **TotalCount** (int) - 组的总的节点个数 - + **Response Model** - - **UMemcacheGroupSet** - + + **UMemcacheGroupSet** + - **ChargeType** (str) - 计费类型:Year,Month,Dynamic 默认Dynamic - **ConfigId** (str) - 节点的配置ID - **CreateTime** (int) - 创建时间 (UNIX时间戳) @@ -316,10 +316,10 @@ def describe_umem_cache_group(self, req=None, **kwargs): - **Port** (int) - 节点分配的服务端口 - **Size** (int) - 容量单位GB - **State** (str) - 状态标记 Creating // 初始化中 CreateFail // 创建失败 Deleting // 删除中 DeleteFail // 删除失败 Running // 运行 Resizing // 容量调整中 ResizeFail // 容量调整失败 Configing // 配置中 ConfigFail // 配置失败Restarting // 重启中 - - **SubnetId** (str) - + - **SubnetId** (str) - - **Tag** (str) - 业务组名称 - **UsedSize** (int) - 使用量单位MB - - **VPCId** (str) - + - **VPCId** (str) - - **Version** (str) - Memcache版本信息,默认为1.4.31 - **VirtualIP** (str) - 节点的虚拟IP地址 @@ -331,26 +331,26 @@ def describe_umem_cache_group(self, req=None, **kwargs): return apis.DescribeUMemcacheGroupResponseSchema().loads(resp) def describe_umem_cache_price(self, req=None, **kwargs): - """ DescribeUMemcachePrice - 获取umemcache组价格信息 + """DescribeUMemcachePrice - 获取umemcache组价格信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 容量大小,单位:GB 取值范围[1-32] - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - 计费模式，Year， Month， Dynamic，默认: Dynamic 默认: 获取所有计费模式的价格 - **Quantity** (int) - 购买umemcache的时长，默认值为1 - **Type** (str) - 空间类型:single(无热备),double(热备)(默认: double) - + **Response** - **DataSet** (list) - 见 **UMemcachePriceSet** 模型定义 - + **Response Model** - - **UMemcachePriceSet** - + + **UMemcachePriceSet** + - **ChargeType** (str) - 计费模式，Year, Month, Dynamic - **OriginalPrice** (int) - 原价 - **Price** (int) - 总价格，单位: 元，保留小数点后两位有效数字 @@ -363,25 +363,25 @@ def describe_umem_cache_price(self, req=None, **kwargs): return apis.DescribeUMemcachePriceResponseSchema().loads(resp) def describe_umem_cache_upgrade_price(self, req=None, **kwargs): - """ DescribeUMemcacheUpgradePrice - 获取umemcache升级价格信息 + """DescribeUMemcacheUpgradePrice - 获取umemcache升级价格信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - (Required) 需要升级的空间的GroupId,请参考DescribeUMemcacheGroup接口 - **Size** (int) - (Required) 购买umemcache大小,单位:GB - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (dict) - 见 **PriceDataSet** 模型定义 - **Price** (int) - 价格，单位：元 - + **Response Model** - - **PriceDataSet** - + + **PriceDataSet** + - **CustomPrice** (int) - 用户折后价 - **PurchaseValue** (int) - 资源有效期 - **TotalPrice** (int) - 升降级资源的价格 @@ -394,25 +394,25 @@ def describe_umem_cache_upgrade_price(self, req=None, **kwargs): return apis.DescribeUMemcacheUpgradePriceResponseSchema().loads(resp) def describe_uredis_backup(self, req=None, **kwargs): - """ DescribeURedisBackup - 查询主备redis备份 + """DescribeURedisBackup - 查询主备redis备份 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - 组的ID - **Limit** (int) - 分页显示的条目数, 默认值为10 - **Offset** (int) - 分页显示的起始偏移, 默认值为0 - + **Response** - **DataSet** (list) - 见 **URedisBackupSet** 模型定义 - **TotalCount** (int) - 用户名下总的备份个数 - + **Response Model** - - **URedisBackupSet** - + + **URedisBackupSet** + - **BackupId** (str) - 备份ID - **BackupName** (str) - 备份的名称 - **BackupSize** (int) - 备份文件大小, 以字节为单位 @@ -421,7 +421,7 @@ def describe_uredis_backup(self, req=None, **kwargs): - **GroupId** (str) - 对应的实例ID - **GroupName** (str) - 组名称 - **State** (str) - 备份的状态: Backuping 备份中 Success 备份成功 Error 备份失败 Expired 备份过期 - - **Zone** (str) - 可用区，参见 `可用区列表 `_ + - **Zone** (str) - 可用区，参见 `可用区列表 `_ """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} @@ -431,23 +431,23 @@ def describe_uredis_backup(self, req=None, **kwargs): return apis.DescribeURedisBackupResponseSchema().loads(resp) def describe_uredis_backup_url(self, req=None, **kwargs): - """ DescribeURedisBackupURL - 获取主备Redis备份下载链接 + """DescribeURedisBackupURL - 获取主备Redis备份下载链接 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BackupId** (str) - (Required) 备份ID - **GroupId** (str) - 实例名称 - **RegionFlag** (bool) - 是否是跨机房URedis(默认false) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **BackupPath** (str) - 备份文件公网的地址 - **BackupURL** (str) - 备份文件公网的地址 - - **InnerBackupPath** (str) - - + - **InnerBackupPath** (str) - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -456,26 +456,26 @@ def describe_uredis_backup_url(self, req=None, **kwargs): return apis.DescribeURedisBackupURLResponseSchema().loads(resp) def describe_uredis_group(self, req=None, **kwargs): - """ DescribeURedisGroup - 查询主备Redis + """DescribeURedisGroup - 查询主备Redis **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - 组的ID,如果指定则获取描述，否则为列表操 作,需指定Offset/Limit - **Limit** (int) - 分页显示的条目数, 默认值为20 - **Offset** (int) - 分页显示的起始偏移, 默认值为0 - - **Zone** (str) - - + - **Zone** (str) - + **Response** - **DataSet** (list) - 见 **URedisGroupSet** 模型定义 - **TotalCount** (int) - 组的总的节点个数 - + **Response Model** - - **URedisGroupSet** - + + **URedisGroupSet** + - **AutoBackup** (str) - 是否需要自动备份,enable,disable - **BackupTime** (int) - 组自动备份开始时间,单位小时计,范围[0-23] - **ChargeType** (str) - 计费类型:Year,Month,Dynamic 默认Dynamic @@ -492,16 +492,16 @@ def describe_uredis_group(self, req=None, **kwargs): - **Protocol** (str) - 协议 - **RewriteTime** (int) - 返回运维时间 0 //0点 1 //1点 以此类推 - **Size** (int) - 容量单位GB - - **SlaveZone** (str) - 跨机房URedis，slave redis所在可用区，参见 `可用区列表 `_ + - **SlaveZone** (str) - 跨机房URedis，slave redis所在可用区，参见 `可用区列表 `_ - **State** (str) - 状态标记 Creating // 初始化中 CreateFail // 创建失败 Deleting // 删除中 DeleteFail // 删除失败 Running // 运行 Resizing // 容量调整中 ResizeFail // 容量调整失败 Configing // 配置中 ConfigFail // 配置失败 - - **SubnetId** (str) - + - **SubnetId** (str) - - **Tag** (str) - 业务组名称 - - **Type** (str) - + - **Type** (str) - - **UsedSize** (int) - 使用量单位MB - - **VPCId** (str) - + - **VPCId** (str) - - **Version** (str) - Redis版本信息 - **VirtualIP** (str) - 节点的虚拟IP地址 - - **Zone** (str) - 实例所在可用区，或者master redis所在可用区，参见 `可用区列表 `_ + - **Zone** (str) - 实例所在可用区，或者master redis所在可用区，参见 `可用区列表 `_ """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} @@ -511,28 +511,28 @@ def describe_uredis_group(self, req=None, **kwargs): return apis.DescribeURedisGroupResponseSchema().loads(resp) def describe_uredis_price(self, req=None, **kwargs): - """ DescribeURedisPrice - 取uredis价格信息 + """DescribeURedisPrice - 取uredis价格信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 量大小,单位:GB 取值范围[1-32] - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - 计费模式，Year， Month， Dynamic；如果不指定，则一次性获取三种计费 - **ProductType** (str) - 产品类型：MS_Redis（标准主备版），S_Redis（从库），默认为MS_Redis - **Quantity** (int) - 计费模式为Dynamic时，购买的时长, 默认为1 - **RegionFlag** (bool) - 是否是跨机房URedis(默认false) - - **Type** (str) - - + - **Type** (str) - + **Response** - **DataSet** (list) - 见 **URedisPriceSet** 模型定义 - + **Response Model** - - **URedisPriceSet** - + + **URedisPriceSet** + - **ChargeType** (str) - Year， Month， Dynamic，Trial - **OriginalPrice** (int) - 原价 - **Price** (int) - 总价格，单位: 元，保留小数点后两位有效数字 @@ -545,26 +545,26 @@ def describe_uredis_price(self, req=None, **kwargs): return apis.DescribeURedisPriceResponseSchema().loads(resp) def describe_uredis_upgrade_price(self, req=None, **kwargs): - """ DescribeURedisUpgradePrice - 获取uredis升级价格信息 + """DescribeURedisUpgradePrice - 获取uredis升级价格信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - (Required) 要升级的空间的GroupId,请参考DescribeURedisGroup接口 - **Size** (int) - (Required) 购买uredis大小,单位:GB,范围是[1-32] - - **Type** (str) - - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Type** (str) - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (dict) - 见 **PriceDataSet** 模型定义 - **Price** (int) - 扩容差价，单位: 元，保留小数点后两位有效数字(兼容老版本) - + **Response Model** - - **PriceDataSet** - + + **PriceDataSet** + - **CustomPrice** (int) - 用户折后价 - **PurchaseValue** (int) - 资源有效期 - **TotalPrice** (int) - 升降级资源的价格 @@ -577,19 +577,19 @@ def describe_uredis_upgrade_price(self, req=None, **kwargs): return apis.DescribeURedisUpgradePriceResponseSchema().loads(resp) def get_umem_space_state(self, req=None, **kwargs): - """ GetUMemSpaceState - 获取UMem内存空间列表 + """GetUMemSpaceState - 获取UMem内存空间列表 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **SpaceId** (str) - (Required) 内存空间ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **State** (str) - Starting:创建中 Running:运行中 Fail:失败 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -598,19 +598,19 @@ def get_umem_space_state(self, req=None, **kwargs): return apis.GetUMemSpaceStateResponseSchema().loads(resp) def modify_umem_space_name(self, req=None, **kwargs): - """ ModifyUMemSpaceName - 修改UMem内存空间名称 + """ModifyUMemSpaceName - 修改UMem内存空间名称 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Name** (str) - (Required) 新的名称,长度(6<=size<=63) - **SpaceId** (str) - (Required) UMem内存空间ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -619,19 +619,19 @@ def modify_umem_space_name(self, req=None, **kwargs): return apis.ModifyUMemSpaceNameResponseSchema().loads(resp) def modify_uredis_group_name(self, req=None, **kwargs): - """ ModifyURedisGroupName - 修改主备redis名称 + """ModifyURedisGroupName - 修改主备redis名称 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - (Required) 组的ID - **Name** (str) - (Required) Redis组名称 (范围[6-63],只能包含英文、数字以及符号-和_) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -640,20 +640,20 @@ def modify_uredis_group_name(self, req=None, **kwargs): return apis.ModifyURedisGroupNameResponseSchema().loads(resp) def resize_udredis_space(self, req=None, **kwargs): - """ ResizeUDredisSpace - 调整内存空间容量 + """ResizeUDredisSpace - 调整内存空间容量 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 内存大小, 单位:GB (需要大于原size,<= 1024) - **SpaceId** (str) - (Required) 高性能UMem 内存空间Id - **CouponId** (str) - 使用的代金券Id - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -662,22 +662,22 @@ def resize_udredis_space(self, req=None, **kwargs): return apis.ResizeUDredisSpaceResponseSchema().loads(resp) def resize_umem_space(self, req=None, **kwargs): - """ ResizeUMemSpace - 调整内存空间容量 + """ResizeUMemSpace - 调整内存空间容量 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Size** (int) - (Required) 内存大小, 单位:GB (需要大于原size,<= 1024) - **SpaceId** (str) - (Required) UMem 内存空间Id - - **ChargeType** (str) - + - **ChargeType** (str) - - **CouponId** (str) - 使用的代金券Id - **Type** (str) - 空间类型:single(无热备),double(热备)(默认: double) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -686,22 +686,22 @@ def resize_umem_space(self, req=None, **kwargs): return apis.ResizeUMemSpaceResponseSchema().loads(resp) def resize_uredis_group(self, req=None, **kwargs): - """ ResizeURedisGroup - 调整主备redis容量 + """ResizeURedisGroup - 调整主备redis容量 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - (Required) 组ID - **Size** (int) - (Required) 内存大小, 单位:GB (需要大于原size,且小于等于32) 目前仅支持1/2/4/8/16/32 G 六种容量规格 - - **ChargeType** (str) - + - **ChargeType** (str) - - **CouponId** (int) - 代金券ID 请参考DescribeCoupon接口 - **Type** (str) - 空间类型:single(无热备),double(热备)(默认: double) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -710,18 +710,18 @@ def resize_uredis_group(self, req=None, **kwargs): return apis.ResizeURedisGroupResponseSchema().loads(resp) def restart_umem_cache_group(self, req=None, **kwargs): - """ RestartUMemcacheGroup - 重启单机Memcache + """RestartUMemcacheGroup - 重启单机Memcache **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **GroupId** (str) - (Required) 组的ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/umem/schemas/apis.py b/ucloud/services/umem/schemas/apis.py index bbf178f..625d872 100644 --- a/ucloud/services/umem/schemas/apis.py +++ b/ucloud/services/umem/schemas/apis.py @@ -14,8 +14,7 @@ class CreateUMemSpaceRequestSchema(schema.RequestSchema): - """ CreateUMemSpace - 创建UMem内存空间 - """ + """CreateUMemSpace - 创建UMem内存空间""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -36,8 +35,7 @@ class CreateUMemSpaceRequestSchema(schema.RequestSchema): class CreateUMemSpaceResponseSchema(schema.ResponseSchema): - """ CreateUMemSpace - 创建UMem内存空间 - """ + """CreateUMemSpace - 创建UMem内存空间""" fields = {"SpaceId": fields.Str(required=False, load_from="SpaceId")} @@ -50,8 +48,7 @@ class CreateUMemSpaceResponseSchema(schema.ResponseSchema): class CreateUMemcacheGroupRequestSchema(schema.RequestSchema): - """ CreateUMemcacheGroup - 创建单机Memcache - """ + """CreateUMemcacheGroup - 创建单机Memcache""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -72,8 +69,7 @@ class CreateUMemcacheGroupRequestSchema(schema.RequestSchema): class CreateUMemcacheGroupResponseSchema(schema.ResponseSchema): - """ CreateUMemcacheGroup - 创建单机Memcache - """ + """CreateUMemcacheGroup - 创建单机Memcache""" fields = {"GroupId": fields.Str(required=False, load_from="GroupId")} @@ -86,8 +82,7 @@ class CreateUMemcacheGroupResponseSchema(schema.ResponseSchema): class CreateURedisGroupRequestSchema(schema.RequestSchema): - """ CreateURedisGroup - 创建主备redis - """ + """CreateURedisGroup - 创建主备redis""" fields = { "AutoBackup": fields.Str(required=False, dump_to="AutoBackup"), @@ -116,8 +111,7 @@ class CreateURedisGroupRequestSchema(schema.RequestSchema): class CreateURedisGroupResponseSchema(schema.ResponseSchema): - """ CreateURedisGroup - 创建主备redis - """ + """CreateURedisGroup - 创建主备redis""" fields = {"GroupId": fields.Str(required=False, load_from="GroupId")} @@ -130,8 +124,7 @@ class CreateURedisGroupResponseSchema(schema.ResponseSchema): class DeleteUMemSpaceRequestSchema(schema.RequestSchema): - """ DeleteUMemSpace - 删除UMem内存空间 - """ + """DeleteUMemSpace - 删除UMem内存空间""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -142,8 +135,7 @@ class DeleteUMemSpaceRequestSchema(schema.RequestSchema): class DeleteUMemSpaceResponseSchema(schema.ResponseSchema): - """ DeleteUMemSpace - 删除UMem内存空间 - """ + """DeleteUMemSpace - 删除UMem内存空间""" fields = {} @@ -156,8 +148,7 @@ class DeleteUMemSpaceResponseSchema(schema.ResponseSchema): class DeleteUMemcacheGroupRequestSchema(schema.RequestSchema): - """ DeleteUMemcacheGroup - 删除单机Memcache - """ + """DeleteUMemcacheGroup - 删除单机Memcache""" fields = { "GroupId": fields.Str(required=True, dump_to="GroupId"), @@ -168,8 +159,7 @@ class DeleteUMemcacheGroupRequestSchema(schema.RequestSchema): class DeleteUMemcacheGroupResponseSchema(schema.ResponseSchema): - """ DeleteUMemcacheGroup - 删除单机Memcache - """ + """DeleteUMemcacheGroup - 删除单机Memcache""" fields = {} @@ -182,8 +172,7 @@ class DeleteUMemcacheGroupResponseSchema(schema.ResponseSchema): class DeleteURedisGroupRequestSchema(schema.RequestSchema): - """ DeleteURedisGroup - 删除主备redis - """ + """DeleteURedisGroup - 删除主备redis""" fields = { "GroupId": fields.Str(required=True, dump_to="GroupId"), @@ -193,8 +182,7 @@ class DeleteURedisGroupRequestSchema(schema.RequestSchema): class DeleteURedisGroupResponseSchema(schema.ResponseSchema): - """ DeleteURedisGroup - 删除主备redis - """ + """DeleteURedisGroup - 删除主备redis""" fields = {} @@ -207,8 +195,7 @@ class DeleteURedisGroupResponseSchema(schema.ResponseSchema): class DescribeUMemPriceRequestSchema(schema.RequestSchema): - """ DescribeUMemPrice - 获取UMem实例价格信息 - """ + """DescribeUMemPrice - 获取UMem实例价格信息""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -223,8 +210,7 @@ class DescribeUMemPriceRequestSchema(schema.RequestSchema): class DescribeUMemPriceResponseSchema(schema.ResponseSchema): - """ DescribeUMemPrice - 获取UMem实例价格信息 - """ + """DescribeUMemPrice - 获取UMem实例价格信息""" fields = { "DataSet": fields.List( @@ -241,8 +227,7 @@ class DescribeUMemPriceResponseSchema(schema.ResponseSchema): class DescribeUMemSpaceRequestSchema(schema.RequestSchema): - """ DescribeUMemSpace - 获取UMem内存空间列表 - """ + """DescribeUMemSpace - 获取UMem内存空间列表""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -255,8 +240,7 @@ class DescribeUMemSpaceRequestSchema(schema.RequestSchema): class DescribeUMemSpaceResponseSchema(schema.ResponseSchema): - """ DescribeUMemSpace - 获取UMem内存空间列表 - """ + """DescribeUMemSpace - 获取UMem内存空间列表""" fields = { "DataSet": fields.List( @@ -274,8 +258,7 @@ class DescribeUMemSpaceResponseSchema(schema.ResponseSchema): class DescribeUMemUpgradePriceRequestSchema(schema.RequestSchema): - """ DescribeUMemUpgradePrice - 获取UMem升级价格信息 - """ + """DescribeUMemUpgradePrice - 获取UMem升级价格信息""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -288,8 +271,7 @@ class DescribeUMemUpgradePriceRequestSchema(schema.RequestSchema): class DescribeUMemUpgradePriceResponseSchema(schema.ResponseSchema): - """ DescribeUMemUpgradePrice - 获取UMem升级价格信息 - """ + """DescribeUMemUpgradePrice - 获取UMem升级价格信息""" fields = { "DataSet": models.PriceDataSetSchema(), @@ -305,8 +287,7 @@ class DescribeUMemUpgradePriceResponseSchema(schema.ResponseSchema): class DescribeUMemcacheGroupRequestSchema(schema.RequestSchema): - """ DescribeUMemcacheGroup - 显示Memcache - """ + """DescribeUMemcacheGroup - 显示Memcache""" fields = { "GroupId": fields.Str(required=False, dump_to="GroupId"), @@ -319,8 +300,7 @@ class DescribeUMemcacheGroupRequestSchema(schema.RequestSchema): class DescribeUMemcacheGroupResponseSchema(schema.ResponseSchema): - """ DescribeUMemcacheGroup - 显示Memcache - """ + """DescribeUMemcacheGroup - 显示Memcache""" fields = { "DataSet": fields.List( @@ -340,8 +320,7 @@ class DescribeUMemcacheGroupResponseSchema(schema.ResponseSchema): class DescribeUMemcachePriceRequestSchema(schema.RequestSchema): - """ DescribeUMemcachePrice - 获取umemcache组价格信息 - """ + """DescribeUMemcachePrice - 获取umemcache组价格信息""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -355,8 +334,7 @@ class DescribeUMemcachePriceRequestSchema(schema.RequestSchema): class DescribeUMemcachePriceResponseSchema(schema.ResponseSchema): - """ DescribeUMemcachePrice - 获取umemcache组价格信息 - """ + """DescribeUMemcachePrice - 获取umemcache组价格信息""" fields = { "DataSet": fields.List( @@ -375,8 +353,7 @@ class DescribeUMemcachePriceResponseSchema(schema.ResponseSchema): class DescribeUMemcacheUpgradePriceRequestSchema(schema.RequestSchema): - """ DescribeUMemcacheUpgradePrice - 获取umemcache升级价格信息 - """ + """DescribeUMemcacheUpgradePrice - 获取umemcache升级价格信息""" fields = { "GroupId": fields.Str(required=True, dump_to="GroupId"), @@ -388,8 +365,7 @@ class DescribeUMemcacheUpgradePriceRequestSchema(schema.RequestSchema): class DescribeUMemcacheUpgradePriceResponseSchema(schema.ResponseSchema): - """ DescribeUMemcacheUpgradePrice - 获取umemcache升级价格信息 - """ + """DescribeUMemcacheUpgradePrice - 获取umemcache升级价格信息""" fields = { "DataSet": models.PriceDataSetSchema(), @@ -405,8 +381,7 @@ class DescribeUMemcacheUpgradePriceResponseSchema(schema.ResponseSchema): class DescribeURedisBackupRequestSchema(schema.RequestSchema): - """ DescribeURedisBackup - 查询主备redis备份 - """ + """DescribeURedisBackup - 查询主备redis备份""" fields = { "GroupId": fields.Str(required=False, dump_to="GroupId"), @@ -418,8 +393,7 @@ class DescribeURedisBackupRequestSchema(schema.RequestSchema): class DescribeURedisBackupResponseSchema(schema.ResponseSchema): - """ DescribeURedisBackup - 查询主备redis备份 - """ + """DescribeURedisBackup - 查询主备redis备份""" fields = { "DataSet": fields.List( @@ -437,8 +411,7 @@ class DescribeURedisBackupResponseSchema(schema.ResponseSchema): class DescribeURedisBackupURLRequestSchema(schema.RequestSchema): - """ DescribeURedisBackupURL - 获取主备Redis备份下载链接 - """ + """DescribeURedisBackupURL - 获取主备Redis备份下载链接""" fields = { "BackupId": fields.Str(required=True, dump_to="BackupId"), @@ -451,8 +424,7 @@ class DescribeURedisBackupURLRequestSchema(schema.RequestSchema): class DescribeURedisBackupURLResponseSchema(schema.ResponseSchema): - """ DescribeURedisBackupURL - 获取主备Redis备份下载链接 - """ + """DescribeURedisBackupURL - 获取主备Redis备份下载链接""" fields = { "BackupPath": fields.Str(required=False, load_from="BackupPath"), @@ -471,8 +443,7 @@ class DescribeURedisBackupURLResponseSchema(schema.ResponseSchema): class DescribeURedisGroupRequestSchema(schema.RequestSchema): - """ DescribeURedisGroup - 查询主备Redis - """ + """DescribeURedisGroup - 查询主备Redis""" fields = { "GroupId": fields.Str(required=False, dump_to="GroupId"), @@ -485,8 +456,7 @@ class DescribeURedisGroupRequestSchema(schema.RequestSchema): class DescribeURedisGroupResponseSchema(schema.ResponseSchema): - """ DescribeURedisGroup - 查询主备Redis - """ + """DescribeURedisGroup - 查询主备Redis""" fields = { "DataSet": fields.List( @@ -504,8 +474,7 @@ class DescribeURedisGroupResponseSchema(schema.ResponseSchema): class DescribeURedisPriceRequestSchema(schema.RequestSchema): - """ DescribeURedisPrice - 取uredis价格信息 - """ + """DescribeURedisPrice - 取uredis价格信息""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -521,8 +490,7 @@ class DescribeURedisPriceRequestSchema(schema.RequestSchema): class DescribeURedisPriceResponseSchema(schema.ResponseSchema): - """ DescribeURedisPrice - 取uredis价格信息 - """ + """DescribeURedisPrice - 取uredis价格信息""" fields = { "DataSet": fields.List( @@ -539,8 +507,7 @@ class DescribeURedisPriceResponseSchema(schema.ResponseSchema): class DescribeURedisUpgradePriceRequestSchema(schema.RequestSchema): - """ DescribeURedisUpgradePrice - 获取uredis升级价格信息 - """ + """DescribeURedisUpgradePrice - 获取uredis升级价格信息""" fields = { "GroupId": fields.Str(required=True, dump_to="GroupId"), @@ -553,8 +520,7 @@ class DescribeURedisUpgradePriceRequestSchema(schema.RequestSchema): class DescribeURedisUpgradePriceResponseSchema(schema.ResponseSchema): - """ DescribeURedisUpgradePrice - 获取uredis升级价格信息 - """ + """DescribeURedisUpgradePrice - 获取uredis升级价格信息""" fields = { "DataSet": models.PriceDataSetSchema(), @@ -570,8 +536,7 @@ class DescribeURedisUpgradePriceResponseSchema(schema.ResponseSchema): class GetUMemSpaceStateRequestSchema(schema.RequestSchema): - """ GetUMemSpaceState - 获取UMem内存空间列表 - """ + """GetUMemSpaceState - 获取UMem内存空间列表""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -582,8 +547,7 @@ class GetUMemSpaceStateRequestSchema(schema.RequestSchema): class GetUMemSpaceStateResponseSchema(schema.ResponseSchema): - """ GetUMemSpaceState - 获取UMem内存空间列表 - """ + """GetUMemSpaceState - 获取UMem内存空间列表""" fields = {"State": fields.Str(required=False, load_from="State")} @@ -596,8 +560,7 @@ class GetUMemSpaceStateResponseSchema(schema.ResponseSchema): class ModifyUMemSpaceNameRequestSchema(schema.RequestSchema): - """ ModifyUMemSpaceName - 修改UMem内存空间名称 - """ + """ModifyUMemSpaceName - 修改UMem内存空间名称""" fields = { "Name": fields.Str(required=True, dump_to="Name"), @@ -609,8 +572,7 @@ class ModifyUMemSpaceNameRequestSchema(schema.RequestSchema): class ModifyUMemSpaceNameResponseSchema(schema.ResponseSchema): - """ ModifyUMemSpaceName - 修改UMem内存空间名称 - """ + """ModifyUMemSpaceName - 修改UMem内存空间名称""" fields = {} @@ -623,8 +585,7 @@ class ModifyUMemSpaceNameResponseSchema(schema.ResponseSchema): class ModifyURedisGroupNameRequestSchema(schema.RequestSchema): - """ ModifyURedisGroupName - 修改主备redis名称 - """ + """ModifyURedisGroupName - 修改主备redis名称""" fields = { "GroupId": fields.Str(required=True, dump_to="GroupId"), @@ -636,8 +597,7 @@ class ModifyURedisGroupNameRequestSchema(schema.RequestSchema): class ModifyURedisGroupNameResponseSchema(schema.ResponseSchema): - """ ModifyURedisGroupName - 修改主备redis名称 - """ + """ModifyURedisGroupName - 修改主备redis名称""" fields = {} @@ -650,8 +610,7 @@ class ModifyURedisGroupNameResponseSchema(schema.ResponseSchema): class ResizeUDredisSpaceRequestSchema(schema.RequestSchema): - """ ResizeUDredisSpace - 调整内存空间容量 - """ + """ResizeUDredisSpace - 调整内存空间容量""" fields = { "CouponId": fields.Str(required=False, dump_to="CouponId"), @@ -664,8 +623,7 @@ class ResizeUDredisSpaceRequestSchema(schema.RequestSchema): class ResizeUDredisSpaceResponseSchema(schema.ResponseSchema): - """ ResizeUDredisSpace - 调整内存空间容量 - """ + """ResizeUDredisSpace - 调整内存空间容量""" fields = {} @@ -678,8 +636,7 @@ class ResizeUDredisSpaceResponseSchema(schema.ResponseSchema): class ResizeUMemSpaceRequestSchema(schema.RequestSchema): - """ ResizeUMemSpace - 调整内存空间容量 - """ + """ResizeUMemSpace - 调整内存空间容量""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -694,8 +651,7 @@ class ResizeUMemSpaceRequestSchema(schema.RequestSchema): class ResizeUMemSpaceResponseSchema(schema.ResponseSchema): - """ ResizeUMemSpace - 调整内存空间容量 - """ + """ResizeUMemSpace - 调整内存空间容量""" fields = {} @@ -708,8 +664,7 @@ class ResizeUMemSpaceResponseSchema(schema.ResponseSchema): class ResizeURedisGroupRequestSchema(schema.RequestSchema): - """ ResizeURedisGroup - 调整主备redis容量 - """ + """ResizeURedisGroup - 调整主备redis容量""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -724,8 +679,7 @@ class ResizeURedisGroupRequestSchema(schema.RequestSchema): class ResizeURedisGroupResponseSchema(schema.ResponseSchema): - """ ResizeURedisGroup - 调整主备redis容量 - """ + """ResizeURedisGroup - 调整主备redis容量""" fields = {} @@ -738,8 +692,7 @@ class ResizeURedisGroupResponseSchema(schema.ResponseSchema): class RestartUMemcacheGroupRequestSchema(schema.RequestSchema): - """ RestartUMemcacheGroup - 重启单机Memcache - """ + """RestartUMemcacheGroup - 重启单机Memcache""" fields = { "GroupId": fields.Str(required=True, dump_to="GroupId"), @@ -750,7 +703,6 @@ class RestartUMemcacheGroupRequestSchema(schema.RequestSchema): class RestartUMemcacheGroupResponseSchema(schema.ResponseSchema): - """ RestartUMemcacheGroup - 重启单机Memcache - """ + """RestartUMemcacheGroup - 重启单机Memcache""" fields = {} diff --git a/ucloud/services/umem/schemas/models.py b/ucloud/services/umem/schemas/models.py index 57d7f23..375927c 100644 --- a/ucloud/services/umem/schemas/models.py +++ b/ucloud/services/umem/schemas/models.py @@ -5,8 +5,7 @@ class UMemPriceSetSchema(schema.ResponseSchema): - """ UMemPriceSet - DescribeUMemPrice - """ + """UMemPriceSet - DescribeUMemPrice""" fields = { "ChargeType": fields.Str(required=False, load_from="ChargeType"), @@ -16,8 +15,7 @@ class UMemPriceSetSchema(schema.ResponseSchema): class UMemSpaceAddressSetSchema(schema.ResponseSchema): - """ UMemSpaceAddressSet - DescribeUMemSpace - """ + """UMemSpaceAddressSet - DescribeUMemSpace""" fields = { "IP": fields.Str(required=False, load_from="IP"), @@ -26,8 +24,7 @@ class UMemSpaceAddressSetSchema(schema.ResponseSchema): class UMemSpaceSetSchema(schema.ResponseSchema): - """ UMemSpaceSet - DescribeUMemSpace - """ + """UMemSpaceSet - DescribeUMemSpace""" fields = { "Address": fields.List(UMemSpaceAddressSetSchema()), @@ -50,8 +47,7 @@ class UMemSpaceSetSchema(schema.ResponseSchema): class PriceDataSetSchema(schema.ResponseSchema): - """ PriceDataSet - 升降级价格 - """ + """PriceDataSet - 升降级价格""" fields = { "CustomPrice": fields.Int(required=False, load_from="CustomPrice"), @@ -61,8 +57,7 @@ class PriceDataSetSchema(schema.ResponseSchema): class UMemcacheGroupSetSchema(schema.ResponseSchema): - """ UMemcacheGroupSet - DescribeUMemcacheGroup - """ + """UMemcacheGroupSet - DescribeUMemcacheGroup""" fields = { "ChargeType": fields.Str(required=False, load_from="ChargeType"), @@ -85,8 +80,7 @@ class UMemcacheGroupSetSchema(schema.ResponseSchema): class UMemcachePriceSetSchema(schema.ResponseSchema): - """ UMemcachePriceSet - DescribeUMemcachePrice - """ + """UMemcachePriceSet - DescribeUMemcachePrice""" fields = { "ChargeType": fields.Str(required=False, load_from="ChargeType"), @@ -96,8 +90,7 @@ class UMemcachePriceSetSchema(schema.ResponseSchema): class URedisBackupSetSchema(schema.ResponseSchema): - """ URedisBackupSet - DescribeURedisBackup - """ + """URedisBackupSet - DescribeURedisBackup""" fields = { "BackupId": fields.Str(required=False, load_from="BackupId"), @@ -113,8 +106,7 @@ class URedisBackupSetSchema(schema.ResponseSchema): class URedisGroupSetSchema(schema.ResponseSchema): - """ URedisGroupSet - DescribeURedisGroup - """ + """URedisGroupSet - DescribeURedisGroup""" fields = { "AutoBackup": fields.Str(required=False, load_from="AutoBackup"), @@ -149,8 +141,7 @@ class URedisGroupSetSchema(schema.ResponseSchema): class URedisPriceSetSchema(schema.ResponseSchema): - """ URedisPriceSet - 主备Redis价格 - """ + """URedisPriceSet - 主备Redis价格""" fields = { "ChargeType": fields.Str(required=False, load_from="ChargeType"), diff --git a/ucloud/services/unet/client.py b/ucloud/services/unet/client.py index e925f68..2894a0d 100644 --- a/ucloud/services/unet/client.py +++ b/ucloud/services/unet/client.py @@ -10,7 +10,7 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(UNetClient, self).__init__(config, transport, middleware, logger) def allocate_eip(self, req=None, **kwargs): - """ AllocateEIP - 根据提供信息, 申请弹性IP + """AllocateEIP - 根据提供信息, 申请弹性IP **Request** @@ -26,20 +26,20 @@ def allocate_eip(self, req=None, **kwargs): - **Remark** (str) - 弹性IP的备注, 默认为空 - **ShareBandwidthId** (str) - 绑定的共享带宽Id，仅当PayMode为ShareBandwidth时有效 - **Tag** (str) - 业务组名称, 默认为 "Default" - + **Response** - **EIPSet** (list) - 见 **UnetAllocateEIPSet** 模型定义 - + **Response Model** - - **UnetEIPAddrSet** - + + **UnetEIPAddrSet** + - **IP** (str) - IP地址 - **OperatorName** (str) - 运营商信息如: 电信: Telecom, 联通: Unicom, 国际: International, Duplet: 双线IP（电信+联通), BGP: Bgp - **UnetAllocateEIPSet** - + **UnetAllocateEIPSet** + - **EIPAddr** (list) - 见 **UnetEIPAddrSet** 模型定义 - **EIPId** (str) - 申请到的EIP资源ID @@ -52,23 +52,23 @@ def allocate_eip(self, req=None, **kwargs): return apis.AllocateEIPResponseSchema().loads(resp) def allocate_share_bandwidth(self, req=None, **kwargs): - """ AllocateShareBandwidth - 开通共享带宽 + """AllocateShareBandwidth - 开通共享带宽 **Request** - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ChargeType** (str) - (Required) 付费方式:Year 按年,Month 按月,Dynamic 按时; - **Name** (str) - (Required) 共享带宽名字 - **ShareBandwidth** (int) - (Required) 共享带宽值 - **BwType** (str) - 共享带宽类型，ipv4或者ipv6，不传默认ipv4 - **Quantity** (int) - 购买时长 - **ShareBandwidthGuarantee** (int) - 共享带宽保底值(后付费) - + **Response** - **ShareBandwidthId** (str) - 共享带宽资源Id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -78,11 +78,11 @@ def allocate_share_bandwidth(self, req=None, **kwargs): return apis.AllocateShareBandwidthResponseSchema().loads(resp) def allocate_vip(self, req=None, **kwargs): - """ AllocateVIP - 根据提供信息，申请内网VIP(Virtual IP），多用于高可用程序作为漂移IP。 + """AllocateVIP - 根据提供信息，申请内网VIP(Virtual IP），多用于高可用程序作为漂移IP。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Region** (str) - (Config) 地域 - **SubnetId** (str) - (Required) 子网id - **VPCId** (str) - (Required) 指定vip所属的VPC @@ -93,16 +93,16 @@ def allocate_vip(self, req=None, **kwargs): - **Remark** (str) - 备注 - **Tag** (str) - 业务组名称，默认为Default - **Zone** (str) - 可用区 - + **Response** - **DataSet** (list) - 申请到的VIP地址 - **VIPSet** (list) - 见 **VIPSet** 模型定义 - + **Response Model** - - **VIPSet** - + + **VIPSet** + - **VIP** (str) - 虚拟ip - **VIPId** (str) - 虚拟ip id - **VPCId** (str) - VPC id @@ -116,7 +116,7 @@ def allocate_vip(self, req=None, **kwargs): return apis.AllocateVIPResponseSchema().loads(resp) def associate_eip_with_share_bandwidth(self, req=None, **kwargs): - """ AssociateEIPWithShareBandwidth - 将EIP加入共享带宽 + """AssociateEIPWithShareBandwidth - 将EIP加入共享带宽 **Request** @@ -124,10 +124,10 @@ def associate_eip_with_share_bandwidth(self, req=None, **kwargs): - **Region** (str) - (Config) 地域。 - **EIPIds** (list) - (Required) 要加入共享带宽的EIP的资源Id - **ShareBandwidthId** (str) - (Required) 共享带宽ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -136,7 +136,7 @@ def associate_eip_with_share_bandwidth(self, req=None, **kwargs): return apis.AssociateEIPWithShareBandwidthResponseSchema().loads(resp) def bind_eip(self, req=None, **kwargs): - """ BindEIP - 将尚未使用的弹性IP绑定到指定的资源 + """BindEIP - 将尚未使用的弹性IP绑定到指定的资源 **Request** @@ -145,10 +145,10 @@ def bind_eip(self, req=None, **kwargs): - **EIPId** (str) - (Required) 弹性IP的资源Id - **ResourceId** (str) - (Required) 弹性IP请求绑定的资源ID - **ResourceType** (str) - (Required) 弹性IP请求绑定的资源类型, 枚举值为: uhost: 云主机; ulb, 负载均衡器 upm: 物理机; hadoophost: 大数据集群;fortresshost：堡垒机；udockhost：容器；udhost：私有专区主机；natgw：natgw；udb：udb；vpngw：ipsec vpn；ucdr：云灾备；dbaudit：数据库审计；uni：虚拟网卡。 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -157,7 +157,7 @@ def bind_eip(self, req=None, **kwargs): return apis.BindEIPResponseSchema().loads(resp) def create_bandwidth_package(self, req=None, **kwargs): - """ CreateBandwidthPackage - 为非共享带宽模式下, 已绑定资源实例的带宽计费弹性IP附加临时带宽包 + """CreateBandwidthPackage - 为非共享带宽模式下, 已绑定资源实例的带宽计费弹性IP附加临时带宽包 **Request** @@ -168,11 +168,11 @@ def create_bandwidth_package(self, req=None, **kwargs): - **TimeRange** (int) - (Required) 带宽包有效时长, 取值范围为大于0的整数, 即该带宽包在EnableTime到 EnableTime+TimeRange时间段内生效 - **CouponId** (str) - 代金券ID - **EnableTime** (int) - 生效时间, 格式为 Unix timestamp, 默认为立即开通 - + **Response** - **BandwidthPackageId** (str) - 所创建带宽包的资源ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -182,7 +182,7 @@ def create_bandwidth_package(self, req=None, **kwargs): return apis.CreateBandwidthPackageResponseSchema().loads(resp) def create_firewall(self, req=None, **kwargs): - """ CreateFirewall - 创建防火墙 + """CreateFirewall - 创建防火墙 **Request** @@ -192,11 +192,11 @@ def create_firewall(self, req=None, **kwargs): - **Rule** (list) - (Required) 防火墙规则，例如：TCP|22|192.168.1.1/22|DROP|LOW|禁用22端口，第一个参数代表协议：第二个参数代表端口号，第三个参数为ip，第四个参数为ACCEPT（接受）和DROP（拒绝），第五个参数优先级：HIGH（高），MEDIUM（中），LOW（低），第六个参数为该条规则的自定义备注 - **Remark** (str) - 防火墙描述，默认为空 - **Tag** (str) - 防火墙业务组，默认为Default - + **Response** - **FWId** (str) - 防火墙ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -206,17 +206,17 @@ def create_firewall(self, req=None, **kwargs): return apis.CreateFirewallResponseSchema().loads(resp) def delete_bandwidth_package(self, req=None, **kwargs): - """ DeleteBandwidthPackage - 删除弹性IP上已附加带宽包 + """DeleteBandwidthPackage - 删除弹性IP上已附加带宽包 **Request** - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写 - **Region** (str) - (Config) 地域 - **BandwidthPackageId** (str) - (Required) 带宽包资源ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -225,17 +225,17 @@ def delete_bandwidth_package(self, req=None, **kwargs): return apis.DeleteBandwidthPackageResponseSchema().loads(resp) def delete_firewall(self, req=None, **kwargs): - """ DeleteFirewall - 删除防火墙 + """DeleteFirewall - 删除防火墙 **Request** - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写 - **Region** (str) - (Config) 地域 - **FWId** (str) - (Required) 防火墙资源ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -244,29 +244,29 @@ def delete_firewall(self, req=None, **kwargs): return apis.DeleteFirewallResponseSchema().loads(resp) def describe_bandwidth_package(self, req=None, **kwargs): - """ DescribeBandwidthPackage - 获取某地域下的带宽包信息 + """DescribeBandwidthPackage - 获取某地域下的带宽包信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - 返回数据分页值, 取值范围为 [0,10000000] 之间的整数, 默认为20 - **Offset** (int) - 返回数据偏移量, 默认为0 - + **Response** - **DataSets** (list) - 见 **UnetBandwidthPackageSet** 模型定义 - **TotalCount** (int) - 满足条件的带宽包总数 - + **Response Model** - - **EIPAddrSet** - + + **EIPAddrSet** + - **IP** (str) - 弹性IP地址 - **OperatorName** (str) - 运营商信息, 枚举值为: Telecom 电信; Unicom: 联通; Duplet: 双线; Bgp: BGP; International: 国际. - **UnetBandwidthPackageSet** - + **UnetBandwidthPackageSet** + - **Bandwidth** (int) - 带宽包的临时带宽值, 单位Mbps - **BandwidthPackageId** (str) - 带宽包的资源ID - **CreateTime** (int) - 创建时间, 格式为 Unix Timestamp @@ -283,25 +283,25 @@ def describe_bandwidth_package(self, req=None, **kwargs): return apis.DescribeBandwidthPackageResponseSchema().loads(resp) def describe_bandwidth_usage(self, req=None, **kwargs): - """ DescribeBandwidthUsage - 获取带宽用量信息 + """DescribeBandwidthUsage - 获取带宽用量信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **EIPIds** (list) - 弹性IP的资源Id. 如果为空, 则返回当前 Region中符合条件的所有EIP的带宽用量, n为自然数 - **Limit** (int) - 返回数据分页值, 取值范围为 [0,10000000] 之间的整数, 默认为20 - **OffSet** (int) - 返回数据偏移量, 默认为0 - + **Response** - **EIPSet** (list) - 见 **UnetBandwidthUsageEIPSet** 模型定义 - **TotalCount** (int) - EIPSet中的元素个数 - + **Response Model** - - **UnetBandwidthUsageEIPSet** - + + **UnetBandwidthUsageEIPSet** + - **CurBandwidth** (float) - 最近5分钟带宽用量, 单位Mbps - **EIPId** (str) - 弹性IP资源ID @@ -313,7 +313,7 @@ def describe_bandwidth_usage(self, req=None, **kwargs): return apis.DescribeBandwidthUsageResponseSchema().loads(resp) def describe_eip(self, req=None, **kwargs): - """ DescribeEIP - 获取弹性IP信息 + """DescribeEIP - 获取弹性IP信息 **Request** @@ -322,28 +322,28 @@ def describe_eip(self, req=None, **kwargs): - **EIPIds** (list) - 弹性IP的资源ID如果为空, 则返回当前 Region中符合条件的的所有EIP - **Limit** (int) - 数据分页值, 默认为20 - **Offset** (int) - 数据偏移量, 默认为0 - + **Response** - **EIPSet** (list) - 见 **UnetEIPSet** 模型定义 - **TotalBandwidth** (int) - 满足条件的弹性IP带宽总和, 单位Mbps - **TotalCount** (int) - 满足条件的弹性IP总数 - + **Response Model** - - **ShareBandwidthSet** - + + **ShareBandwidthSet** + - **ShareBandwidth** (int) - 共享带宽带宽值 - **ShareBandwidthId** (str) - 共享带宽ID - **ShareBandwidthName** (str) - 共享带宽的资源名称 - **UnetEIPAddrSet** - + **UnetEIPAddrSet** + - **IP** (str) - IP地址 - **OperatorName** (str) - 运营商信息如: 电信: Telecom, 联通: Unicom, 国际: International, Duplet: 双线IP（电信+联通), BGP: Bgp - **UnetEIPResourceSet** - + **UnetEIPResourceSet** + - **EIPId** (str) - 弹性IP的资源ID - **ResourceId** (str) - 已绑定资源的资源ID - **ResourceName** (str) - 已绑定的资源名称 @@ -352,8 +352,8 @@ def describe_eip(self, req=None, **kwargs): - **SubResourceName** (str) - 资源绑定的虚拟网卡的名称 - **SubResourceType** (str) - 资源绑定的虚拟网卡的类型。uni，虚拟网卡。 - **UnetEIPSet** - + **UnetEIPSet** + - **Bandwidth** (int) - 弹性IP的带宽, 单位为Mbps, 当BandwidthType=1时, 该处显示为共享带宽值. 当BandwidthType=0时, 该处显示这个弹性IP的带宽. - **BandwidthType** (int) - 带宽模式, 枚举值为: 0: 非共享带宽模式, 1: 共享带宽模式 - **ChargeType** (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费; Dynamic, 按小时付费; Trial, 试用. 按小时付费和试用这两种付费模式需要开通权限. @@ -379,7 +379,7 @@ def describe_eip(self, req=None, **kwargs): return apis.DescribeEIPResponseSchema().loads(resp) def describe_firewall(self, req=None, **kwargs): - """ DescribeFirewall - 获取防火墙组信息 + """DescribeFirewall - 获取防火墙组信息 **Request** @@ -390,16 +390,16 @@ def describe_firewall(self, req=None, **kwargs): - **Offset** (int) - 列表起始位置偏移量，默认为0 - **ResourceId** (str) - 绑定防火墙组的资源ID - **ResourceType** (str) - 绑定防火墙组的资源类型，默认为全部资源类型。枚举值为："unatgw"，NAT网关； "uhost"，云主机； "upm"，物理云主机； "hadoophost"，hadoop节点； "fortresshost"，堡垒机； "udhost"，私有专区主机；"udockhost"，容器；"dbaudit"，数据库审计. - + **Response** - **DataSet** (list) - 见 **FirewallDataSet** 模型定义 - - **TotalCount** (int) - - + - **TotalCount** (int) - + **Response Model** - - **FirewallRuleSet** - + + **FirewallRuleSet** + - **DstPort** (str) - 目标端口 - **Priority** (str) - 优先级 - **ProtocolType** (str) - 协议类型 @@ -407,8 +407,8 @@ def describe_firewall(self, req=None, **kwargs): - **RuleAction** (str) - 防火墙动作 - **SrcIP** (str) - 源地址 - **FirewallDataSet** - + **FirewallDataSet** + - **CreateTime** (int) - 防火墙组创建时间，格式为Unix Timestamp - **FWId** (str) - 防火墙ID - **GroupId** (str) - 安全组ID（即将废弃） @@ -427,25 +427,25 @@ def describe_firewall(self, req=None, **kwargs): return apis.DescribeFirewallResponseSchema().loads(resp) def describe_firewall_resource(self, req=None, **kwargs): - """ DescribeFirewallResource - 获取防火墙组所绑定资源的外网IP + """DescribeFirewallResource - 获取防火墙组所绑定资源的外网IP **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **FWId** (str) - (Required) 防火墙ID - **Limit** (int) - 返回数据长度，默认为20，最大10000000 - **Offset** (int) - 列表起始位置偏移量，默认为0 - + **Response** - **ResourceSet** (list) - 见 **ResourceSet** 模型定义 - **TotalCount** (int) - 绑定资源总数 - + **Response Model** - - **ResourceSet** - + + **ResourceSet** + - **Name** (str) - 名称 - **PrivateIP** (str) - 内网IP - **Remark** (str) - 备注 @@ -463,34 +463,34 @@ def describe_firewall_resource(self, req=None, **kwargs): return apis.DescribeFirewallResourceResponseSchema().loads(resp) def describe_share_bandwidth(self, req=None, **kwargs): - """ DescribeShareBandwidth - 获取共享带宽信息 + """DescribeShareBandwidth - 获取共享带宽信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ShareBandwidthIds** (list) - 需要返回的共享带宽Id - + **Response** - **DataSet** (list) - 见 **UnetShareBandwidthSet** 模型定义 - **TotalCount** (int) - 符合条件的共享带宽总数，大于等于返回DataSet长度 - + **Response Model** - - **EIPAddrSet** - + + **EIPAddrSet** + - **IP** (str) - 弹性IP地址 - **OperatorName** (str) - 运营商信息, 枚举值为: Telecom 电信; Unicom: 联通; Duplet: 双线; Bgp: BGP; International: 国际. - **EIPSetData** - + **EIPSetData** + - **Bandwidth** (int) - EIP带宽值 - **EIPAddr** (list) - 见 **EIPAddrSet** 模型定义 - **EIPId** (str) - EIP资源Id - **UnetShareBandwidthSet** - + **UnetShareBandwidthSet** + - **BandwidthGuarantee** (int) - 共享带宽保底值(后付费) - **ChargeType** (str) - 付费方式, 预付费:Year 按年,Month 按月,Dynamic 按需;后付费:PostPay(按月) - **CreateTime** (int) - 创建时间, 格式为Unix Timestamp @@ -509,30 +509,30 @@ def describe_share_bandwidth(self, req=None, **kwargs): return apis.DescribeShareBandwidthResponseSchema().loads(resp) def describe_vip(self, req=None, **kwargs): - """ DescribeVIP - 获取内网VIP详细信息 + """DescribeVIP - 获取内网VIP详细信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **BusinessId** (str) - 业务组 - **SubnetId** (str) - 子网id，不指定则获取VPCId下的所有vip - **Tag** (str) - 业务组名称, 默认为 Default - **VPCId** (str) - vpc的id,指定SubnetId时必填 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **DataSet** (list) - 内网VIP地址列表 - **TotalCount** (int) - vip数量 - **VIPSet** (list) - 见 **VIPDetailSet** 模型定义 - + **Response Model** - - **VIPDetailSet** - + + **VIPDetailSet** + - **CreateTime** (int) - 创建时间 - - **Name** (str) - + - **Name** (str) - - **RealIp** (str) - 真实主机ip - **SubnetId** (str) - 子网id - **VIP** (str) - 虚拟ip @@ -548,20 +548,20 @@ def describe_vip(self, req=None, **kwargs): return apis.DescribeVIPResponseSchema().loads(resp) def disassociate_eip_with_share_bandwidth(self, req=None, **kwargs): - """ DisassociateEIPWithShareBandwidth - 将EIP移出共享带宽 + """DisassociateEIPWithShareBandwidth - 将EIP移出共享带宽 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Bandwidth** (int) - (Required) 移出共享带宽后，EIP的外网带宽, 单位为Mbps. 各地域带宽范围如下： 流量计费[1-200],带宽计费[1-800] - **ShareBandwidthId** (str) - (Required) 共享带宽ID - **EIPIds** (list) - EIP的资源Id；默认移出该共享带宽下所有的EIP - **PayMode** (str) - 移出共享带宽后，EIP的计费模式. 枚举值: "Traffic", 流量计费; "Bandwidth", 带宽计费; 默认为 "Bandwidth". - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -572,22 +572,22 @@ def disassociate_eip_with_share_bandwidth(self, req=None, **kwargs): ) def get_eip_pay_mode(self, req=None, **kwargs): - """ GetEIPPayMode - 获取弹性IP计费模式 + """GetEIPPayMode - 获取弹性IP计费模式 **Request** - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写 - **Region** (str) - (Config) 地域 - **EIPId** (list) - (Required) 弹性IP的资源Id - + **Response** - **EIPPayMode** (list) - 见 **EIPPayModeSet** 模型定义 - + **Response Model** - - **EIPPayModeSet** - + + **EIPPayModeSet** + - **EIPId** (str) - EIP的资源ID - **EIPPayMode** (str) - EIP的计费模式. 枚举值为：Bandwidth, 带宽计费;Traffic, 流量计费; "ShareBandwidth",共享带宽模式 @@ -599,26 +599,26 @@ def get_eip_pay_mode(self, req=None, **kwargs): return apis.GetEIPPayModeResponseSchema().loads(resp) def get_eip_price(self, req=None, **kwargs): - """ GetEIPPrice - 获取弹性IP价格 + """GetEIPPrice - 获取弹性IP价格 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Bandwidth** (int) - (Required) 弹性IP的外网带宽, 单位为Mbps, 范围 [0-800] - **OperatorName** (str) - (Required) 弹性IP的线路如下: 国际: International BGP: Bgp 各地域允许的线路参数如下: cn-sh1: Bgp cn-sh2: Bgp cn-gd: Bgp cn-bj1: Bgp cn-bj2: Bgp hk: International us-ca: International th-bkk: International kr-seoul:International us-ws:International ge-fra:International sg:International tw-kh:International.其他海外线路均为 International,泉州为移动单线cn-qz:ChinaMobile - **ChargeType** (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费; Dynamic, 按时付费; 默认为获取三种价格 - **PayMode** (str) - 弹性IP计费方式r. 枚举值为: Traffic, 流量计费; Bandwidth, 带宽计费; "ShareBandwidth",共享带宽模式. 默认为Bandwidth - **Quantity** (int) - 购买时长。默认: 1。按小时购买(Dynamic)时无需此参数。 月付时，此参数传0，代表了购买至月末 - + **Response** - **PriceSet** (list) - 见 **EIPPriceDetailSet** 模型定义 - + **Response Model** - - **EIPPriceDetailSet** - + + **EIPPriceDetailSet** + - **ChargeType** (str) - 弹性IP付费方式 - **Price** (float) - 弹性IP价格, 单位"元" - **PurchaseValue** (int) - 资源有效期, 以Unix Timestamp表示 @@ -631,19 +631,19 @@ def get_eip_price(self, req=None, **kwargs): return apis.GetEIPPriceResponseSchema().loads(resp) def get_eip_upgrade_price(self, req=None, **kwargs): - """ GetEIPUpgradePrice - 获取弹性IP带宽改动价格 + """GetEIPUpgradePrice - 获取弹性IP带宽改动价格 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Bandwidth** (int) - (Required) 弹性IP的外网带宽, 单位为Mbps, 范围 [1-800] - **EIPId** (str) - (Required) 弹性IP的资源ID - + **Response** - **Price** (float) - 调整带宽后的EIP价格, 单位为"元", 如需退费此处为负值 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -652,19 +652,19 @@ def get_eip_upgrade_price(self, req=None, **kwargs): return apis.GetEIPUpgradePriceResponseSchema().loads(resp) def grant_firewall(self, req=None, **kwargs): - """ GrantFirewall - 将防火墙应用到资源上 + """GrantFirewall - 将防火墙应用到资源上 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **FWId** (str) - (Required) 防火墙资源ID - **ResourceId** (str) - (Required) 所应用资源ID - **ResourceType** (str) - (Required) 绑定防火墙组的资源类型，默认为全部资源类型。枚举值为："unatgw"，NAT网关； "uhost"，云主机； "upm"，物理云主机； "hadoophost"，hadoop节点； "fortresshost"，堡垒机； "udhost"，私有专区主机；"udockhost"，容器；"dbaudit"，数据库审计，”uni“，虚拟网卡。 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -673,18 +673,18 @@ def grant_firewall(self, req=None, **kwargs): return apis.GrantFirewallResponseSchema().loads(resp) def modify_eip_bandwidth(self, req=None, **kwargs): - """ ModifyEIPBandwidth - 调整弹性IP的外网带宽 + """ModifyEIPBandwidth - 调整弹性IP的外网带宽 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Bandwidth** (int) - (Required) 弹性IP的外网带宽, 单位为Mbps. 各地域的带宽值范围如下：流量计费[1-200],带宽计费[1-800] - **EIPId** (str) - (Required) 弹性IP的资源ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -693,18 +693,18 @@ def modify_eip_bandwidth(self, req=None, **kwargs): return apis.ModifyEIPBandwidthResponseSchema().loads(resp) def modify_eip_weight(self, req=None, **kwargs): - """ ModifyEIPWeight - 修改弹性IP的外网出口权重 + """ModifyEIPWeight - 修改弹性IP的外网出口权重 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **EIPId** (str) - (Required) 弹性IP的资源ID - **Weight** (int) - (Required) 外网出口权重, 范围[0-100] 取值为0时, 该弹性IP不会被使用. 取值为100时, 同主机下只会使用这个弹性IP，其他弹性IP不会被使用 请勿将多个绑定在同一资源的弹性IP设置为相同权重 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -713,17 +713,17 @@ def modify_eip_weight(self, req=None, **kwargs): return apis.ModifyEIPWeightResponseSchema().loads(resp) def release_eip(self, req=None, **kwargs): - """ ReleaseEIP - 释放弹性IP资源, 所释放弹性IP必须为非绑定状态. + """ReleaseEIP - 释放弹性IP资源, 所释放弹性IP必须为非绑定状态. **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **EIPId** (str) - (Required) 弹性IP的资源ID - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -732,19 +732,19 @@ def release_eip(self, req=None, **kwargs): return apis.ReleaseEIPResponseSchema().loads(resp) def release_share_bandwidth(self, req=None, **kwargs): - """ ReleaseShareBandwidth - 关闭共享带宽 + """ReleaseShareBandwidth - 关闭共享带宽 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **EIPBandwidth** (int) - (Required) 关闭共享带宽后，各EIP恢复为的带宽值 - **ShareBandwidthId** (str) - (Required) 共享带宽ID - **PayMode** (str) - Bandwidth 带宽计费, Traffic 转流量计费 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -753,7 +753,7 @@ def release_share_bandwidth(self, req=None, **kwargs): return apis.ReleaseShareBandwidthResponseSchema().loads(resp) def release_vip(self, req=None, **kwargs): - """ ReleaseVIP - 释放VIP资源 + """ReleaseVIP - 释放VIP资源 **Request** @@ -761,10 +761,10 @@ def release_vip(self, req=None, **kwargs): - **Region** (str) - (Config) 地域 - **VIPId** (str) - (Required) 内网VIP的id - **Zone** (str) - 可用区 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -773,18 +773,18 @@ def release_vip(self, req=None, **kwargs): return apis.ReleaseVIPResponseSchema().loads(resp) def resize_share_bandwidth(self, req=None, **kwargs): - """ ResizeShareBandwidth - 调整共享带宽的带宽值 + """ResizeShareBandwidth - 调整共享带宽的带宽值 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ShareBandwidth** (int) - (Required) 带宽值，单位为Mb，范围 [20-5000] (最大值受地域限制) - **ShareBandwidthId** (str) - (Required) 共享带宽的Id - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -793,19 +793,19 @@ def resize_share_bandwidth(self, req=None, **kwargs): return apis.ResizeShareBandwidthResponseSchema().loads(resp) def set_eip_pay_mode(self, req=None, **kwargs): - """ SetEIPPayMode - 设置弹性IP计费模式, 切换时会涉及付费/退费. + """SetEIPPayMode - 设置弹性IP计费模式, 切换时会涉及付费/退费. **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Bandwidth** (int) - (Required) 调整的目标带宽值, 单位Mbps. 各地域的带宽值范围如下: 流量计费[1-200],其余情况[1-800] - **EIPId** (str) - (Required) 弹性IP的资源Id - **PayMode** (str) - (Required) 计费模式. 枚举值："Traffic", 流量计费模式; "Bandwidth", 带宽计费模式 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -814,19 +814,19 @@ def set_eip_pay_mode(self, req=None, **kwargs): return apis.SetEIPPayModeResponseSchema().loads(resp) def un_bind_eip(self, req=None, **kwargs): - """ UnBindEIP - 将弹性IP从资源上解绑 + """UnBindEIP - 将弹性IP从资源上解绑 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **EIPId** (str) - (Required) 弹性IP的资源Id - **ResourceId** (str) - (Required) 弹性IP请求解绑的资源ID - **ResourceType** (str) - (Required) 弹性IP请求解绑的资源类型, 枚举值为: uhost: 云主机; ulb, 负载均衡器 upm: 物理机; hadoophost: 大数据集群;fortresshost：堡垒机；udockhost：容器；udhost：私有专区主机；natgw：NAT网关；udb：udb；vpngw：ipsec vpn；ucdr：云灾备；dbaudit：数据库审计；uni，虚拟网卡。 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -835,20 +835,20 @@ def un_bind_eip(self, req=None, **kwargs): return apis.UnBindEIPResponseSchema().loads(resp) def update_eip_attribute(self, req=None, **kwargs): - """ UpdateEIPAttribute - 更新弹性IP名称，业务组，备注等属性字段 + """UpdateEIPAttribute - 更新弹性IP名称，业务组，备注等属性字段 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **EIPId** (str) - (Required) EIP资源ID - **Name** (str) - 名字（Name Tag Remark都为空则报错） - **Remark** (str) - 备注 - **Tag** (str) - 业务 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -857,19 +857,19 @@ def update_eip_attribute(self, req=None, **kwargs): return apis.UpdateEIPAttributeResponseSchema().loads(resp) def update_firewall(self, req=None, **kwargs): - """ UpdateFirewall - 更新防火墙规则 + """UpdateFirewall - 更新防火墙规则 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **FWId** (str) - (Required) 防火墙资源ID - **Rule** (list) - (Required) 防火墙规则，例如：TCP|22|192.168.1.1/22|DROP|LOW|禁用22端口，第一个参数代表协议：第二个参数代表端口号，第三个参数为ip，第四个参数为ACCEPT（接受）和DROP（拒绝），第五个参数优先级：HIGH（高），MEDIUM（中），LOW（低），第六个参数为该条规则的自定义备注 - + **Response** - **FWId** (str) - 防火墙id - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -878,20 +878,20 @@ def update_firewall(self, req=None, **kwargs): return apis.UpdateFirewallResponseSchema().loads(resp) def update_firewall_attribute(self, req=None, **kwargs): - """ UpdateFirewallAttribute - 更新防火墙规则 + """UpdateFirewallAttribute - 更新防火墙规则 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **FWId** (str) - (Required) 防火墙资源ID - **Name** (str) - 防火墙名称，默认为空，为空则不做修改。Name,Tag,Remark必须填写1个及以上 - **Remark** (str) - 防火墙备注，默认为空，为空则不做修改。Name,Tag,Remark必须填写1个及以上 - **Tag** (str) - 防火墙业务组，默认为空，为空则不做修改。Name,Tag,Remark必须填写1个及以上 - + **Response** - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/unet/schemas/apis.py b/ucloud/services/unet/schemas/apis.py index bce0f77..d343f2e 100644 --- a/ucloud/services/unet/schemas/apis.py +++ b/ucloud/services/unet/schemas/apis.py @@ -14,8 +14,7 @@ class AllocateEIPRequestSchema(schema.RequestSchema): - """ AllocateEIP - 根据提供信息, 申请弹性IP - """ + """AllocateEIP - 根据提供信息, 申请弹性IP""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -36,8 +35,7 @@ class AllocateEIPRequestSchema(schema.RequestSchema): class AllocateEIPResponseSchema(schema.ResponseSchema): - """ AllocateEIP - 根据提供信息, 申请弹性IP - """ + """AllocateEIP - 根据提供信息, 申请弹性IP""" fields = { "EIPSet": fields.List( @@ -56,8 +54,7 @@ class AllocateEIPResponseSchema(schema.ResponseSchema): class AllocateShareBandwidthRequestSchema(schema.RequestSchema): - """ AllocateShareBandwidth - 开通共享带宽 - """ + """AllocateShareBandwidth - 开通共享带宽""" fields = { "BwType": fields.Str(required=False, dump_to="BwType"), @@ -74,8 +71,7 @@ class AllocateShareBandwidthRequestSchema(schema.RequestSchema): class AllocateShareBandwidthResponseSchema(schema.ResponseSchema): - """ AllocateShareBandwidth - 开通共享带宽 - """ + """AllocateShareBandwidth - 开通共享带宽""" fields = { "ShareBandwidthId": fields.Str( @@ -92,8 +88,7 @@ class AllocateShareBandwidthResponseSchema(schema.ResponseSchema): class AllocateVIPRequestSchema(schema.RequestSchema): - """ AllocateVIP - 根据提供信息，申请内网VIP(Virtual IP），多用于高可用程序作为漂移IP。 - """ + """AllocateVIP - 根据提供信息，申请内网VIP(Virtual IP），多用于高可用程序作为漂移IP。""" fields = { "BusinessId": fields.Str(required=False, dump_to="BusinessId"), @@ -111,8 +106,7 @@ class AllocateVIPRequestSchema(schema.RequestSchema): class AllocateVIPResponseSchema(schema.ResponseSchema): - """ AllocateVIP - 根据提供信息，申请内网VIP(Virtual IP），多用于高可用程序作为漂移IP。 - """ + """AllocateVIP - 根据提供信息，申请内网VIP(Virtual IP），多用于高可用程序作为漂移IP。""" fields = { "DataSet": fields.List( @@ -132,8 +126,7 @@ class AllocateVIPResponseSchema(schema.ResponseSchema): class AssociateEIPWithShareBandwidthRequestSchema(schema.RequestSchema): - """ AssociateEIPWithShareBandwidth - 将EIP加入共享带宽 - """ + """AssociateEIPWithShareBandwidth - 将EIP加入共享带宽""" fields = { "EIPIds": fields.List(fields.Str()), @@ -146,8 +139,7 @@ class AssociateEIPWithShareBandwidthRequestSchema(schema.RequestSchema): class AssociateEIPWithShareBandwidthResponseSchema(schema.ResponseSchema): - """ AssociateEIPWithShareBandwidth - 将EIP加入共享带宽 - """ + """AssociateEIPWithShareBandwidth - 将EIP加入共享带宽""" fields = {} @@ -160,8 +152,7 @@ class AssociateEIPWithShareBandwidthResponseSchema(schema.ResponseSchema): class BindEIPRequestSchema(schema.RequestSchema): - """ BindEIP - 将尚未使用的弹性IP绑定到指定的资源 - """ + """BindEIP - 将尚未使用的弹性IP绑定到指定的资源""" fields = { "EIPId": fields.Str(required=True, dump_to="EIPId"), @@ -173,8 +164,7 @@ class BindEIPRequestSchema(schema.RequestSchema): class BindEIPResponseSchema(schema.ResponseSchema): - """ BindEIP - 将尚未使用的弹性IP绑定到指定的资源 - """ + """BindEIP - 将尚未使用的弹性IP绑定到指定的资源""" fields = {} @@ -187,8 +177,7 @@ class BindEIPResponseSchema(schema.ResponseSchema): class CreateBandwidthPackageRequestSchema(schema.RequestSchema): - """ CreateBandwidthPackage - 为非共享带宽模式下, 已绑定资源实例的带宽计费弹性IP附加临时带宽包 - """ + """CreateBandwidthPackage - 为非共享带宽模式下, 已绑定资源实例的带宽计费弹性IP附加临时带宽包""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -202,8 +191,7 @@ class CreateBandwidthPackageRequestSchema(schema.RequestSchema): class CreateBandwidthPackageResponseSchema(schema.ResponseSchema): - """ CreateBandwidthPackage - 为非共享带宽模式下, 已绑定资源实例的带宽计费弹性IP附加临时带宽包 - """ + """CreateBandwidthPackage - 为非共享带宽模式下, 已绑定资源实例的带宽计费弹性IP附加临时带宽包""" fields = { "BandwidthPackageId": fields.Str( @@ -220,8 +208,7 @@ class CreateBandwidthPackageResponseSchema(schema.ResponseSchema): class CreateFirewallRequestSchema(schema.RequestSchema): - """ CreateFirewall - 创建防火墙 - """ + """CreateFirewall - 创建防火墙""" fields = { "Name": fields.Str(required=True, dump_to="Name"), @@ -234,8 +221,7 @@ class CreateFirewallRequestSchema(schema.RequestSchema): class CreateFirewallResponseSchema(schema.ResponseSchema): - """ CreateFirewall - 创建防火墙 - """ + """CreateFirewall - 创建防火墙""" fields = {"FWId": fields.Str(required=False, load_from="FWId")} @@ -248,8 +234,7 @@ class CreateFirewallResponseSchema(schema.ResponseSchema): class DeleteBandwidthPackageRequestSchema(schema.RequestSchema): - """ DeleteBandwidthPackage - 删除弹性IP上已附加带宽包 - """ + """DeleteBandwidthPackage - 删除弹性IP上已附加带宽包""" fields = { "BandwidthPackageId": fields.Str( @@ -261,8 +246,7 @@ class DeleteBandwidthPackageRequestSchema(schema.RequestSchema): class DeleteBandwidthPackageResponseSchema(schema.ResponseSchema): - """ DeleteBandwidthPackage - 删除弹性IP上已附加带宽包 - """ + """DeleteBandwidthPackage - 删除弹性IP上已附加带宽包""" fields = {} @@ -275,8 +259,7 @@ class DeleteBandwidthPackageResponseSchema(schema.ResponseSchema): class DeleteFirewallRequestSchema(schema.RequestSchema): - """ DeleteFirewall - 删除防火墙 - """ + """DeleteFirewall - 删除防火墙""" fields = { "FWId": fields.Str(required=True, dump_to="FWId"), @@ -286,8 +269,7 @@ class DeleteFirewallRequestSchema(schema.RequestSchema): class DeleteFirewallResponseSchema(schema.ResponseSchema): - """ DeleteFirewall - 删除防火墙 - """ + """DeleteFirewall - 删除防火墙""" fields = {} @@ -300,8 +282,7 @@ class DeleteFirewallResponseSchema(schema.ResponseSchema): class DescribeBandwidthPackageRequestSchema(schema.RequestSchema): - """ DescribeBandwidthPackage - 获取某地域下的带宽包信息 - """ + """DescribeBandwidthPackage - 获取某地域下的带宽包信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -312,8 +293,7 @@ class DescribeBandwidthPackageRequestSchema(schema.RequestSchema): class DescribeBandwidthPackageResponseSchema(schema.ResponseSchema): - """ DescribeBandwidthPackage - 获取某地域下的带宽包信息 - """ + """DescribeBandwidthPackage - 获取某地域下的带宽包信息""" fields = { "DataSets": fields.List( @@ -333,8 +313,7 @@ class DescribeBandwidthPackageResponseSchema(schema.ResponseSchema): class DescribeBandwidthUsageRequestSchema(schema.RequestSchema): - """ DescribeBandwidthUsage - 获取带宽用量信息 - """ + """DescribeBandwidthUsage - 获取带宽用量信息""" fields = { "EIPIds": fields.List(fields.Str()), @@ -346,8 +325,7 @@ class DescribeBandwidthUsageRequestSchema(schema.RequestSchema): class DescribeBandwidthUsageResponseSchema(schema.ResponseSchema): - """ DescribeBandwidthUsage - 获取带宽用量信息 - """ + """DescribeBandwidthUsage - 获取带宽用量信息""" fields = { "EIPSet": fields.List( @@ -367,8 +345,7 @@ class DescribeBandwidthUsageResponseSchema(schema.ResponseSchema): class DescribeEIPRequestSchema(schema.RequestSchema): - """ DescribeEIP - 获取弹性IP信息 - """ + """DescribeEIP - 获取弹性IP信息""" fields = { "EIPIds": fields.List(fields.Str()), @@ -380,8 +357,7 @@ class DescribeEIPRequestSchema(schema.RequestSchema): class DescribeEIPResponseSchema(schema.ResponseSchema): - """ DescribeEIP - 获取弹性IP信息 - """ + """DescribeEIP - 获取弹性IP信息""" fields = { "EIPSet": fields.List( @@ -402,8 +378,7 @@ class DescribeEIPResponseSchema(schema.ResponseSchema): class DescribeFirewallRequestSchema(schema.RequestSchema): - """ DescribeFirewall - 获取防火墙组信息 - """ + """DescribeFirewall - 获取防火墙组信息""" fields = { "FWId": fields.Str(required=False, dump_to="FWId"), @@ -417,8 +392,7 @@ class DescribeFirewallRequestSchema(schema.RequestSchema): class DescribeFirewallResponseSchema(schema.ResponseSchema): - """ DescribeFirewall - 获取防火墙组信息 - """ + """DescribeFirewall - 获取防火墙组信息""" fields = { "DataSet": fields.List( @@ -436,8 +410,7 @@ class DescribeFirewallResponseSchema(schema.ResponseSchema): class DescribeFirewallResourceRequestSchema(schema.RequestSchema): - """ DescribeFirewallResource - 获取防火墙组所绑定资源的外网IP - """ + """DescribeFirewallResource - 获取防火墙组所绑定资源的外网IP""" fields = { "FWId": fields.Str(required=True, dump_to="FWId"), @@ -449,8 +422,7 @@ class DescribeFirewallResourceRequestSchema(schema.RequestSchema): class DescribeFirewallResourceResponseSchema(schema.ResponseSchema): - """ DescribeFirewallResource - 获取防火墙组所绑定资源的外网IP - """ + """DescribeFirewallResource - 获取防火墙组所绑定资源的外网IP""" fields = { "ResourceSet": fields.List( @@ -468,8 +440,7 @@ class DescribeFirewallResourceResponseSchema(schema.ResponseSchema): class DescribeShareBandwidthRequestSchema(schema.RequestSchema): - """ DescribeShareBandwidth - 获取共享带宽信息 - """ + """DescribeShareBandwidth - 获取共享带宽信息""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -479,8 +450,7 @@ class DescribeShareBandwidthRequestSchema(schema.RequestSchema): class DescribeShareBandwidthResponseSchema(schema.ResponseSchema): - """ DescribeShareBandwidth - 获取共享带宽信息 - """ + """DescribeShareBandwidth - 获取共享带宽信息""" fields = { "DataSet": fields.List( @@ -500,8 +470,7 @@ class DescribeShareBandwidthResponseSchema(schema.ResponseSchema): class DescribeVIPRequestSchema(schema.RequestSchema): - """ DescribeVIP - 获取内网VIP详细信息 - """ + """DescribeVIP - 获取内网VIP详细信息""" fields = { "BusinessId": fields.Str(required=False, dump_to="BusinessId"), @@ -515,8 +484,7 @@ class DescribeVIPRequestSchema(schema.RequestSchema): class DescribeVIPResponseSchema(schema.ResponseSchema): - """ DescribeVIP - 获取内网VIP详细信息 - """ + """DescribeVIP - 获取内网VIP详细信息""" fields = { "DataSet": fields.List( @@ -537,8 +505,7 @@ class DescribeVIPResponseSchema(schema.ResponseSchema): class DisassociateEIPWithShareBandwidthRequestSchema(schema.RequestSchema): - """ DisassociateEIPWithShareBandwidth - 将EIP移出共享带宽 - """ + """DisassociateEIPWithShareBandwidth - 将EIP移出共享带宽""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -553,8 +520,7 @@ class DisassociateEIPWithShareBandwidthRequestSchema(schema.RequestSchema): class DisassociateEIPWithShareBandwidthResponseSchema(schema.ResponseSchema): - """ DisassociateEIPWithShareBandwidth - 将EIP移出共享带宽 - """ + """DisassociateEIPWithShareBandwidth - 将EIP移出共享带宽""" fields = {} @@ -567,8 +533,7 @@ class DisassociateEIPWithShareBandwidthResponseSchema(schema.ResponseSchema): class GetEIPPayModeRequestSchema(schema.RequestSchema): - """ GetEIPPayMode - 获取弹性IP计费模式 - """ + """GetEIPPayMode - 获取弹性IP计费模式""" fields = { "EIPId": fields.List(fields.Str()), @@ -578,8 +543,7 @@ class GetEIPPayModeRequestSchema(schema.RequestSchema): class GetEIPPayModeResponseSchema(schema.ResponseSchema): - """ GetEIPPayMode - 获取弹性IP计费模式 - """ + """GetEIPPayMode - 获取弹性IP计费模式""" fields = { "EIPPayMode": fields.List( @@ -596,8 +560,7 @@ class GetEIPPayModeResponseSchema(schema.ResponseSchema): class GetEIPPriceRequestSchema(schema.RequestSchema): - """ GetEIPPrice - 获取弹性IP价格 - """ + """GetEIPPrice - 获取弹性IP价格""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -611,8 +574,7 @@ class GetEIPPriceRequestSchema(schema.RequestSchema): class GetEIPPriceResponseSchema(schema.ResponseSchema): - """ GetEIPPrice - 获取弹性IP价格 - """ + """GetEIPPrice - 获取弹性IP价格""" fields = { "PriceSet": fields.List( @@ -631,8 +593,7 @@ class GetEIPPriceResponseSchema(schema.ResponseSchema): class GetEIPUpgradePriceRequestSchema(schema.RequestSchema): - """ GetEIPUpgradePrice - 获取弹性IP带宽改动价格 - """ + """GetEIPUpgradePrice - 获取弹性IP带宽改动价格""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -643,8 +604,7 @@ class GetEIPUpgradePriceRequestSchema(schema.RequestSchema): class GetEIPUpgradePriceResponseSchema(schema.ResponseSchema): - """ GetEIPUpgradePrice - 获取弹性IP带宽改动价格 - """ + """GetEIPUpgradePrice - 获取弹性IP带宽改动价格""" fields = {"Price": fields.Float(required=False, load_from="Price")} @@ -657,8 +617,7 @@ class GetEIPUpgradePriceResponseSchema(schema.ResponseSchema): class GrantFirewallRequestSchema(schema.RequestSchema): - """ GrantFirewall - 将防火墙应用到资源上 - """ + """GrantFirewall - 将防火墙应用到资源上""" fields = { "FWId": fields.Str(required=True, dump_to="FWId"), @@ -670,8 +629,7 @@ class GrantFirewallRequestSchema(schema.RequestSchema): class GrantFirewallResponseSchema(schema.ResponseSchema): - """ GrantFirewall - 将防火墙应用到资源上 - """ + """GrantFirewall - 将防火墙应用到资源上""" fields = {} @@ -684,8 +642,7 @@ class GrantFirewallResponseSchema(schema.ResponseSchema): class ModifyEIPBandwidthRequestSchema(schema.RequestSchema): - """ ModifyEIPBandwidth - 调整弹性IP的外网带宽 - """ + """ModifyEIPBandwidth - 调整弹性IP的外网带宽""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -696,8 +653,7 @@ class ModifyEIPBandwidthRequestSchema(schema.RequestSchema): class ModifyEIPBandwidthResponseSchema(schema.ResponseSchema): - """ ModifyEIPBandwidth - 调整弹性IP的外网带宽 - """ + """ModifyEIPBandwidth - 调整弹性IP的外网带宽""" fields = {} @@ -710,8 +666,7 @@ class ModifyEIPBandwidthResponseSchema(schema.ResponseSchema): class ModifyEIPWeightRequestSchema(schema.RequestSchema): - """ ModifyEIPWeight - 修改弹性IP的外网出口权重 - """ + """ModifyEIPWeight - 修改弹性IP的外网出口权重""" fields = { "EIPId": fields.Str(required=True, dump_to="EIPId"), @@ -722,8 +677,7 @@ class ModifyEIPWeightRequestSchema(schema.RequestSchema): class ModifyEIPWeightResponseSchema(schema.ResponseSchema): - """ ModifyEIPWeight - 修改弹性IP的外网出口权重 - """ + """ModifyEIPWeight - 修改弹性IP的外网出口权重""" fields = {} @@ -736,8 +690,7 @@ class ModifyEIPWeightResponseSchema(schema.ResponseSchema): class ReleaseEIPRequestSchema(schema.RequestSchema): - """ ReleaseEIP - 释放弹性IP资源, 所释放弹性IP必须为非绑定状态. - """ + """ReleaseEIP - 释放弹性IP资源, 所释放弹性IP必须为非绑定状态.""" fields = { "EIPId": fields.Str(required=True, dump_to="EIPId"), @@ -747,8 +700,7 @@ class ReleaseEIPRequestSchema(schema.RequestSchema): class ReleaseEIPResponseSchema(schema.ResponseSchema): - """ ReleaseEIP - 释放弹性IP资源, 所释放弹性IP必须为非绑定状态. - """ + """ReleaseEIP - 释放弹性IP资源, 所释放弹性IP必须为非绑定状态.""" fields = {} @@ -761,8 +713,7 @@ class ReleaseEIPResponseSchema(schema.ResponseSchema): class ReleaseShareBandwidthRequestSchema(schema.RequestSchema): - """ ReleaseShareBandwidth - 关闭共享带宽 - """ + """ReleaseShareBandwidth - 关闭共享带宽""" fields = { "EIPBandwidth": fields.Int(required=True, dump_to="EIPBandwidth"), @@ -776,8 +727,7 @@ class ReleaseShareBandwidthRequestSchema(schema.RequestSchema): class ReleaseShareBandwidthResponseSchema(schema.ResponseSchema): - """ ReleaseShareBandwidth - 关闭共享带宽 - """ + """ReleaseShareBandwidth - 关闭共享带宽""" fields = {} @@ -790,8 +740,7 @@ class ReleaseShareBandwidthResponseSchema(schema.ResponseSchema): class ReleaseVIPRequestSchema(schema.RequestSchema): - """ ReleaseVIP - 释放VIP资源 - """ + """ReleaseVIP - 释放VIP资源""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -802,8 +751,7 @@ class ReleaseVIPRequestSchema(schema.RequestSchema): class ReleaseVIPResponseSchema(schema.ResponseSchema): - """ ReleaseVIP - 释放VIP资源 - """ + """ReleaseVIP - 释放VIP资源""" fields = {} @@ -816,8 +764,7 @@ class ReleaseVIPResponseSchema(schema.ResponseSchema): class ResizeShareBandwidthRequestSchema(schema.RequestSchema): - """ ResizeShareBandwidth - 调整共享带宽的带宽值 - """ + """ResizeShareBandwidth - 调整共享带宽的带宽值""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -830,8 +777,7 @@ class ResizeShareBandwidthRequestSchema(schema.RequestSchema): class ResizeShareBandwidthResponseSchema(schema.ResponseSchema): - """ ResizeShareBandwidth - 调整共享带宽的带宽值 - """ + """ResizeShareBandwidth - 调整共享带宽的带宽值""" fields = {} @@ -844,8 +790,7 @@ class ResizeShareBandwidthResponseSchema(schema.ResponseSchema): class SetEIPPayModeRequestSchema(schema.RequestSchema): - """ SetEIPPayMode - 设置弹性IP计费模式, 切换时会涉及付费/退费. - """ + """SetEIPPayMode - 设置弹性IP计费模式, 切换时会涉及付费/退费.""" fields = { "Bandwidth": fields.Int(required=True, dump_to="Bandwidth"), @@ -857,8 +802,7 @@ class SetEIPPayModeRequestSchema(schema.RequestSchema): class SetEIPPayModeResponseSchema(schema.ResponseSchema): - """ SetEIPPayMode - 设置弹性IP计费模式, 切换时会涉及付费/退费. - """ + """SetEIPPayMode - 设置弹性IP计费模式, 切换时会涉及付费/退费.""" fields = {} @@ -871,8 +815,7 @@ class SetEIPPayModeResponseSchema(schema.ResponseSchema): class UnBindEIPRequestSchema(schema.RequestSchema): - """ UnBindEIP - 将弹性IP从资源上解绑 - """ + """UnBindEIP - 将弹性IP从资源上解绑""" fields = { "EIPId": fields.Str(required=True, dump_to="EIPId"), @@ -884,8 +827,7 @@ class UnBindEIPRequestSchema(schema.RequestSchema): class UnBindEIPResponseSchema(schema.ResponseSchema): - """ UnBindEIP - 将弹性IP从资源上解绑 - """ + """UnBindEIP - 将弹性IP从资源上解绑""" fields = {} @@ -898,8 +840,7 @@ class UnBindEIPResponseSchema(schema.ResponseSchema): class UpdateEIPAttributeRequestSchema(schema.RequestSchema): - """ UpdateEIPAttribute - 更新弹性IP名称，业务组，备注等属性字段 - """ + """UpdateEIPAttribute - 更新弹性IP名称，业务组，备注等属性字段""" fields = { "EIPId": fields.Str(required=True, dump_to="EIPId"), @@ -912,8 +853,7 @@ class UpdateEIPAttributeRequestSchema(schema.RequestSchema): class UpdateEIPAttributeResponseSchema(schema.ResponseSchema): - """ UpdateEIPAttribute - 更新弹性IP名称，业务组，备注等属性字段 - """ + """UpdateEIPAttribute - 更新弹性IP名称，业务组，备注等属性字段""" fields = {} @@ -926,8 +866,7 @@ class UpdateEIPAttributeResponseSchema(schema.ResponseSchema): class UpdateFirewallRequestSchema(schema.RequestSchema): - """ UpdateFirewall - 更新防火墙规则 - """ + """UpdateFirewall - 更新防火墙规则""" fields = { "FWId": fields.Str(required=True, dump_to="FWId"), @@ -938,8 +877,7 @@ class UpdateFirewallRequestSchema(schema.RequestSchema): class UpdateFirewallResponseSchema(schema.ResponseSchema): - """ UpdateFirewall - 更新防火墙规则 - """ + """UpdateFirewall - 更新防火墙规则""" fields = {"FWId": fields.Str(required=False, load_from="FWId")} @@ -952,8 +890,7 @@ class UpdateFirewallResponseSchema(schema.ResponseSchema): class UpdateFirewallAttributeRequestSchema(schema.RequestSchema): - """ UpdateFirewallAttribute - 更新防火墙规则 - """ + """UpdateFirewallAttribute - 更新防火墙规则""" fields = { "FWId": fields.Str(required=True, dump_to="FWId"), @@ -966,7 +903,6 @@ class UpdateFirewallAttributeRequestSchema(schema.RequestSchema): class UpdateFirewallAttributeResponseSchema(schema.ResponseSchema): - """ UpdateFirewallAttribute - 更新防火墙规则 - """ + """UpdateFirewallAttribute - 更新防火墙规则""" fields = {} diff --git a/ucloud/services/unet/schemas/models.py b/ucloud/services/unet/schemas/models.py index ff74a6f..25e7fd3 100644 --- a/ucloud/services/unet/schemas/models.py +++ b/ucloud/services/unet/schemas/models.py @@ -5,8 +5,7 @@ class UnetEIPAddrSetSchema(schema.ResponseSchema): - """ UnetEIPAddrSet - DescribeEIP - """ + """UnetEIPAddrSet - DescribeEIP""" fields = { "IP": fields.Str(required=False, load_from="IP"), @@ -15,8 +14,7 @@ class UnetEIPAddrSetSchema(schema.ResponseSchema): class UnetAllocateEIPSetSchema(schema.ResponseSchema): - """ UnetAllocateEIPSet - AllocateEIP - """ + """UnetAllocateEIPSet - AllocateEIP""" fields = { "EIPAddr": fields.List(UnetEIPAddrSetSchema()), @@ -25,8 +23,7 @@ class UnetAllocateEIPSetSchema(schema.ResponseSchema): class VIPSetSchema(schema.ResponseSchema): - """ VIPSet - VIPSet - """ + """VIPSet - VIPSet""" fields = { "VIP": fields.Str(required=False, load_from="VIP"), @@ -36,8 +33,7 @@ class VIPSetSchema(schema.ResponseSchema): class EIPAddrSetSchema(schema.ResponseSchema): - """ EIPAddrSet - DescribeShareBandwidth - """ + """EIPAddrSet - DescribeShareBandwidth""" fields = { "IP": fields.Str(required=False, load_from="IP"), @@ -46,8 +42,7 @@ class EIPAddrSetSchema(schema.ResponseSchema): class UnetBandwidthPackageSetSchema(schema.ResponseSchema): - """ UnetBandwidthPackageSet - DescribeBandwidthPackage - """ + """UnetBandwidthPackageSet - DescribeBandwidthPackage""" fields = { "Bandwidth": fields.Int(required=False, load_from="Bandwidth"), @@ -63,8 +58,7 @@ class UnetBandwidthPackageSetSchema(schema.ResponseSchema): class UnetBandwidthUsageEIPSetSchema(schema.ResponseSchema): - """ UnetBandwidthUsageEIPSet - DescribeBandwidthUsage - """ + """UnetBandwidthUsageEIPSet - DescribeBandwidthUsage""" fields = { "CurBandwidth": fields.Float(required=False, load_from="CurBandwidth"), @@ -73,8 +67,7 @@ class UnetBandwidthUsageEIPSetSchema(schema.ResponseSchema): class ShareBandwidthSetSchema(schema.ResponseSchema): - """ ShareBandwidthSet - DescribeEIP - """ + """ShareBandwidthSet - DescribeEIP""" fields = { "ShareBandwidth": fields.Int( @@ -90,8 +83,7 @@ class ShareBandwidthSetSchema(schema.ResponseSchema): class UnetEIPResourceSetSchema(schema.ResponseSchema): - """ UnetEIPResourceSet - DescribeEIP - """ + """UnetEIPResourceSet - DescribeEIP""" fields = { "EIPId": fields.Str(required=False, load_from="EIPId"), @@ -109,8 +101,7 @@ class UnetEIPResourceSetSchema(schema.ResponseSchema): class UnetEIPSetSchema(schema.ResponseSchema): - """ UnetEIPSet - DescribeEIP - """ + """UnetEIPSet - DescribeEIP""" fields = { "Bandwidth": fields.Int(required=False, load_from="Bandwidth"), @@ -133,8 +124,7 @@ class UnetEIPSetSchema(schema.ResponseSchema): class FirewallRuleSetSchema(schema.ResponseSchema): - """ FirewallRuleSet - DescribeFirewall - """ + """FirewallRuleSet - DescribeFirewall""" fields = { "DstPort": fields.Str(required=False, load_from="DstPort"), @@ -147,8 +137,7 @@ class FirewallRuleSetSchema(schema.ResponseSchema): class FirewallDataSetSchema(schema.ResponseSchema): - """ FirewallDataSet - DescribeFirewall - """ + """FirewallDataSet - DescribeFirewall""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -164,8 +153,7 @@ class FirewallDataSetSchema(schema.ResponseSchema): class ResourceSetSchema(schema.ResponseSchema): - """ ResourceSet - 资源信息 - """ + """ResourceSet - 资源信息""" fields = { "Name": fields.Str(required=False, load_from="Name"), @@ -180,8 +168,7 @@ class ResourceSetSchema(schema.ResponseSchema): class EIPSetDataSchema(schema.ResponseSchema): - """ EIPSetData - describeShareBandwidth - """ + """EIPSetData - describeShareBandwidth""" fields = { "Bandwidth": fields.Int(required=False, load_from="Bandwidth"), @@ -191,8 +178,7 @@ class EIPSetDataSchema(schema.ResponseSchema): class UnetShareBandwidthSetSchema(schema.ResponseSchema): - """ UnetShareBandwidthSet - DescribeShareBandwidth - """ + """UnetShareBandwidthSet - DescribeShareBandwidth""" fields = { "BandwidthGuarantee": fields.Int( @@ -216,8 +202,7 @@ class UnetShareBandwidthSetSchema(schema.ResponseSchema): class VIPDetailSetSchema(schema.ResponseSchema): - """ VIPDetailSet - VIPDetailSet - """ + """VIPDetailSet - VIPDetailSet""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -232,8 +217,7 @@ class VIPDetailSetSchema(schema.ResponseSchema): class EIPPayModeSetSchema(schema.ResponseSchema): - """ EIPPayModeSet - GetEIPPayModeEIP - """ + """EIPPayModeSet - GetEIPPayModeEIP""" fields = { "EIPId": fields.Str(required=False, load_from="EIPId"), @@ -242,8 +226,7 @@ class EIPPayModeSetSchema(schema.ResponseSchema): class EIPPriceDetailSetSchema(schema.ResponseSchema): - """ EIPPriceDetailSet - GetEIPPrice - """ + """EIPPriceDetailSet - GetEIPPrice""" fields = { "ChargeType": fields.Str(required=False, load_from="ChargeType"), diff --git a/ucloud/services/uphost/client.py b/ucloud/services/uphost/client.py index 20358e9..3a132ba 100644 --- a/ucloud/services/uphost/client.py +++ b/ucloud/services/uphost/client.py @@ -12,15 +12,15 @@ def __init__(self, config, transport=None, middleware=None, logger=None): ) def create_phost(self, req=None, **kwargs): - """ CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。 + """CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ImageId** (str) - (Required) 镜像ID。 请通过 [DescribePHostImage]获取 - **Password** (str) - (Required) 密码（密码需使用base64进行编码） - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ChargeType** (str) - 计费模式，枚举值为：year, 按年付费； month,按月付费；dynamic，按需付费，（需开启权限） trial, 试用（需开启权限）。默认为按月付费 - **Cluster** (str) - 网络环境，可选千兆：1G ，万兆：10G， 默认1G - **Count** (int) - 购买数量，默认为1，（暂不支持） @@ -29,16 +29,16 @@ def create_phost(self, req=None, **kwargs): - **Quantity** (str) - 购买时长，默认为1，范围[1-10] - **Raid** (str) - Raid配置，默认Raid10 支持:Raid0、Raid1、Raid5、Raid10，NoRaid - **Remark** (str) - 物理机备注，默认为空 - - **SecurityGroupId** (str) - 防火墙Id，默认：Web推荐防火墙。如何查询SecurityGroupId请参见 `DescribeSecurityGroup `_ + - **SecurityGroupId** (str) - 防火墙Id，默认：Web推荐防火墙。如何查询SecurityGroupId请参见 `DescribeSecurityGroup `_ - **SubnetId** (str) - 子网ID，不填为默认，VPC2.0下需要填写此字段。 - **Tag** (str) - 业务组，默认为default - **Type** (str) - 物理机类型，默认为：db-2(基础型-SAS-V3) - **VPCId** (str) - VPC ID，不填为默认，VPC2.0下需要填写此字段。 - + **Response** - **PHostId** (list) - PHost的资源ID数组 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -47,41 +47,41 @@ def create_phost(self, req=None, **kwargs): return apis.CreatePHostResponseSchema().loads(resp) def describe_phost(self, req=None, **kwargs): - """ DescribePHost - 获取物理机详细信息 + """DescribePHost - 获取物理机详细信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Limit** (int) - 返回数据长度，默认为20 - **Offset** (int) - 数据偏移量，默认为0 - **PHostId** (list) - PHost资源ID，若为空，则返回当前Region所有PHost。 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **PHostSet** (list) - 见 **PHostSet** 模型定义 - **TotalCount** (int) - 满足条件的PHost总数 - + **Response Model** - - **PHostCPUSet** - + + **PHostCPUSet** + - **CoreCount** (int) - CPU核数 - **Count** (int) - CPU个数 - **Frequence** (float) - CPU主频 - **Model** (str) - CPU型号 - **PHostDiskSet** - + **PHostDiskSet** + - **Count** (int) - 磁盘数量 - **IOCap** (int) - 磁盘IO性能，单位MB/s（待废弃） - **Name** (str) - 磁盘名称，sys/data - **Space** (int) - 单盘大小，单位GB - **Type** (str) - 磁盘属性 - **PHostIPSet** - + **PHostIPSet** + - **Bandwidth** (int) - IP对应带宽，单位Mb，内网IP不显示带宽信息 - **IPAddr** (str) - IP地址， - **IPId** (str) - IP资源ID(内网IP无资源ID)（待废弃） @@ -90,8 +90,8 @@ def describe_phost(self, req=None, **kwargs): - **SubnetId** (str) - 子网ID - **VPCId** (str) - VPC ID - **PHostSet** - + **PHostSet** + - **AutoRenew** (str) - 自动续费 - **CPUSet** (dict) - 见 **PHostCPUSet** 模型定义 - **ChargeType** (str) - 计费模式，枚举值为： Year，按年付费； Month，按月付费； Dynamic，按需付费（需开启权限）； Trial，试用（需开启权限）默认为月付 @@ -115,7 +115,7 @@ def describe_phost(self, req=None, **kwargs): - **Remark** (str) - 物理机备注 - **SN** (str) - 物理机序列号 - **Tag** (str) - 业务组 - - **Zone** (str) - 可用区，参见 `可用区列表 `_ + - **Zone** (str) - 可用区，参见 `可用区列表 `_ """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} @@ -125,27 +125,27 @@ def describe_phost(self, req=None, **kwargs): return apis.DescribePHostResponseSchema().loads(resp) def describe_phost_image(self, req=None, **kwargs): - """ DescribePHostImage - 获取物理云主机镜像列表 + """DescribePHostImage - 获取物理云主机镜像列表 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ImageId** (list) - 镜像ID - **ImageType** (str) - 镜像类别，枚举为：Base,标准镜像；默认为标准镜像。 - **Limit** (int) - 返回数据长度，默认为20 - **Offset** (int) - 数据偏移量，默认为0 - + **Response** - **ImageSet** (list) - 见 **PHostImageSet** 模型定义 - **TotalCount** (int) - 满足条件的镜像总数 - + **Response Model** - - **PHostImageSet** - + + **PHostImageSet** + - **ImageId** (str) - 镜像ID - **ImageName** (str) - 镜像名称 - **OsName** (str) - 操作系统名称 @@ -159,23 +159,23 @@ def describe_phost_image(self, req=None, **kwargs): return apis.DescribePHostImageResponseSchema().loads(resp) def describe_phost_tags(self, req=None, **kwargs): - """ DescribePHostTags - 获取物理机tag列表（业务组） + """DescribePHostTags - 获取物理机tag列表（业务组） **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **TagSet** (list) - 见 **PHostTagSet** 模型定义 - **TotalCount** (int) - Tag的个数 - + **Response Model** - - **PHostTagSet** - + + **PHostTagSet** + - **Tag** (str) - 业务组名称 - **TotalCount** (int) - 该业务组中包含的主机个数 @@ -187,27 +187,27 @@ def describe_phost_tags(self, req=None, **kwargs): return apis.DescribePHostTagsResponseSchema().loads(resp) def get_phost_price(self, req=None, **kwargs): - """ GetPHostPrice - 获取物理机价格列表 + """GetPHostPrice - 获取物理机价格列表 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **ChargeType** (str) - (Required) 计费模式，枚举值为： Year/Month/Trial/Dynamic - **Count** (int) - (Required) 购买数量，范围[1-5] - **Quantity** (int) - (Required) 购买时长，1-10个月或1-10年 - **Cluster** (str) - 网络环境，可选千兆：1G ，万兆：10G - **Type** (str) - 默认为：DB(数据库型) - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **PriceSet** (list) - 见 **PHostPriceSet** 模型定义 - + **Response Model** - - **PHostPriceSet** - + + **PHostPriceSet** + - **ChargeType** (str) - Year/Month/Trial/Dynamic - **Price** (float) - 价格, 单位:元, 保留小数点后两位有效数字 @@ -219,22 +219,22 @@ def get_phost_price(self, req=None, **kwargs): return apis.GetPHostPriceResponseSchema().loads(resp) def modify_phost_info(self, req=None, **kwargs): - """ ModifyPHostInfo - 更改物理机信息 + """ModifyPHostInfo - 更改物理机信息 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **PHostId** (str) - (Required) 物理机资源ID - **Name** (str) - 物理机名称，默认不更改 - **Remark** (str) - 物理机备注，默认不更改 - **Tag** (str) - 业务组，默认不更改 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **PHostId** (str) - PHost 的资源ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -243,19 +243,19 @@ def modify_phost_info(self, req=None, **kwargs): return apis.ModifyPHostInfoResponseSchema().loads(resp) def poweroff_phost(self, req=None, **kwargs): - """ PoweroffPHost - 断电物理云主机 + """PoweroffPHost - 断电物理云主机 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **PHostId** (str) - (Required) PHost资源ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **PHostId** (str) - PHost 的资源ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -264,19 +264,19 @@ def poweroff_phost(self, req=None, **kwargs): return apis.PoweroffPHostResponseSchema().loads(resp) def reboot_phost(self, req=None, **kwargs): - """ RebootPHost - 重启物理机 + """RebootPHost - 重启物理机 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **PHostId** (str) - (Required) PHost资源ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **PHostId** (str) - PHost 的资源ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -285,26 +285,26 @@ def reboot_phost(self, req=None, **kwargs): return apis.RebootPHostResponseSchema().loads(resp) def reinstall_phost(self, req=None, **kwargs): - """ ReinstallPHost - 重装物理机操作系统 + """ReinstallPHost - 重装物理机操作系统 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **PHostId** (str) - (Required) PHost资源ID - **Password** (str) - (Required) 密码 - - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ - **ImageId** (str) - 镜像Id，参考镜像列表，默认使用原镜像 - **Name** (str) - 物理机名称，默认不更改 - **Raid** (str) - 不保留数据盘重装，可选Raid - **Remark** (str) - 物理机备注，默认为不更改。 - **ReserveDisk** (str) - 是否保留数据盘，保留：Yes，不报留：No， 默认：Yes - **Tag** (str) - 业务组，默认不更改。 - + **Response** - **PHostId** (str) - PHost 的资源ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -313,19 +313,19 @@ def reinstall_phost(self, req=None, **kwargs): return apis.ReinstallPHostResponseSchema().loads(resp) def start_phost(self, req=None, **kwargs): - """ StartPHost - 启动物理机 + """StartPHost - 启动物理机 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **PHostId** (str) - (Required) PHost资源ID - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **PHostId** (str) - PHost 的资源ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -334,20 +334,20 @@ def start_phost(self, req=None, **kwargs): return apis.StartPHostResponseSchema().loads(resp) def terminate_phost(self, req=None, **kwargs): - """ TerminatePHost - 删除物理云主机 + """TerminatePHost - 删除物理云主机 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **PHostId** (str) - (Required) PHost资源ID - **ReleaseEIP** (bool) - 是否释放绑定的EIP。true: 解绑EIP后，并释放；其他值或不填：解绑EIP。 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **PHostId** (str) - PHost 的资源ID - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/uphost/schemas/apis.py b/ucloud/services/uphost/schemas/apis.py index 7bea31b..769a4da 100644 --- a/ucloud/services/uphost/schemas/apis.py +++ b/ucloud/services/uphost/schemas/apis.py @@ -14,8 +14,7 @@ class CreatePHostRequestSchema(schema.RequestSchema): - """ CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。 - """ + """CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。""" fields = { "ChargeType": fields.Str(required=False, dump_to="ChargeType"), @@ -42,8 +41,7 @@ class CreatePHostRequestSchema(schema.RequestSchema): class CreatePHostResponseSchema(schema.ResponseSchema): - """ CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。 - """ + """CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。""" fields = { "PHostId": fields.List( @@ -60,8 +58,7 @@ class CreatePHostResponseSchema(schema.ResponseSchema): class DescribePHostRequestSchema(schema.RequestSchema): - """ DescribePHost - 获取物理机详细信息 - """ + """DescribePHost - 获取物理机详细信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -74,8 +71,7 @@ class DescribePHostRequestSchema(schema.RequestSchema): class DescribePHostResponseSchema(schema.ResponseSchema): - """ DescribePHost - 获取物理机详细信息 - """ + """DescribePHost - 获取物理机详细信息""" fields = { "PHostSet": fields.List( @@ -93,8 +89,7 @@ class DescribePHostResponseSchema(schema.ResponseSchema): class DescribePHostImageRequestSchema(schema.RequestSchema): - """ DescribePHostImage - 获取物理云主机镜像列表 - """ + """DescribePHostImage - 获取物理云主机镜像列表""" fields = { "ImageId": fields.List(fields.Str()), @@ -108,8 +103,7 @@ class DescribePHostImageRequestSchema(schema.RequestSchema): class DescribePHostImageResponseSchema(schema.ResponseSchema): - """ DescribePHostImage - 获取物理云主机镜像列表 - """ + """DescribePHostImage - 获取物理云主机镜像列表""" fields = { "ImageSet": fields.List( @@ -127,8 +121,7 @@ class DescribePHostImageResponseSchema(schema.ResponseSchema): class DescribePHostTagsRequestSchema(schema.RequestSchema): - """ DescribePHostTags - 获取物理机tag列表（业务组） - """ + """DescribePHostTags - 获取物理机tag列表（业务组）""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -138,8 +131,7 @@ class DescribePHostTagsRequestSchema(schema.RequestSchema): class DescribePHostTagsResponseSchema(schema.ResponseSchema): - """ DescribePHostTags - 获取物理机tag列表（业务组） - """ + """DescribePHostTags - 获取物理机tag列表（业务组）""" fields = { "TagSet": fields.List( @@ -157,8 +149,7 @@ class DescribePHostTagsResponseSchema(schema.ResponseSchema): class GetPHostPriceRequestSchema(schema.RequestSchema): - """ GetPHostPrice - 获取物理机价格列表 - """ + """GetPHostPrice - 获取物理机价格列表""" fields = { "ChargeType": fields.Str(required=True, dump_to="ChargeType"), @@ -173,8 +164,7 @@ class GetPHostPriceRequestSchema(schema.RequestSchema): class GetPHostPriceResponseSchema(schema.ResponseSchema): - """ GetPHostPrice - 获取物理机价格列表 - """ + """GetPHostPrice - 获取物理机价格列表""" fields = { "PriceSet": fields.List( @@ -191,8 +181,7 @@ class GetPHostPriceResponseSchema(schema.ResponseSchema): class ModifyPHostInfoRequestSchema(schema.RequestSchema): - """ ModifyPHostInfo - 更改物理机信息 - """ + """ModifyPHostInfo - 更改物理机信息""" fields = { "Name": fields.Str(required=False, dump_to="Name"), @@ -206,8 +195,7 @@ class ModifyPHostInfoRequestSchema(schema.RequestSchema): class ModifyPHostInfoResponseSchema(schema.ResponseSchema): - """ ModifyPHostInfo - 更改物理机信息 - """ + """ModifyPHostInfo - 更改物理机信息""" fields = {"PHostId": fields.Str(required=False, load_from="PHostId")} @@ -220,8 +208,7 @@ class ModifyPHostInfoResponseSchema(schema.ResponseSchema): class PoweroffPHostRequestSchema(schema.RequestSchema): - """ PoweroffPHost - 断电物理云主机 - """ + """PoweroffPHost - 断电物理云主机""" fields = { "PHostId": fields.Str(required=True, dump_to="PHostId"), @@ -232,8 +219,7 @@ class PoweroffPHostRequestSchema(schema.RequestSchema): class PoweroffPHostResponseSchema(schema.ResponseSchema): - """ PoweroffPHost - 断电物理云主机 - """ + """PoweroffPHost - 断电物理云主机""" fields = {"PHostId": fields.Str(required=False, load_from="PHostId")} @@ -246,8 +232,7 @@ class PoweroffPHostResponseSchema(schema.ResponseSchema): class RebootPHostRequestSchema(schema.RequestSchema): - """ RebootPHost - 重启物理机 - """ + """RebootPHost - 重启物理机""" fields = { "PHostId": fields.Str(required=True, dump_to="PHostId"), @@ -258,8 +243,7 @@ class RebootPHostRequestSchema(schema.RequestSchema): class RebootPHostResponseSchema(schema.ResponseSchema): - """ RebootPHost - 重启物理机 - """ + """RebootPHost - 重启物理机""" fields = {"PHostId": fields.Str(required=False, load_from="PHostId")} @@ -272,8 +256,7 @@ class RebootPHostResponseSchema(schema.ResponseSchema): class ReinstallPHostRequestSchema(schema.RequestSchema): - """ ReinstallPHost - 重装物理机操作系统 - """ + """ReinstallPHost - 重装物理机操作系统""" fields = { "ImageId": fields.Str(required=False, dump_to="ImageId"), @@ -291,8 +274,7 @@ class ReinstallPHostRequestSchema(schema.RequestSchema): class ReinstallPHostResponseSchema(schema.ResponseSchema): - """ ReinstallPHost - 重装物理机操作系统 - """ + """ReinstallPHost - 重装物理机操作系统""" fields = {"PHostId": fields.Str(required=False, load_from="PHostId")} @@ -305,8 +287,7 @@ class ReinstallPHostResponseSchema(schema.ResponseSchema): class StartPHostRequestSchema(schema.RequestSchema): - """ StartPHost - 启动物理机 - """ + """StartPHost - 启动物理机""" fields = { "PHostId": fields.Str(required=True, dump_to="PHostId"), @@ -317,8 +298,7 @@ class StartPHostRequestSchema(schema.RequestSchema): class StartPHostResponseSchema(schema.ResponseSchema): - """ StartPHost - 启动物理机 - """ + """StartPHost - 启动物理机""" fields = {"PHostId": fields.Str(required=False, load_from="PHostId")} @@ -331,8 +311,7 @@ class StartPHostResponseSchema(schema.ResponseSchema): class TerminatePHostRequestSchema(schema.RequestSchema): - """ TerminatePHost - 删除物理云主机 - """ + """TerminatePHost - 删除物理云主机""" fields = { "PHostId": fields.Str(required=True, dump_to="PHostId"), @@ -344,7 +323,6 @@ class TerminatePHostRequestSchema(schema.RequestSchema): class TerminatePHostResponseSchema(schema.ResponseSchema): - """ TerminatePHost - 删除物理云主机 - """ + """TerminatePHost - 删除物理云主机""" fields = {"PHostId": fields.Str(required=False, load_from="PHostId")} diff --git a/ucloud/services/uphost/schemas/models.py b/ucloud/services/uphost/schemas/models.py index a608c10..35960c0 100644 --- a/ucloud/services/uphost/schemas/models.py +++ b/ucloud/services/uphost/schemas/models.py @@ -5,8 +5,7 @@ class PHostIPSetSchema(schema.ResponseSchema): - """ PHostIPSet - DescribePHost - """ + """PHostIPSet - DescribePHost""" fields = { "Bandwidth": fields.Int(required=False, load_from="Bandwidth"), @@ -20,8 +19,7 @@ class PHostIPSetSchema(schema.ResponseSchema): class PHostDiskSetSchema(schema.ResponseSchema): - """ PHostDiskSet - GetPHostTypeInfo - """ + """PHostDiskSet - GetPHostTypeInfo""" fields = { "Count": fields.Int(required=False, load_from="Count"), @@ -33,8 +31,7 @@ class PHostDiskSetSchema(schema.ResponseSchema): class PHostCPUSetSchema(schema.ResponseSchema): - """ PHostCPUSet - DescribePHost - """ + """PHostCPUSet - DescribePHost""" fields = { "CoreCount": fields.Int(required=False, load_from="CoreCount"), @@ -45,8 +42,7 @@ class PHostCPUSetSchema(schema.ResponseSchema): class PHostSetSchema(schema.ResponseSchema): - """ PHostSet - DescribePHost - """ + """PHostSet - DescribePHost""" fields = { "AutoRenew": fields.Str(required=False, load_from="AutoRenew"), @@ -77,8 +73,7 @@ class PHostSetSchema(schema.ResponseSchema): class PHostImageSetSchema(schema.ResponseSchema): - """ PHostImageSet - DescribePHostImage - """ + """PHostImageSet - DescribePHostImage""" fields = { "ImageId": fields.Str(required=False, load_from="ImageId"), @@ -89,8 +84,7 @@ class PHostImageSetSchema(schema.ResponseSchema): class PHostTagSetSchema(schema.ResponseSchema): - """ PHostTagSet - DescribePHostTags - """ + """PHostTagSet - DescribePHostTags""" fields = { "Tag": fields.Str(required=False, load_from="Tag"), @@ -99,8 +93,7 @@ class PHostTagSetSchema(schema.ResponseSchema): class PHostPriceSetSchema(schema.ResponseSchema): - """ PHostPriceSet - GetPHostPrice - """ + """PHostPriceSet - GetPHostPrice""" fields = { "ChargeType": fields.Str(required=False, load_from="ChargeType"), diff --git a/ucloud/services/usms/client.py b/ucloud/services/usms/client.py index 19f8c88..316e7eb 100644 --- a/ucloud/services/usms/client.py +++ b/ucloud/services/usms/client.py @@ -10,11 +10,11 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(USMSClient, self).__init__(config, transport, middleware, logger) def create_usms_signature(self, req=None, **kwargs): - """ CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名 + """CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名 **Request** - - **ProjectId** (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **CertificateType** (int) - (Required) 签名的资质证明文件类型，需与签名类型保持一致，说明如下：0-三证合一/企业营业执照/组织机构代码证书/社会信用代码证书；1-应用商店后台开发者管理截图；2-备案服务商的备案成功截图(含域名，网站名称，备案号)；3-公众号或小程序的管理界面截图；4-商标注册证书；5-组织机构代码证书、社会信用代码证书； - **Description** (str) - (Required) 短信签名申请原因 - **File** (str) - (Required) 短信签名的资质证明文件，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB @@ -22,13 +22,13 @@ def create_usms_signature(self, req=None, **kwargs): - **SigPurpose** (int) - (Required) 签名用途，0-自用，1-他用； - **SigType** (int) - (Required) 签名类型，说明如下：0-公司或企业的全称或简称；1-App应用的全称或简称；2-工信部备案网站的全称或简称；3-公众号或小程序的全称或简称；4-商标名的全称或简称；5-政府/机关事业单位/其他单位的全称或简称； - **ProxyFile** (str) - 短信签名授权委托文件，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB；当您是代理并使用第三方的签名时（也即SigPurpose为1-他用），该项为必填项； - + **Response** - **Message** (str) - 返回状态码描述，如果操作成功，默认返回为空 - **SigContent** (str) - 短信签名名称 - **SigId** (str) - 短信签名ID（短信签名申请时的工单ID） - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -38,24 +38,24 @@ def create_usms_signature(self, req=None, **kwargs): return apis.CreateUSMSSignatureResponseSchema().loads(resp) def create_usms_template(self, req=None, **kwargs): - """ CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板 + """CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板 **Request** - - **ProjectId** (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Purpose** (int) - (Required) 短信模板用途类型：1-验证码类短信模板；2-系统通知类短信模板；3-会员推广类短信模板； - **Template** (str) - (Required) 短信模板内容，说明如下：字数不超过500，每个中文、符号、英文、数组等都计为一个字；模板中的变量填写格式：{N}，其中N为大于1的整数，有多个参数时，建议N从1开始顺次，例如：{1}、{2}等；短信模板禁止仅包括变量的情况； - **TemplateName** (str) - (Required) 短信模板名称，不超过32个字符，每个中文、符号、英文、数字等都计为1个字。 - **Remark** (str) - 短信模板申请原因说明，字数不超过128，每个中文、符号、英文、数字等都计为1个字。 - **UnsubscribeInfo** (str) - 当Purpose为3时，也即会员推广类短信模板，该项必填。枚举值：TD退订、回T退订、回N退订、回TD退订、退订回T、退订回D、退订回TD、退订回复T、退订回复D、退订回复N、退订回复TD、拒收回T - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **Message** (str) - 返回状态码描述，如果操作成功，默认返回为空 - **TemplateId** (str) - 短信模板ID（短信模板申请时的工单ID） - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -65,17 +65,17 @@ def create_usms_template(self, req=None, **kwargs): return apis.CreateUSMSTemplateResponseSchema().loads(resp) def delete_usms_signature(self, req=None, **kwargs): - """ DeleteUSMSSignature - 调用接口DeleteUSMSSignature删除短信签名 + """DeleteUSMSSignature - 调用接口DeleteUSMSSignature删除短信签名 **Request** - - **ProjectId** (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **SigIds** (list) - (Required) 签名ID（也即短信签名申请时的工单ID），支持以数组的方式，举例，以SigIds.0、SigIds.1...SigIds.N方式传入 - + **Response** - **Message** (str) - 返回状态码描述，如果操作成功，默认返回为空 - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -84,19 +84,19 @@ def delete_usms_signature(self, req=None, **kwargs): return apis.DeleteUSMSSignatureResponseSchema().loads(resp) def delete_usms_template(self, req=None, **kwargs): - """ DeleteUSMSTemplate - 调用接口DeleteUSMSTemplate删除短信模板 + """DeleteUSMSTemplate - 调用接口DeleteUSMSTemplate删除短信模板 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **TemplateIds** (list) - (Required) 模板ID（也即短信模板申请时的工单ID），支持以数组的方式，举例，以TemplateIds.0、TemplateIds.1...TemplateIds.N方式传入 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **Message** (str) - 返回状态码描述，如果操作成功，默认返回为空 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -105,32 +105,32 @@ def delete_usms_template(self, req=None, **kwargs): return apis.DeleteUSMSTemplateResponseSchema().loads(resp) def get_usms_send_receipt(self, req=None, **kwargs): - """ GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时，建议发送完短信以后，5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回，则请联系技术支持确认原因 + """GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时，建议发送完短信以后，5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回，则请联系技术支持确认原因 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **SessionNoSet** (list) - (Required) 发送短信时返回的SessionNo集合，SessionNoSet.0,SessionNoSet.1....格式 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **Data** (list) - 见 **ReceiptPerSession** 模型定义 - **Message** (str) - 错误描述 - + **Response Model** - - **ReceiptPerPhone** - + + **ReceiptPerPhone** + - **CostCount** (int) - 消耗短信条数 - **Phone** (str) - 手机号码 - **ReceiptDesc** (str) - 回执结果描述 - **ReceiptResult** (str) - 回执结果 - **ReceiptTime** (int) - 回执返回时间 - **ReceiptPerSession** - + **ReceiptPerSession** + - **ReceiptSet** (list) - 见 **ReceiptPerPhone** 模型定义 - **SessionNo** (str) - 发送短信时返回的SessionNo @@ -142,23 +142,23 @@ def get_usms_send_receipt(self, req=None, **kwargs): return apis.GetUSMSSendReceiptResponseSchema().loads(resp) def query_usms_signature(self, req=None, **kwargs): - """ QueryUSMSSignature - 调用接口QueryUSMSSignature查询短信签名申请状态 + """QueryUSMSSignature - 调用接口QueryUSMSSignature查询短信签名申请状态 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **SigContent** (str) - 签名内容；签名ID和签名至少需填写1项； - **SigId** (str) - 已申请的短信签名ID（短信签名申请时的工单ID）；签名ID和签名至少需填写1项； - + **Response** - **Data** (dict) - 见 **OutSignature** 模型定义 - **Message** (str) - 发生错误时，表示具体错误描述 - + **Response Model** - - **OutSignature** - + + **OutSignature** + - **ErrDesc** (str) - 签名审核失败原因 - **SigContent** (str) - 签名内容 - **SigId** (str) - 签名ID @@ -172,22 +172,22 @@ def query_usms_signature(self, req=None, **kwargs): return apis.QueryUSMSSignatureResponseSchema().loads(resp) def query_usms_template(self, req=None, **kwargs): - """ QueryUSMSTemplate - 调用接口QueryUSMSTemplate查询短信模板申请状态 + """QueryUSMSTemplate - 调用接口QueryUSMSTemplate查询短信模板申请状态 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **TemplateId** (str) - (Required) 模板ID - + **Response** - **Data** (dict) - 见 **OutTemplate** 模型定义 - **Message** (str) - 当RetCode不为0时，Message中显示具体错误描述 - + **Response Model** - - **OutTemplate** - + + **OutTemplate** + - **CreateTime** (int) - 创建时间 - **ErrDesc** (str) - 审核失败原因 - **Purpose** (int) - 模板类型，选项：1-验证码类 2-通知类 3-会员推广类 @@ -206,25 +206,25 @@ def query_usms_template(self, req=None, **kwargs): return apis.QueryUSMSTemplateResponseSchema().loads(resp) def send_usms_message(self, req=None, **kwargs): - """ SendUSMSMessage - 发送短信息。短信字数超过70个后，按照每66个进行切割(因为要加上1/3), 2/3)等字样，占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计 + """SendUSMSMessage - 发送短信息。短信字数超过70个后，按照每66个进行切割(因为要加上1/3), 2/3)等字样，占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **PhoneNumbers** (list) - (Required) 电话号码数组，电话号码格式为(60)1xxxxxxxx，()中为国际长途区号(如中国为86或0086，两种格式都支持)，后面为电话号码.若不传入国际区号，如1851623xxxx，则默认为国内手机号 - **TemplateId** (str) - (Required) 模板ID。若指定的模板ID审核未通过(status不等于2)则不允许发送 - **TemplateParams** (list) - (Required) 模板参数数组，以TempalteParams.0，TempalteParams.1.。。格式。若模板ID指定的模板无可变参数，则不传入该参数。模板参数个数与模板不匹配，则不允许发送 - **SigContent** (str) - 使用的签名，如果不输入则使用默认签名，若没有申请默认签名不允许发送；若输入的签名没有申请，则无法发送 - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **Action** (str) - 操作名称 - **Message** (str) - 发生错误时表示错误描述 - **RetCode** (int) - 返回码 - **SessionNo** (str) - 本次提交发送的短信的唯一ID，可根据该值查询本次发送的短信列表 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) @@ -234,11 +234,11 @@ def send_usms_message(self, req=None, **kwargs): return apis.SendUSMSMessageResponseSchema().loads(resp) def update_usms_signature(self, req=None, **kwargs): - """ UpdateUSMSSignature - 调用接口UpdateUSMSSignature修改未通过审核的短信签名，并重新提交审核 + """UpdateUSMSSignature - 调用接口UpdateUSMSSignature修改未通过审核的短信签名，并重新提交审核 **Request** - - **ProjectId** (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **ProjectId** (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **File** (str) - (Required) 短信签名的资质证明文件，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB - **SigContent** (str) - (Required) 新的短信签名名称；长度为2-12个字符, 可包含中文、数字和符号；无需填写【】或[]，系统会自动添加 - **SigId** (str) - (Required) 签名ID（也即短信签名申请时的工单ID），支持以数组的方式，举例，以SigIds.0、SigIds.1...SigIds.N方式传入 @@ -246,11 +246,11 @@ def update_usms_signature(self, req=None, **kwargs): - **SigType** (int) - (Required) 签名类型，说明如下：0-公司或企业的全称或简称；1-App应用的全称或简称；2-工信部备案网站的全称或简称；3-公众号或小程序的全称或简称；4-商标名的全称或简称；5-政府/机关事业单位/其他单位的全称或简称； - **CertificateType** (int) - 签名的资质证明文件类型，需与签名类型保持一致，说明如下：0-三证合一/企业营业执照/组织机构代码证书/社会信用代码证书；1-应用商店后台开发者管理截图；2-备案服务商的备案成功截图(含域名，网站名称，备案号)；3-公众号或小程序的管理界面截图；4-商标注册证书；5-组织机构代码证书、社会信用代码证书； - **ProxyFile** (str) - 短信签名授权委托文件，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB；当您是代理并使用第三方的签名时（也即SigPurpose为1-他用），该项为必填项； - + **Response** - **Message** (str) - 返回状态码描述，如果操作成功，默认返回为空 - + """ d = {"ProjectId": self.config.project_id} req and d.update(req) @@ -259,23 +259,23 @@ def update_usms_signature(self, req=None, **kwargs): return apis.UpdateUSMSSignatureResponseSchema().loads(resp) def update_usms_template(self, req=None, **kwargs): - """ UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板，并重新提交审核 + """UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板，并重新提交审核 **Request** - - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ - **Template** (str) - (Required) 新的模板内容。模板名称和模板内容必须提供一个，否则会报错。小于等于600个字 - **TemplateId** (str) - (Required) 短信模板ID - **Remark** (str) - 短信模板申请原因说明，字数不超过128，每个中文、符号、英文、数字等都计为1个字。 - **TemplateName** (str) - 新的模板名称。小于等于32个字，每个中文、英文、数组、符合都计为一个字 - **UnsubscribeInfo** (str) - 当Purpose为3时，也即会员推广类短信模板，该项必填。枚举值：TD退订、回T退订、回N退订、回TD退订、退订回T、退订回D、退订回TD、退订回复T、退订回复D、退订回复N、退订回复TD、拒收回T - - **Zone** (str) - 可用区。参见 `可用区列表 `_ - + - **Zone** (str) - 可用区。参见 `可用区列表 `_ + **Response** - **Message** (str) - 发生错误时表示错误描述 - + """ d = {"ProjectId": self.config.project_id, "Region": self.config.region} req and d.update(req) diff --git a/ucloud/services/usms/schemas/apis.py b/ucloud/services/usms/schemas/apis.py index f25c0c2..85b9880 100644 --- a/ucloud/services/usms/schemas/apis.py +++ b/ucloud/services/usms/schemas/apis.py @@ -14,8 +14,7 @@ class CreateUSMSSignatureRequestSchema(schema.RequestSchema): - """ CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名 - """ + """CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名""" fields = { "CertificateType": fields.Int(required=True, dump_to="CertificateType"), @@ -30,8 +29,7 @@ class CreateUSMSSignatureRequestSchema(schema.RequestSchema): class CreateUSMSSignatureResponseSchema(schema.ResponseSchema): - """ CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名 - """ + """CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -48,8 +46,7 @@ class CreateUSMSSignatureResponseSchema(schema.ResponseSchema): class CreateUSMSTemplateRequestSchema(schema.RequestSchema): - """ CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板 - """ + """CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -66,8 +63,7 @@ class CreateUSMSTemplateRequestSchema(schema.RequestSchema): class CreateUSMSTemplateResponseSchema(schema.ResponseSchema): - """ CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板 - """ + """CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板""" fields = { "Message": fields.Str(required=True, load_from="Message"), @@ -83,8 +79,7 @@ class CreateUSMSTemplateResponseSchema(schema.ResponseSchema): class DeleteUSMSSignatureRequestSchema(schema.RequestSchema): - """ DeleteUSMSSignature - 调用接口DeleteUSMSSignature删除短信签名 - """ + """DeleteUSMSSignature - 调用接口DeleteUSMSSignature删除短信签名""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -93,8 +88,7 @@ class DeleteUSMSSignatureRequestSchema(schema.RequestSchema): class DeleteUSMSSignatureResponseSchema(schema.ResponseSchema): - """ DeleteUSMSSignature - 调用接口DeleteUSMSSignature删除短信签名 - """ + """DeleteUSMSSignature - 调用接口DeleteUSMSSignature删除短信签名""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -107,8 +101,7 @@ class DeleteUSMSSignatureResponseSchema(schema.ResponseSchema): class DeleteUSMSTemplateRequestSchema(schema.RequestSchema): - """ DeleteUSMSTemplate - 调用接口DeleteUSMSTemplate删除短信模板 - """ + """DeleteUSMSTemplate - 调用接口DeleteUSMSTemplate删除短信模板""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -119,8 +112,7 @@ class DeleteUSMSTemplateRequestSchema(schema.RequestSchema): class DeleteUSMSTemplateResponseSchema(schema.ResponseSchema): - """ DeleteUSMSTemplate - 调用接口DeleteUSMSTemplate删除短信模板 - """ + """DeleteUSMSTemplate - 调用接口DeleteUSMSTemplate删除短信模板""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -133,8 +125,7 @@ class DeleteUSMSTemplateResponseSchema(schema.ResponseSchema): class GetUSMSSendReceiptRequestSchema(schema.RequestSchema): - """ GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时，建议发送完短信以后，5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回，则请联系技术支持确认原因 - """ + """GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时，建议发送完短信以后，5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回，则请联系技术支持确认原因""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -145,8 +136,7 @@ class GetUSMSSendReceiptRequestSchema(schema.RequestSchema): class GetUSMSSendReceiptResponseSchema(schema.ResponseSchema): - """ GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时，建议发送完短信以后，5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回，则请联系技术支持确认原因 - """ + """GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时，建议发送完短信以后，5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回，则请联系技术支持确认原因""" fields = { "Data": fields.List( @@ -164,8 +154,7 @@ class GetUSMSSendReceiptResponseSchema(schema.ResponseSchema): class QueryUSMSSignatureRequestSchema(schema.RequestSchema): - """ QueryUSMSSignature - 调用接口QueryUSMSSignature查询短信签名申请状态 - """ + """QueryUSMSSignature - 调用接口QueryUSMSSignature查询短信签名申请状态""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -175,8 +164,7 @@ class QueryUSMSSignatureRequestSchema(schema.RequestSchema): class QueryUSMSSignatureResponseSchema(schema.ResponseSchema): - """ QueryUSMSSignature - 调用接口QueryUSMSSignature查询短信签名申请状态 - """ + """QueryUSMSSignature - 调用接口QueryUSMSSignature查询短信签名申请状态""" fields = { "Data": models.OutSignatureSchema(), @@ -192,8 +180,7 @@ class QueryUSMSSignatureResponseSchema(schema.ResponseSchema): class QueryUSMSTemplateRequestSchema(schema.RequestSchema): - """ QueryUSMSTemplate - 调用接口QueryUSMSTemplate查询短信模板申请状态 - """ + """QueryUSMSTemplate - 调用接口QueryUSMSTemplate查询短信模板申请状态""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -202,8 +189,7 @@ class QueryUSMSTemplateRequestSchema(schema.RequestSchema): class QueryUSMSTemplateResponseSchema(schema.ResponseSchema): - """ QueryUSMSTemplate - 调用接口QueryUSMSTemplate查询短信模板申请状态 - """ + """QueryUSMSTemplate - 调用接口QueryUSMSTemplate查询短信模板申请状态""" fields = { "Data": models.OutTemplateSchema(), @@ -219,8 +205,7 @@ class QueryUSMSTemplateResponseSchema(schema.ResponseSchema): class SendUSMSMessageRequestSchema(schema.RequestSchema): - """ SendUSMSMessage - 发送短信息。短信字数超过70个后，按照每66个进行切割(因为要加上1/3), 2/3)等字样，占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计 - """ + """SendUSMSMessage - 发送短信息。短信字数超过70个后，按照每66个进行切割(因为要加上1/3), 2/3)等字样，占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计""" fields = { "PhoneNumbers": fields.List(fields.Str()), @@ -234,8 +219,7 @@ class SendUSMSMessageRequestSchema(schema.RequestSchema): class SendUSMSMessageResponseSchema(schema.ResponseSchema): - """ SendUSMSMessage - 发送短信息。短信字数超过70个后，按照每66个进行切割(因为要加上1/3), 2/3)等字样，占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计 - """ + """SendUSMSMessage - 发送短信息。短信字数超过70个后，按照每66个进行切割(因为要加上1/3), 2/3)等字样，占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计""" fields = { "Action": fields.Str(required=True, load_from="Action"), @@ -253,8 +237,7 @@ class SendUSMSMessageResponseSchema(schema.ResponseSchema): class UpdateUSMSSignatureRequestSchema(schema.RequestSchema): - """ UpdateUSMSSignature - 调用接口UpdateUSMSSignature修改未通过审核的短信签名，并重新提交审核 - """ + """UpdateUSMSSignature - 调用接口UpdateUSMSSignature修改未通过审核的短信签名，并重新提交审核""" fields = { "CertificateType": fields.Int( @@ -271,8 +254,7 @@ class UpdateUSMSSignatureRequestSchema(schema.RequestSchema): class UpdateUSMSSignatureResponseSchema(schema.ResponseSchema): - """ UpdateUSMSSignature - 调用接口UpdateUSMSSignature修改未通过审核的短信签名，并重新提交审核 - """ + """UpdateUSMSSignature - 调用接口UpdateUSMSSignature修改未通过审核的短信签名，并重新提交审核""" fields = {"Message": fields.Str(required=True, load_from="Message")} @@ -285,8 +267,7 @@ class UpdateUSMSSignatureResponseSchema(schema.ResponseSchema): class UpdateUSMSTemplateRequestSchema(schema.RequestSchema): - """ UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板，并重新提交审核 - """ + """UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板，并重新提交审核""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -303,7 +284,6 @@ class UpdateUSMSTemplateRequestSchema(schema.RequestSchema): class UpdateUSMSTemplateResponseSchema(schema.ResponseSchema): - """ UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板，并重新提交审核 - """ + """UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板，并重新提交审核""" fields = {"Message": fields.Str(required=True, load_from="Message")} diff --git a/ucloud/services/usms/schemas/models.py b/ucloud/services/usms/schemas/models.py index eb82e14..0419da8 100644 --- a/ucloud/services/usms/schemas/models.py +++ b/ucloud/services/usms/schemas/models.py @@ -5,8 +5,7 @@ class ReceiptPerPhoneSchema(schema.ResponseSchema): - """ ReceiptPerPhone - 每个目的手机号的发送回执信息 - """ + """ReceiptPerPhone - 每个目的手机号的发送回执信息""" fields = { "CostCount": fields.Int(required=True, load_from="CostCount"), @@ -18,8 +17,7 @@ class ReceiptPerPhoneSchema(schema.ResponseSchema): class ReceiptPerSessionSchema(schema.ResponseSchema): - """ ReceiptPerSession - 每个提交的回执结果集合 - """ + """ReceiptPerSession - 每个提交的回执结果集合""" fields = { "ReceiptSet": fields.List(ReceiptPerPhoneSchema()), @@ -28,8 +26,7 @@ class ReceiptPerSessionSchema(schema.ResponseSchema): class OutSignatureSchema(schema.ResponseSchema): - """ OutSignature - 短信签名 - """ + """OutSignature - 短信签名""" fields = { "ErrDesc": fields.Str(required=True, load_from="ErrDesc"), @@ -40,8 +37,7 @@ class OutSignatureSchema(schema.ResponseSchema): class OutTemplateSchema(schema.ResponseSchema): - """ OutTemplate - 短信模板 - """ + """OutTemplate - 短信模板""" fields = { "CreateTime": fields.Int(required=True, load_from="CreateTime"), diff --git a/ucloud/services/vpc/client.py b/ucloud/services/vpc/client.py index 0b22082..84c9c83 100644 --- a/ucloud/services/vpc/client.py +++ b/ucloud/services/vpc/client.py @@ -10,7 +10,7 @@ def __init__(self, config, transport=None, middleware=None, logger=None): super(VPCClient, self).__init__(config, transport, middleware, logger) def add_vpc_network(self, req=None, **kwargs): - """ AddVPCNetwork - 添加VPC网段 + """AddVPCNetwork - 添加VPC网段 **Request** @@ -31,7 +31,7 @@ def add_vpc_network(self, req=None, **kwargs): return apis.AddVPCNetworkResponseSchema().loads(resp) def associate_route_table(self, req=None, **kwargs): - """ AssociateRouteTable - 绑定子网的路由表 + """AssociateRouteTable - 绑定子网的路由表 **Request** @@ -51,7 +51,7 @@ def associate_route_table(self, req=None, **kwargs): return apis.AssociateRouteTableResponseSchema().loads(resp) def clone_route_table(self, req=None, **kwargs): - """ CloneRouteTable - 根据一张现有路由表复制一张新的路由表 + """CloneRouteTable - 根据一张现有路由表复制一张新的路由表 **Request** @@ -71,7 +71,7 @@ def clone_route_table(self, req=None, **kwargs): return apis.CloneRouteTableResponseSchema().loads(resp) def create_route_table(self, req=None, **kwargs): - """ CreateRouteTable - 创建路由表 + """CreateRouteTable - 创建路由表 **Request** @@ -95,7 +95,7 @@ def create_route_table(self, req=None, **kwargs): return apis.CreateRouteTableResponseSchema().loads(resp) def create_subnet(self, req=None, **kwargs): - """ CreateSubnet - 创建子网 + """CreateSubnet - 创建子网 **Request** @@ -121,7 +121,7 @@ def create_subnet(self, req=None, **kwargs): return apis.CreateSubnetResponseSchema().loads(resp) def create_vpc(self, req=None, **kwargs): - """ CreateVPC - 创建VPC + """CreateVPC - 创建VPC **Request** @@ -146,7 +146,7 @@ def create_vpc(self, req=None, **kwargs): return apis.CreateVPCResponseSchema().loads(resp) def create_vpc_intercom(self, req=None, **kwargs): - """ CreateVPCIntercom - 新建VPC互通关系 + """CreateVPCIntercom - 新建VPC互通关系 **Request** @@ -169,7 +169,7 @@ def create_vpc_intercom(self, req=None, **kwargs): return apis.CreateVPCIntercomResponseSchema().loads(resp) def delete_route_table(self, req=None, **kwargs): - """ DeleteRouteTable - 删除自定义路由表 + """DeleteRouteTable - 删除自定义路由表 **Request** @@ -188,7 +188,7 @@ def delete_route_table(self, req=None, **kwargs): return apis.DeleteRouteTableResponseSchema().loads(resp) def delete_subnet(self, req=None, **kwargs): - """ DeleteSubnet - 删除子网 + """DeleteSubnet - 删除子网 **Request** @@ -207,7 +207,7 @@ def delete_subnet(self, req=None, **kwargs): return apis.DeleteSubnetResponseSchema().loads(resp) def delete_vpc(self, req=None, **kwargs): - """ DeleteVPC - 删除VPC + """DeleteVPC - 删除VPC **Request** @@ -226,7 +226,7 @@ def delete_vpc(self, req=None, **kwargs): return apis.DeleteVPCResponseSchema().loads(resp) def delete_vpc_intercom(self, req=None, **kwargs): - """ DeleteVPCIntercom - 删除VPC互通关系 + """DeleteVPCIntercom - 删除VPC互通关系 **Request** @@ -248,7 +248,7 @@ def delete_vpc_intercom(self, req=None, **kwargs): return apis.DeleteVPCIntercomResponseSchema().loads(resp) def describe_route_table(self, req=None, **kwargs): - """ DescribeRouteTable - 获取路由表详细信息(包括路由策略) + """DescribeRouteTable - 获取路由表详细信息(包括路由策略) **Request** @@ -296,7 +296,7 @@ def describe_route_table(self, req=None, **kwargs): return apis.DescribeRouteTableResponseSchema().loads(resp) def describe_subnet(self, req=None, **kwargs): - """ DescribeSubnet - 获取子网信息 + """DescribeSubnet - 获取子网信息 **Request** @@ -346,7 +346,7 @@ def describe_subnet(self, req=None, **kwargs): return apis.DescribeSubnetResponseSchema().loads(resp) def describe_subnet_resource(self, req=None, **kwargs): - """ DescribeSubnetResource - 展示子网资源 + """DescribeSubnetResource - 展示子网资源 **Request** - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 `_ - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ @@ -379,7 +379,7 @@ def describe_subnet_resource(self, req=None, **kwargs): return apis.DescribeSubnetResourceResponseSchema().loads(resp) def describe_vpc(self, req=None, **kwargs): - """ DescribeVPC - 获取VPC信息 + """DescribeVPC - 获取VPC信息 **Request** @@ -422,7 +422,7 @@ def describe_vpc(self, req=None, **kwargs): return apis.DescribeVPCResponseSchema().loads(resp) def describe_vpc_intercom(self, req=None, **kwargs): - """ DescribeVPCIntercom - 获取VPC互通信息 + """DescribeVPCIntercom - 获取VPC互通信息 **Request** @@ -455,7 +455,7 @@ def describe_vpc_intercom(self, req=None, **kwargs): return apis.DescribeVPCIntercomResponseSchema().loads(resp) def modify_route_rule(self, req=None, **kwargs): - """ ModifyRouteRule - 路由策略增、删、改 + """ModifyRouteRule - 路由策略增、删、改 **Request** @@ -475,7 +475,7 @@ def modify_route_rule(self, req=None, **kwargs): return apis.ModifyRouteRuleResponseSchema().loads(resp) def update_route_table_attribute(self, req=None, **kwargs): - """ UpdateRouteTableAttribute - 更新路由表基本信息 + """UpdateRouteTableAttribute - 更新路由表基本信息 **Request** @@ -497,7 +497,7 @@ def update_route_table_attribute(self, req=None, **kwargs): return apis.UpdateRouteTableAttributeResponseSchema().loads(resp) def update_subnet_attribute(self, req=None, **kwargs): - """ UpdateSubnetAttribute - 更新子网信息 + """UpdateSubnetAttribute - 更新子网信息 **Request** @@ -518,7 +518,7 @@ def update_subnet_attribute(self, req=None, **kwargs): return apis.UpdateSubnetAttributeResponseSchema().loads(resp) def update_vpc_network(self, req=None, **kwargs): - """ UpdateVPCNetwork - 更新VPC网段 + """UpdateVPCNetwork - 更新VPC网段 **Request** diff --git a/ucloud/services/vpc/schemas/apis.py b/ucloud/services/vpc/schemas/apis.py index 3986831..3c36121 100644 --- a/ucloud/services/vpc/schemas/apis.py +++ b/ucloud/services/vpc/schemas/apis.py @@ -14,8 +14,7 @@ class AddVPCNetworkRequestSchema(schema.RequestSchema): - """ AddVPCNetwork - 添加VPC网段 - """ + """AddVPCNetwork - 添加VPC网段""" fields = { "Network": fields.List(fields.Str()), @@ -26,8 +25,7 @@ class AddVPCNetworkRequestSchema(schema.RequestSchema): class AddVPCNetworkResponseSchema(schema.ResponseSchema): - """ AddVPCNetwork - 添加VPC网段 - """ + """AddVPCNetwork - 添加VPC网段""" fields = {} @@ -40,8 +38,7 @@ class AddVPCNetworkResponseSchema(schema.ResponseSchema): class AssociateRouteTableRequestSchema(schema.RequestSchema): - """ AssociateRouteTable - 绑定子网的路由表 - """ + """AssociateRouteTable - 绑定子网的路由表""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -52,8 +49,7 @@ class AssociateRouteTableRequestSchema(schema.RequestSchema): class AssociateRouteTableResponseSchema(schema.ResponseSchema): - """ AssociateRouteTable - 绑定子网的路由表 - """ + """AssociateRouteTable - 绑定子网的路由表""" fields = {} @@ -66,8 +62,7 @@ class AssociateRouteTableResponseSchema(schema.ResponseSchema): class CloneRouteTableRequestSchema(schema.RequestSchema): - """ CloneRouteTable - 根据一张现有路由表复制一张新的路由表 - """ + """CloneRouteTable - 根据一张现有路由表复制一张新的路由表""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -77,8 +72,7 @@ class CloneRouteTableRequestSchema(schema.RequestSchema): class CloneRouteTableResponseSchema(schema.ResponseSchema): - """ CloneRouteTable - 根据一张现有路由表复制一张新的路由表 - """ + """CloneRouteTable - 根据一张现有路由表复制一张新的路由表""" fields = {} @@ -91,8 +85,7 @@ class CloneRouteTableResponseSchema(schema.ResponseSchema): class CreateRouteTableRequestSchema(schema.RequestSchema): - """ CreateRouteTable - 创建路由表 - """ + """CreateRouteTable - 创建路由表""" fields = { "Name": fields.Str(required=False, dump_to="Name"), @@ -105,8 +98,7 @@ class CreateRouteTableRequestSchema(schema.RequestSchema): class CreateRouteTableResponseSchema(schema.ResponseSchema): - """ CreateRouteTable - 创建路由表 - """ + """CreateRouteTable - 创建路由表""" fields = { "RouteTableId": fields.Str(required=False, load_from="RouteTableId") @@ -121,8 +113,7 @@ class CreateRouteTableResponseSchema(schema.ResponseSchema): class CreateSubnetRequestSchema(schema.RequestSchema): - """ CreateSubnet - 创建子网 - """ + """CreateSubnet - 创建子网""" fields = { "Netmask": fields.Int(required=False, dump_to="Netmask"), @@ -137,8 +128,7 @@ class CreateSubnetRequestSchema(schema.RequestSchema): class CreateSubnetResponseSchema(schema.ResponseSchema): - """ CreateSubnet - 创建子网 - """ + """CreateSubnet - 创建子网""" fields = {"SubnetId": fields.Str(required=False, load_from="SubnetId")} @@ -151,8 +141,7 @@ class CreateSubnetResponseSchema(schema.ResponseSchema): class CreateVPCRequestSchema(schema.RequestSchema): - """ CreateVPC - 创建VPC - """ + """CreateVPC - 创建VPC""" fields = { "Name": fields.Str(required=True, dump_to="Name"), @@ -166,8 +155,7 @@ class CreateVPCRequestSchema(schema.RequestSchema): class CreateVPCResponseSchema(schema.ResponseSchema): - """ CreateVPC - 创建VPC - """ + """CreateVPC - 创建VPC""" fields = {"VPCId": fields.Str(required=False, load_from="VPCId")} @@ -180,8 +168,7 @@ class CreateVPCResponseSchema(schema.ResponseSchema): class CreateVPCIntercomRequestSchema(schema.RequestSchema): - """ CreateVPCIntercom - 新建VPC互通关系 - """ + """CreateVPCIntercom - 新建VPC互通关系""" fields = { "DstProjectId": fields.Str(required=False, dump_to="DstProjectId"), @@ -194,8 +181,7 @@ class CreateVPCIntercomRequestSchema(schema.RequestSchema): class CreateVPCIntercomResponseSchema(schema.ResponseSchema): - """ CreateVPCIntercom - 新建VPC互通关系 - """ + """CreateVPCIntercom - 新建VPC互通关系""" fields = {} @@ -208,8 +194,7 @@ class CreateVPCIntercomResponseSchema(schema.ResponseSchema): class DeleteRouteTableRequestSchema(schema.RequestSchema): - """ DeleteRouteTable - 删除自定义路由表 - """ + """DeleteRouteTable - 删除自定义路由表""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -219,8 +204,7 @@ class DeleteRouteTableRequestSchema(schema.RequestSchema): class DeleteRouteTableResponseSchema(schema.ResponseSchema): - """ DeleteRouteTable - 删除自定义路由表 - """ + """DeleteRouteTable - 删除自定义路由表""" fields = {} @@ -233,8 +217,7 @@ class DeleteRouteTableResponseSchema(schema.ResponseSchema): class DeleteSubnetRequestSchema(schema.RequestSchema): - """ DeleteSubnet - 删除子网 - """ + """DeleteSubnet - 删除子网""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -244,8 +227,7 @@ class DeleteSubnetRequestSchema(schema.RequestSchema): class DeleteSubnetResponseSchema(schema.ResponseSchema): - """ DeleteSubnet - 删除子网 - """ + """DeleteSubnet - 删除子网""" fields = {} @@ -258,8 +240,7 @@ class DeleteSubnetResponseSchema(schema.ResponseSchema): class DeleteVPCRequestSchema(schema.RequestSchema): - """ DeleteVPC - 删除VPC - """ + """DeleteVPC - 删除VPC""" fields = { "ProjectId": fields.Str(required=False, dump_to="ProjectId"), @@ -269,8 +250,7 @@ class DeleteVPCRequestSchema(schema.RequestSchema): class DeleteVPCResponseSchema(schema.ResponseSchema): - """ DeleteVPC - 删除VPC - """ + """DeleteVPC - 删除VPC""" fields = {} @@ -283,8 +263,7 @@ class DeleteVPCResponseSchema(schema.ResponseSchema): class DeleteVPCIntercomRequestSchema(schema.RequestSchema): - """ DeleteVPCIntercom - 删除VPC互通关系 - """ + """DeleteVPCIntercom - 删除VPC互通关系""" fields = { "DstProjectId": fields.Str(required=False, dump_to="DstProjectId"), @@ -297,8 +276,7 @@ class DeleteVPCIntercomRequestSchema(schema.RequestSchema): class DeleteVPCIntercomResponseSchema(schema.ResponseSchema): - """ DeleteVPCIntercom - 删除VPC互通关系 - """ + """DeleteVPCIntercom - 删除VPC互通关系""" fields = {} @@ -311,8 +289,7 @@ class DeleteVPCIntercomResponseSchema(schema.ResponseSchema): class DescribeRouteTableRequestSchema(schema.RequestSchema): - """ DescribeRouteTable - 获取路由表详细信息(包括路由策略) - """ + """DescribeRouteTable - 获取路由表详细信息(包括路由策略)""" fields = { "BusinessId": fields.Str(required=False, dump_to="BusinessId"), @@ -326,8 +303,7 @@ class DescribeRouteTableRequestSchema(schema.RequestSchema): class DescribeRouteTableResponseSchema(schema.ResponseSchema): - """ DescribeRouteTable - 获取路由表详细信息(包括路由策略) - """ + """DescribeRouteTable - 获取路由表详细信息(包括路由策略)""" fields = { "RouteTables": fields.List( @@ -347,8 +323,7 @@ class DescribeRouteTableResponseSchema(schema.ResponseSchema): class DescribeSubnetRequestSchema(schema.RequestSchema): - """ DescribeSubnet - 获取子网信息 - """ + """DescribeSubnet - 获取子网信息""" fields = { "BusinessId": fields.Str(required=False, dump_to="BusinessId"), @@ -368,8 +343,7 @@ class DescribeSubnetRequestSchema(schema.RequestSchema): class DescribeSubnetResponseSchema(schema.ResponseSchema): - """ DescribeSubnet - 获取子网信息 - """ + """DescribeSubnet - 获取子网信息""" fields = { "DataSet": fields.List( @@ -387,8 +361,7 @@ class DescribeSubnetResponseSchema(schema.ResponseSchema): class DescribeSubnetResourceRequestSchema(schema.RequestSchema): - """ DescribeSubnetResource - 展示子网资源 - """ + """DescribeSubnetResource - 展示子网资源""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -401,8 +374,7 @@ class DescribeSubnetResourceRequestSchema(schema.RequestSchema): class DescribeSubnetResourceResponseSchema(schema.ResponseSchema): - """ DescribeSubnetResource - 展示子网资源 - """ + """DescribeSubnetResource - 展示子网资源""" fields = { "DataSet": fields.List( @@ -420,8 +392,7 @@ class DescribeSubnetResourceResponseSchema(schema.ResponseSchema): class DescribeVPCRequestSchema(schema.RequestSchema): - """ DescribeVPC - 获取VPC信息 - """ + """DescribeVPC - 获取VPC信息""" fields = { "Limit": fields.Int(required=False, dump_to="Limit"), @@ -434,8 +405,7 @@ class DescribeVPCRequestSchema(schema.RequestSchema): class DescribeVPCResponseSchema(schema.ResponseSchema): - """ DescribeVPC - 获取VPC信息 - """ + """DescribeVPC - 获取VPC信息""" fields = { "DataSet": fields.List( @@ -452,8 +422,7 @@ class DescribeVPCResponseSchema(schema.ResponseSchema): class DescribeVPCIntercomRequestSchema(schema.RequestSchema): - """ DescribeVPCIntercom - 获取VPC互通信息 - """ + """DescribeVPCIntercom - 获取VPC互通信息""" fields = { "DstProjectId": fields.Str(required=False, dump_to="DstProjectId"), @@ -465,8 +434,7 @@ class DescribeVPCIntercomRequestSchema(schema.RequestSchema): class DescribeVPCIntercomResponseSchema(schema.ResponseSchema): - """ DescribeVPCIntercom - 获取VPC互通信息 - """ + """DescribeVPCIntercom - 获取VPC互通信息""" fields = { "DataSet": fields.List( @@ -483,8 +451,7 @@ class DescribeVPCIntercomResponseSchema(schema.ResponseSchema): class ModifyRouteRuleRequestSchema(schema.RequestSchema): - """ ModifyRouteRule - 路由策略增、删、改 - """ + """ModifyRouteRule - 路由策略增、删、改""" fields = { "ProjectId": fields.Str(required=True, dump_to="ProjectId"), @@ -495,8 +462,7 @@ class ModifyRouteRuleRequestSchema(schema.RequestSchema): class ModifyRouteRuleResponseSchema(schema.ResponseSchema): - """ ModifyRouteRule - 路由策略增、删、改 - """ + """ModifyRouteRule - 路由策略增、删、改""" fields = {} @@ -509,8 +475,7 @@ class ModifyRouteRuleResponseSchema(schema.ResponseSchema): class UpdateRouteTableAttributeRequestSchema(schema.RequestSchema): - """ UpdateRouteTableAttribute - 更新路由表基本信息 - """ + """UpdateRouteTableAttribute - 更新路由表基本信息""" fields = { "Name": fields.Str(required=False, dump_to="Name"), @@ -523,8 +488,7 @@ class UpdateRouteTableAttributeRequestSchema(schema.RequestSchema): class UpdateRouteTableAttributeResponseSchema(schema.ResponseSchema): - """ UpdateRouteTableAttribute - 更新路由表基本信息 - """ + """UpdateRouteTableAttribute - 更新路由表基本信息""" fields = {} @@ -537,8 +501,7 @@ class UpdateRouteTableAttributeResponseSchema(schema.ResponseSchema): class UpdateSubnetAttributeRequestSchema(schema.RequestSchema): - """ UpdateSubnetAttribute - 更新子网信息 - """ + """UpdateSubnetAttribute - 更新子网信息""" fields = { "Name": fields.Str(required=False, dump_to="Name"), @@ -550,8 +513,7 @@ class UpdateSubnetAttributeRequestSchema(schema.RequestSchema): class UpdateSubnetAttributeResponseSchema(schema.ResponseSchema): - """ UpdateSubnetAttribute - 更新子网信息 - """ + """UpdateSubnetAttribute - 更新子网信息""" fields = {} @@ -564,8 +526,7 @@ class UpdateSubnetAttributeResponseSchema(schema.ResponseSchema): class UpdateVPCNetworkRequestSchema(schema.RequestSchema): - """ UpdateVPCNetwork - 更新VPC网段 - """ + """UpdateVPCNetwork - 更新VPC网段""" fields = { "Network": fields.List(fields.Str()), @@ -576,7 +537,6 @@ class UpdateVPCNetworkRequestSchema(schema.RequestSchema): class UpdateVPCNetworkResponseSchema(schema.ResponseSchema): - """ UpdateVPCNetwork - 更新VPC网段 - """ + """UpdateVPCNetwork - 更新VPC网段""" fields = {"Message": fields.Str(required=True, load_from="Message")} diff --git a/ucloud/services/vpc/schemas/models.py b/ucloud/services/vpc/schemas/models.py index 51ec466..0213423 100644 --- a/ucloud/services/vpc/schemas/models.py +++ b/ucloud/services/vpc/schemas/models.py @@ -5,8 +5,7 @@ class RouteRuleInfoSchema(schema.ResponseSchema): - """ RouteRuleInfo - 路由规则信息 - """ + """RouteRuleInfo - 路由规则信息""" fields = { "DstAddr": fields.Str(required=False, load_from="DstAddr"), @@ -19,8 +18,7 @@ class RouteRuleInfoSchema(schema.ResponseSchema): class RouteTableInfoSchema(schema.ResponseSchema): - """ RouteTableInfo - 路由表信息 - """ + """RouteTableInfo - 路由表信息""" fields = { "CreateTime": fields.Int(required=False, load_from="CreateTime"), @@ -38,8 +36,7 @@ class RouteTableInfoSchema(schema.ResponseSchema): class SubnetInfoSchema(schema.ResponseSchema): - """ SubnetInfo - 子网信息 - """ + """SubnetInfo - 子网信息""" fields = { "AvailableIPs": fields.Int(required=False, load_from="AvailableIPs"), @@ -62,8 +59,7 @@ class SubnetInfoSchema(schema.ResponseSchema): class SubnetResourceSchema(schema.ResponseSchema): - """ SubnetResource - 子网下资源 - """ + """SubnetResource - 子网下资源""" fields = { "IP": fields.Str(required=False, load_from="IP"), @@ -82,8 +78,7 @@ class SubnetResourceSchema(schema.ResponseSchema): class VPCNetworkInfoSchema(schema.ResponseSchema): - """ VPCNetworkInfo - vpc地址空间信息 - """ + """VPCNetworkInfo - vpc地址空间信息""" fields = { "Network": fields.Str(required=False, load_from="Network"), @@ -92,8 +87,7 @@ class VPCNetworkInfoSchema(schema.ResponseSchema): class VPCInfoSchema(schema.ResponseSchema): - """ VPCInfo - VPC信息 - """ + """VPCInfo - VPC信息""" fields = { "CreateTime": fields.Int(required=True, load_from="CreateTime"), @@ -110,8 +104,7 @@ class VPCInfoSchema(schema.ResponseSchema): class VPCIntercomInfoSchema(schema.ResponseSchema): - """ VPCIntercomInfo - - """ + """VPCIntercomInfo -""" fields = { "DstRegion": fields.Str(required=False, load_from="DstRegion"), diff --git a/ucloud/testing/driver/_step.py b/ucloud/testing/driver/_step.py index 0b9168d..d3cce5e 100644 --- a/ucloud/testing/driver/_step.py +++ b/ucloud/testing/driver/_step.py @@ -23,7 +23,7 @@ def __init__( title="", **kwargs ): - """ Step is the test step in a test scenario + """Step is the test step in a test scenario :param invoker: invoker is a callable function :param max_retries: the maximum retry number by the `retry_for` exception, it will resolve the flaky testing case diff --git a/ucloud/testing/env.py b/ucloud/testing/env.py index a41ee14..13bfa20 100644 --- a/ucloud/testing/env.py +++ b/ucloud/testing/env.py @@ -21,7 +21,7 @@ def is_ut(): def pre_check_env(): - """ pre check environment for testing + """pre check environment for testing NOTE: system environment variables credential is required for test environment """ diff --git a/ucloud/testing/funcs.py b/ucloud/testing/funcs.py index 2d5b7ad..50b48c7 100644 --- a/ucloud/testing/funcs.py +++ b/ucloud/testing/funcs.py @@ -5,7 +5,7 @@ def concat(*args): - """ cancat strings + """cancat strings >>> concat(42, 'foo', 'bar') '42foobar' @@ -14,7 +14,7 @@ def concat(*args): def concat_without_dot(args): - """ replace blank + """replace blank >>> concat_without_dot('42foo bar') '42foobar' @@ -23,7 +23,7 @@ def concat_without_dot(args): def search_value(array, origin_key, origin_value, dest_key): - """ given origin key and value,search dest_value form array by dest_key + """given origin key and value,search dest_value form array by dest_key >>> d = [{"UHostId": "foo", "Name": "testing"}] >>> search_value(d, "Name", "testing", "UHostId") @@ -36,7 +36,7 @@ def search_value(array, origin_key, origin_value, dest_key): def timedelta(timestamp, value, typ="days"): - """ given timestamp(10bit) and calculate relative delta time + """given timestamp(10bit) and calculate relative delta time >>> timedelta(0, 1, "days") 86400.0 @@ -56,7 +56,7 @@ def timedelta(timestamp, value, typ="days"): def get_timestamp(length=13): - """ get current timestamp string + """get current timestamp string >>> len(str(int(get_timestamp(10)))) 10 diff --git a/ucloud/testing/op.py b/ucloud/testing/op.py index 000beb5..aed3ebc 100644 --- a/ucloud/testing/op.py +++ b/ucloud/testing/op.py @@ -5,103 +5,87 @@ def eq(value, expected): - """ value is equal to expected - """ + """value is equal to expected""" assert value == expected def ne(value, expected): - """ value is equal to expected - """ + """value is equal to expected""" assert value != expected def gt(value, expected): - """ value is greater than expected - """ + """value is greater than expected""" assert float(value) > float(expected) def ge(value, expected): - """ value is greater than or equal to expected - """ + """value is greater than or equal to expected""" assert float(value) >= float(expected) def abs_eq(value, expected): - """ value is approx equal to expected - """ + """value is approx equal to expected""" assert round(float(value), 2) == round(float(expected), 2) def lt(value, expected): - """ value is less than excepted - """ + """value is less than excepted""" assert float(value) < float(expected) def le(value, expected): - """ value is less than or equal to excepted - """ + """value is less than or equal to excepted""" assert float(value) <= float(expected) def str_eq(value, expected): - """ value is equal to excepted as string - """ + """value is equal to excepted as string""" assert str(value) == str(expected) def float_eq(value, expected): - """ value is equal to excepted as float - """ + """value is equal to excepted as float""" assert round(float(value), 2) == round(float(expected), 2) def len_eq(value, expected): - """ length of value is equal to excepted - """ + """length of value is equal to excepted""" assert isinstance(expected, int) assert len(value) == expected def len_gt(value, expected): - """ length of value is greater than excepted - """ + """length of value is greater than excepted""" assert isinstance(expected, int) assert len(value) > expected def len_ge(value, expected): - """ length of value is greater than or equal to excepted - """ + """length of value is greater than or equal to excepted""" assert isinstance(expected, int) assert len(value) >= expected def len_lt(value, expected): - """ length of value is less than excepted - """ + """length of value is less than excepted""" assert isinstance(expected, int) assert len(value) < expected def len_le(value, expected): - """ length of value is less than or equal to excepted - """ + """length of value is less than or equal to excepted""" assert isinstance(expected, int) assert len(value) <= expected def contains(value, expected): - """ value is contains expected - """ + """value is contains expected""" assert expected in value def contained_by(value, expected): - """ value is contained by expected - """ + """value is contained by expected""" assert value in expected diff --git a/ucloud/testing/utest.py b/ucloud/testing/utest.py index d9ca1b0..e3dc788 100644 --- a/ucloud/testing/utest.py +++ b/ucloud/testing/utest.py @@ -21,7 +21,7 @@ def __init__( validators=None, **kwargs ): - """ Step is the test step in a test scenario + """Step is the test step in a test scenario :param invoker: invoker is a callable function :param max_retries: the maximum retry number by the `retry_for` exception, it will resolve the flaky testing case @@ -149,7 +149,7 @@ def initial(self, variables=None): def value_at_path(d, path): - """ access value by object path + """access value by object path :param d: dict or list of dict :param path: object path like `Data.1.UHostId` diff --git a/ucloud/version.py b/ucloud/version.py index 3a06d93..60177ee 100644 --- a/ucloud/version.py +++ b/ucloud/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- -version = "0.9.1" +version = "0.9.3"