{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dms-dg/add-database":{"post":{"operationId":"cloud_aliyun_dms_dg_add_database","summary":"Use this API to connect databases on other clouds or on-premises to Alibaba Cloud","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayId","Host","Port","RegionId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The ID of the gateway"},"Host":{"type":"string","description":"The database endpoint, as accessible from the gateway"},"Port":{"type":"integer","description":"The database port, as accessible from the gateway"},"DbType":{"type":"string","description":"The database type"},"DbUserName":{"type":"string","description":"The database username"},"DbPassword":{"type":"string","description":"The database password. This password is used only to verify the connection and is not used for other operations"},"DbDescription":{"type":"string","description":"A description of the database"},"RegionId":{"type":"string","description":"The region where the database is located"},"DbName":{"type":"string","description":"The database name"},"ClientToken":{"type":"string","description":"A client-generated token that ensures request idempotence. This token must be unique for each request, be case-sensitive, and have a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/add-database-list":{"post":{"operationId":"cloud_aliyun_dms_dg_add_database_list","summary":"Adds multiple databases to a gateway in a batch operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DatabaseString"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"DatabaseString":{"type":"string","description":"A JSON string that contains information about the databases to add"},"ClientToken":{"type":"string","description":"A unique, client-generated token that ensures request idempotency. The token is case-sensitive and can be up to 64 ASCII characters long"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/check-dgenabled":{"post":{"operationId":"cloud_aliyun_dms_dg_check_dgenabled","summary":"Checks if Database Gateway (DG) is enabled","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/connect-database":{"post":{"operationId":"cloud_aliyun_dms_dg_connect_database","summary":"Call this API to test database connectivity","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayId","Host","Port"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The gateway ID"},"Host":{"type":"string","description":"The address used to access the database via the gateway host"},"Port":{"type":"integer","description":"The port used to access the database via the gateway host"},"DbType":{"type":"string","description":"The database type"},"DbUserName":{"type":"string","description":"The database username"},"DbPassword":{"type":"string","description":"The database password"},"DbName":{"type":"string","description":"The database name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/create-gateway":{"post":{"operationId":"cloud_aliyun_dms_dg_create_gateway","summary":"Creates a new database gateway","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayName"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayName":{"type":"string","description":"The name of the database gateway"},"GatewayDesc":{"type":"string","description":"The description of the database gateway"},"RegionId":{"type":"string","description":"The region where the database gateway is created"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/create-gateway-verify-code":{"post":{"operationId":"cloud_aliyun_dms_dg_create_gateway_verify_code","summary":"Generates a verification code to link an on-premises Database Gateway installation to its corresponding…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The gateway ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/delete-database":{"post":{"operationId":"cloud_aliyun_dms_dg_delete_database","summary":"Deletes a database from a database gateway","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"InstanceId":{"type":"string","description":"The ID of the database instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/delete-gateway":{"post":{"operationId":"cloud_aliyun_dms_dg_delete_gateway","summary":"Deletes the specified gateway","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The gateway ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/delete-gateway-instance":{"post":{"operationId":"cloud_aliyun_dms_dg_delete_gateway_instance","summary":"Deletes the specified database gateway instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayId","GatewayInstanceId","RegionId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The ID of the gateway"},"GatewayInstanceId":{"type":"string","description":"The ID of the gateway instance"},"RegionId":{"type":"string","description":"The region where the gateway is located"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/describe-regions":{"post":{"operationId":"cloud_aliyun_dms_dg_describe_regions","summary":"Queries the regions where you can create database gateways","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/download-gateway-program":{"post":{"operationId":"cloud_aliyun_dms_dg_download_gateway_program","summary":"Retrieves the download URL for the gateway program. Any Alibaba Cloud user can call this operation without…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"UserOS":{"type":"string","description":"The operating system of the gateway"},"DgVersion":{"type":"string","description":"The DG version"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/find-user-gateway-by-id":{"post":{"operationId":"cloud_aliyun_dms_dg_find_user_gateway_by_id","summary":"Retrieves the details of a gateway, including the user who created it and the number of running gateway…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The ID of the gateway"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/get-user-databases":{"post":{"operationId":"cloud_aliyun_dms_dg_get_user_databases","summary":"This API lists the databases in a specified gateway","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The ID of the gateway"},"PageSize":{"type":"string","description":"The number of entries to return on each page"},"PageNumber":{"type":"string","description":"The page number to return"},"SearchKey":{"type":"string","description":"The keyword for the search"},"DbType":{"type":"string","description":"The database type"},"InstanceId":{"type":"string","description":"The ID of the database instance"},"RegionId":{"type":"string","description":"The region of the gateway"},"Host":{"type":"string","description":"The host address of the database that the gateway can access"},"Port":{"type":"integer","description":"The database port that the gateway can access"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/get-user-gateway-instances":{"post":{"operationId":"cloud_aliyun_dms_dg_get_user_gateway_instances","summary":"Call this API to get the details of the gateway node","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The ID of the gateway"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/get-user-gateways":{"post":{"operationId":"cloud_aliyun_dms_dg_get_user_gateways","summary":"Retrieves a list of user-created Database Gateways","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"PageSize":{"type":"integer","description":"The number of entries per page"},"PageNumber":{"type":"integer","description":"The page number to retrieve"},"SearchKey":{"type":"string","description":"The keyword to search for gateways"},"RegionId":{"type":"string","description":"The ID of the region where the gateway is located"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/list-database-access-point":{"post":{"operationId":"cloud_aliyun_dms_dg_list_database_access_point","summary":"Gets a list of database access points","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The gateway ID"},"PageSize":{"type":"string","description":"The number of entries per page"},"PageNumber":{"type":"string","description":"The page number to return"},"SearchKey":{"type":"string","description":"The search keyword"},"DbInstanceId":{"type":"string","description":"The database instance ID"},"RegionId":{"type":"string","description":"The ID of the region where the gateway is located"},"Host":{"type":"string","description":"The host address the gateway uses to connect to the database"},"Port":{"type":"integer","description":"The port the gateway uses to connect to the database"},"VpcId":{"type":"string","description":"The ID of the VPC where the database access point is located"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/modify-database":{"post":{"operationId":"cloud_aliyun_dms_dg_modify_database","summary":"This operation modifies database information, such as its description","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Host","Port","InstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"Host":{"type":"string","description":"The address used to connect to the database from the gateway host"},"Port":{"type":"integer","description":"The port used to connect to the database from the gateway host"},"DbType":{"type":"string","description":"The database type"},"DbUserName":{"type":"string","description":"The username used to connect to the database"},"DbPassword":{"type":"string","description":"The password used to connect to the database"},"DbDescription":{"type":"string","description":"The database description"},"InstanceId":{"type":"string","description":"The database instance ID"},"DbName":{"type":"string","description":"The database name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/modify-gateway":{"post":{"operationId":"cloud_aliyun_dms_dg_modify_gateway","summary":"Call this API to modify the basic information of a gateway, including the gateway name and gateway description","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayName","GatewayId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayName":{"type":"string","description":"The gateway name"},"GatewayDesc":{"type":"string","description":"The gateway description"},"GatewayId":{"type":"string","description":"The gateway ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/retry-database":{"post":{"operationId":"cloud_aliyun_dms_dg_retry_database","summary":"Call this API operation to reconnect a database gateway to a database","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayId","Host","Port","RegionId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The ID of the database gateway"},"Host":{"type":"string","description":"The hostname or IP address of the database"},"Port":{"type":"integer","description":"The port number of the database"},"DbType":{"type":"string","description":"The type of the database"},"DbUserName":{"type":"string","description":"The username used to access the database"},"DbPassword":{"type":"string","description":"The password used to access the database"},"DbDescription":{"type":"string","description":"The description of the database"},"RegionId":{"type":"string","description":"The ID of the region"},"DbName":{"type":"string","description":"The name of the database"},"ClientToken":{"type":"string","description":"A client-generated token to ensure the idempotence of the request. The token must be unique across requests and is case-sensitive. It can…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/stop-gateway":{"post":{"operationId":"cloud_aliyun_dms_dg_stop_gateway","summary":"Stops a gateway","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GatewayId"],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"},"GatewayId":{"type":"string","description":"The ID of the gateway"},"GatewayInstanceId":{"type":"string","description":"The ID of the gateway node instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dms-dg/version":{"post":{"operationId":"cloud_aliyun_dms_dg_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dms-dg.ap-northeast-1.aliyuncs.com","https://dms-dg.ap-southeast-1.aliyuncs.com","https://dms-dg.ap-southeast-3.aliyuncs.com","https://dms-dg.ap-southeast-5.aliyuncs.com","https://dms-dg.cn-beijing.aliyuncs.com","https://dms-dg.cn-chengdu.aliyuncs.com","https://dms-dg.cn-hangzhou.aliyuncs.com","https://dms-dg.cn-hongkong.aliyuncs.com","https://dms-dg.cn-huhehaote.aliyuncs.com","https://dms-dg.cn-qingdao.aliyuncs.com","https://dms-dg.cn-shanghai.aliyuncs.com","https://dms-dg.cn-shenzhen.aliyuncs.com","https://dms-dg.cn-zhangjiakou.aliyuncs.com","https://dms-dg.eu-central-1.aliyuncs.com","https://dms-dg.eu-west-1.aliyuncs.com","https://dms-dg.us-east-1.aliyuncs.com","https://dms-dg.us-west-1.aliyuncs.com"],"default":"https://dms-dg.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dms-dg.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}