diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/tablestore/2020-12-09 | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/tablestore/2020-12-09')
| -rw-r--r-- | data/zh_cn/tablestore/2020-12-09/api-docs.php | 2943 |
1 files changed, 2943 insertions, 0 deletions
diff --git a/data/zh_cn/tablestore/2020-12-09/api-docs.php b/data/zh_cn/tablestore/2020-12-09/api-docs.php new file mode 100644 index 0000000..92682b1 --- /dev/null +++ b/data/zh_cn/tablestore/2020-12-09/api-docs.php @@ -0,0 +1,2943 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'Tablestore', + 'version' => '2020-12-09', + ], + 'directories' => [ + [ + 'id' => 366132, + 'title' => '实例', + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'CreateVCUInstance', + 'DeleteInstance', + 'DeleteVCUInstance', + 'GetInstance', + 'UpdateInstance', + 'ListInstances', + ], + ], + [ + 'id' => 366140, + 'title' => '资源标签', + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 366145, + 'title' => '实例访问控制策略', + 'type' => 'directory', + 'children' => [ + 'UpdateInstancePolicy', + 'DeleteInstancePolicy', + 'CheckInstancePolicy', + ], + ], + [ + 'id' => 366149, + 'title' => '地域', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 366151, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ListClusterType', + 'UpdateInstanceElasticVCUUpperLimit', + 'BindInstance2Vpc', + 'ListVpcInfoByInstance', + 'ListVpcInfoByVpc', + 'UnbindInstance2Vpc', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateInstance' => [ + 'summary' => '创建实例。', + 'path' => '/v2/openapi/createinstance', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '85461', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'request body', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'title' => 'instance name', + 'description' => '实例名称。实例的命名规范如下：'."\n" + .'- 必须由英文字母、数字或短划线（-）组成。'."\n" + .'- 首字符必须为英文字母。'."\n" + .'- 末尾字符不能为短划线（-）。'."\n" + .'- 大小写不敏感。'."\n" + .'- 长度在3~16字符之间。'."\n" + .'- 实例名称不能包含ali、ay、ots、taobao、admin这几个单词。', + 'type' => 'string', + 'required' => true, + 'example' => 'instance-test', + ], + 'ClusterType' => [ + 'title' => 'cluster type', + 'description' => '集群类型（即实例规格）。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SSD' => '高性能', + 'HYBRID' => '容量型', + ], + 'example' => 'SSD', + ], + 'InstanceDescription' => [ + 'title' => 'instance description', + 'description' => '实例描述。长度限制在3-256个字符之间。', + 'type' => 'string', + 'required' => false, + 'example' => 'the test instance', + ], + 'ResourceGroupId' => [ + 'title' => 'resource group id', + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxh4em5jnbcd', + ], + 'Network' => [ + 'title' => '（已弃用）实例网络类型。NORMAL, VPC_CONSOLE。默认为NORMAL。', + 'description' => '（已弃用）实例网络类型。NORMAL, VPC_CONSOLE。默认为NORMAL。', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + ], + 'NetworkTypeACL' => [ + 'title' => '实例允许的网络类型列表。默认都允许。CLASSIC: 经典网；INTERNET: 公网；VPC：VPC网络。', + 'description' => '实例允许的网络类型列表，默认都允许。'."\n" + .'- INTERNET：公网。'."\n" + .'- VPC：VPC网络。'."\n" + .'- CLASSIC：经典网。', + 'type' => 'array', + 'items' => [ + 'description' => '实例允许的网络类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'INTERNET' => '公网', + 'VPC' => 'VPC网络', + 'CLASSIC' => '经典网', + ], + 'example' => 'VPC', + ], + 'required' => false, + ], + 'NetworkSourceACL' => [ + 'title' => '实例允许的网络来源列表。默认都允许。TRUST_PROXY: 控制台。', + 'description' => '实例允许的网络来源列表，默认都允许。'."\n" + ."\n" + .'TRUST_PROXY：可信网关（控制台）。', + 'type' => 'array', + 'items' => [ + 'description' => '实例允许的网络来源。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TRUST_PROXY' => '可信网关（控制台）', + ], + 'example' => 'TRUST_PROXY', + ], + 'required' => false, + ], + 'Policy' => [ + 'title' => '实例访问控制策略，JSON格式。配置语法见：https://help.aliyun.com/zh/ram/user-guide/policy-structure-and-syntax', + 'description' => '实例访问控制策略，JSON格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Version": "1",'."\n" + .' "Statement": ['."\n" + .' {'."\n" + .' "Action": ['."\n" + .' "ots:*"'."\n" + .' ],'."\n" + .' "Resource": ['."\n" + .' "acs:ots:*:13791xxxxxxxxxxx:instance/myinstance*"'."\n" + .' ],'."\n" + .' "Principal": ['."\n" + .' "*"'."\n" + .' ],'."\n" + .' "Effect": "Allow",'."\n" + .' "Condition": {'."\n" + .' "StringEquals": {'."\n" + .' "ots:TLSVersion": ['."\n" + .' "1.2"'."\n" + .' ]'."\n" + .' },'."\n" + .' "IpAddress": {'."\n" + .' "acs:SourceIp": ['."\n" + .' "192.168.0.1",'."\n" + .' "198.51.100.1"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + 'maxLength' => 4000, + ], + 'Tags' => [ + 'title' => 'tag', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键值对。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。'."\n" + .'长度限制为64个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'p_instance', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + .'长度限制为64个字符。', + 'type' => 'string', + 'required' => true, + 'example' => '0woauavextilfqr61', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'DisableReplication' => [ + 'title' => '是否开启实例的容灾状态', + 'description' => '（已弃用）是否开启实例的容灾状态。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'request id', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '39871ED2-62C0-578F-A32E-B88072D5582F', + ], + 'Code' => [ + 'title' => '响应状态码', + 'description' => '响应状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => '响应消息描述', + 'description' => '响应消息描述。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39871ED2-62C0-578F-A32E-B88072D5582F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '创建实例', + 'description' => '- **请确保在使用该接口前，已充分了解Tablestore产品的计费说明和价格。更多信息，请参见[计费概览](~~27291~~)。**'."\n" + .'- 单个阿里云账户最多可以创建10个实例，且在同一地域中实例名称必须唯一。'."\n" + .'- 集群类型（即实例规格）在实例创建后无法修改，请谨慎选择。', + ], + 'CreateVCUInstance' => [ + 'summary' => '创建VCU实例。', + 'path' => '/v2/openapi/createvcuinstance', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '85461', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'request body', + 'description' => 'request body', + 'type' => 'object', + 'properties' => [ + 'ClusterType' => [ + 'title' => 'cluster type', + 'description' => 'cluster type', + 'type' => 'string', + 'required' => true, + 'example' => 'SSD vs HYBRID', + ], + 'VCU' => [ + 'title' => '实例规格：VCU数量', + 'description' => '实例规格：VCU数量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '2000', + 'minimum' => '0', + 'example' => '1', + ], + 'PeriodInMonth' => [ + 'title' => '购买的时长。单位：月。', + 'description' => '购买的时长。单位：月。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '24', + 'minimum' => '1', + 'example' => '1', + ], + 'EnableElasticVCU' => [ + 'title' => '是否开启实例弹性。如果开启弹性，实例的峰值VCU用量可以超过购买的VCU量，但是会有额外的费用。', + 'description' => '是否开启实例弹性。如果开启弹性，实例的峰值VCU用量可以超过购买的VCU量，但是会有额外的费用。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'AliasName' => [ + 'title' => '实例别名', + 'description' => '实例别名', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'InstanceDescription' => [ + 'title' => '实例描述', + 'description' => '实例描述', + 'type' => 'string', + 'required' => false, + 'example' => 'testvcu', + ], + 'Tags' => [ + 'title' => 'tag', + 'description' => 'tag', + 'type' => 'array', + 'items' => [ + 'description' => '标签键值对。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。'."\n" + .'长度限制为64个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'created', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + .'长度限制为64个字符。', + 'type' => 'string', + 'required' => true, + 'example' => '0woauavextilfqr61', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ResourceGroupId' => [ + 'title' => 'resource group id', + 'description' => 'resource group id', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxh4em5jnbcd', + ], + 'EnableAutoRenew' => [ + 'title' => '是否开启自动续费', + 'description' => '是否开启自动续费', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'AutoRenewPeriodInMonth' => [ + 'title' => '自动续费周期，当开启自动续费时，必填', + 'description' => '自动续费周期，当开启自动续费时，必填', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '24', + 'minimum' => '1', + 'example' => '1', + ], + 'DryRun' => [ + 'title' => '是否是空跑，如果空跑，则不生产实例。', + 'description' => '是否是空跑，如果空跑，则不生产实例。', + 'type' => 'boolean', + 'deprecated' => false, + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'request id', + 'description' => 'request id', + 'type' => 'string', + 'example' => '39871ED2-62C0-578F-A32E-B88072D5582F', + ], + 'InstanceName' => [ + 'title' => '生产的实例名称', + 'description' => '生产的实例名称', + 'type' => 'string', + 'example' => 'instance-test', + ], + 'Code' => [ + 'title' => '响应状态码', + 'description' => '响应状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => '响应消息描述', + 'description' => '响应消息描述', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39871ED2-62C0-578F-A32E-B88072D5582F\\",\\n \\"InstanceName\\": \\"instance-test\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '创建VCU实例', + 'description' => '- **请确保在使用该接口前，已充分了解Tablestore产品的计费说明和价格。更多信息，请参见[计费概览](~~27291~~)。**'."\n" + .'- 单个阿里云账户最多可以创建10个实例，且在同一地域中实例名称必须唯一。'."\n" + .'- 集群类型（即实例规格）在实例创建后无法修改，请谨慎选择。', + ], + 'DeleteInstance' => [ + 'summary' => '删除实例。', + 'path' => '/v2/openapi/deleteinstance', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '85462', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'request body', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'title' => 'instance name', + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'instance-test', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '17827FB1-CC71-559D-BBDF-9D41534322E7', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17827FB1-CC71-559D-BBDF-9D41534322E7\\"\\n}","type":"json"}]', + 'title' => '删除实例', + 'description' => '- 删除实例前，必须先删除实例中的数据表和时序表以及解除已绑定的VPC。'."\n" + .'- 为了避免冲突，在删除过程中，请不要创建与删除实例名称相同的实例。'."\n" + .'- 实例删除后会导致实例不可用，且实例中的表、表数据以及相关索引不可恢复，请谨慎操作。', + ], + 'DeleteVCUInstance' => [ + 'summary' => '删除VCU实例', + 'path' => '/v2/openapi/deletevcuinstance', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '85461', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Instance name', + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'instance_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'request id', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '39871ED2-62C0-578F-A32E-B88072D5582F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39871ED2-62C0-578F-A32E-B88072D5582F\\"\\n}","type":"json"}]', + 'title' => '删除VCU实例', + ], + 'GetInstance' => [ + 'summary' => '获取实例信息。', + 'path' => '/v2/openapi/getinstance', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8524', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'instance-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '757E172A-F94B-5E78-8A23-D9068E42F2E9', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'instance-test', + ], + 'ResourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxh4em5jncda', + ], + 'RegionId' => [ + 'description' => '实例的地域ID。', + 'type' => 'string', + 'example' => 'cn-chengdu', + ], + 'SPInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'ots_standard_public_cn-9lb34u7u5001', + ], + 'AliasName' => [ + 'description' => '实例别名。', + 'type' => 'string', + 'example' => 'instance-test', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '16542312566', + ], + 'Network' => [ + 'description' => '网络类型，取值范围如下：'."\n" + .'- VPC：限定绑定VPC访问。'."\n" + .'- VPC_CONSOLE：限定控制台或绑定VPC访问。'."\n" + .'- NORMAL：自定义。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'VPC', + ], + 'InstanceDescription' => [ + 'description' => '实例描述。', + 'type' => 'string', + 'example' => '测试实例的描述信息。', + ], + 'InstanceSpecification' => [ + 'description' => '实例规格。'."\n" + .'- SSD：高性能。'."\n" + .'- HYBRID：容量型。', + 'type' => 'string', + 'example' => 'SSD', + ], + 'PaymentType' => [ + 'description' => '付费方式。'."\n" + .'- Subscription：包年包月。'."\n" + .'- PayAsYouGo：按量付费。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'StorageType' => [ + 'description' => '存储类型。'."\n" + .'- SSD：高性能。'."\n" + .'- HYBRID：容量型。', + 'type' => 'string', + 'example' => 'HYBRID', + ], + 'VCUQuota' => [ + 'description' => 'VCU配额。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TableQuota' => [ + 'description' => '实例下的表总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InstanceStatus' => [ + 'description' => '实例状态。'."\n" + .'- normal：正常。'."\n" + .'- forbidden：禁用。'."\n" + .'- deleting：释放中。', + 'type' => 'string', + 'example' => 'normal', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2019-12-23T07:24:33Z', + ], + 'Tags' => [ + 'description' => '实例的标签集合。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => '333', + ], + 'TagKey' => [ + 'description' => '（已废弃）标签键。', + 'type' => 'string', + 'example' => 'keyTestA', + ], + 'TagValue' => [ + 'description' => '（已废弃）标签值。', + 'type' => 'string', + 'example' => '00004a20240452b0', + ], + ], + ], + ], + 'NetworkTypeACL' => [ + 'title' => '实例允许的网络类型列表。CLASSIC: 经典网；INTERNET: 公网；VPC：VPC网络。', + 'description' => '实例允许的网络类型列表。'."\n" + .'- CLASSIC：经典网。'."\n" + .'- INTERNET：公网。'."\n" + .'- VPC：VPC网络。', + 'type' => 'array', + 'items' => [ + 'description' => '实例允许的网络类型。', + 'type' => 'string', + 'example' => 'INTERNET', + ], + ], + 'NetworkSourceACL' => [ + 'title' => '实例允许的网络来源列表。TRUST_PROXY: 控制台；', + 'description' => '实例允许的网络来源列表。'."\n" + ."\n" + .'TRUST_PROXY：控制台。', + 'type' => 'array', + 'items' => [ + 'description' => '实例允许的网络来源。', + 'type' => 'string', + 'example' => 'TRUST_PROXY', + ], + ], + 'Policy' => [ + 'title' => 'Instance policy 访问控制策略', + 'description' => '实例访问控制策略。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Version": "1",'."\n" + .' "Statement": ['."\n" + .' {'."\n" + .' "Action": ['."\n" + .' "ots:*"'."\n" + .' ],'."\n" + .' "Resource": ['."\n" + .' "acs:ots:*:13791xxxxxxxxxxx:instance/myinstance*"'."\n" + .' ],'."\n" + .' "Principal": ['."\n" + .' "*"'."\n" + .' ],'."\n" + .' "Effect": "Allow",'."\n" + .' "Condition": {'."\n" + .' "StringEquals": {'."\n" + .' "ots:TLSVersion": ['."\n" + .' "1.2"'."\n" + .' ]'."\n" + .' },'."\n" + .' "IpAddress": {'."\n" + .' "acs:SourceIp": ['."\n" + .' "192.168.0.1",'."\n" + .' "198.51.100.1"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'PolicyVersion' => [ + 'title' => 'Instance policy的版本', + 'description' => '实例访问控制策略的版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'IsMultiAZ' => [ + 'title' => '冗余类型。true表示同城冗余，false表示本地冗余', + 'description' => '是否同城冗余。'."\n" + .'- true：是，表示同城冗余。'."\n" + .'- false：否，表示本地冗余。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ElasticVCUUpperLimit' => [ + 'description' => '实例弹性上限。', + 'type' => 'number', + 'format' => 'float', + 'example' => '6', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"757E172A-F94B-5E78-8A23-D9068E42F2E9\\",\\n \\"InstanceName\\": \\"instance-test\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxh4em5jncda\\",\\n \\"RegionId\\": \\"cn-chengdu\\",\\n \\"SPInstanceId\\": \\"ots_standard_public_cn-9lb34u7u5001\\",\\n \\"AliasName\\": \\"instance-test\\",\\n \\"UserId\\": \\"16542312566\\",\\n \\"Network\\": \\"VPC\\",\\n \\"InstanceDescription\\": \\"测试实例的描述信息。\\",\\n \\"InstanceSpecification\\": \\"SSD\\",\\n \\"PaymentType\\": \\"Subscription\\",\\n \\"StorageType\\": \\"HYBRID\\",\\n \\"VCUQuota\\": 20,\\n \\"TableQuota\\": 100,\\n \\"InstanceStatus\\": \\"normal\\",\\n \\"CreateTime\\": \\"2019-12-23T07:24:33Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"333\\",\\n \\"TagKey\\": \\"keyTestA\\",\\n \\"TagValue\\": \\"00004a20240452b0\\"\\n }\\n ],\\n \\"NetworkTypeACL\\": [\\n \\"INTERNET\\"\\n ],\\n \\"NetworkSourceACL\\": [\\n \\"TRUST_PROXY\\"\\n ],\\n \\"Policy\\": \\"{\\\\n \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"Statement\\\\\\": [\\\\n {\\\\n \\\\\\"Action\\\\\\": [\\\\n \\\\\\"ots:*\\\\\\"\\\\n ],\\\\n \\\\\\"Resource\\\\\\": [\\\\n \\\\\\"acs:ots:*:13791xxxxxxxxxxx:instance/myinstance*\\\\\\"\\\\n ],\\\\n \\\\\\"Principal\\\\\\": [\\\\n \\\\\\"*\\\\\\"\\\\n ],\\\\n \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n \\\\\\"Condition\\\\\\": {\\\\n \\\\\\"StringEquals\\\\\\": {\\\\n \\\\\\"ots:TLSVersion\\\\\\": [\\\\n \\\\\\"1.2\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"IpAddress\\\\\\": {\\\\n \\\\\\"acs:SourceIp\\\\\\": [\\\\n \\\\\\"192.168.0.1\\\\\\",\\\\n \\\\\\"198.51.100.1\\\\\\"\\\\n ]\\\\n }\\\\n }\\\\n }\\\\n ]\\\\n}\\",\\n \\"PolicyVersion\\": 1,\\n \\"IsMultiAZ\\": true,\\n \\"ElasticVCUUpperLimit\\": 6\\n}","errorExample":""},{"type":"xml","example":"<Tags>\\n <Tags/>\\n</Tags>","errorExample":""}]', + 'title' => '获取实例信息', + ], + 'UpdateInstance' => [ + 'summary' => '更新实例信息。', + 'path' => '/v2/openapi/updateinstance', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '需要更新的实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'instance-test', + ], + 'AliasName' => [ + 'description' => '实例别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance-test', + ], + 'InstanceDescription' => [ + 'description' => '实例描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'the test instance', + ], + 'Network' => [ + 'title' => '（已弃用）实例网络类型。NORMAL, VPC_CONSOLE。默认为NORMAL。', + 'description' => '（已弃用）实例网络类型。NORMAL, VPC_CONSOLE。默认为NORMAL。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + 'NetworkTypeACL' => [ + 'title' => '更新实例允许的网络类型列表。默认都允许。CLASSIC: 经典网；INTERNET: 公网；VPC：VPC网络。', + 'description' => '更新实例允许的网络类型列表，默认都允许。'."\n" + .'- INTERNET：公网。'."\n" + .'- VPC：VPC网络。'."\n" + .'- CLASSIC：经典网。', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '更新实例允许的网络类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'INTERNET' => '公网', + 'VPC' => 'VPC网络', + 'CLASSIC' => '经典网', + ], + 'example' => 'INTERNET', + ], + 'required' => false, + ], + 'NetworkSourceACL' => [ + 'title' => '更新实例允许的网络来源列表，默认都允许。必须与TRUST_PROXY: 控制台；', + 'description' => '更新实例允许的网络来源列表，默认都允许。'."\n" + ."\n" + .'TRUST_PROXY：可信网关（控制台）。', + 'type' => 'array', + 'items' => [ + 'description' => '更新实例允许的网络来源。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TRUST_PROXY' => '可信网关（控制台）', + ], + 'example' => 'TRUST_PROXY', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3104C83E-6E82-57FB-BB88-8C64CCFDEF89', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3104C83E-6E82-57FB-BB88-8C64CCFDEF89\\"\\n}","type":"json"}]', + 'title' => '更新实例信息', + ], + 'ListInstances' => [ + 'summary' => '获取实例列表。', + 'path' => '/v2/openapi/listinstances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8522', + 'abilityTreeNodes' => [ + 'FEATUREots74FK9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '实例状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '正常', + ' deleting' => '释放中', + 'forbidden' => '禁用', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回实例的最大个数，取值范围为0~200。不设置此参数或者设置为0时，则默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。从NextToken开始按字典序返回实例列表。第一次调用此接口时，设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESCG15aC1xxxxx', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称，支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，可通过资源组控制台查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek24upgom6p5ri', + ], + ], + [ + 'name' => 'InstanceNameList', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '实例名称列表，用于批量查询多个指定实例。', + 'type' => 'array', + 'items' => [ + 'description' => '实例名称，精准匹配查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance-test', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'Owner', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Tester', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E734979F-5A44-5993-9CE5-C23103576923', + ], + 'TotalCount' => [ + 'description' => '返回实例的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'NextToken' => [ + 'description' => '当预期返回的实例总数大于设置的MaxResults时，将作为查询后续页的凭证。只有当实例未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'CAESCG15aC1xxxxx', + ], + 'Instances' => [ + 'description' => '实例信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例对象。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'title' => '实例名称，唯一键', + 'description' => '实例名称，用于唯一标识一个实例。', + 'type' => 'string', + 'example' => 'instance-test', + ], + 'ResourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxh4em5jnbcd', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-huhehaote', + ], + 'SPInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'ots_standard_public_cn-g4t3igqjj002', + ], + 'AliasName' => [ + 'description' => '实例别名。', + 'type' => 'string', + 'example' => 'instance-test', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '13542356466', + ], + 'InstanceDescription' => [ + 'description' => '实例描述。', + 'type' => 'string', + 'example' => '测试实例的描述信息。', + ], + 'InstanceSpecification' => [ + 'description' => '实例规格。'."\n" + .'- SSD：高性能。'."\n" + .'- HYBRID：容量型。', + 'type' => 'string', + 'example' => 'HYBRID', + ], + 'PaymentType' => [ + 'description' => '付费方式。'."\n" + .'- Subscription：包年包月。'."\n" + .'- PayAsYouGo：按量付费。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'StorageType' => [ + 'description' => '存储类型。'."\n" + .'- SSD：高性能。'."\n" + .'- HYBRID：容量型。', + 'type' => 'string', + 'example' => 'HYBRID', + ], + 'VCUQuota' => [ + 'description' => 'VCU配额。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'InstanceStatus' => [ + 'description' => '实例状态。'."\n" + .'- normal：正常。'."\n" + .'- forbidden：禁用。'."\n" + .'- deleting：释放中。', + 'type' => 'string', + 'example' => 'normal', + ], + 'CreateTime' => [ + 'description' => '实例的创建时间。', + 'type' => 'string', + 'example' => '2019-04-07T09:19:21Z', + ], + 'IsMultiAZ' => [ + 'title' => '冗余类型。true表示同城冗余，false表示本地冗余', + 'description' => '是否同城冗余。'."\n" + .'- true：是，表示同城冗余。'."\n" + .'- false：否，表示本地冗余。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E734979F-5A44-5993-9CE5-C23103576923\\",\\n \\"TotalCount\\": 2,\\n \\"NextToken\\": \\"CAESCG15aC1xxxxx\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceName\\": \\"instance-test\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxh4em5jnbcd\\",\\n \\"RegionId\\": \\"cn-huhehaote\\",\\n \\"SPInstanceId\\": \\"ots_standard_public_cn-g4t3igqjj002\\",\\n \\"AliasName\\": \\"instance-test\\",\\n \\"UserId\\": \\"13542356466\\",\\n \\"InstanceDescription\\": \\"测试实例的描述信息。\\",\\n \\"InstanceSpecification\\": \\"HYBRID\\",\\n \\"PaymentType\\": \\"Subscription\\",\\n \\"StorageType\\": \\"HYBRID\\",\\n \\"VCUQuota\\": 3,\\n \\"InstanceStatus\\": \\"normal\\",\\n \\"CreateTime\\": \\"2019-04-07T09:19:21Z\\",\\n \\"IsMultiAZ\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取实例列表', + ], + 'ChangeResourceGroup' => [ + 'summary' => '变更实例所属的资源组。', + 'path' => '/v2/openapi/changeresourcegroup', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'title' => 'resource id, aka ots instance name', + 'description' => '资源ID（即实例名称）。', + 'type' => 'string', + 'required' => true, + 'example' => 'first-ins', + ], + 'NewResourceGroupId' => [ + 'title' => 'new resource group id', + 'description' => '新资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aek3bgek3kxhyky', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '39871ED2-62C0-578F-A32E-B88072D5582F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39871ED2-62C0-578F-A32E-B88072D5582F\\"\\n}","type":"json"}]', + 'title' => '变更资源组', + ], + 'ListTagResources' => [ + 'summary' => '获取标签资源列表。', + 'path' => '/v2/openapi/listtagresources', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回标签资源的最大个数，取值范围为0~200。不设置此参数或者设置为0时，则默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'instance：实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '资源ID列表（即实例名称列表）。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID（即实例名称）。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance-test', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'Owner', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Tester', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。从NextToken开始按字典序返回资源标签列表。第一次调用此接口时，设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESCG15aC1xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '31D8120C-AC52-5CA9-BE4A-E4C6316E19AD', + ], + 'NextToken' => [ + 'description' => '当预期返回的标签资源总数大于设置的MaxResults时，将作为查询后续页的凭证。只有当资源标签未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'CAESCG15aC1xxxxx', + ], + 'MaxResults' => [ + 'description' => '本次请求返回标签资源的最大个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TagResources' => [ + 'title' => '标签列表。', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '标签对象。', + 'description' => '标签对象。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'title' => '标签键。', + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'Owner', + ], + 'TagValue' => [ + 'title' => '标签值。', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'Tester', + ], + 'ResourceId' => [ + 'title' => '资源ID（名称）。', + 'description' => '资源ID（即实例名称）。', + 'type' => 'string', + 'example' => 'instance-test', + ], + 'ResourceType' => [ + 'title' => '资源类型。如ALIYUN::OTS::INSTANCE, ALIYUN::VPC::VPC。', + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'ALIYUN::OTS::INSTANCE', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"31D8120C-AC52-5CA9-BE4A-E4C6316E19AD\\",\\n \\"NextToken\\": \\"CAESCG15aC1xxxxx\\",\\n \\"MaxResults\\": 20,\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"Owner\\",\\n \\"TagValue\\": \\"Tester\\",\\n \\"ResourceId\\": \\"instance-test\\",\\n \\"ResourceType\\": \\"ALIYUN::OTS::INSTANCE\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取标签资源列表', + ], + 'TagResources' => [ + 'summary' => '为实例创建并绑定标签。', + 'path' => '/v2/openapi/tagresources', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'title' => 'resource type', + 'description' => '资源类型。'."\n" + ."\n" + .'instance：实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'instance', + ], + 'ResourceIds' => [ + 'title' => 'resource ids', + 'description' => '资源ID列表（即实例名称列表）。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID（即实例名称）。', + 'type' => 'string', + 'required' => true, + 'example' => 'c-74b774f34061e022', + ], + 'required' => true, + ], + 'Tags' => [ + 'title' => 'tags', + 'description' => '标签键值对列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键值对。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'tag key', + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'created', + ], + 'Value' => [ + 'title' => 'tag value', + 'description' => '标签值。', + 'type' => 'string', + 'required' => true, + 'example' => 'job-0007z8j1omiabo5i872l', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '44FDC379-4443-560E-B652-9F7476D8854F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"44FDC379-4443-560E-B652-9F7476D8854F\\"\\n}","type":"json"}]', + 'title' => '绑定资源标签', + ], + 'UntagResources' => [ + 'summary' => '解绑资源标签。', + 'path' => '/v2/openapi/untagresources', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'instance：实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'ResourceIds' => [ + 'description' => '资源ID列表（即实例名称列表）。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID（即实例名称）。', + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp1gnlr8vqatuqukwrx1', + ], + 'required' => false, + ], + 'TagKeys' => [ + 'description' => '标签键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-fl-test-0', + ], + 'required' => false, + ], + 'All' => [ + 'description' => '是否解绑资源上全部的标签，默认值为false。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '解绑资源上的全部标签', + 'false' => '按照TagKeys参数解绑资源上的标签', + ], + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '26B43C99-F5C9-5341-B462-37427C5BF201', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"26B43C99-F5C9-5341-B462-37427C5BF201\\"\\n}","type":"json"}]', + 'title' => '解绑资源标签', + 'description' => '解绑资源标签可以简化资源管理、提高系统性能优化、降低安全风险。解绑标签后，如果该标签没有绑定其他任何资源，则会被自动删除。', + ], + 'UpdateInstancePolicy' => [ + 'summary' => '修改实例访问控制策略。', + 'path' => '/v2/openapi/updateinstancepolicy', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数的主体信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'my-test-12345', + ], + 'Policy' => [ + 'title' => '实例访问控制策略，JSON格式，详见：https://help.aliyun.com/zh/ram/user-guide/policy-structure-and-syntax', + 'description' => '实例访问控制策略，JSON格式。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "Version": "1",'."\n" + .' "Statement": ['."\n" + .' {'."\n" + .' "Action": ['."\n" + .' "ots:*"'."\n" + .' ],'."\n" + .' "Resource": ['."\n" + .' "acs:ots:*:13791xxxxxxxxxxx:instance/myinstance*"'."\n" + .' ],'."\n" + .' "Principal": ['."\n" + .' "*"'."\n" + .' ],'."\n" + .' "Effect": "Allow",'."\n" + .' "Condition": {'."\n" + .' "StringEquals": {'."\n" + .' "ots:TLSVersion": ['."\n" + .' "1.2"'."\n" + .' ]'."\n" + .' },'."\n" + .' "IpAddress": {'."\n" + .' "acs:SourceIp": ['."\n" + .' "192.168.0.1",'."\n" + .' "172.16.0.1"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'PolicyVersion' => [ + 'title' => 'Instance policy的版本', + 'description' => '实例访问控制策略的版本。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '31D8120C-AC52-5CA9-BE4A-E4C6316E19AD', + ], + 'Code' => [ + 'title' => '响应状态码', + 'description' => '响应状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => '响应消息描述', + 'description' => '响应消息描述。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"31D8120C-AC52-5CA9-BE4A-E4C6316E19AD\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '修改实例访问控制策略', + ], + 'DeleteInstancePolicy' => [ + 'summary' => '删除实例访问控制策略。', + 'path' => '/v2/openapi/deleteinstancepolicy', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'my-test-12345', + ], + 'PolicyVersion' => [ + 'title' => 'Instance policy的版本', + 'description' => '实例访问控制策略的版本。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3104C83E-6E82-57FB-BB88-8C64CCFDEF89', + ], + 'Code' => [ + 'title' => '响应状态码', + 'description' => '响应状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => '响应消息描述', + 'description' => '响应消息描述。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3104C83E-6E82-57FB-BB88-8C64CCFDEF89\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '删除实例访问控制策略', + 'description' => '- 实例策略删除后不可恢复，请谨慎操作。'."\n" + .'- 实例策略删除后，相应权限控制将失效，请确保实例处于安全环境。', + ], + 'CheckInstancePolicy' => [ + 'summary' => '检查实例访问控制策略的有效性。', + 'path' => '/v2/openapi/checkinstancepolicy', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workshop-bj-ots1', + ], + 'Policy' => [ + 'title' => '实例访问控制策略，JSON格式', + 'description' => '实例访问控制策略，JSON格式。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "Version": "1",'."\n" + .' "Statement": ['."\n" + .' {'."\n" + .' "Action": ['."\n" + .' "ots:*"'."\n" + .' ],'."\n" + .' "Resource": ['."\n" + .' "acs:ots:*:13791xxxxxxxxxxx:instance/myinstance*"'."\n" + .' ],'."\n" + .' "Principal": ['."\n" + .' "*"'."\n" + .' ],'."\n" + .' "Effect": "Allow",'."\n" + .' "Condition": {'."\n" + .' "StringEquals": {'."\n" + .' "ots:TLSVersion": ['."\n" + .' "1.2"'."\n" + .' ]'."\n" + .' },'."\n" + .' "IpAddress": {'."\n" + .' "acs:SourceIp": ['."\n" + .' "192.168.0.1",'."\n" + .' "172.16.0.1"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '757E172A-F94B-5E78-8A23-D9068E42F2E9', + ], + 'Code' => [ + 'title' => '响应状态码', + 'description' => '响应状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'title' => '响应消息描述', + 'description' => '响应消息描述。', + 'type' => 'string', + 'example' => 'Verification passed.', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"757E172A-F94B-5E78-8A23-D9068E42F2E9\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Verification passed.\\"\\n}","type":"json"}]', + 'title' => '检查实例访问控制策略的有效性', + ], + 'DescribeRegions' => [ + 'summary' => '获取可用地域列表。', + 'path' => '/region/DescribeRegions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREots4PD2C1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数。'."\n" + .'> 用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '39871ED2-62C0-578F-A32E-B88072D5582F', + ], + 'Regions' => [ + 'title' => 'region list', + 'description' => '地域信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地域对象。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'title' => 'region id', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'I18nKey' => [ + 'title' => 'region key', + 'description' => '地域KEY。', + 'type' => 'string', + 'example' => 'yunjiankong.cloud.region.cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39871ED2-62C0-578F-A32E-B88072D5582F\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"I18nKey\\": \\"yunjiankong.cloud.region.cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取地域列表', + ], + 'ListClusterType' => [ + 'summary' => '列举当前地域支持的集群类型。', + 'path' => '/v2/openapi/listclustertype', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8522', + 'abilityTreeNodes' => [ + 'FEATUREots74FK9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '88BA193C-4918-08C4-9870-E1FE6BBECF34', + ], + 'ClusterTypes' => [ + 'title' => 'list of cluster type', + 'description' => '集群类型列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'cluster type', + 'description' => '集群类型。'."\n" + ."\n" + .'- HYBRID：容量型。'."\n" + ."\n" + .'- SSD：高性能型。', + 'type' => 'string', + 'example' => 'SSD', + ], + ], + 'ClusterTypeInfos' => [ + 'title' => 'list of cluster type detail', + 'description' => '集群类型详细信息列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'cluster type detail', + 'description' => '集群类型详细信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterType' => [ + 'title' => 'cluster type', + 'description' => '集群类型。'."\n" + ."\n" + .'- HYBRID：容量型。'."\n" + ."\n" + .'- SSD：高性能型。', + 'type' => 'string', + 'example' => 'SSD', + ], + 'IsMultiAZ' => [ + 'title' => 'redundancy type', + 'description' => '是否支持多可用区（AZ）。'."\n" + ."\n" + .'- true：支持多可用区，同城冗余。'."\n" + ."\n" + .'- false：不支持多可用区，本地冗余。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88BA193C-4918-08C4-9870-E1FE6BBECF34\\",\\n \\"ClusterTypes\\": [\\n \\"SSD\\"\\n ],\\n \\"ClusterTypeInfos\\": [\\n {\\n \\"ClusterType\\": \\"SSD\\",\\n \\"IsMultiAZ\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列举集群类型', + ], + 'UpdateInstanceElasticVCUUpperLimit' => [ + 'summary' => '修改VCU模式（原预留模式）下实例的弹性上限。', + 'path' => '/v2/openapi/updateinstanceelasticvcuupperlimit', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '221366', + 'abilityTreeNodes' => [ + 'FEATUREotsDNUEK6', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workshop-bj-ots1', + ], + 'ElasticVCUUpperLimit' => [ + 'description' => '实例弹性上限。'."\n" + .'> 实例弹性上限的取值范围为**预留VCU个数+0.1~2000**，单位为VCU，其中预留VCU支持通过升降配修改，调整步长为1。实例弹性上限支持动态调整，调整步长最小为0.1。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '6', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B37BBA04-D827-55C8-B901-5264B904E8C6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B37BBA04-D827-55C8-B901-5264B904E8C6\\"\\n}","type":"json"}]', + 'title' => '设置实例弹性上限', + 'description' => '- **请确保在使用该接口前，已充分了解 Tablestore 产品的计费说明和价格。更多信息，请参见[计费概览](~~27291~~)。**'."\n" + .'- 为实例开启弹性能力后，实例的默认弹性上限为弹性能力与预留VCU之和。'."\n" + .'- 随着业务量增大需要使用更多计算资源时，您可以通过调整弹性上限来获取。实例弹性上限调整后立即生效。', + ], + 'BindInstance2Vpc' => [ + 'summary' => '绑定VPC。', + 'path' => '/v2/openapi/bindinstance2vpc', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC ID', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-2ze***********g31n7', + ], + 'VirtualSwitchId' => [ + 'description' => '虚拟交换机ID', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-uf6***********ez6ge', + ], + 'InstanceName' => [ + 'description' => '实例名称', + 'type' => 'string', + 'required' => true, + 'example' => 'mkdd-test', + ], + 'InstanceVpcName' => [ + 'description' => 'VPC名称', + 'type' => 'string', + 'required' => true, + 'example' => 'xu6666', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题', + 'type' => 'string', + 'example' => 'E734979F-5A44-5993-9CE5-C23103576923', + ], + 'Domain' => [ + 'description' => '域名', + 'type' => 'string', + 'example' => 'xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com', + ], + 'Endpoint' => [ + 'description' => '实例的连接地址', + 'type' => 'string', + 'example' => '172.**.***.34', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E734979F-5A44-5993-9CE5-C23103576923\\",\\n \\"Domain\\": \\"xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com\\",\\n \\"Endpoint\\": \\"172.**.***.34\\"\\n}","type":"json"}]', + 'title' => '绑定VPC', + ], + 'ListVpcInfoByInstance' => [ + 'summary' => '获取实例的VpcInfo列表。', + 'path' => '/v2/openapi/listvpcinfobyinstance', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称', + 'type' => 'string', + 'required' => true, + 'example' => 'mkdd-test', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，查询时设置的每页VPC数量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题', + 'type' => 'string', + 'example' => '44FDC379-4443-560E-B652-9F7476D8854F', + ], + 'PageNum' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'TotalCount' => [ + 'description' => 'VPC总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'InstanceName' => [ + 'description' => '实例名称', + 'type' => 'string', + 'example' => 'mkdd-test', + ], + 'VpcInfos' => [ + 'description' => 'VPC详情', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC详细信息', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC ID', + 'type' => 'string', + 'example' => 'vpc-2z***********n7w3dl', + ], + 'Domain' => [ + 'description' => 'VPC访问地址', + 'type' => 'string', + 'example' => 'http://xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com', + ], + 'InstanceVpcName' => [ + 'description' => 'VPC名称', + 'type' => 'string', + 'example' => 'xu6666', + ], + 'RegionNo' => [ + 'description' => '地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Endpoint' => [ + 'description' => '实例的连接地址', + 'type' => 'string', + 'example' => 'http://172.**.***.34:80/', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"44FDC379-4443-560E-B652-9F7476D8854F\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 8,\\n \\"TotalCount\\": 1,\\n \\"InstanceName\\": \\"mkdd-test\\",\\n \\"VpcInfos\\": [\\n {\\n \\"VpcId\\": \\"vpc-2z***********n7w3dl\\",\\n \\"Domain\\": \\"http://xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com\\",\\n \\"InstanceVpcName\\": \\"xu6666\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"Endpoint\\": \\"http://172.**.***.34:80/\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取实例的VpcInfo列表', + ], + 'ListVpcInfoByVpc' => [ + 'summary' => '获取给定VPC对应的VpcInfo列表信息。', + 'path' => '/v2/openapi/listvpcinfobyvpc', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC ID', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-bp1***********0mh8', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，查询时设置的每页VPC数量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4141784E-91FF-56E3-9371-FD011FF876F4', + ], + 'PageNum' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'VPC总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'VpcId' => [ + 'description' => 'VPC ID', + 'type' => 'string', + 'example' => 'vpc-bp1***********0mh8', + ], + 'VpcInfos' => [ + 'description' => 'VPC详情', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC详细信息', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => 'VPC访问地址', + 'type' => 'string', + 'example' => 'http://xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com', + ], + 'InstanceVpcName' => [ + 'description' => 'VPC名称', + 'type' => 'string', + 'example' => 'xu6666', + ], + 'RegionNo' => [ + 'description' => '地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceName' => [ + 'description' => '实例名称', + 'type' => 'string', + 'example' => 'mkdd-test', + ], + 'Endpoint' => [ + 'description' => '实例的连接地址', + 'type' => 'string', + 'example' => 'http://172.**.***.34:80/', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4141784E-91FF-56E3-9371-FD011FF876F4\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"VpcId\\": \\"vpc-bp1***********0mh8\\",\\n \\"VpcInfos\\": [\\n {\\n \\"Domain\\": \\"http://xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com\\",\\n \\"InstanceVpcName\\": \\"xu6666\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"InstanceName\\": \\"mkdd-test\\",\\n \\"Endpoint\\": \\"http://172.**.***.34:80/\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取VPC的VpcInfo列表', + ], + 'UnbindInstance2Vpc' => [ + 'summary' => '用于解绑VPC。', + 'path' => '/v2/openapi/unbindinstance2vpc', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREotsBN42MI', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '需要更新的实例名称', + 'type' => 'string', + 'required' => true, + 'example' => 'mkdd-test', + ], + 'InstanceVpcName' => [ + 'description' => 'VPC名称', + 'type' => 'string', + 'required' => true, + 'example' => 'xu6666', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，可用于排查和定位问题', + 'type' => 'string', + 'example' => '18DD77BF-F967-576D-80D1-79121399AB53', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18DD77BF-F967-576D-80D1-79121399AB53\\"\\n}","type":"json"}]', + 'title' => '解绑VPC', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'tablestore.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'tablestore.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'tablestore.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'tablestore.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'tablestore.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'tablestore.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'tablestore.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'tablestore.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'tablestore.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'tablestore.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'tablestore.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'tablestore.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'tablestore.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'tablestore.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'tablestore.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'tablestore.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'tablestore.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'tablestore.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'tablestore.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'tablestore.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'tablestore.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'tablestore.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'tablestore.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'tablestore.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'tablestore.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'tablestore.me-central-1.aliyuncs.com', + ], + ], +]; |