| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735 |
- # -*- coding: utf-8 -*-
- # This file is auto-generated, don't edit it. Thanks.
- from __future__ import annotations
- import os
- from typing import Dict, Generator, AsyncGenerator, Any
- from alibabacloud_credentials import models as credential_models
- from alibabacloud_credentials.client import Client as CredentialClient
- from alibabacloud_gateway_spi import models as spi_models
- from alibabacloud_gateway_spi.client import Client as SPIClient
- from alibabacloud_tea_openapi import exceptions as main_exceptions
- from alibabacloud_tea_openapi import models as main_models
- from alibabacloud_tea_openapi import utils_models as open_api_util_models
- from alibabacloud_tea_openapi.utils import Utils
- from darabonba.core import DaraCore as DaraCore
- from darabonba.core import DaraCore
- from darabonba.exceptions import DaraException, UnretryableException
- from darabonba.policy.retry import RetryOptions, RetryPolicyContext
- from darabonba.request import DaraRequest
- from darabonba.runtime import RuntimeOptions
- from darabonba.utils.bytes import Bytes as DaraBytes
- from darabonba.utils.form import Form as DaraForm
- from darabonba.utils.stream import Stream as DaraStream
- from darabonba.utils.xml import XML as DaraXML
- from darabonba.websocket import (
- get_web_socket_enable_reconnect,
- get_web_socket_handshake_timeout,
- get_web_socket_max_reconnect_times,
- get_web_socket_ping_interval,
- get_web_socket_pong_timeout,
- get_web_socket_reconnect_interval,
- get_web_socket_write_timeout,
- new_websocket_client_and_connect,
- )
- from alibabacloud_tea_openapi import websocket_utils
- """
- * @remarks
- * This is for OpenApi SDK
- """
- class Client:
- _endpoint: str = None
- _region_id: str = None
- _protocol: str = None
- _method: str = None
- _user_agent: str = None
- _endpoint_rule: str = None
- _endpoint_map: Dict[str, str] = None
- _suffix: str = None
- _read_timeout: int = None
- _connect_timeout: int = None
- _http_proxy: str = None
- _https_proxy: str = None
- _socks_5proxy: str = None
- _socks_5net_work: str = None
- _no_proxy: str = None
- _network: str = None
- _product_id: str = None
- _max_idle_conns: int = None
- _endpoint_type: str = None
- _open_platform_endpoint: str = None
- _credential: CredentialClient = None
- _signature_version: str = None
- _signature_algorithm: str = None
- _headers: Dict[str, str] = None
- _spi: SPIClient = None
- _global_parameters: open_api_util_models.GlobalParameters = None
- _key: str = None
- _cert: str = None
- _ca: str = None
- _disable_http_2: bool = None
- _retry_options: RetryOptions = None
- _tls_min_version: str = None
- _attribute_map: spi_models.AttributeMap = None
- def __init__(
- self,
- config: open_api_util_models.Config,
- ):
- if DaraCore.is_null(config):
- raise main_exceptions.ClientException(
- code = 'ParameterMissing',
- message = '\'config\' can not be unset'
- )
- if (not DaraCore.is_null(config.access_key_id) and config.access_key_id != '') and (not DaraCore.is_null(config.access_key_secret) and config.access_key_secret != ''):
- if not DaraCore.is_null(config.security_token) and config.security_token != '':
- config.type = 'sts'
- else:
- config.type = 'access_key'
- credential_config = credential_models.Config(
- access_key_id = config.access_key_id,
- type = config.type,
- access_key_secret = config.access_key_secret
- )
- credential_config.security_token = config.security_token
- self._credential = CredentialClient(credential_config)
- elif not DaraCore.is_null(config.bearer_token) and config.bearer_token != '':
- cc = credential_models.Config(
- type = 'bearer',
- bearer_token = config.bearer_token
- )
- self._credential = CredentialClient(cc)
- elif not DaraCore.is_null(config.credential):
- self._credential = config.credential
- if DaraCore.is_null(config.user_agent):
- self._user_agent = os.environ.get('ALIBABA_CLOUD_USER_AGENT')
- else:
- self._user_agent = config.user_agent
- self._endpoint = config.endpoint
- self._endpoint_type = config.endpoint_type
- self._network = config.network
- self._suffix = config.suffix
- self._protocol = config.protocol
- self._method = config.method
- self._region_id = config.region_id
- self._read_timeout = config.read_timeout
- self._connect_timeout = config.connect_timeout
- self._http_proxy = config.http_proxy
- self._https_proxy = config.https_proxy
- self._no_proxy = config.no_proxy
- self._socks_5proxy = config.socks_5proxy
- self._socks_5net_work = config.socks_5net_work
- self._max_idle_conns = config.max_idle_conns
- self._signature_version = config.signature_version
- self._signature_algorithm = config.signature_algorithm
- self._global_parameters = config.global_parameters
- self._key = config.key
- self._cert = config.cert
- self._ca = config.ca
- self._disable_http_2 = config.disable_http_2
- self._retry_options = config.retry_options
- self._tls_min_version = config.tls_min_version
- """
- * @remarks
- * Encapsulate the request and invoke the network
- *
- * @param action - api name
- * @param version - product version
- * @param protocol - http or https
- * @param method - e.g. GET
- * @param authType - authorization type e.g. AK
- * @param bodyType - response body type e.g. String
- * @param request - object of OpenApiRequest
- * @param runtime - which controls some details of call api, such as retry times
- * @returns the response
- """
- def do_rpcrequest(
- self,
- action: str,
- version: str,
- protocol: str,
- method: str,
- auth_type: str,
- body_type: str,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or protocol
- _request.method = method
- _request.pathname = '/'
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.query = DaraCore.merge({
- 'Action': action,
- 'Format': 'json',
- 'Version': version,
- 'Timestamp': Utils.get_timestamp(),
- 'SignatureNonce': Utils.get_nonce(),
- }, global_queries, extends_queries, request.query)
- headers = self.get_rpc_headers()
- if DaraCore.is_null(headers):
- # endpoint is setted in product client
- _request.headers = DaraCore.merge({
- 'host': self._endpoint,
- 'x-acs-version': version,
- 'x-acs-action': action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- }, global_headers, extends_headers, request.headers)
- else:
- _request.headers = DaraCore.merge({
- 'host': self._endpoint,
- 'x-acs-version': version,
- 'x-acs-action': action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- }, global_headers, extends_headers, request.headers, headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- if not DaraCore.is_null(request.body):
- m = request.body
- tmp = Utils.query(m)
- _request.body = DaraForm.to_form_string(tmp)
- _request.headers["content-type"] = 'application/x-www-form-urlencoded'
- if auth_type != 'Anonymous':
- if DaraCore.is_null(self._credential):
- raise main_exceptions.ClientException(
- code = f'InvalidCredentials',
- message = f'Please set up the credentials correctly. If you are setting them through environment variables, please ensure that ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set correctly. See https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems for more details.'
- )
- credential_model = self._credential.get_credential()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- credential_type = credential_model.type
- if credential_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.query["BearerToken"] = bearer_token
- _request.query["SignatureType"] = 'BEARERTOKEN'
- elif credential_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.query["SecurityToken"] = security_token
- _request.query["SignatureMethod"] = 'HMAC-SHA1'
- _request.query["SignatureVersion"] = '1.0'
- _request.query["AccessKeyId"] = access_key_id
- t = None
- if not DaraCore.is_null(request.body):
- t = request.body
- signed_param = DaraCore.merge({}, _request.query, Utils.query(t))
- _request.query["Signature"] = Utils.get_rpcsignature(signed_param, _request.method, access_key_secret)
- _last_request = _request
- _response = DaraCore.do_action(_request, _runtime)
- _last_response = _response
- if (_response.status_code >= 400) and (_response.status_code < 600):
- _res = DaraStream.read_as_json(_response.body)
- err = _res
- request_id = err.get("RequestId") or err.get("requestId")
- code = err.get("Code") or err.get("code")
- if 'Throttling' in f'{code}':
- raise main_exceptions.ThrottlingException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- retry_after = Utils.get_throttling_time_left(_response.headers),
- data = err,
- request_id = f'{request_id}'
- )
- elif (_response.status_code >= 400) and (_response.status_code < 500):
- raise main_exceptions.ClientException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- access_denied_detail = self.get_access_denied_detail(err),
- request_id = f'{request_id}'
- )
- else:
- raise main_exceptions.ServerException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- request_id = f'{request_id}'
- )
- if body_type == 'binary':
- resp = {
- 'body': _response.body,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- return resp
- elif body_type == 'byte':
- byt = DaraStream.read_as_bytes(_response.body)
- return {
- 'body': byt,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'string':
- _str = DaraStream.read_as_string(_response.body)
- return {
- 'body': _str,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'json':
- obj = DaraStream.read_as_json(_response.body)
- res = obj
- return {
- 'body': res,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'array':
- arr = DaraStream.read_as_json(_response.body)
- return {
- 'body': arr,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- else:
- return {
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- async def do_rpcrequest_async(
- self,
- action: str,
- version: str,
- protocol: str,
- method: str,
- auth_type: str,
- body_type: str,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or protocol
- _request.method = method
- _request.pathname = '/'
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.query = DaraCore.merge({
- 'Action': action,
- 'Format': 'json',
- 'Version': version,
- 'Timestamp': Utils.get_timestamp(),
- 'SignatureNonce': Utils.get_nonce(),
- }, global_queries, extends_queries, request.query)
- headers = self.get_rpc_headers()
- if DaraCore.is_null(headers):
- # endpoint is setted in product client
- _request.headers = DaraCore.merge({
- 'host': self._endpoint,
- 'x-acs-version': version,
- 'x-acs-action': action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- }, global_headers, extends_headers, request.headers)
- else:
- _request.headers = DaraCore.merge({
- 'host': self._endpoint,
- 'x-acs-version': version,
- 'x-acs-action': action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- }, global_headers, extends_headers, request.headers, headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- if not DaraCore.is_null(request.body):
- m = request.body
- tmp = Utils.query(m)
- _request.body = DaraForm.to_form_string(tmp)
- _request.headers["content-type"] = 'application/x-www-form-urlencoded'
- if auth_type != 'Anonymous':
- if DaraCore.is_null(self._credential):
- raise main_exceptions.ClientException(
- code = f'InvalidCredentials',
- message = f'Please set up the credentials correctly. If you are setting them through environment variables, please ensure that ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set correctly. See https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems for more details.'
- )
- credential_model = await self._credential.get_credential_async()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- credential_type = credential_model.type
- if credential_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.query["BearerToken"] = bearer_token
- _request.query["SignatureType"] = 'BEARERTOKEN'
- elif credential_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.query["SecurityToken"] = security_token
- _request.query["SignatureMethod"] = 'HMAC-SHA1'
- _request.query["SignatureVersion"] = '1.0'
- _request.query["AccessKeyId"] = access_key_id
- t = None
- if not DaraCore.is_null(request.body):
- t = request.body
- signed_param = DaraCore.merge({}, _request.query, Utils.query(t))
- _request.query["Signature"] = Utils.get_rpcsignature(signed_param, _request.method, access_key_secret)
- _last_request = _request
- _response = await DaraCore.async_do_action(_request, _runtime)
- _last_response = _response
- if (_response.status_code >= 400) and (_response.status_code < 600):
- _res = await DaraStream.read_as_json_async(_response.body)
- err = _res
- request_id = err.get("RequestId") or err.get("requestId")
- code = err.get("Code") or err.get("code")
- if 'Throttling' in f'{code}':
- raise main_exceptions.ThrottlingException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- retry_after = Utils.get_throttling_time_left(_response.headers),
- data = err,
- request_id = f'{request_id}'
- )
- elif (_response.status_code >= 400) and (_response.status_code < 500):
- raise main_exceptions.ClientException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- access_denied_detail = self.get_access_denied_detail(err),
- request_id = f'{request_id}'
- )
- else:
- raise main_exceptions.ServerException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- request_id = f'{request_id}'
- )
- if body_type == 'binary':
- resp = {
- 'body': _response.body,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- return resp
- elif body_type == 'byte':
- byt = await DaraStream.read_as_bytes_async(_response.body)
- return {
- 'body': byt,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'string':
- _str = await DaraStream.read_as_string_async(_response.body)
- return {
- 'body': _str,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'json':
- obj = await DaraStream.read_as_json_async(_response.body)
- res = obj
- return {
- 'body': res,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'array':
- arr = await DaraStream.read_as_json_async(_response.body)
- return {
- 'body': arr,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- else:
- return {
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- """
- * @remarks
- * Encapsulate the request and invoke the network
- *
- * @param action - api name
- * @param version - product version
- * @param protocol - http or https
- * @param method - e.g. GET
- * @param authType - authorization type e.g. AK
- * @param pathname - pathname of every api
- * @param bodyType - response body type e.g. String
- * @param request - object of OpenApiRequest
- * @param runtime - which controls some details of call api, such as retry times
- * @returns the response
- """
- def do_roarequest(
- self,
- action: str,
- version: str,
- protocol: str,
- method: str,
- auth_type: str,
- pathname: str,
- body_type: str,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or protocol
- _request.method = method
- _request.pathname = pathname
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.headers = DaraCore.merge({
- 'date': Utils.get_date_utcstring(),
- 'host': self._endpoint,
- 'accept': 'application/json',
- 'x-acs-signature-nonce': Utils.get_nonce(),
- 'x-acs-signature-method': 'HMAC-SHA1',
- 'x-acs-signature-version': '1.0',
- 'x-acs-version': version,
- 'x-acs-action': action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- }, global_headers, extends_headers, request.headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- if not DaraCore.is_null(request.body):
- _request.body = DaraCore.to_json_string(request.body)
- _request.headers["content-type"] = 'application/json; charset=utf-8'
- _request.query = DaraCore.merge({}, global_queries, extends_queries)
- if not DaraCore.is_null(request.query):
- _request.query = DaraCore.merge({}, _request.query, request.query)
- if auth_type != 'Anonymous':
- if DaraCore.is_null(self._credential):
- raise main_exceptions.ClientException(
- code = f'InvalidCredentials',
- message = f'Please set up the credentials correctly. If you are setting them through environment variables, please ensure that ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set correctly. See https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems for more details.'
- )
- credential_model = self._credential.get_credential()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- credential_type = credential_model.type
- if credential_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.headers["x-acs-bearer-token"] = bearer_token
- _request.headers["x-acs-signature-type"] = 'BEARERTOKEN'
- elif credential_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.headers["x-acs-accesskey-id"] = access_key_id
- _request.headers["x-acs-security-token"] = security_token
- string_to_sign = Utils.get_string_to_sign(_request)
- _request.headers["authorization"] = f'acs {access_key_id}:{Utils.get_roasignature(string_to_sign, access_key_secret)}'
- _last_request = _request
- _response = DaraCore.do_action(_request, _runtime)
- _last_response = _response
- if _response.status_code == 204:
- return {
- 'headers': _response.headers
- }
- if (_response.status_code >= 400) and (_response.status_code < 600):
- _res = DaraStream.read_as_json(_response.body)
- err = _res
- request_id = err.get("RequestId") or err.get("requestId")
- request_id = request_id or err.get("requestid")
- code = err.get("Code") or err.get("code")
- if 'Throttling' in f'{code}':
- raise main_exceptions.ThrottlingException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- retry_after = Utils.get_throttling_time_left(_response.headers),
- data = err,
- request_id = f'{request_id}'
- )
- elif (_response.status_code >= 400) and (_response.status_code < 500):
- raise main_exceptions.ClientException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- access_denied_detail = self.get_access_denied_detail(err),
- request_id = f'{request_id}'
- )
- else:
- raise main_exceptions.ServerException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- request_id = f'{request_id}'
- )
- if body_type == 'binary':
- resp = {
- 'body': _response.body,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- return resp
- elif body_type == 'byte':
- byt = DaraStream.read_as_bytes(_response.body)
- return {
- 'body': byt,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'string':
- _str = DaraStream.read_as_string(_response.body)
- return {
- 'body': _str,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'json':
- obj = DaraStream.read_as_json(_response.body)
- res = obj
- return {
- 'body': res,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'array':
- arr = DaraStream.read_as_json(_response.body)
- return {
- 'body': arr,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- else:
- return {
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- async def do_roarequest_async(
- self,
- action: str,
- version: str,
- protocol: str,
- method: str,
- auth_type: str,
- pathname: str,
- body_type: str,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or protocol
- _request.method = method
- _request.pathname = pathname
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.headers = DaraCore.merge({
- 'date': Utils.get_date_utcstring(),
- 'host': self._endpoint,
- 'accept': 'application/json',
- 'x-acs-signature-nonce': Utils.get_nonce(),
- 'x-acs-signature-method': 'HMAC-SHA1',
- 'x-acs-signature-version': '1.0',
- 'x-acs-version': version,
- 'x-acs-action': action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- }, global_headers, extends_headers, request.headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- if not DaraCore.is_null(request.body):
- _request.body = DaraCore.to_json_string(request.body)
- _request.headers["content-type"] = 'application/json; charset=utf-8'
- _request.query = DaraCore.merge({}, global_queries, extends_queries)
- if not DaraCore.is_null(request.query):
- _request.query = DaraCore.merge({}, _request.query, request.query)
- if auth_type != 'Anonymous':
- if DaraCore.is_null(self._credential):
- raise main_exceptions.ClientException(
- code = f'InvalidCredentials',
- message = f'Please set up the credentials correctly. If you are setting them through environment variables, please ensure that ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set correctly. See https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems for more details.'
- )
- credential_model = await self._credential.get_credential_async()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- credential_type = credential_model.type
- if credential_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.headers["x-acs-bearer-token"] = bearer_token
- _request.headers["x-acs-signature-type"] = 'BEARERTOKEN'
- elif credential_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.headers["x-acs-accesskey-id"] = access_key_id
- _request.headers["x-acs-security-token"] = security_token
- string_to_sign = Utils.get_string_to_sign(_request)
- _request.headers["authorization"] = f'acs {access_key_id}:{Utils.get_roasignature(string_to_sign, access_key_secret)}'
- _last_request = _request
- _response = await DaraCore.async_do_action(_request, _runtime)
- _last_response = _response
- if _response.status_code == 204:
- return {
- 'headers': _response.headers
- }
- if (_response.status_code >= 400) and (_response.status_code < 600):
- _res = await DaraStream.read_as_json_async(_response.body)
- err = _res
- request_id = err.get("RequestId") or err.get("requestId")
- request_id = request_id or err.get("requestid")
- code = err.get("Code") or err.get("code")
- if 'Throttling' in f'{code}':
- raise main_exceptions.ThrottlingException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- retry_after = Utils.get_throttling_time_left(_response.headers),
- data = err,
- request_id = f'{request_id}'
- )
- elif (_response.status_code >= 400) and (_response.status_code < 500):
- raise main_exceptions.ClientException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- access_denied_detail = self.get_access_denied_detail(err),
- request_id = f'{request_id}'
- )
- else:
- raise main_exceptions.ServerException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- request_id = f'{request_id}'
- )
- if body_type == 'binary':
- resp = {
- 'body': _response.body,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- return resp
- elif body_type == 'byte':
- byt = await DaraStream.read_as_bytes_async(_response.body)
- return {
- 'body': byt,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'string':
- _str = await DaraStream.read_as_string_async(_response.body)
- return {
- 'body': _str,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'json':
- obj = await DaraStream.read_as_json_async(_response.body)
- res = obj
- return {
- 'body': res,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'array':
- arr = await DaraStream.read_as_json_async(_response.body)
- return {
- 'body': arr,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- else:
- return {
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- """
- * @remarks
- * Encapsulate the request and invoke the network with form body
- *
- * @param action - api name
- * @param version - product version
- * @param protocol - http or https
- * @param method - e.g. GET
- * @param authType - authorization type e.g. AK
- * @param pathname - pathname of every api
- * @param bodyType - response body type e.g. String
- * @param request - object of OpenApiRequest
- * @param runtime - which controls some details of call api, such as retry times
- * @returns the response
- """
- def do_roarequest_with_form(
- self,
- action: str,
- version: str,
- protocol: str,
- method: str,
- auth_type: str,
- pathname: str,
- body_type: str,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or protocol
- _request.method = method
- _request.pathname = pathname
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.headers = DaraCore.merge({
- 'date': Utils.get_date_utcstring(),
- 'host': self._endpoint,
- 'accept': 'application/json',
- 'x-acs-signature-nonce': Utils.get_nonce(),
- 'x-acs-signature-method': 'HMAC-SHA1',
- 'x-acs-signature-version': '1.0',
- 'x-acs-version': version,
- 'x-acs-action': action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- }, global_headers, extends_headers, request.headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- if not DaraCore.is_null(request.body):
- m = request.body
- _request.body = Utils.to_form(m)
- _request.headers["content-type"] = 'application/x-www-form-urlencoded'
- _request.query = DaraCore.merge({}, global_queries, extends_queries)
- if not DaraCore.is_null(request.query):
- _request.query = DaraCore.merge({}, _request.query, request.query)
- if auth_type != 'Anonymous':
- if DaraCore.is_null(self._credential):
- raise main_exceptions.ClientException(
- code = f'InvalidCredentials',
- message = f'Please set up the credentials correctly. If you are setting them through environment variables, please ensure that ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set correctly. See https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems for more details.'
- )
- credential_model = self._credential.get_credential()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- credential_type = credential_model.type
- if credential_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.headers["x-acs-bearer-token"] = bearer_token
- _request.headers["x-acs-signature-type"] = 'BEARERTOKEN'
- elif credential_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.headers["x-acs-accesskey-id"] = access_key_id
- _request.headers["x-acs-security-token"] = security_token
- string_to_sign = Utils.get_string_to_sign(_request)
- _request.headers["authorization"] = f'acs {access_key_id}:{Utils.get_roasignature(string_to_sign, access_key_secret)}'
- _last_request = _request
- _response = DaraCore.do_action(_request, _runtime)
- _last_response = _response
- if _response.status_code == 204:
- return {
- 'headers': _response.headers
- }
- if (_response.status_code >= 400) and (_response.status_code < 600):
- _res = DaraStream.read_as_json(_response.body)
- err = _res
- request_id = err.get("RequestId") or err.get("requestId")
- code = err.get("Code") or err.get("code")
- if 'Throttling' in f'{code}':
- raise main_exceptions.ThrottlingException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- retry_after = Utils.get_throttling_time_left(_response.headers),
- data = err,
- request_id = f'{request_id}'
- )
- elif (_response.status_code >= 400) and (_response.status_code < 500):
- raise main_exceptions.ClientException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- access_denied_detail = self.get_access_denied_detail(err),
- request_id = f'{request_id}'
- )
- else:
- raise main_exceptions.ServerException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- request_id = f'{request_id}'
- )
- if body_type == 'binary':
- resp = {
- 'body': _response.body,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- return resp
- elif body_type == 'byte':
- byt = DaraStream.read_as_bytes(_response.body)
- return {
- 'body': byt,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'string':
- _str = DaraStream.read_as_string(_response.body)
- return {
- 'body': _str,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'json':
- obj = DaraStream.read_as_json(_response.body)
- res = obj
- return {
- 'body': res,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'array':
- arr = DaraStream.read_as_json(_response.body)
- return {
- 'body': arr,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- else:
- return {
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- async def do_roarequest_with_form_async(
- self,
- action: str,
- version: str,
- protocol: str,
- method: str,
- auth_type: str,
- pathname: str,
- body_type: str,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or protocol
- _request.method = method
- _request.pathname = pathname
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.headers = DaraCore.merge({
- 'date': Utils.get_date_utcstring(),
- 'host': self._endpoint,
- 'accept': 'application/json',
- 'x-acs-signature-nonce': Utils.get_nonce(),
- 'x-acs-signature-method': 'HMAC-SHA1',
- 'x-acs-signature-version': '1.0',
- 'x-acs-version': version,
- 'x-acs-action': action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- }, global_headers, extends_headers, request.headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- if not DaraCore.is_null(request.body):
- m = request.body
- _request.body = Utils.to_form(m)
- _request.headers["content-type"] = 'application/x-www-form-urlencoded'
- _request.query = DaraCore.merge({}, global_queries, extends_queries)
- if not DaraCore.is_null(request.query):
- _request.query = DaraCore.merge({}, _request.query, request.query)
- if auth_type != 'Anonymous':
- if DaraCore.is_null(self._credential):
- raise main_exceptions.ClientException(
- code = f'InvalidCredentials',
- message = f'Please set up the credentials correctly. If you are setting them through environment variables, please ensure that ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set correctly. See https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems for more details.'
- )
- credential_model = await self._credential.get_credential_async()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- credential_type = credential_model.type
- if credential_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.headers["x-acs-bearer-token"] = bearer_token
- _request.headers["x-acs-signature-type"] = 'BEARERTOKEN'
- elif credential_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.headers["x-acs-accesskey-id"] = access_key_id
- _request.headers["x-acs-security-token"] = security_token
- string_to_sign = Utils.get_string_to_sign(_request)
- _request.headers["authorization"] = f'acs {access_key_id}:{Utils.get_roasignature(string_to_sign, access_key_secret)}'
- _last_request = _request
- _response = await DaraCore.async_do_action(_request, _runtime)
- _last_response = _response
- if _response.status_code == 204:
- return {
- 'headers': _response.headers
- }
- if (_response.status_code >= 400) and (_response.status_code < 600):
- _res = await DaraStream.read_as_json_async(_response.body)
- err = _res
- request_id = err.get("RequestId") or err.get("requestId")
- code = err.get("Code") or err.get("code")
- if 'Throttling' in f'{code}':
- raise main_exceptions.ThrottlingException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- retry_after = Utils.get_throttling_time_left(_response.headers),
- data = err,
- request_id = f'{request_id}'
- )
- elif (_response.status_code >= 400) and (_response.status_code < 500):
- raise main_exceptions.ClientException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- access_denied_detail = self.get_access_denied_detail(err),
- request_id = f'{request_id}'
- )
- else:
- raise main_exceptions.ServerException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- request_id = f'{request_id}'
- )
- if body_type == 'binary':
- resp = {
- 'body': _response.body,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- return resp
- elif body_type == 'byte':
- byt = await DaraStream.read_as_bytes_async(_response.body)
- return {
- 'body': byt,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'string':
- _str = await DaraStream.read_as_string_async(_response.body)
- return {
- 'body': _str,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'json':
- obj = await DaraStream.read_as_json_async(_response.body)
- res = obj
- return {
- 'body': res,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif body_type == 'array':
- arr = await DaraStream.read_as_json_async(_response.body)
- return {
- 'body': arr,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- else:
- return {
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- """
- * @remarks
- * Encapsulate the request and invoke the network
- *
- * @param action - api name
- * @param version - product version
- * @param protocol - http or https
- * @param method - e.g. GET
- * @param authType - authorization type e.g. AK
- * @param bodyType - response body type e.g. String
- * @param request - object of OpenApiRequest
- * @param runtime - which controls some details of call api, such as retry times
- * @returns the response
- """
- def do_request(
- self,
- params: open_api_util_models.Params,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- protocol = f'{self._protocol or params.protocol or ""}'.lower()
- is_websocket = protocol in ('ws', 'wss')
- ws_handler = None
- if is_websocket:
- websocket_sub_protocol = params.websocket_sub_protocol or ''
- if not websocket_sub_protocol:
- raise main_exceptions.ClientException(
- code='MissingWebSocketSubProtocol',
- message='websocketSubProtocol is required: please set it in params.websocketSubProtocol',
- )
- if websocket_sub_protocol not in (
- websocket_utils.SubProtocolAWAP,
- websocket_utils.SubProtocolGeneral,
- ):
- raise main_exceptions.ClientException(
- code='InvalidWebSocketSubProtocol',
- message=(
- "websocketSubProtocol must be 'awap' or 'general', "
- f'got: {websocket_sub_protocol}'
- ),
- )
- if request.headers is None:
- request.headers = {}
- request.headers['sec-websocket-protocol'] = websocket_sub_protocol
- ws_handler = runtime.web_socket_handler
- if ws_handler is None:
- raise main_exceptions.ClientException(
- code='MissingWebSocketHandler',
- message='WebSocketHandler is required: please set it in runtime.webSocketHandler',
- )
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- if is_websocket:
- _runtime.update({
- 'webSocketPingInterval': get_web_socket_ping_interval(runtime),
- 'webSocketPongTimeout': get_web_socket_pong_timeout(runtime),
- 'webSocketEnableReconnect': get_web_socket_enable_reconnect(runtime),
- 'webSocketReconnectInterval': get_web_socket_reconnect_interval(runtime),
- 'webSocketMaxReconnectTimes': get_web_socket_max_reconnect_times(runtime),
- 'webSocketWriteTimeout': get_web_socket_write_timeout(runtime),
- 'webSocketHandshakeTimeout': get_web_socket_handshake_timeout(runtime),
- 'webSocketHandler': ws_handler,
- })
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or params.protocol
- _request.method = params.method
- _request.pathname = params.pathname
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.query = DaraCore.merge({}, global_queries, extends_queries, request.query)
- # endpoint is setted in product client
- _request.headers = DaraCore.merge({
- 'host': self._endpoint,
- 'x-acs-version': params.version,
- 'x-acs-action': params.action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- 'x-acs-date': Utils.get_timestamp(),
- 'x-acs-signature-nonce': Utils.get_nonce(),
- 'accept': 'application/json',
- }, global_headers, extends_headers, request.headers)
- if params.style == 'RPC':
- headers = self.get_rpc_headers()
- if not DaraCore.is_null(headers):
- _request.headers = DaraCore.merge({}, _request.headers, headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- signature_algorithm = self._signature_algorithm or 'ACS3-HMAC-SHA256'
- hashed_request_payload = Utils.hash(DaraBytes.from_('', 'utf-8'), signature_algorithm)
- if not DaraCore.is_null(request.stream):
- tmp = DaraStream.read_as_bytes(request.stream)
- hashed_request_payload = Utils.hash(tmp, signature_algorithm)
- _request.body = tmp
- _request.headers["content-type"] = 'application/octet-stream'
- else:
- if not DaraCore.is_null(request.body):
- if params.req_body_type == 'byte':
- byte_obj = bytes(request.body)
- hashed_request_payload = Utils.hash(byte_obj, signature_algorithm)
- _request.body = byte_obj
- elif params.req_body_type == 'json':
- json_obj = DaraCore.to_json_string(request.body)
- hashed_request_payload = Utils.hash(json_obj.encode('utf-8'), signature_algorithm)
- _request.body = json_obj
- _request.headers["content-type"] = 'application/json; charset=utf-8'
- else:
- m = request.body
- form_obj = Utils.to_form(m)
- hashed_request_payload = Utils.hash(form_obj.encode('utf-8'), signature_algorithm)
- _request.body = form_obj
- _request.headers["content-type"] = 'application/x-www-form-urlencoded'
- _request.headers["x-acs-content-sha256"] = hashed_request_payload.hex()
- if params.auth_type != 'Anonymous':
- if DaraCore.is_null(self._credential):
- raise main_exceptions.ClientException(
- code = f'InvalidCredentials',
- message = f'Please set up the credentials correctly. If you are setting them through environment variables, please ensure that ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set correctly. See https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems for more details.'
- )
- credential_model = self._credential.get_credential()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- auth_type = credential_model.type
- if auth_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.headers["x-acs-bearer-token"] = bearer_token
- if params.style == 'RPC':
- _request.query["SignatureType"] = 'BEARERTOKEN'
- else:
- _request.headers["x-acs-signature-type"] = 'BEARERTOKEN'
- elif auth_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.headers["x-acs-accesskey-id"] = access_key_id
- _request.headers["x-acs-security-token"] = security_token
- _request.headers["Authorization"] = Utils.get_authorization(_request, signature_algorithm, hashed_request_payload.hex(), access_key_id, access_key_secret)
- else:
- if params.style == 'RPC':
- _request.query["Format"] = 'json'
- _last_request = _request
- if is_websocket:
- stream_handler = websocket_utils.StreamHandler(
- ws_handler,
- websocket_sub_protocol,
- )
- _runtime['webSocketHandler'] = stream_handler
- ws_client, response_ = new_websocket_client_and_connect(_request, _runtime)
- ws_client_obj = websocket_utils.new_websocket_client(ws_client, response_)
- stream_handler.client = ws_client_obj
- return {
- 'webSocketClient': ws_client_obj,
- }
- _response = DaraCore.do_action(_request, _runtime)
- _last_response = _response
- if (_response.status_code >= 400) and (_response.status_code < 600):
- err = {}
- if not DaraCore.is_null(_response.headers.get("content-type")) and _response.headers.get("content-type") == 'text/xml;charset=utf-8':
- _str = DaraStream.read_as_string(_response.body)
- resp_map = DaraXML.parse_xml(_str, None)
- err = resp_map.get("Error")
- else:
- _res = DaraStream.read_as_json(_response.body)
- err = _res
- request_id = err.get("RequestId") or err.get("requestId")
- code = err.get("Code") or err.get("code")
- if 'Throttling' in f'{code}':
- raise main_exceptions.ThrottlingException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- retry_after = Utils.get_throttling_time_left(_response.headers),
- data = err,
- request_id = f'{request_id}'
- )
- elif (_response.status_code >= 400) and (_response.status_code < 500):
- raise main_exceptions.ClientException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- access_denied_detail = self.get_access_denied_detail(err),
- request_id = f'{request_id}'
- )
- else:
- raise main_exceptions.ServerException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- request_id = f'{request_id}'
- )
- if params.body_type == 'binary':
- resp = {
- 'body': _response.body,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- return resp
- elif params.body_type == 'byte':
- byt = DaraStream.read_as_bytes(_response.body)
- return {
- 'body': byt,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif params.body_type == 'string':
- resp_str = DaraStream.read_as_string(_response.body)
- return {
- 'body': resp_str,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif params.body_type == 'json':
- obj = DaraStream.read_as_json(_response.body)
- res = obj
- return {
- 'body': res,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif params.body_type == 'array':
- arr = DaraStream.read_as_json(_response.body)
- return {
- 'body': arr,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- else:
- anything = DaraStream.read_as_string(_response.body)
- return {
- 'body': anything,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- async def do_request_async(
- self,
- params: open_api_util_models.Params,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or params.protocol
- _request.method = params.method
- _request.pathname = params.pathname
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.query = DaraCore.merge({}, global_queries, extends_queries, request.query)
- # endpoint is setted in product client
- _request.headers = DaraCore.merge({
- 'host': self._endpoint,
- 'x-acs-version': params.version,
- 'x-acs-action': params.action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- 'x-acs-date': Utils.get_timestamp(),
- 'x-acs-signature-nonce': Utils.get_nonce(),
- 'accept': 'application/json',
- }, global_headers, extends_headers, request.headers)
- if params.style == 'RPC':
- headers = self.get_rpc_headers()
- if not DaraCore.is_null(headers):
- _request.headers = DaraCore.merge({}, _request.headers, headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- signature_algorithm = self._signature_algorithm or 'ACS3-HMAC-SHA256'
- hashed_request_payload = Utils.hash(DaraBytes.from_('', 'utf-8'), signature_algorithm)
- if not DaraCore.is_null(request.stream):
- tmp = await DaraStream.read_as_bytes_async(request.stream)
- hashed_request_payload = Utils.hash(tmp, signature_algorithm)
- _request.body = tmp
- _request.headers["content-type"] = 'application/octet-stream'
- else:
- if not DaraCore.is_null(request.body):
- if params.req_body_type == 'byte':
- byte_obj = bytes(request.body)
- hashed_request_payload = Utils.hash(byte_obj, signature_algorithm)
- _request.body = byte_obj
- elif params.req_body_type == 'json':
- json_obj = DaraCore.to_json_string(request.body)
- hashed_request_payload = Utils.hash(json_obj.encode('utf-8'), signature_algorithm)
- _request.body = json_obj
- _request.headers["content-type"] = 'application/json; charset=utf-8'
- else:
- m = request.body
- form_obj = Utils.to_form(m)
- hashed_request_payload = Utils.hash(form_obj.encode('utf-8'), signature_algorithm)
- _request.body = form_obj
- _request.headers["content-type"] = 'application/x-www-form-urlencoded'
- _request.headers["x-acs-content-sha256"] = hashed_request_payload.hex()
- if params.auth_type != 'Anonymous':
- if DaraCore.is_null(self._credential):
- raise main_exceptions.ClientException(
- code = f'InvalidCredentials',
- message = f'Please set up the credentials correctly. If you are setting them through environment variables, please ensure that ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set correctly. See https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems for more details.'
- )
- credential_model = await self._credential.get_credential_async()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- auth_type = credential_model.type
- if auth_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.headers["x-acs-bearer-token"] = bearer_token
- if params.style == 'RPC':
- _request.query["SignatureType"] = 'BEARERTOKEN'
- else:
- _request.headers["x-acs-signature-type"] = 'BEARERTOKEN'
- elif auth_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.headers["x-acs-accesskey-id"] = access_key_id
- _request.headers["x-acs-security-token"] = security_token
- _request.headers["Authorization"] = Utils.get_authorization(_request, signature_algorithm, hashed_request_payload.hex(), access_key_id, access_key_secret)
- else:
- if params.style == 'RPC':
- _request.query["Format"] = 'json'
- _last_request = _request
- _response = await DaraCore.async_do_action(_request, _runtime)
- _last_response = _response
- if (_response.status_code >= 400) and (_response.status_code < 600):
- err = {}
- if not DaraCore.is_null(_response.headers.get("content-type")) and _response.headers.get("content-type") == 'text/xml;charset=utf-8':
- _str = await DaraStream.read_as_string_async(_response.body)
- resp_map = DaraXML.parse_xml(_str, None)
- err = resp_map.get("Error")
- else:
- _res = await DaraStream.read_as_json_async(_response.body)
- err = _res
- request_id = err.get("RequestId") or err.get("requestId")
- code = err.get("Code") or err.get("code")
- if 'Throttling' in f'{code}':
- raise main_exceptions.ThrottlingException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- retry_after = Utils.get_throttling_time_left(_response.headers),
- data = err,
- request_id = f'{request_id}'
- )
- elif (_response.status_code >= 400) and (_response.status_code < 500):
- raise main_exceptions.ClientException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- access_denied_detail = self.get_access_denied_detail(err),
- request_id = f'{request_id}'
- )
- else:
- raise main_exceptions.ServerException(
- status_code = _response.status_code,
- code = f'{code}',
- message = f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {request_id}',
- detail = f'{err.get("Detail") or err.get("detail")}',
- description = f'{err.get("Description") or err.get("description")}',
- data = err,
- request_id = f'{request_id}'
- )
- if params.body_type == 'binary':
- resp = {
- 'body': _response.body,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- return resp
- elif params.body_type == 'byte':
- byt = await DaraStream.read_as_bytes_async(_response.body)
- return {
- 'body': byt,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif params.body_type == 'string':
- resp_str = await DaraStream.read_as_string_async(_response.body)
- return {
- 'body': resp_str,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif params.body_type == 'json':
- obj = await DaraStream.read_as_json_async(_response.body)
- res = obj
- return {
- 'body': res,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- elif params.body_type == 'array':
- arr = await DaraStream.read_as_json_async(_response.body)
- return {
- 'body': arr,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- else:
- anything = await DaraStream.read_as_string_async(_response.body)
- return {
- 'body': anything,
- 'headers': _response.headers,
- 'statusCode': _response.status_code
- }
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- """
- * @remarks
- * Encapsulate the request and invoke the network
- *
- * @param action - api name
- * @param version - product version
- * @param protocol - http or https
- * @param method - e.g. GET
- * @param authType - authorization type e.g. AK
- * @param bodyType - response body type e.g. String
- * @param request - object of OpenApiRequest
- * @param runtime - which controls some details of call api, such as retry times
- * @returns the response
- """
- def execute(
- self,
- params: open_api_util_models.Params,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- 'disableHttp2': bool(self._disable_http_2 or False),
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- # spi = new Gateway();//Gateway implements SPI,这一步在产品 SDK 中实例化
- headers = self.get_rpc_headers()
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- request_context = spi_models.InterceptorContextRequest(
- headers = DaraCore.merge({}, global_headers, extends_headers, request.headers, headers),
- query = DaraCore.merge({}, global_queries, extends_queries, request.query),
- body = request.body,
- stream = request.stream,
- host_map = request.host_map,
- pathname = params.pathname,
- product_id = self._product_id,
- action = params.action,
- version = params.version,
- protocol = self._protocol or params.protocol,
- method = self._method or params.method,
- auth_type = params.auth_type,
- body_type = params.body_type,
- req_body_type = params.req_body_type,
- style = params.style,
- credential = self._credential,
- signature_version = self._signature_version,
- signature_algorithm = self._signature_algorithm,
- user_agent = Utils.get_user_agent(self._user_agent)
- )
- configuration_context = spi_models.InterceptorContextConfiguration(
- region_id = self._region_id,
- endpoint = request.endpoint_override or self._endpoint,
- endpoint_rule = self._endpoint_rule,
- endpoint_map = self._endpoint_map,
- endpoint_type = self._endpoint_type,
- network = self._network,
- suffix = self._suffix
- )
- interceptor_context = spi_models.InterceptorContext(
- request = request_context,
- configuration = configuration_context
- )
- attribute_map = spi_models.AttributeMap()
- if not DaraCore.is_null(self._attribute_map):
- attribute_map = self._attribute_map
- # 1. spi.modifyConfiguration(context: SPI.InterceptorContext, attributeMap: SPI.AttributeMap);
- self._spi.modify_configuration(interceptor_context, attribute_map)
- # 2. spi.modifyRequest(context: SPI.InterceptorContext, attributeMap: SPI.AttributeMap);
- self._spi.modify_request(interceptor_context, attribute_map)
- _request.protocol = interceptor_context.request.protocol
- _request.method = interceptor_context.request.method
- _request.pathname = interceptor_context.request.pathname
- _request.query = interceptor_context.request.query
- _request.body = interceptor_context.request.stream
- _request.headers = interceptor_context.request.headers
- _last_request = _request
- _response = DaraCore.do_action(_request, _runtime)
- _last_response = _response
- response_context = spi_models.InterceptorContextResponse(
- status_code = _response.status_code,
- headers = _response.headers,
- body = _response.body
- )
- interceptor_context.response = response_context
- # 3. spi.modifyResponse(context: SPI.InterceptorContext, attributeMap: SPI.AttributeMap);
- self._spi.modify_response(interceptor_context, attribute_map)
- resp = {
- 'headers': interceptor_context.response.headers,
- 'statusCode': interceptor_context.response.status_code,
- 'body': interceptor_context.response.deserialized_body
- }
- return resp
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- async def execute_async(
- self,
- params: open_api_util_models.Params,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- 'disableHttp2': bool(self._disable_http_2 or False),
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- # spi = new Gateway();//Gateway implements SPI,这一步在产品 SDK 中实例化
- headers = self.get_rpc_headers()
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- request_context = spi_models.InterceptorContextRequest(
- headers = DaraCore.merge({}, global_headers, extends_headers, request.headers, headers),
- query = DaraCore.merge({}, global_queries, extends_queries, request.query),
- body = request.body,
- stream = request.stream,
- host_map = request.host_map,
- pathname = params.pathname,
- product_id = self._product_id,
- action = params.action,
- version = params.version,
- protocol = self._protocol or params.protocol,
- method = self._method or params.method,
- auth_type = params.auth_type,
- body_type = params.body_type,
- req_body_type = params.req_body_type,
- style = params.style,
- credential = self._credential,
- signature_version = self._signature_version,
- signature_algorithm = self._signature_algorithm,
- user_agent = Utils.get_user_agent(self._user_agent)
- )
- configuration_context = spi_models.InterceptorContextConfiguration(
- region_id = self._region_id,
- endpoint = request.endpoint_override or self._endpoint,
- endpoint_rule = self._endpoint_rule,
- endpoint_map = self._endpoint_map,
- endpoint_type = self._endpoint_type,
- network = self._network,
- suffix = self._suffix
- )
- interceptor_context = spi_models.InterceptorContext(
- request = request_context,
- configuration = configuration_context
- )
- attribute_map = spi_models.AttributeMap()
- if not DaraCore.is_null(self._attribute_map):
- attribute_map = self._attribute_map
- # 1. spi.modifyConfiguration(context: SPI.InterceptorContext, attributeMap: SPI.AttributeMap);
- await self._spi.modify_configuration_async(interceptor_context, attribute_map)
- # 2. spi.modifyRequest(context: SPI.InterceptorContext, attributeMap: SPI.AttributeMap);
- await self._spi.modify_request_async(interceptor_context, attribute_map)
- _request.protocol = interceptor_context.request.protocol
- _request.method = interceptor_context.request.method
- _request.pathname = interceptor_context.request.pathname
- _request.query = interceptor_context.request.query
- _request.body = interceptor_context.request.stream
- _request.headers = interceptor_context.request.headers
- _last_request = _request
- _response = await DaraCore.async_do_action(_request, _runtime)
- _last_response = _response
- response_context = spi_models.InterceptorContextResponse(
- status_code = _response.status_code,
- headers = _response.headers,
- body = _response.body
- )
- interceptor_context.response = response_context
- # 3. spi.modifyResponse(context: SPI.InterceptorContext, attributeMap: SPI.AttributeMap);
- await self._spi.modify_response_async(interceptor_context, attribute_map)
- resp = {
- 'headers': interceptor_context.response.headers,
- 'statusCode': interceptor_context.response.status_code,
- 'body': interceptor_context.response.deserialized_body
- }
- return resp
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- def call_sseapi(
- self,
- params: open_api_util_models.Params,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> Generator[main_models.SSEResponse, None, None]:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or params.protocol
- _request.method = params.method
- _request.pathname = params.pathname
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.query = DaraCore.merge({}, global_queries, extends_queries, request.query)
- # endpoint is setted in product client
- _request.headers = DaraCore.merge({
- 'host': self._endpoint,
- 'x-acs-version': params.version,
- 'x-acs-action': params.action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- 'x-acs-date': Utils.get_timestamp(),
- 'x-acs-signature-nonce': Utils.get_nonce(),
- 'accept': 'application/json',
- }, extends_headers, global_headers, request.headers)
- if params.style == 'RPC':
- headers = self.get_rpc_headers()
- if not DaraCore.is_null(headers):
- _request.headers = DaraCore.merge({}, _request.headers, headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- signature_algorithm = self._signature_algorithm or 'ACS3-HMAC-SHA256'
- hashed_request_payload = Utils.hash(DaraBytes.from_('', 'utf-8'), signature_algorithm)
- if not DaraCore.is_null(request.stream):
- tmp = DaraStream.read_as_bytes(request.stream)
- hashed_request_payload = Utils.hash(tmp, signature_algorithm)
- _request.body = tmp
- _request.headers["content-type"] = 'application/octet-stream'
- else:
- if not DaraCore.is_null(request.body):
- if params.req_body_type == 'byte':
- byte_obj = bytes(request.body)
- hashed_request_payload = Utils.hash(byte_obj, signature_algorithm)
- _request.body = byte_obj
- elif params.req_body_type == 'json':
- json_obj = DaraCore.to_json_string(request.body)
- hashed_request_payload = Utils.hash(json_obj.encode('utf-8'), signature_algorithm)
- _request.body = json_obj
- _request.headers["content-type"] = 'application/json; charset=utf-8'
- else:
- m = request.body
- form_obj = Utils.to_form(m)
- hashed_request_payload = Utils.hash(form_obj.encode('utf-8'), signature_algorithm)
- _request.body = form_obj
- _request.headers["content-type"] = 'application/x-www-form-urlencoded'
- _request.headers["x-acs-content-sha256"] = hashed_request_payload.hex()
- if params.auth_type != 'Anonymous':
- credential_model = self._credential.get_credential()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- auth_type = credential_model.type
- if auth_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.headers["x-acs-bearer-token"] = bearer_token
- elif auth_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.headers["x-acs-accesskey-id"] = access_key_id
- _request.headers["x-acs-security-token"] = security_token
- _request.headers["Authorization"] = Utils.get_authorization(_request, signature_algorithm, hashed_request_payload.hex(), access_key_id, access_key_secret)
- _last_request = _request
- _response = DaraCore.do_sse_action(_request, _runtime)
- _last_response = _response
- if (_response.status_code >= 400) and (_response.status_code < 600):
- err = {}
- if not DaraCore.is_null(_response.headers.get("content-type")) and _response.headers.get("content-type") == 'text/xml;charset=utf-8':
- _str = DaraStream.read_as_string(_response.body)
- resp_map = DaraXML.parse_xml(_str, None)
- err = resp_map.get("Error")
- else:
- _res = DaraStream.read_as_json(_response.body)
- err = _res
- err["statusCode"] = _response.status_code
- raise DaraException({
- 'code': f'{err.get("Code") or err.get("code")}',
- 'message': f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {err.get("RequestId") or err.get("requestId")}',
- 'data': err,
- 'detail': f'{err.get("Detail") or err.get("detail")}',
- 'description': f'{err.get("Description") or err.get("description")}',
- 'accessDeniedDetail': err.get("AccessDeniedDetail") or err.get("accessDeniedDetail")
- })
- events = DaraStream.read_as_sse(_response.body)
- for event in events:
- yield main_models.SSEResponse(
- status_code = _response.status_code,
- headers = _response.headers,
- event = event
- )
- return
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- async def call_sseapi_async(
- self,
- params: open_api_util_models.Params,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> AsyncGenerator[main_models.SSEResponse, None, None]:
- _runtime = {
- 'key': runtime.key or self._key,
- 'cert': runtime.cert or self._cert,
- 'ca': runtime.ca or self._ca,
- 'readTimeout': DaraCore.to_number(runtime.read_timeout or self._read_timeout),
- 'connectTimeout': DaraCore.to_number(runtime.connect_timeout or self._connect_timeout),
- 'httpProxy': runtime.http_proxy or self._http_proxy,
- 'httpsProxy': runtime.https_proxy or self._https_proxy,
- 'noProxy': runtime.no_proxy or self._no_proxy,
- 'socks5Proxy': runtime.socks_5proxy or self._socks_5proxy,
- 'socks5NetWork': runtime.socks_5net_work or self._socks_5net_work,
- 'maxIdleConns': DaraCore.to_number(runtime.max_idle_conns or self._max_idle_conns),
- 'retryOptions': self._retry_options,
- 'ignoreSSL': runtime.ignore_ssl,
- 'tlsMinVersion': self._tls_min_version,
- }
- _last_request = None
- _last_response = None
- _retries_attempted = 0
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted
- )
- while DaraCore.should_retry(_runtime.get('retryOptions'), _context):
- _backoff_time = 0
- if _retries_attempted > 0:
- _backoff_time = DaraCore.get_backoff_time(_runtime.get('retryOptions'), _context)
- if _backoff_time > 0:
- DaraCore.sleep(_backoff_time)
- _retry_attempts = _retries_attempted
- _retries_attempted = _retries_attempted + 1
- try:
- _request = DaraRequest()
- _request.protocol = self._protocol or params.protocol
- _request.method = params.method
- _request.pathname = params.pathname
- global_queries = {}
- global_headers = {}
- if not DaraCore.is_null(self._global_parameters):
- global_params = self._global_parameters
- if not DaraCore.is_null(global_params.queries):
- global_queries = global_params.queries
- if not DaraCore.is_null(global_params.headers):
- global_headers = global_params.headers
- extends_headers = {}
- extends_queries = {}
- if not DaraCore.is_null(runtime.extends_parameters):
- extends_parameters = runtime.extends_parameters
- if not DaraCore.is_null(extends_parameters.headers):
- extends_headers = extends_parameters.headers
- if not DaraCore.is_null(extends_parameters.queries):
- extends_queries = extends_parameters.queries
- _request.query = DaraCore.merge({}, global_queries, extends_queries, request.query)
- # endpoint is setted in product client
- _request.headers = DaraCore.merge({
- 'host': self._endpoint,
- 'x-acs-version': params.version,
- 'x-acs-action': params.action,
- 'user-agent': Utils.get_user_agent(self._user_agent),
- 'x-acs-date': Utils.get_timestamp(),
- 'x-acs-signature-nonce': Utils.get_nonce(),
- 'accept': 'application/json',
- }, extends_headers, global_headers, request.headers)
- if params.style == 'RPC':
- headers = self.get_rpc_headers()
- if not DaraCore.is_null(headers):
- _request.headers = DaraCore.merge({}, _request.headers, headers)
- Utils.apply_retry_headers(_request.headers, _retry_attempts, _backoff_time)
- signature_algorithm = self._signature_algorithm or 'ACS3-HMAC-SHA256'
- hashed_request_payload = Utils.hash(DaraBytes.from_('', 'utf-8'), signature_algorithm)
- if not DaraCore.is_null(request.stream):
- tmp = await DaraStream.read_as_bytes_async(request.stream)
- hashed_request_payload = Utils.hash(tmp, signature_algorithm)
- _request.body = tmp
- _request.headers["content-type"] = 'application/octet-stream'
- else:
- if not DaraCore.is_null(request.body):
- if params.req_body_type == 'byte':
- byte_obj = bytes(request.body)
- hashed_request_payload = Utils.hash(byte_obj, signature_algorithm)
- _request.body = byte_obj
- elif params.req_body_type == 'json':
- json_obj = DaraCore.to_json_string(request.body)
- hashed_request_payload = Utils.hash(json_obj.encode('utf-8'), signature_algorithm)
- _request.body = json_obj
- _request.headers["content-type"] = 'application/json; charset=utf-8'
- else:
- m = request.body
- form_obj = Utils.to_form(m)
- hashed_request_payload = Utils.hash(form_obj.encode('utf-8'), signature_algorithm)
- _request.body = form_obj
- _request.headers["content-type"] = 'application/x-www-form-urlencoded'
- _request.headers["x-acs-content-sha256"] = hashed_request_payload.hex()
- if params.auth_type != 'Anonymous':
- credential_model = await self._credential.get_credential_async()
- if not DaraCore.is_null(credential_model.provider_name):
- _request.headers["x-acs-credentials-provider"] = credential_model.provider_name
- auth_type = credential_model.type
- if auth_type == 'bearer':
- bearer_token = credential_model.bearer_token
- _request.headers["x-acs-bearer-token"] = bearer_token
- elif auth_type == 'id_token':
- id_token = credential_model.security_token
- _request.headers["x-acs-zero-trust-idtoken"] = id_token
- else:
- access_key_id = credential_model.access_key_id
- access_key_secret = credential_model.access_key_secret
- security_token = credential_model.security_token
- if not DaraCore.is_null(security_token) and security_token != '':
- _request.headers["x-acs-accesskey-id"] = access_key_id
- _request.headers["x-acs-security-token"] = security_token
- _request.headers["Authorization"] = Utils.get_authorization(_request, signature_algorithm, hashed_request_payload.hex(), access_key_id, access_key_secret)
- _last_request = _request
- _response = await DaraCore.async_do_sse_action(_request, _runtime)
- _last_response = _response
- if (_response.status_code >= 400) and (_response.status_code < 600):
- err = {}
- if not DaraCore.is_null(_response.headers.get("content-type")) and _response.headers.get("content-type") == 'text/xml;charset=utf-8':
- _str = await DaraStream.read_as_string_async(_response.body)
- resp_map = DaraXML.parse_xml(_str, None)
- err = resp_map.get("Error")
- else:
- _res = await DaraStream.read_as_json_async(_response.body)
- err = _res
- err["statusCode"] = _response.status_code
- raise DaraException({
- 'code': f'{err.get("Code") or err.get("code")}',
- 'message': f'code: {_response.status_code}, {err.get("Message") or err.get("message")} request id: {err.get("RequestId") or err.get("requestId")}',
- 'data': err,
- 'detail': f'{err.get("Detail") or err.get("detail")}',
- 'description': f'{err.get("Description") or err.get("description")}',
- 'accessDeniedDetail': err.get("AccessDeniedDetail") or err.get("accessDeniedDetail")
- })
- events = DaraStream.read_as_sse_async(_response.body)
- async for event in events:
- yield main_models.SSEResponse(
- status_code = _response.status_code,
- headers = _response.headers,
- event = event
- )
- return
- except Exception as e:
- _context = RetryPolicyContext(
- retries_attempted= _retries_attempted,
- http_request = _last_request,
- http_response = _last_response,
- exception = e
- )
- continue
- raise UnretryableException(_context)
- def call_api(
- self,
- params: open_api_util_models.Params,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- if DaraCore.is_null(params):
- raise main_exceptions.ClientException(
- code = 'ParameterMissing',
- message = '\'params\' can not be unset'
- )
- if DaraCore.is_null(self._signature_version) or self._signature_version != 'v4':
- if DaraCore.is_null(self._signature_algorithm) or self._signature_algorithm != 'v2':
- return self.do_request(params, request, runtime)
- elif (params.style == 'ROA') and (params.req_body_type == 'json'):
- return self.do_roarequest(params.action, params.version, params.protocol, params.method, params.auth_type, params.pathname, params.body_type, request, runtime)
- elif params.style == 'ROA':
- return self.do_roarequest_with_form(params.action, params.version, params.protocol, params.method, params.auth_type, params.pathname, params.body_type, request, runtime)
- else:
- return self.do_rpcrequest(params.action, params.version, params.protocol, params.method, params.auth_type, params.body_type, request, runtime)
- else:
- return self.execute(params, request, runtime)
- async def call_api_async(
- self,
- params: open_api_util_models.Params,
- request: open_api_util_models.OpenApiRequest,
- runtime: RuntimeOptions,
- ) -> dict:
- if DaraCore.is_null(params):
- raise main_exceptions.ClientException(
- code = 'ParameterMissing',
- message = '\'params\' can not be unset'
- )
- if DaraCore.is_null(self._signature_version) or self._signature_version != 'v4':
- if DaraCore.is_null(self._signature_algorithm) or self._signature_algorithm != 'v2':
- return await self.do_request_async(params, request, runtime)
- elif (params.style == 'ROA') and (params.req_body_type == 'json'):
- return await self.do_roarequest_async(params.action, params.version, params.protocol, params.method, params.auth_type, params.pathname, params.body_type, request, runtime)
- elif params.style == 'ROA':
- return await self.do_roarequest_with_form_async(params.action, params.version, params.protocol, params.method, params.auth_type, params.pathname, params.body_type, request, runtime)
- else:
- return await self.do_rpcrequest_async(params.action, params.version, params.protocol, params.method, params.auth_type, params.body_type, request, runtime)
- else:
- return await self.execute_async(params, request, runtime)
- def get_access_key_id(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- access_key_id = self._credential.get_access_key_id()
- return access_key_id
- async def get_access_key_id_async(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- access_key_id = await self._credential.get_access_key_id_async()
- return access_key_id
- def get_access_key_secret(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- secret = self._credential.get_access_key_secret()
- return secret
- async def get_access_key_secret_async(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- secret = await self._credential.get_access_key_secret_async()
- return secret
- def get_security_token(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- token = self._credential.get_security_token()
- return token
- async def get_security_token_async(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- token = await self._credential.get_security_token_async()
- return token
- def get_bearer_token(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- token = self._credential.get_bearer_token()
- return token
- async def get_bearer_token_async(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- token = self._credential.get_bearer_token()
- return token
- def get_type(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- auth_type = self._credential.get_type()
- return auth_type
- async def get_type_async(self) -> str:
- if DaraCore.is_null(self._credential):
- return ''
- auth_type = self._credential.get_type()
- return auth_type
- def check_config(
- self,
- config: open_api_util_models.Config,
- ) -> None:
- if DaraCore.is_null(self._endpoint_rule) and DaraCore.is_null(config.endpoint):
- raise main_exceptions.ClientException(
- code = 'ParameterMissing',
- message = '\'config.endpoint\' can not be empty'
- )
- def set_gateway_client(
- self,
- spi: SPIClient,
- ) -> None:
- self._spi = spi
- def set_rpc_headers(
- self,
- headers: Dict[str, str],
- ) -> None:
- self._headers = headers
- def get_rpc_headers(self) -> Dict[str, str]:
- headers = self._headers
- self._headers = None
- return headers
- def default_any(
- input_value: Any,
- default_value: Any,
- ) -> Any:
- if DaraCore.is_null(input_value):
- return default_value
- return input_value
- def get_access_denied_detail(
- self,
- err: Dict[str, Any],
- ) -> Dict[str, Any]:
- access_denied_detail = None
- if not DaraCore.is_null(err.get("AccessDeniedDetail")):
- detail_1 = err.get("AccessDeniedDetail")
- access_denied_detail = detail_1
- elif not DaraCore.is_null(err.get("accessDeniedDetail")):
- detail_2 = err.get("accessDeniedDetail")
- access_denied_detail = detail_2
- return access_denied_detail
|