diff options
Diffstat (limited to 'data/en_us/dms-dg')
| -rw-r--r-- | data/en_us/dms-dg/2023-09-14/api-docs.php | 3400 |
1 files changed, 924 insertions, 2476 deletions
diff --git a/data/en_us/dms-dg/2023-09-14/api-docs.php b/data/en_us/dms-dg/2023-09-14/api-docs.php index 2f27b00..59cbefe 100644 --- a/data/en_us/dms-dg/2023-09-14/api-docs.php +++ b/data/en_us/dms-dg/2023-09-14/api-docs.php @@ -1,167 +1,15 @@ <?php return [ 'version' => '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', - ], + 'info' => ['style' => 'RPC', 'product' => 'dms-dg', 'version' => '2023-09-14'], + 'directories' => ['AddDatabase', 'AddDatabaseList', 'CheckDGEnabled', 'ConnectDatabase', 'CreateGatewayVerifyCode', 'DeleteGatewayInstance', 'DownloadGatewayProgram', 'FindUserGatewayById', 'GetUserDatabases', 'GetUserGatewayInstances', 'GetUserGateways', 'ListDatabaseAccessPoint', 'ModifyGateway', 'RetryDatabase', 'StopGateway', 'CreateGateway', 'DeleteDatabase', 'DeleteGateway', 'DescribeRegions', 'ModifyDatabase'], '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', - ], + 'summary' => 'Use this API to connect databases on other clouds or on-premises to Alibaba Cloud.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -174,119 +22,61 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197520', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-8d9bqu1030m****', - ], + 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-8d9bqu1030m****', 'title' => ''], ], [ 'name' => 'Host', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.XX.XX', - ], + 'schema' => ['description' => 'The database endpoint, as accessible from the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.XX.XX', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '3306', - ], + 'schema' => ['description' => 'The database port, as accessible from the gateway.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3306', 'title' => ''], ], [ 'name' => 'DbType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'MYSQL', - ], + 'schema' => ['description' => 'The database type.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'MYSQL', 'title' => ''], ], [ 'name' => 'DbUserName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test_usr', - ], + 'schema' => ['description' => 'The database username.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test_usr', 'title' => ''], ], [ 'name' => 'DbPassword', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1234!2#%A***', - ], + 'schema' => ['description' => 'The database password.'."\n" + ."\n" + .'> This password is used only to verify the connection and is not used for other operations.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1234!2#%A***', 'title' => ''], ], [ 'name' => 'DbDescription', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'A description of the database.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the database is located.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ETnLKlblzczshOTUbOCzxxxx', - ], + 'schema' => ['description' => 'A client-generated token that ensures request idempotence. This token must be unique for each request, be case-sensitive, and have a maximum length of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxx', 'title' => ''], ], ], 'responses' => [ @@ -294,243 +84,82 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SYSTEM_ERR', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. This unique identifier, generated by Alibaba Cloud, helps you troubleshoot issues.', 'type' => 'string', 'example' => 'A8B2EED2-70EF-51F1-8820-914F9AC9BAD2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DbInstance' => [ - 'description' => '', + 'description' => 'Details of the database connection instance.', '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' => '', - ], + 'Port' => ['description' => 'The port used to access the database from the gateway\'s host.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '3306'], + 'Host' => ['description' => 'The address used to access the database from the gateway\'s host.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '127.0.0.1'], + 'GatewayId' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'dg-8d9bqu1030*****'], + 'DbType' => ['description' => 'The database type.', 'type' => 'string', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'MYSQL'], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'cn-hangzhou'], + 'ConnectHost' => ['description' => 'The host address for the database connection, as mapped by the Database Gateway.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '10.0.0.1'], + 'ConnectPort' => ['description' => 'The port for the database connection, as mapped by the Database Gateway.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '32875', 'title' => ''], + 'ServiceType' => ['description' => 'The service type of the Database Gateway.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'ECS'], + 'NetworkType' => ['description' => 'The network type of the Database Gateway.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'VPC'], + 'NodeId' => ['description' => 'The node ID of the Database Gateway.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'dg-node-r0SR-E90lsIR*****'], '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', + 'description' => 'The status of the database connection instance.', 'type' => 'string', 'deprecated' => false, - 'example' => 'vpc-xxxxx', - 'pattern' => '', - 'default' => '', - ], - 'VpcInstanceId' => [ - 'title' => 'VpcInstanceId', - 'description' => 'VpcInstanceId', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'i-xxxxxxx', 'pattern' => '', 'default' => '', + 'enum' => ['SUCCESS', 'EXCEPTION', 'INIT', 'DELETED'], + 'title' => '', + 'example' => 'SUCCESS', ], + 'DbDescription' => ['description' => 'The description of the database connection instance.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'test'], + 'InstanceId' => ['description' => 'The database connection instance ID.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'dg-db-rgfg9p4586o*****'], + 'GatewayName' => ['description' => 'The name of the gateway.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'test'], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '167xxxxxxxxxx'], + 'ParentId' => ['description' => 'The ID of the main account that owns the resource.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '167xxxxxxxxxx'], + 'VpcId' => ['title' => 'VpcId', 'description' => 'The ID of the Database Gateway\'s VPC.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'vpc-xxxxx'], + 'VpcInstanceId' => ['title' => 'VpcInstanceId', 'description' => 'The ID of the instance on which the Database Gateway is running.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'i-xxxxxxx'], ], + 'title' => '', + 'example' => '', ], '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', - ], + 'AuthAction' => ['description' => 'The API action that was denied.', 'type' => 'string', 'example' => 'dms-dg:AddDatabase', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identifier of the principal that made the request.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the Alibaba Cloud account to which the principal belongs.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The complete, encrypted diagnostic message.', 'type' => 'string', 'example' => 'AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The type of permission denial.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type that caused the authentication failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the access denial.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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-8d9bqu1030*****\\",\\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-E90lsIR*****\\",\\n \\"InstanceStatus\\": \\"SUCCESS\\",\\n \\"DbDescription\\": \\"test\\",\\n \\"InstanceId\\": \\"dg-db-rgfg9p4586o*****\\",\\n \\"GatewayName\\": \\"test\\",\\n \\"UserId\\": \\"167xxxxxxxxxx\\",\\n \\"ParentId\\": \\"167xxxxxxxxxx\\",\\n \\"VpcId\\": \\"vpc-xxxxx\\",\\n \\"VpcInstanceId\\": \\"i-xxxxxxx\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"dms-dg:AddDatabase\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Connect to a database through DG', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'AddDatabaseList' => [ - 'summary' => 'Adds multiple databases to a database gateway at a time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Adds multiple databases to a gateway in a batch operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -543,32 +172,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197527', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + '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****"}]', - ], + 'schema' => ['description' => 'A JSON string that contains information about the databases to add.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"host":"127.0.0.1","port":"3306","gatewayId":"dg-xsdasdasdas****"}]', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ETnLKlblzczshOTUbOCzxxxx', - ], + 'schema' => ['description' => 'A unique, client-generated token that ensures request idempotency. The token is case-sensitive and can be up to 64 ASCII characters long.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxx', 'title' => ''], ], ], 'responses' => [ @@ -576,74 +192,49 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ERROR', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '514F794F-7E30-5DAA-97C0-0B0D75DA0259', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'dms-dg:AddDatabaseList', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The principal that initiated the request.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the main account that the principal belongs to.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The complete, encoded diagnostic information.', 'type' => 'string', 'example' => 'AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of policy that caused the authorization failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the request failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + '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\\": \\"dms-dg:AddDatabaseList\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Batch connect databases through DG', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'CheckDGEnabled' => [ - 'summary' => 'Queries whether Database Gateway is activated for the current user.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Checks if Database Gateway (DG) is enabled.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -655,9 +246,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197534', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], @@ -666,73 +255,49 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The response data.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Not activated', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '8F29E3E9-2847-53BF-ADF0-130E3CEA5C63', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'dms-dg:CheckDGEnabled', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The principal that initiated the request.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the Alibaba Cloud account that owns the principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The principal type.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The cause of the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type that caused the authorization failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the access denial.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"true\\",\\n \\"ErrorMsg\\": \\"Not activated\\",\\n \\"RequestId\\": \\"8F29E3E9-2847-53BF-ADF0-130E3CEA5C63\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"dms-dg:CheckDGEnabled\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Check whether the current user has activated the Database Gateway product', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'translator' => 'machine', ], 'ConnectDatabase' => [ - 'summary' => 'Queries whether a database gateway can connect to a database.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Call this API to test database connectivity.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -745,161 +310,170 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197505', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-58c36y906675****', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-58c36y906675****', 'title' => ''], ], [ 'name' => 'Host', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.XX.XX', - ], + 'schema' => ['description' => 'The address used to access the database via the gateway host.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.XX.XX', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '3306', - ], + 'schema' => ['description' => 'The port used to access the database via the gateway host.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3306', 'title' => ''], ], [ 'name' => 'DbType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'MYSQL', - ], + 'schema' => ['description' => 'The database type.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'MYSQL', 'title' => ''], ], [ 'name' => 'DbUserName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test_usr'."\n", - ], + 'schema' => ['description' => 'The database username.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test_usr'."\n", 'title' => ''], ], [ 'name' => 'DbPassword', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1234!2#%A****'."\n", - ], + 'schema' => ['description' => 'The database password.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1234!2#%A****'."\n", 'title' => ''], ], [ 'name' => 'DbName', 'in' => 'formData', + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The response data.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'F4EFCDC5-E69C-5A6F-B170-C5379D9D6811', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AccessDeniedDetail' => [ + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['description' => 'The API operation name.', 'type' => 'string', 'example' => 'dms-dg:ConnectDatabase', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the identity that made the request.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the account that owns the principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The principal type.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded full diagnostic message.', 'type' => 'string', 'example' => 'AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The type of denial that led to the authentication failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of policy that resulted in the access denial.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], + ], + 'description' => 'Details returned when a request fails due to insufficient permissions.', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'title' => '', + 'example' => '', ], ], ], + '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\\": \\"dms-dg:ConnectDatabase\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Database Connectivity Testing', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'CreateGateway' => [ + 'summary' => 'Creates a new 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' => 'The name of the database gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DG', 'title' => ''], + ], + [ + 'name' => 'GatewayDesc', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the database gateway.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'DG_Test', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region where the database gateway is created.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the created database gateway.', 'type' => 'string', 'example' => 'dg-nmz841r7b681****', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID for tracing and troubleshooting.', 'type' => 'string', 'example' => 'A9A8885B-3626-592E-9149-8D2971A545AD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'dms-dg:CreateGateway', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the requesting principal.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the principal\'s owner.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded, full diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaaZEZjJGOTRFMjY0LUZCREUtNTY0MS04N0MzLTAzMkZEMzBBMzE3RQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The type of permission failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of policy that caused the access denial.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the access denial.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:CreateGateway\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaaZEZjJGOTRFMjY0LUZCREUtNTY0MS04N0MzLTAzMkZEMzBBMzE3RQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create Gateway', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], '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', - ], + 'summary' => 'Generates a verification code to link an on-premises Database Gateway installation to its corresponding gateway in the cloud.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -912,21 +486,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197526', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-8e0j08630s08****', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-8e0j08630s08****', 'title' => ''], ], ], 'responses' => [ @@ -934,73 +500,48 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The generated verification code.', 'type' => 'string', 'example' => '0N3ufVIG43RRAs7diEoep6WHVOHPKj3a', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'C9ADD2AA-27E3-5D62-A676-092EDC5303C1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'dms-dg:CreateGatewayVerifyCode', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the authenticating principal.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the principal owner.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The principal type.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type that caused the authorization failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Access denial details.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:CreateGatewayVerifyCode\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Generate a verification code required for offline gateway installation', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'DeleteDatabase' => [ - 'summary' => 'Deletes a database that is added to a database gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes a database from a database gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1013,21 +554,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197529', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'db-22h1qa9d452f****', - ], + 'schema' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'db-22h1qa9d452f****', 'title' => ''], ], ], 'responses' => [ @@ -1035,73 +568,48 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The operation result.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'B9FB545B-03E3-5AE3-9D9E-2FE26EE2C48F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'dms-dg:DeleteDatabase', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the principal.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the principal\'s owner.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded complete diagnostic message.', 'type' => 'string', 'example' => 'AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type that caused the authorization failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the authorization failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response.', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:DeleteDatabase\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Delete Database', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'DeleteGateway' => [ - 'summary' => 'Deletes a database gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes the specified gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1113,21 +621,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197522', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-nmz841r7b681****', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', 'title' => ''], ], ], 'responses' => [ @@ -1135,73 +635,48 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The Request ID. Use this ID to trace logs and troubleshoot issues.', 'type' => 'string', 'example' => '8F29E3E9-2847-53BF-ADF0-130E3CEA5C63', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API operation.', 'type' => 'string', 'example' => 'dms-dg:DeleteGateway', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the principal that requested authorization.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the principal\'s owner.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The principal type.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The full, encrypted diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaYFcQjgzQThBRTMyLUE0RTItNUVDNy1BNkI3LTZFMjVCMUEyQUEzRQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The cause of the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type that caused the authorization failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the authorization failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:DeleteGateway\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaYFcQjgzQThBRTMyLUE0RTItNUVDNy1BNkI3LTZFMjVCMUEyQUEzRQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Delete Gateway', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'DeleteGatewayInstance' => [ - 'summary' => 'Deletes a database gateway node.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes the specified database gateway instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1214,43 +689,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197518', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-nmz841r7b681****', - ], + 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', 'title' => ''], ], [ 'name' => 'GatewayInstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-node-QeH6VfT8GRnPrYWX****', - ], + 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-node-QeH6VfT8GRnPrYWX****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the gateway is located.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -1258,74 +713,48 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '8F29E3E9-2847-53BF-ADF0-130E3CEA5C63', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The name of the API operation.', 'type' => 'string', 'example' => 'dms-dg:DeleteGatewayInstance', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the authenticating principal.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The owner ID of the principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encrypted full diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaKvGBjQwQzQ3OUI0LUVDNjQtNTIwQi1CRENDLTY5MDVDQ0Y3N0MxRA==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of policy that caused the authorization failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'The details of the request failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response.', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:DeleteGatewayInstance\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKvGBjQwQzQ3OUI0LUVDNjQtNTIwQi1CRENDLTY5MDVDQ0Y3N0MxRA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Delete Gateway Edge Zone', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'DescribeRegions' => [ - 'summary' => 'Queries the regions in which a database gateway can be created.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries the regions where you can create database gateways.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1337,21 +766,14 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197516', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -1359,99 +781,73 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'B0557F7A-62C3-50DC-9E09-77CAE658F776', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Region' => [ - 'description' => '', + 'description' => 'The list of regions.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of a region.', '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', - ], + 'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'dg.cn-hangzhou.aliyuncs.com', 'title' => ''], + 'LocalName' => ['description' => 'The region name.', 'type' => 'string', 'example' => '杭州', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], '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', - ], + 'AuthAction' => ['description' => 'The name of the API operation.', 'type' => 'string', 'example' => 'dms-dg:DescribeRegions', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identity used for authentication.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the owner of the authorized principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the authorized principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded diagnostic information.', 'type' => 'string', 'example' => 'AQFoXfyYaF38mEJGQzU4RDlDLTdFNzItNTYxMi1CM0ZDLUZBODQxQjVGNjdDOA==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of the policy that caused the authorization failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the access denied error.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:DescribeRegions\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFoXfyYaF38mEJGQzU4RDlDLTdFNzItNTYxMi1CM0ZDLUZBODQxQjVGNjdDOA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain the regions supported by Database Gateway ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], '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', - ], + 'summary' => 'Retrieves the download URL for the gateway program. Any Alibaba Cloud user can call this operation without requiring permissions.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1464,31 +860,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197530', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'UserOS', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'LINUX', - ], + 'schema' => ['description' => 'The operating system of the gateway.', 'type' => 'string', 'required' => false, 'example' => 'LINUX', 'title' => ''], ], [ 'name' => 'DgVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3.0', - ], + 'schema' => ['description' => 'The DG version.', 'type' => 'string', 'required' => false, 'example' => '3.0', 'title' => ''], ], ], 'responses' => [ @@ -1496,73 +880,48 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The response data.', 'type' => 'string', 'example' => 'https://dg-prod-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dg3-pkgs/DBGateway_linux?Expires=170833****&OSSAccessKeyId=*************&Signature=****************', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Use this ID to track and troubleshoot your request.', 'type' => 'string', 'example' => '15D856B8-A95C-5DA5-B0FC-67246286EA7F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API operation name.', 'type' => 'string', 'example' => 'dms-dg:DownloadGatewayProgram', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identity that is used to access the resource.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the Alibaba Cloud account that owns the principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded diagnostic information.', 'type' => 'string', 'example' => 'AQEAAAAAaGXktUZBOTgwNkQwLTY5ODYtNTlGNC1CQTlELTk1NjlEMjA2NDAyRA==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of the policy that denies the access.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'The request failure details.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:DownloadGatewayProgram\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaGXktUZBOTgwNkQwLTY5ODYtNTlGNC1CQTlELTk1NjlEMjA2NDAyRA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain the download URL of the gateway program', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], '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', - ], + 'summary' => 'Retrieves the details of a gateway, including the user who created it and the number of running gateway instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1574,21 +933,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197510', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-nmz841r7b681****', - ], + 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', 'title' => ''], ], ], 'responses' => [ @@ -1596,148 +947,72 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '41FC4DFE-EA8A-5A56-A16C-F607C3409C79', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Gateway' => [ - 'description' => '', + 'description' => 'The details of the gateway.', '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****', - ], + 'GatewayDesc' => ['description' => 'The description of the gateway.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'test'], + 'GatewayName' => ['description' => 'The name of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'test'], + 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], + 'GatewayId' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'title' => '', 'example' => 'dg-pv33g51gw69h****'], 'Status' => [ - 'title' => '状态', - 'description' => '网关的状态', + 'description' => 'The status of the gateway.', 'type' => 'string', + 'enum' => ['RUNNING', 'NEW', 'STOPPED', 'EXCEPTION'], + 'title' => '', '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', ], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '100****'], + 'CreatorId' => ['description' => 'The user who created the gateway.', 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'DgVersion' => ['description' => 'The version of DG.', 'type' => 'string', 'example' => '3.0', 'title' => ''], + 'ExceptionMsg' => ['description' => 'The exception message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'NumOfExceptionInstance' => ['description' => 'The number of gateway instances that are in an exception state.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'NumOfRunningInstance' => ['description' => 'The number of running gateway instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], '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', - ], + 'AuthAction' => ['description' => 'The API operation that was called.', 'type' => 'string', 'example' => 'dms-dg:FindUserGatewayById', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identity used for authentication in the request.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the owner of the authorization principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the authorization principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The complete, encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaEo6p0VFOTM5RkEwLTRBRUItNTA5NS04Q0JGLTJFRjUxNDJDRjkwQg==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason the authentication failed.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type that caused the authentication failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details of the access denial.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"test\\",\\n \\"GatewayName\\": \\"test\\",\\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\\": \\"dms-dg:FindUserGatewayById\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaEo6p0VFOTM5RkEwLTRBRUItNTA5NS04Q0JGLTJFRjUxNDJDRjkwQg==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain the details of a gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'GetUserDatabases' => [ - 'summary' => 'Queries a list of databases that are added to a database gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'This API lists the databases in a specified gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1750,103 +1025,53 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197519', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dg-nmz841r7b681****', - ], + 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => false, 'example' => 'dg-nmz841r7b681****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number to return.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'SearchKey', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The keyword for the search.', 'type' => 'string', 'required' => false, 'example' => 'gateway', 'title' => ''], ], [ 'name' => 'DbType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MYSQL'."\n", - ], + 'schema' => ['description' => 'The database type.', 'type' => 'string', 'required' => false, 'example' => 'MYSQL'."\n", 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'db-22h1qa9d452f****'."\n", - ], + 'schema' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => false, 'example' => 'db-22h1qa9d452f****'."\n", 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region of the gateway.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Host', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.XX.XX', - ], + 'schema' => ['description' => 'The host address of the database that the gateway can access.', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3306', - ], + 'schema' => ['description' => 'The database port that the gateway can access.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3306', 'title' => ''], ], ], 'responses' => [ @@ -1854,268 +1079,99 @@ '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', - ], + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '514F794F-7E30-5DAA-97C0-0B0D75DA0259', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'Count' => ['description' => 'The number of database instances returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'DbInstanceList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DbInstance' => [ - 'description' => '', + 'description' => 'A list of database instances.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A database instance.', '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' => '', - ], + 'Port' => ['description' => 'The database port that is accessible from the gateway host.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '3306'], + 'Host' => ['description' => 'The database host that is accessible from the gateway host.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '127.0.XX.XX'], + 'GatewayId' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'dg-pil582nbfe6p****'], + 'DbType' => ['description' => 'The database type.', 'type' => 'string', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'MYSQL'], + 'RegionId' => ['description' => 'The region ID of the database.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'cn-hangzhou'], + 'ConnectHost' => ['description' => 'The IP address of the Database Gateway (DG) service proxy.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '10.0.0.0'], + 'ConnectPort' => ['description' => 'The port of the Database Gateway (DG) service proxy.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '10001', 'title' => ''], + 'ServiceType' => ['description' => 'The type of instance for the Database Gateway (DG) service.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'ECS'], + 'NetworkType' => ['description' => 'The network type of the Database Gateway (DG) proxy node.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'VPC'], + 'NodeId' => ['description' => 'The ID of the Database Gateway (DG) proxy node.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'dg-node-xxxxx'], 'InstanceStatus' => [ - 'title' => '当前实例的状态', - 'description' => '当前实例的状态', + 'description' => 'The status of the database instance.', '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' => '', + 'enum' => ['SUCCESS', 'EXCEPTION', 'INIT', 'DELETED'], + 'title' => '', + 'example' => 'SUCCESS', ], + 'DbDescription' => ['description' => 'The description of the database instance.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Test'], + 'InstanceId' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'db-22h1qa9d452f****'."\n"], + 'GatewayName' => ['description' => 'The name of the gateway.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Test'], + 'GmtCreate' => ['description' => 'The creation time of the database instance.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '2023-05-03 00:00:00'], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '100XXXXX'], + 'ParentId' => ['description' => 'The ID of the main account.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '100XXXXX'], + 'VpcId' => ['title' => 'VpcId', 'description' => 'The ID of the VPC in which the Database Gateway (DG) service is deployed.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'vpc-bp1alpkpdb8fh3avx****'], + 'VpcInstanceId' => ['title' => 'VpcInstanceId', 'description' => 'The ID of the instance on which the Database Gateway (DG) service runs.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'i-xxxxxxxxxx'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], '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', - ], + 'AuthAction' => ['description' => 'The API operation that was denied access.', 'type' => 'string', 'example' => 'dms-dg:GetUserDatabases', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the identity that made the request.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the owner of the authenticated principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encrypted, complete diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaKvGBjQwQzQ3OUI0LUVDNjQtNTIwQi1CRENDLTY5MDVDQ0Y3N0MxRA==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of the policy that caused the authorization failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about why access was denied. This parameter is returned only if the request fails.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"Test\\",\\n \\"InstanceId\\": \\"db-22h1qa9d452f****\\\\n\\",\\n \\"GatewayName\\": \\"Test\\",\\n \\"GmtCreate\\": 0,\\n \\"UserId\\": \\"100XXXXX\\",\\n \\"ParentId\\": \\"100XXXXX\\",\\n \\"VpcId\\": \\"vpc-bp1alpkpdb8fh3avx****\\",\\n \\"VpcInstanceId\\": \\"i-xxxxxxxxxx\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"dms-dg:GetUserDatabases\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKvGBjQwQzQ3OUI0LUVDNjQtNTIwQi1CRENDLTY5MDVDQ0Y3N0MxRA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain the database list in the gateway ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'GetUserGatewayInstances' => [ - 'summary' => 'Queries the details of a gateway node.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Call this API to get the details of the gateway node.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2128,21 +1184,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197528', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-nmz841r7b681****', - ], + 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', 'title' => ''], ], ], 'responses' => [ @@ -2150,151 +1198,73 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '514F794F-7E30-5DAA-97C0-0B0D75DA0259', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'GatewayInstanceList' => [ - 'description' => '', + 'description' => 'The list of gateway instances.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The gateway instance.', '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', - ], - ], + 'GatewayInstanceId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'title' => '', 'example' => 'dg-node-wJOb0tO-gaaWFCug****'], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'string', 'title' => '', 'example' => 'dg-159t17m19ps0****'], + 'LastUpdateTime' => ['description' => 'The timestamp of the last update to the gateway node.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1699330233000'], + 'LocalIP' => ['description' => 'The local IP address.', 'type' => 'string', 'title' => '', 'example' => '127.0.XX.XX'], + 'OutputIP' => ['description' => 'The host.', 'type' => 'string', 'title' => '', 'example' => ' 127.0.0.1'], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'title' => '', 'example' => 'SUCCESS'], + 'EndPoint' => ['description' => 'The endpoint address.', 'type' => 'string', 'title' => '', 'example' => '127.0.XX.XX'], + 'CurrentDaemonVersion' => ['description' => 'The version number of the process.', 'type' => 'string', 'title' => '', 'example' => '3.0'], + 'CurrentVersion' => ['description' => 'The version number.', 'type' => 'string', 'title' => '', 'example' => '3.0'], + 'RegionId' => ['description' => 'The region where the gateway node is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'ConnectEndpointType' => ['description' => 'The connection type.', 'type' => 'string', 'title' => '', 'example' => 'internet'], + 'GatewayInstanceStatus' => ['description' => 'The gateway node status.', 'type' => 'string', 'example' => 'STOPPED', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], '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', - ], + 'AuthAction' => ['description' => 'The API operation.', 'type' => 'string', 'example' => 'dms-dg:GetUserGatewayInstances', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identity credential used for authentication in the request.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the authorization principal owner.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the authorization principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded complete diagnostic information.', 'type' => 'string', 'example' => 'AQEAAAAAaKvGBjQwQzQ3OUI0LUVDNjQtNTIwQi1CRENDLTY5MDVDQ0Y3N0MxRA==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authentication failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of policy that caused the authentication failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'The details of the request failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:GetUserGatewayInstances\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKvGBjQwQzQ3OUI0LUVDNjQtNTIwQi1CRENDLTY5MDVDQ0Y3N0MxRA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain detailed information about gateway edge zones ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'GetUserGateways' => [ - 'summary' => 'Queries a list of database gateways that are created by a user.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Retrieves a list of user-created Database Gateways.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2307,52 +1277,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197533', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number to retrieve.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'SearchKey', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The keyword to search for gateways.', 'type' => 'string', 'required' => false, 'example' => 'gateway', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region where the gateway is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -2360,184 +1306,88 @@ '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', - ], + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '41FC4DFE-EA8A-5A56-A16C-F607C3409C79', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'Count' => ['description' => 'The total number of gateways.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'GatewayList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Gateway' => [ - 'description' => '', + 'description' => 'An array of gateway details.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Details of a gateway.', '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****', - ], + 'GatewayDesc' => ['description' => 'The description of the gateway.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'test'], + 'GatewayName' => ['description' => 'The name of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'test'], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'string', 'title' => '', 'example' => 'dg-lch384wg5701****'], 'Status' => [ - 'title' => '状态', - 'description' => '网关的状态', + 'description' => 'The status of the gateway.', 'type' => 'string', + 'enum' => ['RUNNING', 'NEW', 'STOPPED', 'EXCEPTION'], + 'title' => '', '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' => '', ], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '100****'], + 'CreatorId' => ['description' => 'The ID of the user who created the gateway.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '100****'], + 'DgVersion' => ['description' => 'The version of the gateway.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '3.0'], + 'ExceptionMsg' => ['description' => 'The exception message for the gateway.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'exception'], + 'NumOfExceptionInstance' => ['description' => 'The number of instances in an exceptional state.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '3'], + 'NumOfRunningInstance' => ['description' => 'The number of running instances.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '3'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => 'A list of gateways.', + 'title' => '', + 'example' => '', ], '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', - ], + 'AuthAction' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'dms-dg:GetUserGateways', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the principal used for authentication.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The principal owner ID.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The full encoded diagnostic message.', 'type' => 'string', 'example' => 'AQFprivgaa4r4EEyRDc1QjgxLUY2QkMtNTZDNS1BMkFELTQ5NEUzNURBMjQwNQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The cause of the authorization failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type that caused the authorization failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the request failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"test\\",\\n \\"GatewayName\\": \\"test\\",\\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\\": \\"dms-dg:GetUserGateways\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFprivgaa4r4EEyRDc1QjgxLUY2QkMtNTZDNS1BMkFELTQ5NEUzNURBMjQwNQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve gateway list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'ListDatabaseAccessPoint' => [ - 'summary' => 'Queries a list of database access points.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Gets a list of database access points.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2550,107 +1400,53 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198266', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dg-nmz841r7b681****', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => false, 'example' => 'dg-nmz841r7b681****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number to return.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'SearchKey', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'gateway', 'title' => ''], ], [ 'name' => 'DbInstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dg-db-n2a285spnpy3****', - ], + 'schema' => ['description' => 'The database instance ID.', 'type' => 'string', 'required' => false, 'example' => 'dg-db-n2a285spnpy3****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region where the gateway is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Host', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.XX.XX', - ], + 'schema' => ['description' => 'The host address the gateway uses to connect to the database.', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '65535', - 'minimum' => '0', - 'example' => '3306', - 'default' => '', - ], + 'schema' => ['description' => 'The port the gateway uses to connect to the database.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '65535', 'minimum' => '0', 'default' => '', 'example' => '3306', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-wz9c473cmu2gg7i7l****', - ], + 'schema' => ['description' => 'The ID of the VPC where the database access point is located.', 'type' => 'string', 'required' => false, 'example' => 'vpc-wz9c473cmu2gg7i7l****', 'title' => ''], ], ], 'responses' => [ @@ -2658,133 +1454,72 @@ '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', - ], + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'C9ADD2AA-27E3-5D62-A676-092EDC5303C1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'Count' => ['description' => 'The number of returned database access points.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'DbInstanceAccessPointList' => [ - 'description' => '', + 'description' => 'A list of database access points.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A database access point.', '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****', - ], - ], + 'AccessAddr' => ['description' => 'The IP address of the access point.', 'type' => 'string', 'example' => '10.0.0.0', 'title' => ''], + 'AccessPort' => ['description' => 'The port number of the access point.', 'type' => 'integer', 'format' => 'int32', 'example' => '33306', 'title' => ''], + 'DbInstanceId' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'example' => 'dg-db-n2a285spnpy3****'."\n", 'title' => ''], + 'GmtCreate' => ['description' => 'The time the access point was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-03-09 14:20:04.0', 'title' => ''], + 'GmtModified' => ['description' => 'The time the access point was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-03-09 14:20:04.0', 'title' => ''], + 'RouterId' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'example' => 'dg-nmz841r7b681****', 'title' => ''], + 'VpcAzoneId' => ['description' => 'The ID of the availability zone that contains the access point.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the VPC that contains the access point.', 'type' => 'string', 'example' => 'vpc-2ze0612ts436tn0sh****', 'title' => ''], + 'VswitchId' => ['description' => 'The ID of the VSwitch that contains the access point.', 'type' => 'string', 'example' => 'vsw-8vbgi74rgel72rax4****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], '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', - ], + 'AuthAction' => ['description' => 'The API operation that was denied.', 'type' => 'string', 'example' => 'dms-dg:ListDatabaseAccessPoint', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the principal that initiated the request.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the principal\'s account.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The full diagnostic message in encrypted form.', 'type' => 'string', 'example' => 'AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The type of permission error.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type that caused the denial.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the access denial.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + '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\\": \\"dms-dg:ListDatabaseAccessPoint\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain the database endpoint list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'ModifyDatabase' => [ - 'summary' => 'Modifies the information about a database, such as the description.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'This operation modifies database information, such as its description.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2797,97 +1532,48 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197525', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'Host', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.XX.XX', - ], + 'schema' => ['description' => 'The address used to connect to the database from the gateway host.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.XX.XX', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '3306', - ], + 'schema' => ['description' => 'The port used to connect to the database from the gateway host.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3306', 'title' => ''], ], [ 'name' => 'DbType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'MYSQL', - ], + 'schema' => ['description' => 'The database type.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'MYSQL', 'title' => ''], ], [ 'name' => 'DbUserName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The username used to connect to the database.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'DbPassword', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '817130****', - ], + 'schema' => ['description' => 'The password used to connect to the database.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '817130****', 'title' => ''], ], [ 'name' => 'DbDescription', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The database description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-db-n2a285spnpy3****'."\n", - ], + 'schema' => ['description' => 'The database instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-db-n2a285spnpy3****'."\n", 'title' => ''], ], [ 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -2895,73 +1581,48 @@ '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", - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Use this ID to trace logs and troubleshoot issues.', 'type' => 'string', 'example' => '8F29E3E9-2847-53BF-ADF0-130E3CEA5C63', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API operation that was performed.', 'type' => 'string', 'example' => 'dms-dg:ModifyDatabase', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identity used for authentication.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The owner ID of the authorization principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the authorization principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encrypted full diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaQQYWjRDMkY1NjE1LTQwRDMtNTIyOS1BQjg0LTg0NDE0OTVCNTIwOA==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authentication failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type that caused the authentication failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details about the request failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:ModifyDatabase\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaQQYWjRDMkY1NjE1LTQwRDMtNTIyOS1BQjg0LTg0NDE0OTVCNTIwOA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Modify Database Information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'ModifyGateway' => [ - 'summary' => 'Modifies the basic information about a database gateway, including the name and description.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Call this API to modify the basic information of a gateway, including the gateway name and gateway description.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2974,43 +1635,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197501', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The gateway name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'GatewayDesc', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The gateway description.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'DG_Test', 'title' => ''], ], [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-nmz841r7b681****', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', 'title' => ''], ], ], 'responses' => [ @@ -3018,74 +1659,48 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use this ID to trace logs and troubleshoot issues.', 'type' => 'string', 'example' => '18071187-5EA1-5DD4-AAD9-F27C5713CD1C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API operation that was performed.', 'type' => 'string', 'example' => 'dms-dg:ModifyGateway', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => '23894333884425****', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The complete encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaQQYWjRDMkY1NjE1LTQwRDMtNTIyOS1BQjg0LTg0NDE0OTVCNTIwOA==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason for the authentication failure.', 'type' => 'string', 'example' => 'ExplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of policy that caused the authentication failure.', 'type' => 'string', 'example' => 'COST_OPTIMIZED', 'title' => ''], ], + 'description' => 'Details of the request failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + '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\\": \\"dms-dg:ModifyGateway\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaQQYWjRDMkY1NjE1LTQwRDMtNTIyOS1BQjg0LTg0NDE0OTVCNTIwOA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\"\\n }\\n}","type":"json"}]', + 'title' => 'Modify the basic information of a gateway', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'RetryDatabase' => [ - 'summary' => 'Reconnects a database gateway to a database.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Call this API operation to reconnect a database gateway to a database.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3098,120 +1713,58 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197521', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-nmz841r7b681****', - ], + 'schema' => ['description' => 'The ID of the database gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', 'title' => ''], ], [ 'name' => 'Host', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.XX.XX', - ], + 'schema' => ['description' => 'The hostname or IP address of the database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.XX.XX', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '65535', - 'minimum' => '0', - 'example' => '3306', - ], + 'schema' => ['description' => 'The port number of the database.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '65535', 'minimum' => '0', 'example' => '3306', 'title' => ''], ], [ 'name' => 'DbType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'MYSQL', - ], + 'schema' => ['description' => 'The type of the database.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'MYSQL', 'title' => ''], ], [ 'name' => 'DbUserName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The username used to access the database.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'DbPassword', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'HongRui****', - ], + 'schema' => ['description' => 'The password used to access the database.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'HongRui****', 'title' => ''], ], [ 'name' => 'DbDescription', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The description of the database.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'XXXXX', - ], + 'schema' => ['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 contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'XXXXX', 'title' => ''], ], ], 'responses' => [ @@ -3219,74 +1772,49 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the request.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '19EDB8E2-FCE6-5797-91F4-80F832C90371', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The name of the API operation.', 'type' => 'string', 'example' => 'dms-dg:RetryDatabase', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the authorization principal.', 'type' => 'string', 'example' => '23894333884425****'."\n", 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the owner of the authorization principal.', 'type' => 'string', 'example' => '1218522260143***', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the authorization principal.', 'type' => 'string', 'example' => 'SubUser'."\n", 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The complete, encoded diagnostic information.', 'type' => 'string', 'example' => 'AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason why the authorization failed.', 'type' => 'string', 'example' => 'ExplicitDeny'."\n", 'title' => ''], + 'PolicyType' => ['description' => 'The type of the policy that caused the authorization to fail.', 'type' => 'string', 'example' => 'COST_OPTIMIZED'."\n", 'title' => ''], ], + 'description' => 'The details of the request failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response.', + 'title' => '', + 'example' => '', ], ], ], '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', + '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\\": \\"dms-dg:RetryDatabase\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\\\n\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\\\n\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\\\n\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'Reconnect Database', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'StopGateway' => [ - 'summary' => 'Stops a database gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Stops a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3299,31 +1827,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197509', - 'abilityTreeNodes' => [ - 'FEATUREdms1KPGDT', - ], + 'abilityTreeNodes' => ['FEATUREdms1KPGDT'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-nmz841r7b681****', - ], + 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-nmz841r7b681****', 'title' => ''], ], [ 'name' => 'GatewayInstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dg-node-hvsGB7qVCaaW****-v-0', - ], + 'schema' => ['description' => 'The ID of the gateway node instance.', 'type' => 'string', 'required' => false, 'example' => 'dg-node-hvsGB7qVCaaW****-v-0', 'title' => ''], ], ], 'responses' => [ @@ -3331,138 +1846,71 @@ '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', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the operation. A value of SUCCESS indicates that the operation is successful.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Gateway exception, please launch local dg first', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'DE3CC21B-E317-5ED7-A212-A62517EA0022', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'AuthAction' => ['description' => 'The API operation name.', 'type' => 'string', 'example' => 'dms-dg:StopGateway', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identifier of the principal that made the request.', 'type' => 'string', 'example' => '23894333884425****'."\n", 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The principal owner ID.', 'type' => 'string', 'example' => '1218522260143***'."\n", 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The principal type.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'An encoded message that contains detailed diagnostic information.', 'type' => 'string', 'example' => 'AQEAAAAAaGXktUZBOTgwNkQwLTY5ODYtNTlGNC1CQTlELTk1NjlEMjA2NDAyRA==', 'title' => ''], + 'NoPermissionType' => ['description' => 'The reason the authorization check failed.', 'type' => 'string', 'example' => 'ExplicitDeny'."\n", 'title' => ''], + 'PolicyType' => ['description' => 'The type of policy that caused the authorization check to fail.', 'type' => 'string', 'example' => 'COST_OPTIMIZED'."\n", 'title' => ''], ], + 'description' => 'Details about the request failure.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], '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', + '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\\": \\"dms-dg:StopGateway\\",\\n \\"AuthPrincipalDisplayName\\": \\"23894333884425****\\\\n\\",\\n \\"AuthPrincipalOwnerId\\": \\"1218522260143***\\\\n\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaGXktUZBOTgwNkQwLTY5ODYtNTlGNC1CQTlELTk1NjlEMjA2NDAyRA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\\\n\\",\\n \\"PolicyType\\": \\"COST_OPTIMIZED\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'Stop Gateway Service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], ], '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', - ], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.ap-northeast-1.aliyuncs.com', 'endpoint' => 'dms-dg.ap-northeast-1.aliyuncs.com', 'vpc' => 'dms-dg-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dms-dg.ap-southeast-1.aliyuncs.com', 'vpc' => 'dms-dg-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.ap-southeast-2.aliyuncs.com', 'endpoint' => 'dms-dg.ap-southeast-2.aliyuncs.com', 'vpc' => 'dms-dg-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.ap-southeast-3.aliyuncs.com', 'endpoint' => 'dms-dg.ap-southeast-3.aliyuncs.com', 'vpc' => 'dms-dg-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.ap-southeast-5.aliyuncs.com', 'endpoint' => 'dms-dg.ap-southeast-5.aliyuncs.com', 'vpc' => 'dms-dg-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.cn-beijing.aliyuncs.com', 'endpoint' => 'dms-dg.cn-beijing.aliyuncs.com', 'vpc' => 'dms-dg-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.cn-chengdu.aliyuncs.com', 'endpoint' => 'dms-dg.cn-chengdu.aliyuncs.com', 'vpc' => 'dms-dg-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dms-dg.cn-hangzhou.aliyuncs.com', 'vpc' => 'dms-dg-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.cn-hongkong.aliyuncs.com', 'endpoint' => 'dms-dg.cn-hongkong.aliyuncs.com', 'vpc' => 'dms-dg-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.cn-huhehaote.aliyuncs.com', 'endpoint' => 'dms-dg.cn-huhehaote.aliyuncs.com', 'vpc' => 'dms-dg-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.cn-qingdao.aliyuncs.com', 'endpoint' => 'dms-dg.cn-qingdao.aliyuncs.com', 'vpc' => 'dms-dg-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.cn-shanghai.aliyuncs.com', 'endpoint' => 'dms-dg.cn-shanghai.aliyuncs.com', 'vpc' => 'dms-dg-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.cn-shenzhen.aliyuncs.com', 'endpoint' => 'dms-dg.cn-shenzhen.aliyuncs.com', 'vpc' => 'dms-dg-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms-dg.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'dms-dg.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'dms-dg-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dms-dg.us-west-1.aliyuncs.com', 'endpoint' => 'dms-dg.us-west-1.aliyuncs.com', 'vpc' => 'dms-dg-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dms-dg.us-east-1.aliyuncs.com', 'endpoint' => 'dms-dg.us-east-1.aliyuncs.com', 'vpc' => 'dms-dg-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dms-dg.eu-west-1.aliyuncs.com', 'endpoint' => 'dms-dg.eu-west-1.aliyuncs.com', 'vpc' => 'dms-dg-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dms-dg.eu-central-1.aliyuncs.com', 'endpoint' => 'dms-dg.eu-central-1.aliyuncs.com', 'vpc' => 'dms-dg-vpc.eu-central-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'Error', 'message' => 'The requested service is unavailable. Please try again later.', 'http_code' => 500, 'description' => 'The requested service is unavailable. Please try again later.'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], ]; |