'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'dms-dg', 'version' => '2023-09-14', ], 'directories' => [ 'CreateGateway', 'AddDatabase', 'AddDatabaseList', 'CheckDGEnabled', 'ConnectDatabase', 'CreateGatewayVerifyCode', 'DeleteDatabase', 'DeleteGateway', 'DeleteGatewayInstance', 'DescribeRegions', 'DownloadGatewayProgram', 'FindUserGatewayById', 'GetUserDatabases', 'GetUserGatewayInstances', 'GetUserGateways', 'ListDatabaseAccessPoint', 'ModifyDatabase', 'ModifyGateway', 'RetryDatabase', 'StopGateway', ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CreateGateway' => [ 'summary' => 'Creates a database gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197507', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'GatewayName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'GatewayDesc', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'dg-nmz841r7b681****', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'A9A8885B-3626-592E-9149-8D2971A545AD', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"dg-nmz841r7b681****\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"A9A8885B-3626-592E-9149-8D2971A545AD\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateGateway', ], 'AddDatabase' => [ 'summary' => 'Connects a database hosted on a third-party cloud or an on-premises database to Alibaba Cloud.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197520', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-8d9bqu1030m****', ], ], [ 'name' => 'Host', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3306', ], ], [ 'name' => 'DbType', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'MYSQL', ], ], [ 'name' => 'DbUserName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test_usr', ], ], [ 'name' => 'DbPassword', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1234!2#%A***', ], ], [ 'name' => 'DbDescription', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DbName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'SYSTEM_ERR', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'A8B2EED2-70EF-51F1-8820-914F9AC9BAD2', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'DbInstance' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Port' => [ 'title' => '通过网关所在宿主机去访问数据库的端口。', 'description' => '通过网关所在宿主机去访问数据库的端口。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3306', ], 'Host' => [ 'title' => '通过网关所在宿主机去访问数据库的地址。', 'description' => '通过网关所在宿主机去访问数据库的地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1', ], 'GatewayId' => [ 'title' => '网关ID。', 'description' => '数据库所在网关ID。', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'dg-8d9bqu1030mhk0ix', 'pattern' => '', 'default' => '', ], 'DbType' => [ 'title' => '数据库类型。', 'description' => '数据库类型。', 'type' => 'string', 'deprecated' => false, 'required' => false, 'example' => 'MYSQL', 'pattern' => '', 'default' => '', ], 'RegionId' => [ 'title' => '所在的地域编号', 'description' => '所在的地域编号', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'cn-hangzhou', 'pattern' => '', 'default' => '', ], 'ConnectHost' => [ 'title' => '连接使用的主机', 'description' => '连接使用的主机', 'type' => 'string', 'deprecated' => false, 'example' => '10.0.0.1', 'pattern' => '', 'default' => '', ], 'ConnectPort' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '32875', ], 'ServiceType' => [ 'title' => '服务类型', 'description' => '服务类型', 'type' => 'string', 'deprecated' => false, 'example' => 'ECS', 'pattern' => '', 'default' => '', ], 'NetworkType' => [ 'title' => '网络类型', 'description' => '网络类型', 'type' => 'string', 'deprecated' => false, 'example' => 'VPC', 'pattern' => '', 'default' => '', ], 'NodeId' => [ 'title' => '节点的ID', 'description' => '节点的ID', 'type' => 'string', 'deprecated' => false, 'example' => 'dg-node-r0SR-E90lsIRNgj6B_9m', 'pattern' => '', 'default' => '', ], 'InstanceStatus' => [ 'title' => '当前实例的状态', 'description' => '当前实例的状态', 'type' => 'string', 'deprecated' => false, 'example' => 'SUCCESS', 'pattern' => '', 'default' => '', 'enum' => [ 'SUCCESS', 'EXCEPTION', 'INIT', 'DELETED', ], ], 'DbDescription' => [ 'title' => '备注信息', 'description' => '备注信息', 'type' => 'string', 'deprecated' => false, 'example' => 'test', 'pattern' => '', 'default' => '', ], 'InstanceId' => [ 'title' => '数据库实例ID', 'description' => '数据库实例ID', 'type' => 'string', 'deprecated' => false, 'example' => 'dg-db-rgfg9p4586o7y79b', 'pattern' => '', 'default' => '', ], 'GatewayName' => [ 'title' => '网关名称', 'description' => '网关名称', 'type' => 'string', 'deprecated' => false, 'example' => '', 'pattern' => '', 'default' => '', ], 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'deprecated' => false, 'example' => '167xxxxxxxxxx', 'pattern' => '', 'default' => '', ], 'ParentId' => [ 'title' => '归属主账号ID', 'description' => '归属主账号ID', 'type' => 'string', 'deprecated' => false, 'example' => '167xxxxxxxxxx', 'pattern' => '', 'default' => '', ], 'VpcId' => [ 'title' => 'VpcId', 'description' => 'VpcId', 'type' => 'string', 'deprecated' => false, 'example' => 'vpc-xxxxx', 'pattern' => '', 'default' => '', ], 'VpcInstanceId' => [ 'title' => 'VpcInstanceId', 'description' => 'VpcInstanceId', 'type' => 'string', 'deprecated' => false, 'example' => 'i-xxxxxxx', 'pattern' => '', 'default' => '', ], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMsg\\": \\"SYSTEM_ERR\\",\\n \\"RequestId\\": \\"A8B2EED2-70EF-51F1-8820-914F9AC9BAD2\\",\\n \\"Success\\": true,\\n \\"DbInstance\\": {\\n \\"Port\\": 3306,\\n \\"Host\\": \\"127.0.0.1\\",\\n \\"GatewayId\\": \\"dg-8d9bqu1030mhk0ix\\",\\n \\"DbType\\": \\"MYSQL\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ConnectHost\\": \\"10.0.0.1\\",\\n \\"ConnectPort\\": 32875,\\n \\"ServiceType\\": \\"ECS\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"NodeId\\": \\"dg-node-r0SR-E90lsIRNgj6B_9m\\",\\n \\"InstanceStatus\\": \\"SUCCESS\\",\\n \\"DbDescription\\": \\"test\\",\\n \\"InstanceId\\": \\"dg-db-rgfg9p4586o7y79b\\",\\n \\"GatewayName\\": \\"测试\\",\\n \\"UserId\\": \\"167xxxxxxxxxx\\",\\n \\"ParentId\\": \\"167xxxxxxxxxx\\",\\n \\"VpcId\\": \\"vpc-xxxxx\\",\\n \\"VpcInstanceId\\": \\"i-xxxxxxx\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'AddDatabase', ], 'AddDatabaseList' => [ 'summary' => 'Adds multiple databases to a database gateway at a time.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197527', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'DatabaseString', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"host":"127.0.0.1","port":"3306","gatewayId":"dg-xsdasdasdas****"}]', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'ERROR', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '514F794F-7E30-5DAA-97C0-0B0D75DA0259', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"SUCCESS\\",\\n \\"ErrorMsg\\": \\"ERROR\\",\\n \\"RequestId\\": \\"514F794F-7E30-5DAA-97C0-0B0D75DA0259\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'AddDatabaseList', ], 'CheckDGEnabled' => [ 'summary' => 'Queries whether Database Gateway is activated for the current user.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197534', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'true', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '8F29E3E9-2847-53BF-ADF0-130E3CEA5C63', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"true\\",\\n \\"ErrorMsg\\": \\"未开通\\",\\n \\"RequestId\\": \\"8F29E3E9-2847-53BF-ADF0-130E3CEA5C63\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'CheckDGEnabled', ], 'ConnectDatabase' => [ 'summary' => 'Queries whether a database gateway can connect to a database.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197505', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-58c36y906675****', ], ], [ 'name' => 'Host', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3306', ], ], [ 'name' => 'DbType', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'MYSQL', ], ], [ 'name' => 'DbUserName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test_usr'."\n", ], ], [ 'name' => 'DbPassword', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1234!2#%A****'."\n", ], ], [ 'name' => 'DbName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'OK', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'F4EFCDC5-E69C-5A6F-B170-C5379D9D6811', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"OK\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"F4EFCDC5-E69C-5A6F-B170-C5379D9D6811\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'ConnectDatabase', ], 'CreateGatewayVerifyCode' => [ 'summary' => 'Generates a verification code that is required for offline gateway installation. This verification code is associated with a specific gateway that is created on the cloud.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197526', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-8e0j08630s08****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => '0N3ufVIG43RRAs7diEoep6WHVOHPKj3a', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'C9ADD2AA-27E3-5D62-A676-092EDC5303C1', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"0N3ufVIG43RRAs7diEoep6WHVOHPKj3a\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"C9ADD2AA-27E3-5D62-A676-092EDC5303C1\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateGatewayVerifyCode', ], 'DeleteDatabase' => [ 'summary' => 'Deletes a database that is added to a database gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197529', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'db-22h1qa9d452f****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'B9FB545B-03E3-5AE3-9D9E-2FE26EE2C48F', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"SUCCESS\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"B9FB545B-03E3-5AE3-9D9E-2FE26EE2C48F\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'DeleteDatabase', ], 'DeleteGateway' => [ 'summary' => 'Deletes a database gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197522', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '8F29E3E9-2847-53BF-ADF0-130E3CEA5C63', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"SUCCESS\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"8F29E3E9-2847-53BF-ADF0-130E3CEA5C63\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'DeleteGateway', ], 'DeleteGatewayInstance' => [ 'summary' => 'Deletes a database gateway node.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197518', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', ], ], [ 'name' => 'GatewayInstanceId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-node-QeH6VfT8GRnPrYWX****', ], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '8F29E3E9-2847-53BF-ADF0-130E3CEA5C63', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"SUCCESS\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"8F29E3E9-2847-53BF-ADF0-130E3CEA5C63\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'DeleteGatewayInstance', ], 'DescribeRegions' => [ 'summary' => 'Queries the regions in which a database gateway can be created.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197516', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'B0557F7A-62C3-50DC-9E09-77CAE658F776', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Region' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RegionEndpoint' => [ 'description' => '', 'type' => 'string', 'example' => 'dg.cn-hangzhou.aliyuncs.com', ], 'LocalName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'RegionId' => [ 'description' => '', 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"B0557F7A-62C3-50DC-9E09-77CAE658F776\\",\\n \\"Success\\": true,\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"dg.cn-hangzhou.aliyuncs.com\\",\\n \\"LocalName\\": \\"杭州\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'DescribeRegions', ], 'DownloadGatewayProgram' => [ 'summary' => 'Queries the URL for downloading the Database Gateway agent. All Alibaba Cloud users can download the Database Gateway agent without authentication.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197530', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'UserOS', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'LINUX', ], ], [ 'name' => 'DgVersion', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '3.0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'https://dg-prod-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dg3-pkgs/DBGateway_linux?Expires=170833****&OSSAccessKeyId=LTAIfHvNGC8y****&Signature=wa8KqWuyZdB0hwx%2BKvbgZeSTW****', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '15D856B8-A95C-5DA5-B0FC-67246286EA7F', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"https://dg-prod-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dg3-pkgs/DBGateway_linux?Expires=170833****&OSSAccessKeyId=*************&Signature=****************\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"15D856B8-A95C-5DA5-B0FC-67246286EA7F\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'DownloadGatewayProgram', ], 'FindUserGatewayById' => [ 'summary' => 'Queries the details of a database gateway, including the gateway creator and the number of gateway nodes that are running.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197510', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '41FC4DFE-EA8A-5A56-A16C-F607C3409C79', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Gateway' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'GatewayDesc' => [ 'title' => '网关描述。', 'description' => '网关的描述', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '', ], 'GatewayName' => [ 'title' => '网关名称。', 'description' => '网关的名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '', ], 'RegionId' => [ 'title' => '地域ID。', 'description' => '地域的编号', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'GatewayId' => [ 'title' => '网关ID', 'description' => '网关的编号', 'type' => 'string', 'example' => 'dg-pv33g51gw69h****', ], 'Status' => [ 'title' => '状态', 'description' => '网关的状态', 'type' => 'string', 'example' => 'RUNNING', 'enum' => [ 'RUNNING', 'NEW', 'STOPPED', 'EXCEPTION', ], ], 'UserId' => [ 'title' => '用户ID', 'description' => '用户的编号', 'type' => 'string', 'example' => '100****', ], 'CreatorId' => [ 'description' => '', 'type' => 'string', 'example' => 'test_user', ], 'DgVersion' => [ 'description' => '', 'type' => 'string', 'example' => '3.0', ], 'ExceptionMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'NumOfExceptionInstance' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'NumOfRunningInstance' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"41FC4DFE-EA8A-5A56-A16C-F607C3409C79\\",\\n \\"Success\\": true,\\n \\"Gateway\\": {\\n \\"GatewayDesc\\": \\"本地测试\\",\\n \\"GatewayName\\": \\"本地测试\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GatewayId\\": \\"dg-pv33g51gw69h****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"UserId\\": \\"100****\\",\\n \\"CreatorId\\": \\"test_user\\",\\n \\"DgVersion\\": \\"3.0\\",\\n \\"ExceptionMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"NumOfExceptionInstance\\": 3,\\n \\"NumOfRunningInstance\\": 3\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'FindUserGatewayById', ], 'GetUserDatabases' => [ 'summary' => 'Queries a list of databases that are added to a database gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197519', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dg-nmz841r7b681****', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1', ], ], [ 'name' => 'SearchKey', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'DbType', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'MYSQL'."\n", ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'db-22h1qa9d452f****'."\n", ], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Host', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3306', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '514F794F-7E30-5DAA-97C0-0B0D75DA0259', ], 'Success' => [ 'description' => '', 'type' => 'string', 'example' => 'true', ], 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'Count' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'DbInstanceList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DbInstance' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Port' => [ 'title' => '通过网关所在宿主机去访问数据库的端口。', 'description' => '通过网关所在宿主机去访问数据库的端口。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3306', ], 'Host' => [ 'title' => '通过网关所在宿主机去访问数据库的地址。', 'description' => '通过网关所在宿主机去访问数据库的地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.XX.XX', ], 'GatewayId' => [ 'title' => '网关ID。', 'description' => '数据库所在网关ID。', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'dg-pil582nbfe6p****', 'pattern' => '', 'default' => '', ], 'DbType' => [ 'title' => '数据库类型。', 'description' => '数据库类型。', 'type' => 'string', 'deprecated' => false, 'required' => false, 'example' => 'MYSQL', 'pattern' => '', 'default' => '', ], 'RegionId' => [ 'title' => '所在的地域编号', 'description' => '所在的地域编号', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'cn-hangzhou', 'pattern' => '', 'default' => '', ], 'ConnectHost' => [ 'title' => '连接使用的主机', 'description' => '连接使用的主机', 'type' => 'string', 'deprecated' => false, 'example' => '10.0.0.0', 'pattern' => '', 'default' => '', ], 'ConnectPort' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '10001', ], 'ServiceType' => [ 'title' => '服务类型', 'description' => '服务类型', 'type' => 'string', 'deprecated' => false, 'example' => 'ECS', 'pattern' => '', 'default' => '', ], 'NetworkType' => [ 'title' => '网络类型', 'description' => '网络类型', 'type' => 'string', 'deprecated' => false, 'example' => 'VPC', 'pattern' => '', 'default' => '', ], 'NodeId' => [ 'title' => '节点的ID', 'description' => '节点的ID', 'type' => 'string', 'deprecated' => false, 'example' => 'dg-node-xxxxx', 'pattern' => '', 'default' => '', ], 'InstanceStatus' => [ 'title' => '当前实例的状态', 'description' => '当前实例的状态', 'type' => 'string', 'deprecated' => false, 'example' => 'SUCCESS', 'pattern' => '', 'default' => '', 'enum' => [ 'SUCCESS', 'EXCEPTION', 'INIT', 'DELETED', ], ], 'DbDescription' => [ 'title' => '备注信息', 'description' => '备注信息', 'type' => 'string', 'deprecated' => false, 'example' => '', 'pattern' => '', 'default' => '', ], 'InstanceId' => [ 'title' => '数据库实例ID', 'description' => '数据库实例ID', 'type' => 'string', 'deprecated' => false, 'example' => 'db-22h1qa9d452f****'."\n", 'pattern' => '', 'default' => '', ], 'GatewayName' => [ 'title' => '网关名称', 'description' => '网关名称', 'type' => 'string', 'deprecated' => false, 'example' => '', 'pattern' => '', 'default' => '', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '2023-05-03 00:00:00', 'pattern' => '', 'default' => '', ], 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'deprecated' => false, 'example' => '100XXXXX', 'pattern' => '', 'default' => '', ], 'ParentId' => [ 'title' => '归属主账号ID', 'description' => '归属主账号ID', 'type' => 'string', 'deprecated' => false, 'example' => '100XXXXX', 'pattern' => '', 'default' => '', ], 'VpcId' => [ 'title' => 'VpcId', 'description' => 'VpcId', 'type' => 'string', 'deprecated' => false, 'example' => 'vpc-bp1alpkpdb8fh3avx****', 'pattern' => '', 'default' => '', ], 'VpcInstanceId' => [ 'title' => 'VpcInstanceId', 'description' => 'VpcInstanceId', 'type' => 'string', 'deprecated' => false, 'example' => 'i-xxxxxxxxxx', 'pattern' => '', 'default' => '', ], ], ], ], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"514F794F-7E30-5DAA-97C0-0B0D75DA0259\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"Count\\": 100,\\n \\"DbInstanceList\\": {\\n \\"DbInstance\\": [\\n {\\n \\"Port\\": 3306,\\n \\"Host\\": \\"127.0.XX.XX\\",\\n \\"GatewayId\\": \\"dg-pil582nbfe6p****\\",\\n \\"DbType\\": \\"MYSQL\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ConnectHost\\": \\"10.0.0.0\\",\\n \\"ConnectPort\\": 10001,\\n \\"ServiceType\\": \\"ECS\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"NodeId\\": \\"dg-node-xxxxx\\",\\n \\"InstanceStatus\\": \\"SUCCESS\\",\\n \\"DbDescription\\": \\"测试库\\",\\n \\"InstanceId\\": \\"db-22h1qa9d452f****\\\\n\\",\\n \\"GatewayName\\": \\"测试库\\",\\n \\"GmtCreate\\": 0,\\n \\"UserId\\": \\"100XXXXX\\",\\n \\"ParentId\\": \\"100XXXXX\\",\\n \\"VpcId\\": \\"vpc-bp1alpkpdb8fh3avx****\\",\\n \\"VpcInstanceId\\": \\"i-xxxxxxxxxx\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'GetUserDatabases', ], 'GetUserGatewayInstances' => [ 'summary' => 'Queries the details of a gateway node.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197528', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '514F794F-7E30-5DAA-97C0-0B0D75DA0259', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'GatewayInstanceList' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'GatewayInstanceId' => [ 'title' => '资源一级ID', 'description' => '代表资源一级ID的资源属性字段', 'type' => 'string', 'example' => 'dg-node-wJOb0tO-gaaWFCug****', ], 'GatewayId' => [ 'title' => '网关ID', 'description' => '网关ID', 'type' => 'string', 'example' => 'dg-159t17m19ps0****', ], 'LastUpdateTime' => [ 'title' => '上次更新时间戳', 'description' => '上次更新时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1699330233000', ], 'LocalIP' => [ 'title' => '本地IP地址', 'description' => '本地IP地址', 'type' => 'string', 'example' => '127.0.XX.XX', ], 'OutputIP' => [ 'title' => '主机', 'description' => '主机', 'type' => 'string', 'example' => ' 127.0.0.1', ], 'Message' => [ 'title' => '提示信息', 'description' => '提示信息', 'type' => 'string', 'example' => 'SUCCESS', ], 'EndPoint' => [ 'title' => '端点地址', 'description' => '端点地址', 'type' => 'string', 'example' => '127.0.XX.XX', ], 'CurrentDaemonVersion' => [ 'title' => '进程的版本号', 'description' => '进程的版本号', 'type' => 'string', 'example' => '3.0', ], 'CurrentVersion' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'string', 'example' => '3.0', ], 'RegionId' => [ 'title' => '地域ID', 'description' => '代表region的资源属性字段', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ConnectEndpointType' => [ 'title' => '连接类型', 'description' => '连接类型', 'type' => 'string', 'example' => 'internet', ], 'GatewayInstanceStatus' => [ 'description' => '', 'type' => 'string', 'example' => 'STOPPED', ], ], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"514F794F-7E30-5DAA-97C0-0B0D75DA0259\\",\\n \\"Success\\": true,\\n \\"GatewayInstanceList\\": [\\n {\\n \\"GatewayInstanceId\\": \\"dg-node-wJOb0tO-gaaWFCug****\\",\\n \\"GatewayId\\": \\"dg-159t17m19ps0****\\",\\n \\"LastUpdateTime\\": 1699330233000,\\n \\"LocalIP\\": \\"127.0.XX.XX\\",\\n \\"OutputIP\\": \\" 127.0.0.1\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"EndPoint\\": \\"127.0.XX.XX\\",\\n \\"CurrentDaemonVersion\\": \\"3.0\\",\\n \\"CurrentVersion\\": \\"3.0\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ConnectEndpointType\\": \\"internet\\",\\n \\"GatewayInstanceStatus\\": \\"STOPPED\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'GetUserGatewayInstances', ], 'GetUserGateways' => [ 'summary' => 'Queries a list of database gateways that are created by a user.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197533', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'SearchKey', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '41FC4DFE-EA8A-5A56-A16C-F607C3409C79', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'Count' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'GatewayList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Gateway' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'GatewayDesc' => [ 'title' => '网关描述。', 'description' => '网关的描述', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '', ], 'GatewayName' => [ 'title' => '网关名称。', 'description' => '网关的名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '', ], 'RegionId' => [ 'title' => '地域ID。', 'description' => '地域的编号', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'GatewayId' => [ 'title' => '网关ID', 'description' => '网关的编号', 'type' => 'string', 'example' => 'dg-lch384wg5701****', ], 'Status' => [ 'title' => '状态', 'description' => '网关的状态', 'type' => 'string', 'example' => 'RUNNING', 'enum' => [ 'RUNNING', 'NEW', 'STOPPED', 'EXCEPTION', ], ], 'UserId' => [ 'title' => '用户ID', 'description' => '用户的编号', 'type' => 'string', 'example' => '100****', ], 'CreatorId' => [ 'title' => '创建用户id', 'description' => '创建用户id', 'type' => 'string', 'deprecated' => false, 'example' => '100****', 'pattern' => '', 'default' => '', ], 'DgVersion' => [ 'title' => '网关版本', 'description' => '网关版本', 'type' => 'string', 'deprecated' => false, 'example' => '3.0', 'pattern' => '', 'default' => '', ], 'ExceptionMsg' => [ 'title' => '网关异常信息', 'description' => '网关异常信息', 'type' => 'string', 'deprecated' => false, 'example' => 'exception', 'pattern' => '', 'default' => '', ], 'NumOfExceptionInstance' => [ 'title' => '异常实例数量', 'description' => '异常实例数量', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '3', 'pattern' => '', 'default' => '', ], 'NumOfRunningInstance' => [ 'title' => '运行中实例数量', 'description' => '运行中实例数量', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '3', 'pattern' => '', 'default' => '', ], ], ], ], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41FC4DFE-EA8A-5A56-A16C-F607C3409C79\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"Count\\": 20,\\n \\"GatewayList\\": {\\n \\"Gateway\\": [\\n {\\n \\"GatewayDesc\\": \\"本地测试\\",\\n \\"GatewayName\\": \\"本地测试。\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GatewayId\\": \\"dg-lch384wg5701****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"UserId\\": \\"100****\\",\\n \\"CreatorId\\": \\"100****\\",\\n \\"DgVersion\\": \\"3.0\\",\\n \\"ExceptionMsg\\": \\"exception\\",\\n \\"NumOfExceptionInstance\\": 3,\\n \\"NumOfRunningInstance\\": 3\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'GetUserGateways', ], 'ListDatabaseAccessPoint' => [ 'summary' => 'Queries a list of database access points.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198266', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dg-nmz841r7b681****', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1', ], ], [ 'name' => 'SearchKey', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'DbInstanceId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dg-db-n2a285spnpy3****', ], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Host', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '65535', 'minimum' => '0', 'example' => '3306', 'default' => '', ], ], [ 'name' => 'VpcId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'vpc-wz9c473cmu2gg7i7l****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'C9ADD2AA-27E3-5D62-A676-092EDC5303C1', ], 'Success' => [ 'description' => '', 'type' => 'string', 'example' => 'true', ], 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'Count' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DbInstanceAccessPointList' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AccessAddr' => [ 'description' => '', 'type' => 'string', 'example' => '10.0.0.0', ], 'AccessPort' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '33306', ], 'DbInstanceId' => [ 'description' => '', 'type' => 'string', 'example' => 'dg-db-n2a285spnpy3****'."\n", ], 'GmtCreate' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-03-09 14:20:04.0', ], 'GmtModified' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-03-09 14:20:04.0', ], 'RouterId' => [ 'description' => '', 'type' => 'string', 'example' => 'dg-nmz841r7b681****', ], 'VpcAzoneId' => [ 'description' => '', 'type' => 'string', 'example' => 'cn-hangzhou-j', ], 'VpcId' => [ 'description' => '', 'type' => 'string', 'example' => 'vpc-2ze0612ts436tn0sh****', ], 'VswitchId' => [ 'description' => '', 'type' => 'string', 'example' => 'vsw-8vbgi74rgel72rax4****', ], ], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9ADD2AA-27E3-5D62-A676-092EDC5303C1\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"Count\\": 1,\\n \\"DbInstanceAccessPointList\\": [\\n {\\n \\"AccessAddr\\": \\"10.0.0.0\\",\\n \\"AccessPort\\": 33306,\\n \\"DbInstanceId\\": \\"dg-db-n2a285spnpy3****\\\\n\\",\\n \\"GmtCreate\\": 0,\\n \\"GmtModified\\": 0,\\n \\"RouterId\\": \\"dg-nmz841r7b681****\\",\\n \\"VpcAzoneId\\": \\"cn-hangzhou-j\\",\\n \\"VpcId\\": \\"vpc-2ze0612ts436tn0sh****\\",\\n \\"VswitchId\\": \\"vsw-8vbgi74rgel72rax4****\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'ListDatabaseAccessPoint', ], 'ModifyDatabase' => [ 'summary' => 'Modifies the information about a database, such as the description.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197525', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'Host', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3306', ], ], [ 'name' => 'DbType', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'MYSQL', ], ], [ 'name' => 'DbUserName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'DbPassword', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '817130****', ], ], [ 'name' => 'DbDescription', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-db-n2a285spnpy3****'."\n", ], ], [ 'name' => 'DbName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '8F29E3E9-2847-53BF-ADF0-130E3CEA5C63', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true'."\n", ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"SUCCESS\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"8F29E3E9-2847-53BF-ADF0-130E3CEA5C63\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'ModifyDatabase', ], 'ModifyGateway' => [ 'summary' => 'Modifies the basic information about a database gateway, including the name and description.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197501', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'GatewayDesc', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '18071187-5EA1-5DD4-AAD9-F27C5713CD1C', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"SUCCESS\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"18071187-5EA1-5DD4-AAD9-F27C5713CD1C\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'ModifyGateway', ], 'RetryDatabase' => [ 'summary' => 'Reconnects a database gateway to a database.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197521', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', ], ], [ 'name' => 'Host', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '65535', 'minimum' => '0', 'example' => '3306', ], ], [ 'name' => 'DbType', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'MYSQL', ], ], [ 'name' => 'DbUserName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'DbPassword', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'HongRui****', ], ], [ 'name' => 'DbDescription', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DbName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'XXXXX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '19EDB8E2-FCE6-5797-91F4-80F832C90371', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"SUCCESS\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"19EDB8E2-FCE6-5797-91F4-80F832C90371\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'RetryDatabase', ], 'StopGateway' => [ 'summary' => 'Stops a database gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197509', 'abilityTreeNodes' => [ 'FEATUREdms1KPGDT', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', ], ], [ 'name' => 'GatewayInstanceId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dg-node-hvsGB7qVCaaW****-v-0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMsg' => [ 'description' => '', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'DE3CC21B-E317-5ED7-A212-A62517EA0022', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'type' => 'string', ], 'AuthPrincipalDisplayName' => [ 'type' => 'string', ], 'AuthPrincipalOwnerId' => [ 'type' => 'string', ], 'AuthPrincipalType' => [ 'type' => 'string', ], 'EncodedDiagnosticMessage' => [ 'type' => 'string', ], 'NoPermissionType' => [ 'type' => 'string', ], 'PolicyType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"SUCCESS\\",\\n \\"ErrorMsg\\": \\"Gateway exception, please launch local dg first\\",\\n \\"RequestId\\": \\"DE3CC21B-E317-5ED7-A212-A62517EA0022\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'StopGateway', ], ], 'endpoints' => [ [ 'regionId' => 'cn-qingdao', 'endpoint' => 'dms-dg.cn-qingdao.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'dms-dg.cn-beijing.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'dms-dg.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'dms-dg.cn-huhehaote.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'dms-dg.cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'dms-dg.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'dms-dg.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'dms-dg.cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'dms-dg.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'dms-dg.ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'dms-dg.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-2', 'endpoint' => 'dms-dg.ap-southeast-2.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'dms-dg.ap-southeast-3.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'dms-dg.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'dms-dg.us-east-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'dms-dg.us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'dms-dg.eu-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'dms-dg.eu-central-1.aliyuncs.com', ], ], ];