summaryrefslogtreecommitdiff
path: root/data/en_us/rds-data/2022-03-30/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/rds-data/2022-03-30/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/rds-data/2022-03-30/api-docs.php')
-rw-r--r--data/en_us/rds-data/2022-03-30/api-docs.php1562
1 files changed, 613 insertions, 949 deletions
diff --git a/data/en_us/rds-data/2022-03-30/api-docs.php b/data/en_us/rds-data/2022-03-30/api-docs.php
index 1f50afe..e99ed9e 100644
--- a/data/en_us/rds-data/2022-03-30/api-docs.php
+++ b/data/en_us/rds-data/2022-03-30/api-docs.php
@@ -1,613 +1,307 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'rds-data',
- 'version' => '2022-03-30',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'rds-data', 'version' => '2022-03-30'],
'directories' => [
[
- 'id' => 185481,
- 'title' => null,
+ 'children' => ['BeginTransaction', 'CommitTransaction', 'RollbackTransaction'],
'type' => 'directory',
- 'children' => [
- 'BeginTransaction',
- 'CommitTransaction',
- 'RollbackTransaction',
- ],
+ 'title' => 'Transaction',
],
[
- 'id' => 185482,
- 'title' => null,
+ 'children' => ['InsertList', 'ExecuteStatement', 'BatchExecuteStatement'],
'type' => 'directory',
- 'children' => [
- 'InsertList',
- 'ExecuteStatement',
- 'BatchExecuteStatement',
- ],
+ 'title' => 'Data operation',
],
],
'components' => [
'schemas' => [
'BatchExecuteStatementResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The response of BatchExecuteStatement.',
'type' => 'object',
'properties' => [
'GeneratedFieldsList' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The auto-increment columns generated during batch SQL execution.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'visibility' => 'public',
+ 'description' => 'The auto-increment columns generated by a single SQL statement in batch SQL execution.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/Field',
- ],
- 'extendType' => 'true',
+ 'items' => ['description' => 'The value of the auto-increment column. For more information, see [Field](~~459828~~).', '$ref' => '#/components/schemas/Field', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'backendName' => 'generatedFieldsList',
+ 'example' => '',
],
],
+ 'example' => '',
],
'BeginTransactionResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The response of BeginTransaction.',
'type' => 'object',
'properties' => [
- 'TransactionId' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '86xxxx1d-xxxx-45ce-xxxx-354exxxxcb34',
- 'backendName' => 'transactionId',
- ],
+ 'TransactionId' => ['title' => '', 'description' => 'The ID of the started transaction.', 'type' => 'string', 'example' => '86****1d-****-45ce-****-354e****cb34'],
],
+ 'example' => '',
],
'ColumnMetadata' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The column metadata.',
'type' => 'object',
'properties' => [
- 'ArrayBaseColumnType' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'arrayBaseColumnType',
- ],
- 'IsAutoIncrement' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'boolean',
- 'example' => 'true',
- 'backendName' => 'isAutoIncrement',
- ],
- 'IsCaseSensitive' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'boolean',
- 'example' => 'true',
- 'backendName' => 'isCaseSensitive',
- ],
- 'IsCurrency' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'boolean',
- 'example' => 'true',
- 'backendName' => 'isCurrency',
- ],
- 'IsSigned' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'boolean',
- 'example' => 'false',
- 'backendName' => 'isSigned',
- ],
- 'Label' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'TBL_BIG',
- 'backendName' => 'label',
- ],
- 'Name' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'name',
- 'backendName' => 'name',
- ],
- 'Nullable' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'nullable',
- ],
- 'Precision' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'precision',
- ],
- 'Scale' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- 'backendName' => 'scale',
- ],
- 'SchemaName' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'test_schema',
- 'backendName' => 'schemaName',
- ],
- 'TableName' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'users',
- 'backendName' => 'tableName',
- ],
- 'Type' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '93',
- 'backendName' => 'type',
- ],
- 'TypeName' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'TIMESTAMP',
- 'backendName' => 'typeName',
- ],
- ],
+ 'ArrayBaseColumnType' => ['title' => '', 'description' => 'Indicates whether the column is of the Array type. Valid values:'."\n"
+ ."\n"
+ .'- **1**: The column is of the Array type.'."\n"
+ ."\n"
+ .'- **0**: The column is not of the Array type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'IsAutoIncrement' => ['title' => '', 'description' => 'Indicates whether the column is auto-incremented. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Auto-incremented.'."\n"
+ ."\n"
+ .'- **false**: Not auto-incremented.', 'type' => 'boolean', 'example' => 'true'],
+ 'IsCaseSensitive' => ['title' => '', 'description' => 'Indicates whether the column is case-sensitive. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Case-sensitive.'."\n"
+ ."\n"
+ .'- **false**: Not case-sensitive.', 'type' => 'boolean', 'example' => 'true'],
+ 'IsCurrency' => ['title' => '', 'description' => 'Indicates whether the column stores currency values. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The column stores currency values.'."\n"
+ ."\n"
+ .'- **false**: The column does not store currency values.', 'type' => 'boolean', 'example' => 'true'],
+ 'IsSigned' => ['title' => '', 'description' => 'Indicates whether the column is signed. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Signed.'."\n"
+ ."\n"
+ .'- **false**: Unsigned.', 'type' => 'boolean', 'example' => 'false'],
+ 'Label' => ['title' => '', 'description' => 'The label of the column.', 'type' => 'string', 'example' => 'TBL_BIG'],
+ 'Name' => ['title' => '', 'description' => 'The column name.', 'type' => 'string', 'example' => 'name'],
+ 'Nullable' => ['title' => '', 'description' => 'Indicates whether the column can be null. Valid values:'."\n"
+ ."\n"
+ .'- **1**: The column can be null.'."\n"
+ ."\n"
+ .'- **0**: The column cannot be null.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Precision' => ['title' => '', 'description' => 'The precision of the column, which indicates the total number of digits in both the integer and decimal parts of a decimal number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Scale' => ['title' => '', 'description' => 'The scale of the column, which indicates the number of digits in the decimal part of a decimal number.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'SchemaName' => ['title' => '', 'description' => 'The name of the schema to which the column belongs.', 'type' => 'string', 'example' => 'test_schema'],
+ 'TableName' => ['title' => '', 'description' => 'The name of the table to which the column belongs.', 'type' => 'string', 'example' => 'users'],
+ 'Type' => ['title' => '', 'description' => 'The type of the column.', 'type' => 'integer', 'format' => 'int32', 'example' => '93'],
+ 'TypeName' => ['title' => '', 'description' => 'The type name of the column.', 'type' => 'string', 'example' => 'TIMESTAMP'],
+ ],
+ 'example' => '',
],
'CommitTransactionResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The return value of CommitTransaction.',
'type' => 'object',
'properties' => [
- 'TransactionStatus' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'Transaction Commit',
- 'backendName' => 'transactionStatus',
- ],
+ 'TransactionStatus' => ['title' => '', 'description' => 'The transaction status. Valid values:'."\n"
+ ."\n"
+ .'- **Transaction Commit**: The transaction has been committed.'."\n"
+ ."\n"
+ .'- **Transaction Rollback**: The transaction has been rolled back.', 'type' => 'string', 'example' => 'Transaction Commit'],
],
+ 'example' => '',
],
'DeleteResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The response of the Delete operation.',
'type' => 'object',
'properties' => [
- 'NumberOfRecordsUpdated' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- 'backendName' => 'numberOfRecordsUpdated',
- ],
+ 'NumberOfRecordsUpdated' => ['title' => '', 'description' => 'The number of deleted records.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
],
+ 'example' => '',
],
'ExecuteStatementResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The return value of ExecuteStatement.',
'type' => 'object',
'properties' => [
'ColumnMetadata' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The parameter description is as follows:',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/ColumnMetadata',
- ],
- 'backendName' => 'columnMetadata',
- ],
- 'FormattedRecords' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '[{ "name": "jack" }]',
- 'backendName' => 'formattedRecords',
+ 'items' => ['description' => '列元数据，详情请参见[ColumMetadata](~~459825~~)。', '$ref' => '#/components/schemas/ColumnMetadata', 'title' => '', 'example' => ''],
+ 'example' => '',
],
+ 'FormattedRecords' => ['title' => '', 'description' => 'The return value when the request parameter FormatRecordsAs is set to `JSON`.', 'type' => 'string', 'example' => '[{ "name": "jack" }]'],
'GeneratedFields' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The list of auto-increment columns generated during SQL execution.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/Field',
- ],
- 'backendName' => 'generatedFields',
- ],
- 'NumberOfRecordsUpdated' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- 'backendName' => 'numberOfRecordsUpdated',
+ 'items' => ['description' => 'SQL执行过程中的自增列，详情请参见[Field](~~459828~~)。', '$ref' => '#/components/schemas/Field', 'title' => '', 'example' => ''],
+ 'example' => '',
],
+ 'NumberOfRecordsUpdated' => ['title' => '', 'description' => 'The number of rows affected by the SQL execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Records' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The return value of the query statement.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'visibility' => 'public',
+ 'description' => '返回值中的一条记录。',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/Field',
- ],
- 'extendType' => 'true',
+ 'items' => ['description' => '一条记录中的一个字段，详情请参见[Field](~~459828~~)。', '$ref' => '#/components/schemas/Field', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'backendName' => 'records',
+ 'example' => '',
],
],
+ 'example' => '',
],
'Field' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The value structure.',
'type' => 'object',
'properties' => [
- 'ArrayValue' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '[item1, item2, item3]',
- 'backendName' => 'arrayValue',
- ],
- 'BlobValue' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'aGVsbG8=',
- 'backendName' => 'blobValue',
- ],
- 'BooleanValue' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'boolean',
- 'example' => 'true',
- 'backendName' => 'booleanValue',
- ],
- 'IsNull' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'boolean',
- 'example' => 'true',
- 'backendName' => 'isNull',
- ],
- 'LongValue' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3213212',
- 'backendName' => 'longValue',
- ],
- 'StringValue' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'I am a string',
- 'backendName' => 'stringValue',
- ],
- ],
+ 'ArrayValue' => ['title' => '', 'description' => 'The array type value.', 'type' => 'string', 'example' => '[item1, item2, item3]'],
+ 'BlobValue' => ['title' => '', 'description' => 'The byte stream encoded in Base64 format.', 'type' => 'string', 'example' => 'aGVsbG8='],
+ 'BooleanValue' => ['title' => '', 'description' => 'The Boolean type value.', 'type' => 'boolean', 'example' => 'true'],
+ 'IsNull' => ['title' => '', 'description' => 'Indicates whether the field value is null. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The field value is null.'."\n"
+ ."\n"
+ .'- **false**: The field value is not null.', 'type' => 'boolean', 'example' => 'true'],
+ 'LongValue' => ['title' => '', 'description' => 'The Long type value.', 'type' => 'integer', 'format' => 'int64', 'example' => '3213212'],
+ 'StringValue' => ['title' => '', 'description' => 'The String type value.', 'type' => 'string', 'example' => 'I am a string'],
+ ],
+ 'example' => '',
],
'InsertListResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The response of the InsertList operation.',
'type' => 'object',
'properties' => [
- 'NumberOfRecordsUpdated' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- 'backendName' => 'numberOfRecordsUpdated',
- ],
+ 'NumberOfRecordsUpdated' => ['title' => '', 'description' => 'The number of records inserted.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'AutoIncrementKeys' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The auto-increment column value for each record upon insertion.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- 'extendType' => 'true',
- ],
- 'backendName' => 'autoIncrementKeys',
+ 'items' => ['description' => 'The auto-increment column value upon insertion of a single record.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'example' => '',
],
],
+ 'example' => '',
],
'InsertResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The return value of the Insert operation.',
'type' => 'object',
'properties' => [
- 'NumberOfRecordsUpdated' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- 'backendName' => 'numberOfRecordsUpdated',
- ],
- 'AutoIncrementKey' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- 'backendName' => 'autoIncrementKey',
- ],
+ 'NumberOfRecordsUpdated' => ['title' => '', 'description' => 'The number of records inserted.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'AutoIncrementKey' => ['title' => '', 'description' => 'The value of the auto-increment column in the insert operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
+ 'example' => '',
],
'ResultSetOptions' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The parameter description is as follows:',
'type' => 'object',
'properties' => [
- 'DecimalReturnType' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'STRING',
- 'backendName' => 'decimalReturnType',
- 'default' => 'STRING',
- ],
- 'LongReturnType' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'LONG',
- 'backendName' => 'longReturnType',
- 'default' => 'LONG',
- ],
- ],
+ 'DecimalReturnType' => ['title' => '', 'description' => 'The return type of DECIMAL columns. Valid values:'."\n"
+ ."\n"
+ .'- **STRING**'."\n"
+ ."\n"
+ .'- **DOUBLE_OR_LONG**'."\n"
+ ."\n"
+ .'Default value: **STRING**.', 'type' => 'string', 'example' => 'STRING', 'default' => 'STRING'],
+ 'LongReturnType' => ['title' => '', 'description' => 'The return type of Long columns. Valid values:'."\n"
+ ."\n"
+ .'- **LONG**'."\n"
+ ."\n"
+ .'- **STRING**'."\n"
+ ."\n"
+ .'Default value: **LONG**.', 'type' => 'string', 'example' => 'LONG', 'default' => 'LONG'],
+ ],
+ 'example' => '',
],
'RollbackTransactionResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The response of RollbackTransaction.',
'type' => 'object',
'properties' => [
- 'TransactionStatus' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'Transaction Rollback',
- 'backendName' => 'transactionStatus',
- ],
+ 'TransactionStatus' => ['title' => '', 'description' => 'The transaction status. Valid values:'."\n"
+ ."\n"
+ .'- **Transaction Commit**: The transaction is committed.'."\n"
+ ."\n"
+ .'- **Transaction Rollback**: The transaction is rolled back.', 'type' => 'string', 'example' => 'Transaction Rollback'],
],
+ 'example' => '',
],
'Selector' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The query condition for a single field.',
'type' => 'object',
'properties' => [
- 'Lt' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'lt',
- ],
- 'Le' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'le',
- ],
- 'Gt' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'gt',
- ],
- 'Ge' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'ge',
- ],
- 'Eq' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'eq',
- ],
- 'Ne' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'ne',
- ],
- 'Like' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'like',
- ],
+ 'Lt' => ['title' => '', 'description' => 'Less than.', 'type' => 'string', 'example' => '100（此字段小于100）'],
+ 'Le' => ['title' => '', 'description' => 'Less than or equal to.', 'type' => 'string', 'example' => '100（此字段小于等于100）'],
+ 'Gt' => ['title' => '', 'description' => 'Greater than.', 'type' => 'string', 'example' => '10（此字段大于10）'],
+ 'Ge' => ['title' => '', 'description' => 'Greater than or equal to.', 'type' => 'string', 'example' => '10（此字段大于等于10）'],
+ 'Eq' => ['title' => '', 'description' => 'Equal to.', 'type' => 'string', 'example' => 'victor（此字段等于victor）'],
+ 'Ne' => ['title' => '', 'description' => 'Not equal to.', 'type' => 'string', 'example' => 'rose（此字段不等于rose）'],
+ 'Like' => ['title' => '', 'description' => 'Fuzzy match.', 'type' => 'string', 'example' => 'jack%（此字段以jack开头）'],
],
+ 'example' => '',
],
'SelectResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The response of the Select operation.',
'type' => 'object',
'properties' => [
'Records' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The result set.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'visibility' => 'public',
+ 'description' => 'A record in the result set.',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'any',
- 'example' => 'value1',
- ],
- 'extendType' => 'true',
+ 'additionalProperties' => ['description' => 'A field of a record.', 'type' => 'any', 'example' => 'value1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'backendName' => 'records',
+ 'example' => '',
],
],
+ 'example' => '',
],
'SqlParameter' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The parameter description is as follows:',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'parameter_one',
- 'backendName' => 'name',
- ],
- 'TypeHint' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'string',
- 'example' => 'DATE',
- 'backendName' => 'typeHint',
- 'default' => 'DEFAULE',
- ],
- 'Value' => [
- 'description' => '',
- 'visibility' => 'public',
- 'backendName' => 'value',
- '$ref' => '#/components/schemas/Field',
- ],
- ],
+ 'Name' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => 'parameter_one'],
+ 'TypeHint' => ['title' => '', 'description' => 'The type used to store this parameter in the database. Valid values:'."\n"
+ ."\n"
+ .'- **DATE**'."\n"
+ ."\n"
+ .'- **DECIMAL**'."\n"
+ ."\n"
+ .'- **JSON**'."\n"
+ ."\n"
+ .'- **TIME**'."\n"
+ ."\n"
+ .'- **TIMESTAMP**.', 'type' => 'string', 'example' => 'DATE', 'default' => 'DEFAULE'],
+ 'Value' => ['description' => 'The parameter value. For more information, see [Field](~~459828~~).', '$ref' => '#/components/schemas/Field', 'title' => '', 'example' => ''],
+ ],
+ 'example' => '',
],
'UpdateResult' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
+ 'title' => '',
+ 'description' => 'The return value of the Update operation.',
'type' => 'object',
'properties' => [
- 'NumberOfRecordsUpdated' => [
- 'title' => '-',
- 'description' => '',
- 'visibility' => 'public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- 'backendName' => 'numberOfRecordsUpdated',
- ],
+ 'NumberOfRecordsUpdated' => ['title' => '', 'description' => 'The number of records updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
],
+ 'example' => '',
],
],
],
'apis' => [
- 'BeginTransaction' => [
- 'summary' => '开启事务',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BatchExecuteStatement' => [
+ 'summary' => 'Calls the BatchExecuteStatement operation to execute batch SQL statements on a set of data.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -620,81 +314,101 @@
[
'name' => 'SecretArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acs:rds:cn-hangzhou:1335786916******:rds-db-credent****/zha***Test03-21****',
- ],
+ 'schema' => ['description' => 'The user credential for the Data API account. You can call the [DescribeSecrets](~~446624~~) operation to obtain the value of this parameter. Format: `acs:rds:{{region}}:{{accountId}}:rds-db-credentials/{{secretName}}-{{6 digits random string}}`', 'type' => 'string', 'required' => true, 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credentials/mySecret-Uy****', 'title' => ''],
],
[
'name' => 'ResourceArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Specifies the resource that the user wants to access. Format: ```acs:rds:{{regionId}}:{{accountId}}:dbinstance/{{instanceId}}```'."\n"
+ ."\n"
+ .'Parameter description:'."\n"
+ ."\n"
+ .'- regionId: The region ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- accountId: The Alibaba Cloud account ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- instanceId: The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds:cn-hangzhou:1266348003******:dbinstance/rm-1234567890abc****', 'title' => ''],
],
[
'name' => 'Database',
'in' => 'formData',
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'Sql',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The SQL statement to execute.'."\n"
+ ."\n"
+ .'> The BatchExecuteStatement operation is typically used to execute **INSERT** and **UPDATE** statements.', 'type' => 'string', 'required' => true, 'example' => 'insert into users(name) values(:name)', 'title' => ''],
+ ],
+ [
+ 'name' => 'TransactionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the transaction that has been started. You can call the [BeginTransaction](~~446897~~) operation to obtain the value of this parameter.', 'type' => 'string', 'required' => false, 'example' => '8609****-94e1-45ce-8e25-354e3dd8****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ParameterSets',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
+ 'description' => 'The parameters of the SQL statements.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The parameters for a single SQL statement.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The parameter value. For more information, see [SqlParameter](~~459814~~).', '$ref' => '#/components/schemas/SqlParameter', 'required' => false, 'title' => '', 'example' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '4FD736C2-D774-5ACF-8366-8A72114BE7F9',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'There is an error in the call.',
- ],
- 'Data' => [
- 'description' => '',
- '$ref' => '#/components/schemas/BeginTransactionResult',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CDAEE474-87E5-5AE3-A534-922F90D5867D'],
+ 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request is successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.'."\n"
+ ."\n"
+ .'> This parameter is empty when the request is successful.', 'type' => 'string', 'example' => 'There is an error in the call.', 'title' => ''],
+ 'Data' => ['description' => 'The data returned by the request. For more information, see [BatchExecuteStatementResult](~~459817~~).', '$ref' => '#/components/schemas/BatchExecuteStatementResult', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4FD736C2-D774-5ACF-8366-8A72114BE7F9\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"TransactionId\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<BeginTransactionResponse>\\n <RequestId>4FD736C2-D774-5ACF-8366-8A72114BE7F9</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Data>\\n <TransactionId>8609****-94e1-45ce-8e25-354e3dd8****</TransactionId>\\n </Data>\\n</BeginTransactionResponse>","errorExample":""}]',
- ],
- 'CommitTransaction' => [
- 'summary' => '提交事务',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDAEE474-87E5-5AE3-A534-922F90D5867D\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"GeneratedFieldsList\\": [\\n [\\n {\\n \\"ArrayValue\\": \\"[item1, item2, item3]\\",\\n \\"BlobValue\\": \\"aGVsbG8=\\",\\n \\"BooleanValue\\": true,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 3213212,\\n \\"StringValue\\": \\"I am a string\\"\\n }\\n ]\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Batch execute SQL statements',
+ 'description' => '- This operation currently supports only Serverless instances in the China (Hangzhou) and China (Beijing) regions.'."\n"
+ .'- You can use DML statements with different parameter sets to perform batch update and insert operations on multiple records.'."\n"
+ .'- Compared with individual insert and update operations, batch operations can significantly improve performance.',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-15T06:14:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-08-12T06:43:41.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-08-02T03:25:56.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchExecuteStatement'],
+ ],
],
+ ],
+ 'BeginTransaction' => [
+ 'summary' => 'Starts a transaction.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -707,81 +421,64 @@
[
'name' => 'SecretArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credentials/mySecret-Uy****',
- ],
+ 'schema' => ['description' => 'The user credential of the Data API account. You can call the [DescribeSecrets](~~446624~~) operation to obtain the value of this parameter. Format: `acs:rds:{{region}}:{{accountId}}:rds-db-credentials/{{secretName}}-{{6 digits random string}}`.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds:cn-hangzhou:1335786916******:rds-db-credent****/zha***Test03-21****', 'title' => ''],
],
[
'name' => 'ResourceArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) that specifies the resource to access. Format: ```acs:rds:{{regionId}}:{{accountId}}:dbinstance/{{instanceId}}```'."\n"
+ ."\n"
+ .'Parameter description:'."\n"
+ ."\n"
+ .'- regionId: the region ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- accountId: the Alibaba Cloud account ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- instanceId: the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds:cn-hangzhou:13357869165******:dbinstance/rm-bp1m7l3j633******', 'title' => ''],
],
[
- 'name' => 'TransactionId',
+ 'name' => 'Database',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '8609****-94e1-45ce-8e25-354e3dd8****',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '9689CF67-B653-5A0F-B9E3-3CC6BBD580ED',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'There is an error in the call.',
- ],
- 'Data' => [
- 'description' => '',
- '$ref' => '#/components/schemas/CommitTransactionResult',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4FD736C2-D774-5ACF-8366-8A72114BE7F9'],
+ 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request is successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'There is an error in the call.', 'title' => ''],
+ 'Data' => ['description' => 'The returned data. For more information, see [BeginTransactionResult](~~459816~~).', '$ref' => '#/components/schemas/BeginTransactionResult', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9689CF67-B653-5A0F-B9E3-3CC6BBD580ED\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"TransactionStatus\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CommitTransactionResponse>\\n <RequestId>9689CF67-B653-5A0F-B9E3-3CC6BBD580ED</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Data>\\n <TransactionStatus>Transaction Commit</TransactionStatus>\\n </Data>\\n</CommitTransactionResponse>","errorExample":""}]',
- ],
- 'RollbackTransaction' => [
- 'summary' => '回滚事务',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD736C2-D774-5ACF-8366-8A72114BE7F9\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"TransactionId\\": \\"86****1d-****-45ce-****-354e****cb34\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Start a transaction',
+ 'description' => 'This operation is supported only for Serverless instances in the China (Hangzhou) and China (Beijing) regions.',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-15T06:14:38.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-08-02T03:25:56.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BeginTransaction'],
+ ],
],
+ ],
+ 'CommitTransaction' => [
+ 'summary' => 'Commits transaction changes by calling the CommitTransaction operation.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -794,81 +491,65 @@
[
'name' => 'SecretArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credenti***/mySecret-Uy****',
- ],
+ 'schema' => ['description' => 'The user credential of the Data API account. You can call the [DescribeSecrets](~~446624~~) operation to obtain the value of this parameter. Format: `acs:rds:{{region}}:{{accountId}}:rds-db-credentials/{{secretName}}-{{6 digits random string}}`.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credentials/mySecret-Uy****', 'title' => ''],
],
[
'name' => 'ResourceArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) that specifies the resource to access. Format: ```acs:rds:{{regionId}}:{{accountId}}:dbinstance/{{instanceId}}```'."\n"
+ ."\n"
+ .'Parameter description:'."\n"
+ ."\n"
+ .'- regionId: the region ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- accountId: the Alibaba Cloud account ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- instanceId: the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds:cn-hangzhou:1266348003******:dbinstance/rm-1234567890abc****', 'title' => ''],
],
[
'name' => 'TransactionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '8609****-94e1-45ce-8e25-354e3dd8****',
- ],
+ 'schema' => ['description' => 'The ID of the transaction to commit. You can call the **BeginTransaction** operation to obtain the value of this parameter.', 'type' => 'string', 'required' => true, 'example' => '8609****-94e1-45ce-8e25-354e3dd8****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D2FEE6D7-DCA6-57B4-946A-9E670B773518',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'There is an error in the call.',
- ],
- 'Data' => [
- 'description' => '',
- '$ref' => '#/components/schemas/RollbackTransactionResult',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9689CF67-B653-5A0F-B9E3-3CC6BBD580ED'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'There is an error in the call.', 'title' => ''],
+ 'Data' => ['description' => 'The returned data. For more information, see [CommitTransactionResult](~~459811~~).', '$ref' => '#/components/schemas/CommitTransactionResult', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D2FEE6D7-DCA6-57B4-946A-9E670B773518\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"TransactionStatus\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RollbackTransactionResponse>\\n <RequestId>D2FEE6D7-DCA6-57B4-946A-9E670B773518</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Data>\\n <TransactionStatus>Transaction Rollback</TransactionStatus>\\n </Data>\\n</RollbackTransactionResponse>","errorExample":""}]',
- ],
- 'InsertList' => [
- 'summary' => '批量插入数据',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9689CF67-B653-5A0F-B9E3-3CC6BBD580ED\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"TransactionStatus\\": \\"Transaction Commit\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Commit a transaction',
+ 'description' => 'This operation is supported only for Serverless instances in the China (Hangzhou) and China (Beijing) regions.',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-15T06:14:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-08-08T08:20:28.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-08-02T03:25:56.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CommitTransaction'],
+ ],
],
+ ],
+ 'ExecuteStatement' => [
+ 'summary' => 'Executes an SQL statement on a specified database by calling the ExecuteStatement operation.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -881,121 +562,142 @@
[
'name' => 'SecretArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credenti***/mySecret-Uy****',
- ],
+ 'schema' => ['description' => 'The user credential of the Data API account. You can call the [DescribeSecrets](~~446624~~) operation to obtain the value of this parameter. Format: `acs:rds:{{region}}:{{accountId}}:rds-db-credentials/{{secretName}}-{{6 digits random string}}`.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credentials/mySecret-Uy****', 'title' => ''],
],
[
'name' => 'ResourceArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The resource ARN that points to the resource that the user wants to access. Format: ```acs:rds:{{regionId}}:{{accountId}}:dbinstance/{{instanceId}}```'."\n"
+ ."\n"
+ .'Parameter description:'."\n"
+ ."\n"
+ .'- regionId: The region ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- accountId: The Alibaba Cloud account ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- instanceId: The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds:cn-hangzhou:1266348003******:dbinstance/rm-1234567890abc****', 'title' => ''],
],
[
'name' => 'Database',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_db',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'Table',
+ 'name' => 'ContinueAfterTimeout',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'user',
- ],
+ 'schema' => ['description' => 'Specifies whether to continue running the SQL statement if the call times out. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Continue running.'."\n"
+ .'- **false**: Stop running.'."\n"
+ ."\n"
+ .'> By default, the SQL statement stops running after the call times out.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'FormatRecordsAs',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to format the result set as a single JSON string.'."\n"
+ ."\n"
+ .'- Only **NONE** or **JSON** can be specified.'."\n"
+ .'- Default value: **NONE**.'."\n"
+ .'- This parameter applies only to SELECT statements and is ignored for other types of statements.'."\n"
+ .'- The result is returned in **formattedRecords**.', 'type' => 'string', 'required' => false, 'example' => 'JSON', 'title' => ''],
+ ],
+ [
+ 'name' => 'IncludeResultMetadata',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to include metadata in the result. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Include metadata.'."\n"
+ .'- **false**: Do not include metadata.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'Sql',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The SQL statement to execute.', 'type' => 'string', 'required' => true, 'example' => 'select * from users', 'title' => ''],
],
[
'name' => 'TransactionId',
'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the transaction that has been started. You can call the [BeginTransaction](~~446897~~) operation to obtain the value of this parameter.', 'type' => 'string', 'required' => false, 'example' => '8609****-94e1-45ce-8e25-354e3dd8****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The details of the parameters for the SQL statement to execute.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The parameter value. For more information, see [SqlParameter](~~459814~~).', '$ref' => '#/components/schemas/SqlParameter', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
- 'example' => '8609****-94e1-45ce-8e25-354e3dd8****',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Records',
+ 'name' => 'ResultSetOptions',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => 'test_value',
- 'description' => '',
- ],
+ 'description' => 'The options that control how the result set is returned.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DecimalReturnType' => ['description' => 'The data type that is allowed for display after a DECIMAL value is returned.'."\n"
+ ."\n"
+ .'- **STRING**: Converts the field to a String value.'."\n"
+ .'- **DOUBLE\\_OR\\_LONG**: Converts the field to a **Long** value if its scale is 0. Otherwise, converts the field to a **Double** value.', 'type' => 'string', 'required' => false, 'example' => 'STRING', 'title' => ''],
+ 'LongReturnType' => ['description' => 'The data type that is allowed for display after a LONG value is returned.'."\n"
+ ."\n"
+ .'- Valid values: **LONG** and **STRING**.'."\n"
+ .'- Default value: **LONG**.'."\n"
+ .'- If the length or precision of the value may cause truncation or rounding errors, specify **STRING**.', 'type' => 'string', 'required' => false, 'example' => 'STRING', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D2FEE6D7-DCA6-57B4-946A-9E670B773518',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'There is an error in the call.',
- ],
- 'Data' => [
- 'description' => '',
- '$ref' => '#/components/schemas/InsertListResult',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CDAEE474-87E5-5AE3-A534-922F90D5867D'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'There is an error in the call.', 'title' => ''],
+ 'Data' => ['description' => 'The returned data. For more information, see [ExecuteStatementResult](~~459820~~).', '$ref' => '#/components/schemas/ExecuteStatementResult', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2FEE6D7-DCA6-57B4-946A-9E670B773518\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"NumberOfRecordsUpdated\\": 0,\\n \\"AutoIncrementKeys\\": [\\n 0\\n ]\\n }\\n}","type":"json"}]',
- ],
- 'ExecuteStatement' => [
- 'summary' => '执行SQL',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDAEE474-87E5-5AE3-A534-922F90D5867D\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"ColumnMetadata\\": [\\n {\\n \\"ArrayBaseColumnType\\": 1,\\n \\"IsAutoIncrement\\": true,\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"IsSigned\\": false,\\n \\"Label\\": \\"TBL_BIG\\",\\n \\"Name\\": \\"name\\",\\n \\"Nullable\\": 1,\\n \\"Precision\\": 1,\\n \\"Scale\\": 2,\\n \\"SchemaName\\": \\"test_schema\\",\\n \\"TableName\\": \\"users\\",\\n \\"Type\\": 93,\\n \\"TypeName\\": \\"TIMESTAMP\\"\\n }\\n ],\\n \\"FormattedRecords\\": \\"[{ \\\\\\"name\\\\\\": \\\\\\"jack\\\\\\" }]\\",\\n \\"GeneratedFields\\": [\\n {\\n \\"ArrayValue\\": \\"[item1, item2, item3]\\",\\n \\"BlobValue\\": \\"aGVsbG8=\\",\\n \\"BooleanValue\\": true,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 3213212,\\n \\"StringValue\\": \\"I am a string\\"\\n }\\n ],\\n \\"NumberOfRecordsUpdated\\": 2,\\n \\"Records\\": [\\n [\\n {\\n \\"ArrayValue\\": \\"[item1, item2, item3]\\",\\n \\"BlobValue\\": \\"aGVsbG8=\\",\\n \\"BooleanValue\\": true,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 3213212,\\n \\"StringValue\\": \\"I am a string\\"\\n }\\n ]\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Execute an SQL statement',
+ 'description' => 'This operation is supported only for Serverless instances in the China (Hangzhou) and China (Beijing) regions.',
+ 'changeSet' => [
+ ['createdAt' => '2023-09-14T10:07:57.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-11-15T06:14:38.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-08-12T06:43:41.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-08-10T03:54:48.000Z', 'description' => 'Response parameters changed, Error codes changed'],
+ ['createdAt' => '2022-08-08T08:20:28.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-08-02T03:25:56.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteStatement'],
+ ],
],
+ ],
+ 'InsertList' => [
+ 'summary' => 'Invokes InsertList to bulk insert data.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1008,170 +710,96 @@
[
'name' => 'SecretArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credentials/mySecret-Uy****',
- ],
+ 'schema' => ['description' => 'The user credential of the Data API account. You can call the [DescribeSecrets](https://help.aliyun.com/document_detail/446624.html) operation to obtain the value of this parameter. Format: `acs:rds:{{region}}:{{accountId}}:rds-db-credentials/{{secretName}}-{{6 digits random string}}`.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credenti***/mySecret-Uy****', 'title' => ''],
],
[
'name' => 'ResourceArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) that specifies the resource to access. Format: ```acs:rds:{{regionId}}:{{accountId}}:dbinstance/{{instanceId}}```'."\n"
+ ."\n"
+ .'Parameter description:'."\n"
+ ."\n"
+ .'- regionId: the region ID. You can invoke the [DescribeSecrets](https://help.aliyun.com/document_detail/446624.html) operation to obtain this value.'."\n"
+ .'- accountId: the Alibaba Cloud account ID. You can invoke the [DescribeSecrets](https://help.aliyun.com/document_detail/446624.html) operation to obtain this value.'."\n"
+ .'- instanceId: the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds:cn-hangzhou:1266348003******:dbinstance/rm-1234567890abc****', 'title' => ''],
],
[
'name' => 'Database',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'ContinueAfterTimeout',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'FormatRecordsAs',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'JSON',
- ],
- ],
- [
- 'name' => 'IncludeResultMetadata',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''],
],
[
- 'name' => 'Sql',
+ 'name' => 'Table',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'select * from users',
- ],
+ 'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 'user', 'title' => ''],
],
[
'name' => 'TransactionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8609****-94e1-45ce-8e25-354e3dd8****',
- ],
+ 'schema' => ['description' => 'The ID of the transaction to commit. You can call the **BeginTransaction** operation to obtain the value of this parameter.', 'type' => 'string', 'required' => false, 'example' => '8609****-94e1-45ce-8e25-354e3dd8****', 'title' => ''],
],
[
- 'name' => 'Parameters',
+ 'name' => 'Records',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The data to bulk insert. The data structure is an array, where each item represents a record.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The data to insert. The data structure is a map. '."\n"
+ .'The key is the table field name, and the value is the field value. '."\n"
+ ."\n"
+ .'Example: `{ name: "jack", age: 18 }`.',
+ 'type' => 'object',
'required' => false,
- '$ref' => '#/components/schemas/SqlParameter',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'ResultSetOptions',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'DecimalReturnType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'STRING',
- ],
- 'LongReturnType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'STRING',
- ],
+ 'additionalProperties' => ['description' => 'The value of the data to insert. The value can be of any type.', 'type' => 'any', 'example' => 'test_value', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CDAEE474-87E5-5AE3-A534-922F90D5867D',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'There is an error in the call.',
- ],
- 'Data' => [
- 'description' => '',
- '$ref' => '#/components/schemas/ExecuteStatementResult',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D2FEE6D7-DCA6-57B4-946A-9E670B773518'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.'."\n"
+ ."\n"
+ .'> This parameter is empty when the request is successful.', 'type' => 'string', 'example' => 'There is an error in the call.', 'title' => ''],
+ 'Data' => ['description' => 'The return value of InsertList. For more information, see [InsertListResult](https://help.aliyun.com/document_detail/462779.html).', '$ref' => '#/components/schemas/InsertListResult', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CDAEE474-87E5-5AE3-A534-922F90D5867D\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"ColumnMetadata\\": [\\n {\\n \\"ArrayBaseColumnType\\": 0,\\n \\"IsAutoIncrement\\": true,\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"IsSigned\\": true,\\n \\"Label\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Nullable\\": 0,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"Type\\": 0,\\n \\"TypeName\\": \\"\\"\\n }\\n ],\\n \\"FormattedRecords\\": \\"\\",\\n \\"GeneratedFields\\": [\\n {\\n \\"ArrayValue\\": \\"\\",\\n \\"BlobValue\\": \\"\\",\\n \\"BooleanValue\\": true,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 0,\\n \\"StringValue\\": \\"\\"\\n }\\n ],\\n \\"NumberOfRecordsUpdated\\": 0,\\n \\"Records\\": [\\n [\\n {\\n \\"ArrayValue\\": \\"\\",\\n \\"BlobValue\\": \\"\\",\\n \\"BooleanValue\\": true,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 0,\\n \\"StringValue\\": \\"\\"\\n }\\n ]\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ExecuteStatementResponse>\\n <RequestId>CDAEE474-87E5-5AE3-A534-922F90D5867D</RequestId>\\n <Data>\\n <NumberOfRecordsUpdated>0</NumberOfRecordsUpdated>\\n <Records>\\n <0>\\n <LongValue>1</LongValue>\\n </0>\\n <1>\\n <StringValue>user1</StringValue>\\n </1>\\n </Records>\\n <Records>\\n <0>\\n <LongValue>2</LongValue>\\n </0>\\n <1>\\n <StringValue>user2</StringValue>\\n </1>\\n </Records>\\n <Records>\\n <0>\\n <LongValue>3</LongValue>\\n </0>\\n <1>\\n <StringValue>user3</StringValue>\\n </1>\\n </Records>\\n <Records>\\n <0>\\n <LongValue>4</LongValue>\\n </0>\\n <1>\\n <StringValue>user4</StringValue>\\n </1>\\n </Records>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ExecuteStatementResponse>","errorExample":""}]',
- ],
- 'BatchExecuteStatement' => [
- 'summary' => '批量执行SQL',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2FEE6D7-DCA6-57B4-946A-9E670B773518\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"NumberOfRecordsUpdated\\": 5,\\n \\"AutoIncrementKeys\\": [\\n 2\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Insert multiple data records',
+ 'description' => 'This operation is currently supported only by Serverless instances in the China (Hangzhou) and China (Beijing) regions.',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-15T06:14:37.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InsertList'],
+ ],
],
+ ],
+ 'RollbackTransaction' => [
+ 'summary' => 'Rolls back a transaction by calling the RollbackTransaction operation. Rolling back a transaction cancels its changes.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1184,121 +812,157 @@
[
'name' => 'SecretArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credentials/mySecret-Uy****',
- ],
+ 'schema' => ['description' => 'The user credential of the Data API account. You can call the [DescribeSecrets](~~446624~~) operation to obtain the value of this parameter. Format: `acs:rds:{{region}}:{{accountId}}:rds-db-credentials/{{secretName}}-{{6 digits random string}}`.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds-api:cn-hangzhou:1266348003******:rds-db-credenti***/mySecret-Uy****', 'title' => ''],
],
[
'name' => 'ResourceArn',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'Database',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'Sql',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'insert into users(name) values(:name)',
- ],
+ 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) that specifies the resource to access. Format: ```acs:rds:{{regionId}}:{{accountId}}:dbinstance/{{instanceId}}```'."\n"
+ ."\n"
+ .'Parameter description:'."\n"
+ ."\n"
+ .'- regionId: the region ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- accountId: the Alibaba Cloud account ID. You can call the [DescribeSecrets](~~446624~~) operation to obtain this value.'."\n"
+ .'- instanceId: the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'acs:rds:cn-hangzhou:1266348003******:dbinstance/rm-1234567890abc****', 'title' => ''],
],
[
'name' => 'TransactionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8609****-94e1-45ce-8e25-354e3dd8****',
- ],
- ],
- [
- 'name' => 'ParameterSets',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/SqlParameter',
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the transaction to roll back. You can call the **BeginTransaction** operation to obtain the value of this parameter.', 'type' => 'string', 'required' => true, 'example' => '8609****-94e1-45ce-8e25-354e3dd8****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CDAEE474-87E5-5AE3-A534-922F90D5867D',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'There is an error in the call.',
- ],
- 'Data' => [
- 'description' => '',
- '$ref' => '#/components/schemas/BatchExecuteStatementResult',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D2FEE6D7-DCA6-57B4-946A-9E670B773518'],
+ 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request is successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'There is an error in the call.', 'title' => ''],
+ 'Data' => ['description' => 'The returned data. For more information, see [RollbackTransactionResult](~~459815~~).', '$ref' => '#/components/schemas/RollbackTransactionResult', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CDAEE474-87E5-5AE3-A534-922F90D5867D\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"GeneratedFieldsList\\": [\\n [\\n {\\n \\"ArrayValue\\": \\"\\",\\n \\"BlobValue\\": \\"\\",\\n \\"BooleanValue\\": true,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 0,\\n \\"StringValue\\": \\"\\"\\n }\\n ]\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<BatchExecuteStatementResponse>\\n <RequestId>432A039B-0520-5324-B1CA-87D2FDFC5638</RequestId>\\n <Data>\\n <UpdateResults>\\n <GeneratedFields>\\n <LongValue>16</LongValue>\\n </GeneratedFields>\\n </UpdateResults>\\n <UpdateResults>\\n <GeneratedFields>\\n <LongValue>17</LongValue>\\n </GeneratedFields>\\n </UpdateResults>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchExecuteStatementResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2FEE6D7-DCA6-57B4-946A-9E670B773518\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There is an error in the call.\\",\\n \\"Data\\": {\\n \\"TransactionStatus\\": \\"Transaction Rollback\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Roll back a transaction',
+ 'description' => 'This operation is supported only for Serverless instances in the China (Hangzhou) and China (Beijing) regions.',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-15T06:14:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-09-15T08:44:04.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-08-08T08:20:28.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-08-02T03:25:56.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RollbackTransaction'],
+ ],
+ ],
],
],
'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds-data.cn-beijing.aliyuncs.com', 'endpoint' => 'rds-data.cn-beijing.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds-data.cn-hangzhou.aliyuncs.com', 'endpoint' => 'rds-data.cn-hangzhou.aliyuncs.com', 'vpc' => 'rds-data-vpc.cn-hangzhou.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'InvalidReleasedKeepPolicy.Format', 'message' => 'Specified Released Keep Policy is not valid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidUsedTime', 'message' => 'The usedTime cannot be greater than the instance expiration time.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'Delete'],
+ ['description' => 'Request parameters changed', 'api' => 'ExecuteStatement'],
+ ['description' => 'Request parameters changed', 'api' => 'Select'],
+ ['description' => 'Request parameters changed', 'api' => 'Update'],
+ ],
+ 'createdAt' => '2023-09-14T10:07:28.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'BatchExecuteStatement'],
+ ['description' => 'Request parameters changed', 'api' => 'BeginTransaction'],
+ ['description' => 'Request parameters changed', 'api' => 'CommitTransaction'],
+ ['description' => 'Request parameters changed', 'api' => 'Delete'],
+ ['description' => 'Request parameters changed', 'api' => 'ExecuteStatement'],
+ ['description' => 'Request parameters changed', 'api' => 'Insert'],
+ ['description' => 'Request parameters changed', 'api' => 'InsertList'],
+ ['description' => 'Request parameters changed', 'api' => 'RollbackTransaction'],
+ ['description' => 'Request parameters changed', 'api' => 'Select'],
+ ['description' => 'Request parameters changed', 'api' => 'Update'],
+ ],
+ 'createdAt' => '2022-11-15T06:16:01.000Z',
+ 'description' => '-',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'BatchExecuteStatement'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'BatchExecuteStatement'],
+ ['description' => 'Response parameters changed', 'api' => 'BeginTransaction'],
+ ['description' => 'Response parameters changed', 'api' => 'BeginTransaction'],
+ ['description' => 'Response parameters changed', 'api' => 'CommitTransaction'],
+ ['description' => 'Response parameters changed', 'api' => 'CommitTransaction'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ExecuteStatement'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ExecuteStatement'],
+ ['description' => 'Response parameters changed', 'api' => 'RollbackTransaction'],
+ ['description' => 'Response parameters changed', 'api' => 'RollbackTransaction'],
+ ],
+ 'createdAt' => '2022-09-15T08:44:23.000Z',
+ 'description' => '-',
+ ],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'rds-data.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'BatchExecuteStatement'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ExecuteStatement'],
+ ],
+ 'createdAt' => '2022-08-12T06:44:23.000Z',
+ 'description' => 'update ExecuteStatement BatchExecuteStatement',
],
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'rds-data.cn-beijing.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'ExecuteStatement'],
+ ],
+ 'createdAt' => '2022-08-10T03:55:30.000Z',
+ 'description' => '更新ExecuteStatement',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CommitTransaction'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ExecuteStatement'],
+ ['description' => 'Request parameters changed', 'api' => 'RollbackTransaction'],
+ ],
+ 'createdAt' => '2022-08-08T08:21:00.000Z',
+ 'description' => '修改出入参',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'BatchExecuteStatement'],
+ ['description' => 'OpenAPI offline', 'api' => 'BeginTransaction'],
+ ['description' => 'OpenAPI offline', 'api' => 'CommitTransaction'],
+ ['description' => 'OpenAPI offline', 'api' => 'ExecuteStatement'],
+ ['description' => 'OpenAPI offline', 'api' => 'RollbackTransaction'],
+ ],
+ 'createdAt' => '2022-08-02T04:08:06.000Z',
+ 'description' => 'DataAPI发布',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BeginTransaction'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CommitTransaction'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteStatement'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InsertList'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchExecuteStatement'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RollbackTransaction'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 20:55:21 +0000