'1.0',
'info' => [
'style' => 'RPC',
'product' => 'foasconsole',
'version' => '2019-06-01',
],
'directories' => [
[
'id' => 93127,
'title' => '项目命名空间',
'type' => 'directory',
'children' => [
'CreateNamespace',
'DeleteNamespace',
'ModifyPrepayNamespaceSpec',
'DescribeNamespaces',
],
],
[
'id' => 93132,
'title' => 'flink全托管实例',
'type' => 'directory',
'children' => [
'CreateInstance',
'RenewInstance',
'DeleteInstance',
'ModifyPrepayInstanceSpec',
'ConvertInstance',
'DescribeInstances',
],
],
[
'id' => 93139,
'title' => '费用',
'type' => 'directory',
'children' => [
'QueryCreateInstancePrice',
'QueryModifyInstancePrice',
'QueryRenewInstancePrice',
'QueryConvertInstancePrice',
],
],
[
'id' => 93144,
'title' => '其它',
'type' => 'directory',
'children' => [
'DescribeSupportedZones',
'DescribeSupportedRegions',
],
],
[
'id' => 187207,
'title' => '其他',
'type' => 'directory',
'children' => [
'ListTagResources',
'UntagResources',
'TagResources',
'ConvertPrepayInstance',
'QueryConvertPrepayInstancePrice',
],
],
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
'children' => [
'ChangeResourceGroup',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateNamespace' => [
'summary' => '在flink全托管实例中下创建项目空间。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '45895',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'CreateNamespaceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '创建项目空间所需的请求参数。',
'type' => 'object',
'properties' => [
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => '223493C7-FCA9-13D4-B75B-AF8B32F4****',
],
'Namespace' => [
'description' => '项目空间名称。',
'type' => 'string',
'required' => true,
'example' => 'ns-1',
],
'ResourceSpec' => [
'description' => '资源规格。',
'type' => 'object',
'properties' => [
'Cpu' => [
'description' => 'CPU数量。'."\n"
.'> - 在包年包月的工作空间下,CPU数量必填。在按量付费的工作空间下,可以不用填写CPU数量。- 创建的目标项目空间的CPU数量要小于工作空间中剩余CPU数量(工作空间购买的总CPU数量减去其他项目空间已分配CPU数量),否则会报错。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'MemoryGB' => [
'description' => '内存大小。(单位GB)'."\n"
.'> - 在包年包月的工作空间下,内存大小必填,且要为CPU数量的4倍。在按量付费的工作空间下,可以不用填写内存大小。- 创建的目标项目空间的内存大小要小于工作空间中剩余内存数量(工作空间购买的总内存数量减去其他项目空间已分配内存数量),否则会报错。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '40',
],
],
'required' => false,
],
'Ha' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功,取值如下:'."\n"
."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n","errorExample":""}]',
'title' => '创建项目空间',
],
'DeleteNamespace' => [
'summary' => '删除未使用的项目空间。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'DeleteNamespaceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '删除项目空间的请求参数。',
'type' => 'object',
'properties' => [
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => 'sc_flinkserverlesspost_public_cn-0ju2bj2****',
],
'Namespace' => [
'description' => '项目空间名称。',
'type' => 'string',
'required' => true,
'example' => 'ns-1',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功,取值如下:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n","errorExample":""}]',
'title' => '删除项目空间',
'description' => '> 在以下情况时,您不可以删除项目空间:- 项目空间的已使用资源大于0。- 项目空间的状态是创建中、删除中或修改中。',
],
'ModifyPrepayNamespaceSpec' => [
'summary' => '修改包年包月实例下项目空间的规格。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '45980',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'ModifyPrepayNamespaceSpecRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '包年包月工作空间规格的修改详情。',
'type' => 'object',
'properties' => [
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => 'sc_flinkserverlesspost_public_cn-0ju2bj2****',
],
'Namespace' => [
'description' => '项目空间名称。',
'type' => 'string',
'required' => true,
'example' => 'ns-1',
],
'ResourceSpec' => [
'description' => '资源规格。',
'type' => 'object',
'properties' => [
'Cpu' => [
'description' => 'CPU数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
'MemoryGB' => [
'description' => '内存大小。'."\n"
.'> 内存大小必须为CPU数量的4倍。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '40',
],
],
'required' => true,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '对象详情。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功,取值如下:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'foasconsole::2019-06-01::ModifyNamespaceSpec',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n","errorExample":""}]',
'title' => '修改项目空间规格',
'description' => '>调用该接口时,需要注意以下几点: - 订单必须是包年包月付费类型,即ChargeType=PRE。- 订单状态必须是正常状态,即OrderType=NORMAL。- 降配时,填写的资源规格数量不可小于已使用的资源规格数量。变更前后的项目资源规格详情请通过[DescribeNamespaces](https://help.aliyun.com/document_detail/323441.html)。',
],
'DescribeNamespaces' => [
'summary' => '您可以调用DescribeNamespaces查询某实例下的项目空间信息。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '45983',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'DescribeNamespacesRequest',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '查询项目空间信息的请求参数。',
'type' => 'object',
'properties' => [
'Region' => [
'title' => 'regionId',
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'title' => '实例id',
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => '223493C7-FCA9-13D4-B75B-AF8B32F4****',
],
'Namespace' => [
'title' => '命名空间名称',
'description' => '项目空间名称。',
'type' => 'string',
'required' => false,
'example' => 'ns-1',
],
'PageIndex' => [
'title' => '当前页数',
'description' => '工作空间状态列表的页码。'."\n"
.'起始值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'PageSize' => [
'title' => '每页大小',
'description' => '分页查询时设置的每页行数。 '."\n"
.'最大值为100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'Tags' => [
'description' => '实例标签。',
'type' => 'array',
'items' => [
'description' => '项目空间标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => 'Key值。',
'type' => 'string',
'required' => false,
'example' => 'flink',
],
'Value' => [
'description' => 'Value值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
'required' => false,
],
'required' => false,
],
'Ha' => [
'type' => 'boolean',
'required' => false,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功,取值如下:'."\n"
."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'TotalCount' => [
'description' => '所查询到的项目空间总个数。',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'TotalPage' => [
'description' => '查询到的项目空间总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'PageIndex' => [
'description' => '当前页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '输入时设置的每页行数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Namespaces' => [
'description' => '项目空间的信息数组。',
'type' => 'array',
'items' => [
'description' => '项目空间的信息。',
'type' => 'object',
'properties' => [
'Namespace' => [
'description' => '项目空间的名称。',
'type' => 'string',
'example' => 'ns-1',
],
'Status' => [
'description' => '项目空间的状态,取值如下:'."\n"
.'- CREATING:正在创建。'."\n"
.'- DELETING:正在删除。'."\n"
.'- MODIFYING:正在修改资源规格。'."\n"
.'- SUCCESS:上一个操作执行成功。'."\n"
.'- FAILED:上一个操作执行失败。',
'type' => 'string',
'example' => 'SUCCESS',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1629879567394',
],
'GmtModified' => [
'description' => '修改时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1629879567394',
],
'ResourceSpec' => [
'description' => '资源规格。',
'type' => 'object',
'properties' => [
'Cpu' => [
'description' => 'CPU数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'MemoryGB' => [
'description' => '设置的内存数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '40',
],
],
],
'ResourceUsed' => [
'description' => '已使用的资源。',
'type' => 'object',
'properties' => [
'Cpu' => [
'description' => '已使用的CPU数量。',
'type' => 'number',
'format' => 'float',
'example' => '2.5',
],
'MemoryGB' => [
'description' => '已使用的内存数量。',
'type' => 'number',
'format' => 'float',
'example' => '6.6',
],
'Cu' => [
'description' => '已经使用的CU用量。计算公式为MAX(CPU, MemoryGB/4)。',
'type' => 'number',
'format' => 'float',
'example' => '1.6',
],
],
],
'Tags' => [
'title' => '资源列表',
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '标签键。',
'type' => 'string',
'example' => 'flink',
],
'Value' => [
'title' => '标签值',
'description' => '标签值。',
'type' => 'string',
'example' => 'test',
],
],
],
],
'Ha' => [
'type' => 'boolean',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 15,\\n \\"TotalPage\\": 2,\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"Namespaces\\": [\\n {\\n \\"Namespace\\": \\"ns-1\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"GmtCreate\\": 1629879567394,\\n \\"GmtModified\\": 1629879567394,\\n \\"ResourceSpec\\": {\\n \\"Cpu\\": 10,\\n \\"MemoryGB\\": 40\\n },\\n \\"ResourceUsed\\": {\\n \\"Cpu\\": 2.5,\\n \\"MemoryGB\\": 6.6,\\n \\"Cu\\": 1.6\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"flink\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Ha\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n 15\\n 2\\n 1\\n 10\\n \\n ns-1\\n SUCCESS\\n 1629879567394\\n 1629879567394\\n \\n 10\\n 40\\n \\n \\n 2.5\\n 6.6\\n 1.6\\n \\n \\n flink\\n test\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeNamespaces',
],
'CreateInstance' => [
'summary' => '创建一个包年包月或者按量付费flink全托管实例。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '44259',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'CreateInstanceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '创建工作空间所需的请求参数。',
'type' => 'object',
'properties' => [
'InstanceName' => [
'description' => '工作空间名称。',
'type' => 'string',
'required' => true,
'example' => 'vvp1',
],
'ChargeType' => [
'description' => '付费类型,取值如下:'."\n"
."\n"
.'- POST:按量付费。'."\n"
.'- PRE:包年包月。',
'type' => 'string',
'required' => true,
'example' => 'PRE',
'enum' => [
'PRE',
'POST',
],
],
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'ZoneId' => [
'description' => '工作空间所属的可用区ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing-g',
],
'VpcId' => [
'description' => 'VPC ID。',
'type' => 'string',
'required' => true,
'example' => 'vpc-2ze9*******nxfmfcdi',
],
'VSwitchIds' => [
'description' => '虚拟交换机ID。',
'type' => 'array',
'items' => [
'description' => '虚拟交换机ID。',
'type' => 'string',
'required' => true,
'example' => 'vsw-xzes****bkmuirxxpoxxv',
],
'required' => true,
],
'ResourceSpec' => [
'description' => '资源规格。'."\n"
.'> 当ChargeType配置为PRE时,资源规格参数必填。',
'type' => 'object',
'properties' => [
'Cpu' => [
'description' => 'CPU数量。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'MemoryGB' => [
'description' => '内存大小。单位为GB。'."\n"
."\n"
.'> 内存数量必须为CPU数量的4倍。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '40',
],
],
'required' => false,
],
'PricingCycle' => [
'description' => '订购周期,仅支持按年(Year)和月(Month)订购。',
'type' => 'string',
'required' => false,
'example' => 'Month',
'default' => 'Month',
'enum' => [
'Year',
'Month',
'Day',
'Hour',
],
],
'Duration' => [
'description' => '订购周期数量。'."\n"
.'> 当ChargeType配置为PRE时,Duration参数必填。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'AutoRenew' => [
'description' => '付费类型为包年包月时,取值如下:'."\n"
.'- true:自动续费。'."\n"
.'- false:手动续费。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'Storage' => [
'description' => '存储参数。',
'type' => 'object',
'properties' => [
'Oss' => [
'description' => 'OSS存储。',
'type' => 'object',
'properties' => [
'Bucket' => [
'description' => 'OSS的Bucket名称。',
'type' => 'string',
'required' => true,
'example' => 'oss_flink',
],
],
'required' => true,
],
],
'required' => true,
],
'UsePromotionCode' => [
'title' => '是否使用优惠券',
'description' => '是否使用优惠券。取值如下:'."\n"
."\n"
.'- true:使用。'."\n"
.'- false:不使用。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'PromotionCode' => [
'title' => '优惠券code',
'description' => '优惠码。',
'type' => 'string',
'required' => false,
'example' => '5RT******',
],
'ResourceGroupId' => [
'description' => '新购实例属于的资源组。',
'type' => 'string',
'required' => false,
'example' => 'rg-******',
],
'Extra' => [
'description' => '扩展字段,不用填写',
'type' => 'string',
'required' => false,
'example' => '*',
],
'ArchitectureType' => [
'type' => 'string',
'required' => false,
'enum' => [
'X86',
'ARM',
],
],
'Ha' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
'HaZoneId' => [
'type' => 'string',
'required' => false,
],
'HaVSwitchIds' => [
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'required' => false,
],
'HaResourceSpec' => [
'type' => 'object',
'properties' => [
'Cpu' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
'MemoryGB' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
'required' => false,
],
'MonitorType' => [
'type' => 'string',
'required' => false,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功,取值如下:'."\n"
."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'OrderInfo' => [
'title' => '订单信息',
'description' => '订单信息。',
'type' => 'object',
'properties' => [
'OrderId' => [
'title' => '订单id',
'description' => '订单ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '210406354694567',
],
'InstanceId' => [
'title' => '实例id',
'description' => '工作空间ID。',
'type' => 'string',
'example' => '8D2D5BBF-C302-1A21-80E1-27799802****',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true,\\n \\"OrderInfo\\": {\\n \\"OrderId\\": 210406354694567,\\n \\"InstanceId\\": \\"8D2D5BBF-C302-1A21-80E1-27799802****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n \\n 210406354694567\\n 8D2D5BBF-C302-1A21-80E1-27799802****\\n \\n","errorExample":""}]',
'title' => '创建flink全托管实例',
'description' => '> 在使用该接口前,请确保已充分了解实时计算Flink版产品的收费方式和价格,详情请参见[产品定价](https://help.aliyun.com/document_detail/170103.html)。',
],
'RenewInstance' => [
'summary' => '续费一个包年包月flink全托管实例。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '44666',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'RenewInstanceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '续费所需的请求参数。',
'type' => 'object',
'properties' => [
'Region' => [
'title' => '地域id',
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'title' => '实例id',
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => 'sc_flinkserverless_public_cn-7e22ae5****',
],
'Duration' => [
'title' => '订购周期数量',
'description' => '订购周期数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
'PricingCycle' => [
'title' => '订购周期',
'description' => '订购周期,仅支持按月(Month)订购。',
'type' => 'string',
'required' => true,
'example' => 'Month',
'enum' => [
'Year',
'Month',
'Day',
'Hour',
],
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'OrderId' => [
'title' => 'orderId',
'description' => '订单ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '210406354690749',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功,取值如下:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"OrderId\\": 210406354690749,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n 210406354690749\\n true\\n","errorExample":""}]',
'title' => '实例续费',
'description' => '> 仅包年包月的工作空间支持该接口。',
],
'DeleteInstance' => [
'summary' => '删除未使用的按量付费的flink全托管实例。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '44626',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'DeleteInstanceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '释放工作空间的请求参数。',
'type' => 'object',
'properties' => [
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => '223493C7-FCA9-13D4-B75B-AF8B32F4****',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功。取值如下:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n","errorExample":""}]',
'title' => '删除flink全托管实例',
'description' => '> 在以下情况,不可以释放工作空间:- 按量付费模式下,工作空间状态为创建中、释放中或创建超时。- 付费类型为包年包月,请您在用户中心的退订管理页面退订资源。',
],
'ModifyPrepayInstanceSpec' => [
'summary' => '修改包年包月的flink全托管实例规格。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '44639',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'ModifyPrepayInstanceSpecRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '修改包年包月工作空间规格的请求参数。',
'type' => 'object',
'properties' => [
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => 'sc_flinkserverlesspost_public_cn-0ju2bj2i104',
],
'ResourceSpec' => [
'description' => '资源规格。',
'type' => 'object',
'properties' => [
'Cpu' => [
'description' => 'CPU数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
'MemoryGB' => [
'description' => '内存大小。'."\n"
."\n"
.'>内存大小必须为CPU数量的4倍。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '40',
],
],
'required' => true,
],
'Ha' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
'HaZoneId' => [
'type' => 'string',
'required' => false,
],
'HaVSwitchIds' => [
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'required' => false,
],
'HaResourceSpec' => [
'type' => 'object',
'properties' => [
'Cpu' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
'MemoryGB' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
'required' => false,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'OrderId' => [
'title' => '订单id',
'description' => '订单ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '210406354690749',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功,取值如下:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'foasconsole::2019-06-01::ModifyInstanceSpec',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"OrderId\\": 210406354690749,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n 210406354690749\\n true\\n","errorExample":""}]',
'title' => '修改flink全托管实例规格',
'description' => '> 调用该接口时,您需要注意以下几点:- 订单必须是包年包月付费类型,即ChargeType=PRE。- 订单状态必须是正常状态,即OrderType=NORMAL。- 降配时,填写的资源规格不可小于所有项目空间的资源规格数量总和。工作空间变更前后的资源规格详情请通过[DescribeInstances](https://help.aliyun.com/document_detail/323449.html)接口查询。',
],
'ConvertInstance' => [
'summary' => '您可以将按量付费的实例转换为包年包月的实例。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '90948',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'ConvertPostpayInstanceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '转换付费类型的请求参数。',
'type' => 'object',
'properties' => [
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => 'sc_flinkserverlesspost_public_cn-*******',
],
'PricingCycle' => [
'title' => '订购周期',
'description' => '订购周期,仅支持按月(Month)订购。',
'type' => 'string',
'required' => true,
'example' => 'Month',
'default' => 'Month',
'enum' => [
'Year',
'Month',
'Day',
'Hour',
],
],
'Duration' => [
'title' => '订购周期数量',
'description' => '订购周期数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
'IsAutoRenew' => [
'title' => '是否自动续费',
'description' => '是否自动续费。取值如下:'."\n"
."\n"
.'- true:自动续费。'."\n"
.'- false:手动续费。',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
'NamespaceResourceSpecs' => [
'title' => '项目空间资源规格。',
'description' => '项目空间资源规格。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Namespace' => [
'title' => 'namespace名称,',
'description' => '项目空间名称。',
'type' => 'string',
'required' => true,
'example' => 'ns-1',
],
'ResourceSpec' => [
'title' => '资源规格。',
'description' => '资源规格。',
'type' => 'object',
'properties' => [
'Cpu' => [
'title' => 'cpu数量。',
'description' => 'CPU数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
'MemoryGB' => [
'title' => '内存大小。',
'description' => '内存大小,单位为GB。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '4',
],
],
'required' => true,
],
],
'required' => true,
],
'required' => true,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '是否转换成功,取值如下:'."\n"
."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'OrderId' => [
'title' => '订单id',
'description' => '订单ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '211473228320700',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true,\\n \\"OrderId\\": 211473228320700\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n 211473228320700\\n","errorExample":""}]',
'title' => '预付费转后付费',
],
'DescribeInstances' => [
'summary' => '查询一个或多个flink全托管实例的详细信息。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '44648',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'DescribeInstancesRequest',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '查询工作空间详细信息的请求参数。',
'type' => 'object',
'properties' => [
'PageIndex' => [
'description' => '工作空间状态列表的页码。'."\n"
.'起始值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数。'."\n"
.'最大值为100。'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'required' => false,
'example' => '223493C7-FCA9-13D4-B75B-AF8B32F4****',
],
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'ChargeType' => [
'title' => '付款类型',
'description' => '付费类型,取值如下:'."\n"
.'- POST:按量付费。'."\n"
.'- PRE:包年包月。',
'type' => 'string',
'required' => false,
'example' => 'PRE',
'enum' => [
'PRE',
'POST',
],
],
'Tags' => [
'description' => '工作空间标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'flink',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
'required' => false,
],
'required' => false,
],
'ResourceGroupId' => [
'description' => '指定实例所在资源组。',
'type' => 'string',
'required' => false,
'example' => 'rg-***',
],
'ArchitectureType' => [
'type' => 'string',
'required' => false,
'enum' => [
'X86',
'ARM',
],
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '查询到的工作空间总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'TotalPage' => [
'description' => '查询到的工作空间总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'PageIndex' => [
'description' => '当前页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '设置的每页行数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'description' => '是否成功,取值如下:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'Instances' => [
'description' => '返回工作空间的信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceCreateTime' => [
'description' => '工作空间的创建时间,单位为毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1629879567394',
],
'ResourceExpiredTime' => [
'title' => '超期时间',
'description' => '超期时间,单位为毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1637337600000',
],
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'example' => 'cn-beijing',
],
'ZoneId' => [
'description' => '工作空间所属的可用区ID。',
'type' => 'string',
'example' => 'cn-beijing-g',
],
'VpcId' => [
'description' => '用户的VPC ID。',
'type' => 'string',
'example' => 'vpc-2ze9*******nxfmfcdi',
],
'VSwitchIds' => [
'description' => '虚拟交换机ID数组。',
'type' => 'array',
'items' => [
'description' => '虚拟交换机ID。',
'type' => 'string',
'example' => 'vsw-2ze6yqnc19*****psjj0j',
],
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'example' => 'sc_flinkserverlesspost_public_cn-0ju2bj2****',
],
'ChargeType' => [
'description' => '付费类型,取值如下:'."\n"
.'- POST:按量付费'."\n"
.'- PRE:包年包月',
'type' => 'string',
'example' => 'PRE',
],
'InstanceName' => [
'description' => '工作空间名称。',
'type' => 'string',
'example' => 'vvp1',
],
'Uid' => [
'description' => '工作空间所属用户ID。',
'type' => 'string',
'example' => '183899668736****',
],
'OrderState' => [
'description' => '订单状态,取值如下:'."\n"
.'- NOT_INIT:下单还未部署组件。'."\n"
.'- NORMAL:正常状态。'."\n"
.'- CEASE:过期状态。'."\n"
.'- RELEASE:超期状态。',
'type' => 'string',
'example' => 'NORMAL',
],
'ResourceId' => [
'description' => 'K8s集群ID。',
'type' => 'string',
'example' => 'b3690a1655da47',
],
'Storage' => [
'description' => '存储信息。',
'type' => 'object',
'properties' => [
'Oss' => [
'description' => 'OSS存储信息。',
'type' => 'object',
'properties' => [
'Bucket' => [
'description' => 'OSS的Bucket名称。',
'type' => 'string',
'example' => 'oss_flink',
],
],
],
],
],
'ResourceSpec' => [
'description' => '资源规格。',
'type' => 'object',
'properties' => [
'Cpu' => [
'description' => '设置的CPU数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'MemoryGB' => [
'description' => '设置的内存的大小,单位为GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '40',
],
],
],
'ClusterStatus' => [
'description' => '集群状态,取值如下:'."\n"
.'- CREATING:创建中。'."\n"
.'- RUNNING:运行中。'."\n"
.'- DISABLE:无效。'."\n"
.'- DELETING:删除中。'."\n"
.'- DELETED:已删除。',
'type' => 'string',
'example' => 'RUNNING',
],
'Tags' => [
'title' => '资源列表',
'description' => '资源列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '标签键。',
'type' => 'string',
'example' => 'flink',
],
'Value' => [
'title' => '标签值',
'description' => '标签值。',
'type' => 'string',
'example' => 'test',
],
],
],
],
'AskClusterId' => [
'description' => '集群id。',
'type' => 'string',
'example' => 'c20c******404',
],
'ResourceGroupId' => [
'description' => '资源组。',
'type' => 'string',
'example' => 'rg-***',
],
'HostAliases' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Ip' => [
'type' => 'string',
'required' => true,
],
'HostNames' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
],
],
],
'required' => true,
],
'ArchitectureType' => [
'type' => 'string',
],
'Ha' => [
'type' => 'boolean',
],
'HaZoneId' => [
'type' => 'string',
],
'HaVSwitchIds' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'HaResourceSpec' => [
'type' => 'object',
'properties' => [
'Cpu' => [
'type' => 'integer',
'format' => 'int32',
],
'MemoryGB' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
'MonitorType' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 15,\\n \\"TotalPage\\": 2,\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true,\\n \\"Instances\\": [\\n {\\n \\"ResourceCreateTime\\": 1629879567394,\\n \\"ResourceExpiredTime\\": 1637337600000,\\n \\"Region\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-g\\",\\n \\"VpcId\\": \\"vpc-2ze9*******nxfmfcdi\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-2ze6yqnc19*****psjj0j\\"\\n ],\\n \\"InstanceId\\": \\"sc_flinkserverlesspost_public_cn-0ju2bj2****\\",\\n \\"ChargeType\\": \\"PRE\\",\\n \\"InstanceName\\": \\"vvp1\\",\\n \\"Uid\\": \\"183899668736****\\",\\n \\"OrderState\\": \\"NORMAL\\",\\n \\"ResourceId\\": \\"b3690a1655da47\\",\\n \\"Storage\\": {\\n \\"Oss\\": {\\n \\"Bucket\\": \\"oss_flink\\"\\n }\\n },\\n \\"ResourceSpec\\": {\\n \\"Cpu\\": 10,\\n \\"MemoryGB\\": 40\\n },\\n \\"ClusterStatus\\": \\"RUNNING\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"flink\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"AskClusterId\\": \\"c20c******404\\",\\n \\"ResourceGroupId\\": \\"rg-***\\",\\n \\"HostAliases\\": [\\n {\\n \\"Ip\\": \\"\\",\\n \\"HostNames\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"ArchitectureType\\": \\"\\",\\n \\"Ha\\": true,\\n \\"HaZoneId\\": \\"\\",\\n \\"HaVSwitchIds\\": [\\n \\"\\"\\n ],\\n \\"HaResourceSpec\\": {\\n \\"Cpu\\": 0,\\n \\"MemoryGB\\": 0\\n },\\n \\"MonitorType\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 15\\n 2\\n 1\\n 2\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n \\n 1629879567394\\n 1637337600000\\n cn-beijing\\n cn-beijing-g\\n vpc-2ze9*******nxfmfcdi\\n vsw-2ze6yqnc19*****psjj0j\\n sc_flinkserverlesspost_public_cn-0ju2bj2****\\n PRE\\n vvp1\\n 183899668736****\\n NORMAL\\n b3690a1655da47\\n \\n \\n oss_flink\\n \\n \\n \\n 10\\n 40\\n \\n RUNNING\\n \\n flink\\n test\\n \\n c20c******404\\n rg-***\\n \\n","errorExample":""}]',
'title' => '查询flink全托管实例信息',
],
'QueryCreateInstancePrice' => [
'summary' => '您可以查询创建实例的价格信息。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '86969',
'abilityTreeNodes' => [
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'CreateInstanceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '创建工作空间所需的请求参数。',
'type' => 'object',
'properties' => [
'InstanceName' => [
'description' => '工作空间名称。',
'type' => 'string',
'required' => false,
'example' => 'vvp1',
],
'ChargeType' => [
'description' => '付费类型,取值如下:'."\n"
.'- POST:按量付费。'."\n"
.'- PRE:包年包月。',
'type' => 'string',
'required' => true,
'example' => 'PRE',
'enum' => [
'PRE',
'POST',
],
],
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'ZoneId' => [
'description' => '工作空间所属的可用区ID。',
'type' => 'string',
'required' => false,
'example' => 'cn-beijing-g',
],
'VpcId' => [
'description' => 'VPC ID。',
'type' => 'string',
'required' => false,
'example' => 'vpc-2ze9*******nxfmfcdi',
],
'VSwitchIds' => [
'description' => '虚拟交换机。',
'type' => 'array',
'items' => [
'description' => '虚拟交换机ID。',
'type' => 'string',
'required' => false,
'example' => 'vsw-xzesxxxpbkmuirxxpoxxv',
],
'required' => false,
],
'ResourceSpec' => [
'description' => '资源规格。'."\n"
."\n"
.'> 当ChargeType配置为PRE时,资源规格参数必填。',
'type' => 'object',
'properties' => [
'Cpu' => [
'description' => 'CPU数量。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'MemoryGB' => [
'description' => '内存大小。单位为GB。'."\n"
."\n"
.'> 内存大小必须为CPU数量的4倍。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '40',
],
],
'required' => false,
],
'PricingCycle' => [
'description' => '订购周期,仅支持按月(Month)订购。',
'type' => 'string',
'required' => false,
'example' => 'Month',
'default' => 'Month',
'enum' => [
'Year',
'Month',
'Day',
'Hour',
],
],
'Duration' => [
'description' => '订购周期数量。'."\n"
."\n"
.'> 当ChargeType配置为PRE时,Duration参数必填。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'AutoRenew' => [
'description' => '付费类型为包年包月时,取值如下:'."\n"
.'- true:自动续费。'."\n"
.'- false:手动续费。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'Storage' => [
'description' => '存储参数。',
'type' => 'object',
'properties' => [
'Oss' => [
'description' => 'OSS存储。',
'type' => 'object',
'properties' => [
'Bucket' => [
'description' => 'OSS的Bucket名称。',
'type' => 'string',
'required' => false,
'example' => 'oss_flink',
],
],
'required' => false,
],
],
'required' => false,
],
'UsePromotionCode' => [
'title' => '是否使用优惠券',
'description' => '是否使用优惠券。取值如下:'."\n"
.'- true:使用。'."\n"
.'- false:不使用。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'PromotionCode' => [
'title' => '优惠券code',
'description' => '优惠码。',
'type' => 'string',
'required' => false,
'example' => '5ef***',
],
'Extra' => [
'title' => '优惠券code',
'type' => 'string',
'required' => false,
],
'ArchitectureType' => [
'type' => 'string',
'required' => false,
'enum' => [
'X86',
'ARM',
],
],
'Ha' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
'HaResourceSpec' => [
'type' => 'object',
'properties' => [
'Cpu' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
'MemoryGB' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
'required' => false,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '查询是否成功。取值如下:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'PriceInfo' => [
'title' => '价格信息,包括价格和优惠规则。',
'description' => '价格信息,包括价格和优惠规则。',
'type' => 'object',
'properties' => [
'Currency' => [
'title' => '货币单位。',
'description' => '货币单位。',
'type' => 'string',
'example' => 'CNY',
],
'DiscountAmount' => [
'title' => '折扣',
'description' => '折扣金额。',
'type' => 'number',
'format' => 'float',
'example' => '655.2',
],
'OriginalAmount' => [
'title' => '原价',
'description' => '原价。',
'type' => 'number',
'format' => 'float',
'example' => '4368',
],
'TradeAmount' => [
'title' => '最终价,为原价减去折扣。',
'description' => '最终价格,为原价减去折扣。',
'type' => 'number',
'format' => 'float',
'example' => '3712.8',
],
'Code' => [
'title' => '错误码',
'description' => '错误码。',
'type' => 'string',
'example' => 'ORDER.INST_HAS_UNPAID_ORDER',
],
'Message' => [
'title' => '错误信息',
'description' => '错误信息。',
'type' => 'string',
'example' => '存在未支付订单,请先支付或取消原有订单。',
],
'OptionalPromotions' => [
'description' => '优惠券信息。',
'type' => 'array',
'items' => [
'description' => '优惠券信息。',
'type' => 'object',
'properties' => [
'PromotionDesc' => [
'title' => '优惠券描述',
'description' => '优惠券描述。',
'type' => 'string',
'example' => '¥1,391.5优惠券(有效期至03/23/2022)',
],
'PromotionName' => [
'title' => '优惠券名称',
'description' => '优惠券信息。',
'type' => 'string',
'example' => '¥1,391.5优惠券',
],
'PromotionOptionNo' => [
'title' => '优惠券编号',
'description' => '优惠券编号。',
'type' => 'string',
'example' => '50001122001****',
],
'Selected' => [
'description' => '是否选中优惠券。取值如下:'."\n"
.'- true:选中。'."\n"
.'- false:未选中。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'Rules' => [
'title' => '活动规则。',
'description' => '活动规则。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => [
'title' => '活动规则描述。',
'description' => '活动规则描述。',
'type' => 'string',
'example' => '买满1年,立享官网价格8.5折优惠。',
],
'RuleId' => [
'title' => '活动ID。',
'description' => '活动规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '102007100514****',
],
],
],
],
'StandPrice' => [
'title' => '官网折扣价/直销合同折扣价',
'description' => '官网折扣价/直销合同折扣价',
'type' => 'string',
],
'StandDiscountPrice' => [
'title' => '基于官网折扣的优惠价格',
'description' => '基于官网折扣的优惠价格',
'type' => 'string',
],
'IsContractActivity' => [
'title' => '是否命中大客优惠',
'description' => '是否命中大客优惠',
'type' => 'boolean',
],
'DepreciateInfo' => [
'title' => '降价信息',
'description' => '降价信息',
'type' => 'object',
'properties' => [
'OriginalStandAmount' => [
'title' => '原始官网价总价',
'description' => '原始官网价总价',
'type' => 'string',
],
'CheapStandAmount' => [
'title' => '降价后官网价总价',
'description' => '降价后官网价总价',
'type' => 'string',
],
'CheapRate' => [
'title' => '降价比例',
'description' => '降价比例',
'type' => 'string',
],
'MonthPrice' => [
'title' => '折合月价',
'description' => '折合月价',
'type' => 'string',
],
'StartTime' => [
'title' => '降价开始时间',
'description' => '降价开始时间',
'type' => 'string',
],
'IsShow' => [
'title' => '是否展示降价幅度',
'description' => '是否展示降价幅度',
'type' => 'boolean',
],
],
],
'LxRequestId' => [
'title' => '调用的凌霄requestId',
'description' => '调用的凌霄requestId',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true,\\n \\"PriceInfo\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"DiscountAmount\\": 655.2,\\n \\"OriginalAmount\\": 4368,\\n \\"TradeAmount\\": 3712.8,\\n \\"Code\\": \\"ORDER.INST_HAS_UNPAID_ORDER\\",\\n \\"Message\\": \\"存在未支付订单,请先支付或取消原有订单。\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionDesc\\": \\"¥1,391.5优惠券(有效期至03/23/2022)\\",\\n \\"PromotionName\\": \\"¥1,391.5优惠券\\",\\n \\"PromotionOptionNo\\": \\"50001122001****\\",\\n \\"Selected\\": true\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年,立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 0\\n }\\n ],\\n \\"StandPrice\\": \\"\\",\\n \\"StandDiscountPrice\\": \\"\\",\\n \\"IsContractActivity\\": true,\\n \\"DepreciateInfo\\": {\\n \\"OriginalStandAmount\\": \\"\\",\\n \\"CheapStandAmount\\": \\"\\",\\n \\"CheapRate\\": \\"\\",\\n \\"MonthPrice\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"IsShow\\": true\\n },\\n \\"LxRequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n \\n CNY\\n 655.2\\n 4368\\n 3712.8\\n ORDER.INST_HAS_UNPAID_ORDER\\n 存在未支付订单,请先支付或取消原有订单。\\n \\n ¥1,391.5优惠券(有效期至03/23/2022)\\n ¥1,391.5优惠券\\n 50001122001****\\n true\\n \\n \\n 买满1年,立享官网价格8.5折优惠。\\n \\n \\n","errorExample":""}]',
'title' => '查询创建实例价格',
],
'QueryModifyInstancePrice' => [
'summary' => '您可以查询实例升降配时的价格。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '88699',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'ModifyPrepayInstanceSpecRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '查询工作空间升降配价格的请求信息。',
'type' => 'object',
'properties' => [
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => 'sc_flinkserverless_public_cn-******',
],
'ResourceSpec' => [
'description' => '资源规格信息。',
'type' => 'object',
'properties' => [
'Cpu' => [
'description' => 'CPU数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
'MemoryGB' => [
'description' => '内存大小。单位:GB。'."\n"
."\n"
.'> 内存大小必须为CPU数量大小的4倍。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '40',
],
],
'required' => true,
],
'Ha' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
'HaZoneId' => [
'type' => 'string',
'required' => false,
],
'HaVSwitchIds' => [
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'required' => false,
],
'HaResourceSpec' => [
'type' => 'object',
'properties' => [
'Cpu' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
'MemoryGB' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
'required' => false,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '查询是否成功。取值如下:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'PriceInfo' => [
'title' => '价格信息,包括价格和优惠规则。',
'description' => '价格信息,包括价格和优惠规则。',
'type' => 'object',
'properties' => [
'Currency' => [
'title' => '货币单位。',
'description' => '货币单位。',
'type' => 'string',
'example' => 'CNY',
],
'DiscountAmount' => [
'title' => '折扣',
'description' => '折扣金额。',
'type' => 'number',
'format' => 'float',
'example' => '655.2',
],
'OriginalAmount' => [
'title' => '原价',
'description' => '原价。',
'type' => 'number',
'format' => 'float',
'example' => '4368',
],
'TradeAmount' => [
'title' => '最终价,为原价减去折扣。',
'description' => '最终价,为原价减去折扣金额。',
'type' => 'number',
'format' => 'float',
'example' => '3712.8',
],
'Code' => [
'title' => '错误码',
'description' => '错误码。',
'type' => 'string',
'example' => 'ORDER.INST_HAS_UNPAID_ORDER',
],
'Message' => [
'title' => '错误信息',
'description' => '错误信息。',
'type' => 'string',
'example' => '存在未支付订单,请先支付或取消原有订单。',
],
'OptionalPromotions' => [
'description' => '优惠券信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PromotionDesc' => [
'title' => '优惠券描述',
'description' => '优惠券描述。',
'type' => 'string',
'example' => '¥1,391.5优惠券 (有效期至 03/23/2022)',
],
'PromotionName' => [
'title' => '优惠券名称',
'description' => '优惠券名称。',
'type' => 'string',
'example' => '¥1,391.5优惠券',
],
'PromotionOptionNo' => [
'title' => '优惠券编号',
'description' => '优惠券编号。',
'type' => 'string',
'example' => '500011220010099',
],
'Selected' => [
'description' => '是否选用优惠券。取值如下:'."\n"
."\n"
.'- true:选用。'."\n"
."\n"
.'- false:未选用。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'Rules' => [
'title' => '活动规则。',
'description' => '活动规则。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => [
'title' => '活动规则描述。',
'description' => '活动规则描述。',
'type' => 'string',
'example' => '买满1年,立享官网价格8.5折优惠。',
],
'RuleId' => [
'title' => '活动ID。',
'description' => '活动ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1020071005141834',
],
],
],
],
'StandPrice' => [
'title' => '官网折扣价/直销合同折扣价',
'description' => '官网折扣价/直销合同折扣价',
'type' => 'string',
],
'StandDiscountPrice' => [
'title' => '基于官网折扣的优惠价格',
'description' => '基于官网折扣的优惠价格',
'type' => 'string',
],
'IsContractActivity' => [
'title' => '是否命中大客优惠',
'description' => '是否命中大客优惠',
'type' => 'boolean',
],
'DepreciateInfo' => [
'title' => '降价信息',
'description' => '降价信息',
'type' => 'object',
'properties' => [
'OriginalStandAmount' => [
'title' => '原始官网价总价',
'description' => '原始官网价总价',
'type' => 'string',
],
'CheapStandAmount' => [
'title' => '降价后官网价总价',
'description' => '降价后官网价总价',
'type' => 'string',
],
'CheapRate' => [
'title' => '降价比例',
'description' => '降价比例',
'type' => 'string',
],
'MonthPrice' => [
'title' => '折合月价',
'description' => '折合月价',
'type' => 'string',
],
'StartTime' => [
'title' => '降价开始时间',
'description' => '降价开始时间',
'type' => 'string',
],
'IsShow' => [
'title' => '是否展示降价幅度',
'description' => '是否展示降价幅度',
'type' => 'boolean',
],
],
],
'LxRequestId' => [
'title' => '调用的凌霄requestId',
'description' => '调用的凌霄requestId',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true,\\n \\"PriceInfo\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"DiscountAmount\\": 655.2,\\n \\"OriginalAmount\\": 4368,\\n \\"TradeAmount\\": 3712.8,\\n \\"Code\\": \\"ORDER.INST_HAS_UNPAID_ORDER\\",\\n \\"Message\\": \\"存在未支付订单,请先支付或取消原有订单。\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionDesc\\": \\"¥1,391.5优惠券 (有效期至 03/23/2022)\\",\\n \\"PromotionName\\": \\"¥1,391.5优惠券\\",\\n \\"PromotionOptionNo\\": \\"500011220010099\\",\\n \\"Selected\\": true\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年,立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 1020071005141834\\n }\\n ],\\n \\"StandPrice\\": \\"\\",\\n \\"StandDiscountPrice\\": \\"\\",\\n \\"IsContractActivity\\": true,\\n \\"DepreciateInfo\\": {\\n \\"OriginalStandAmount\\": \\"\\",\\n \\"CheapStandAmount\\": \\"\\",\\n \\"CheapRate\\": \\"\\",\\n \\"MonthPrice\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"IsShow\\": true\\n },\\n \\"LxRequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n \\n CNY\\n 655.2\\n 4368\\n 3712.8\\n ORDER.INST_HAS_UNPAID_ORDER\\n 存在未支付订单,请先支付或取消原有订单。\\n \\n ¥1,391.5优惠券 (有效期至 03/23/2022)\\n ¥1,391.5优惠券\\n 500011220010099\\n true\\n \\n \\n 买满1年,立享官网价格8.5折优惠。\\n 1020071005141834\\n \\n \\n","errorExample":""}]',
'title' => '查询实例升降配价格',
],
'QueryRenewInstancePrice' => [
'summary' => '您可以查询续费一个实例的价格。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '88391',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'RenewInstanceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '查询续费工作空间价格的请求信息。',
'type' => 'object',
'properties' => [
'Region' => [
'title' => '地域id',
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'title' => '实例id',
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => 'sc_flinkserverless_public_cn-******',
],
'Duration' => [
'title' => '订购周期数量',
'description' => '订购周期数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
'PricingCycle' => [
'title' => '订购周期',
'description' => '订购周期。取值支持Month和Year。',
'type' => 'string',
'required' => true,
'example' => 'Month',
'default' => 'Month',
'enum' => [
'Year',
'Month',
'Day',
'Hour',
],
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '查询是否成功。取值如下:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'PriceInfo' => [
'title' => '价格信息,包括价格和优惠规则。',
'description' => '价格信息,包括价格和优惠规则。',
'type' => 'object',
'properties' => [
'Currency' => [
'title' => '货币单位。',
'description' => '货币单位。',
'type' => 'string',
'example' => 'CNY',
],
'DiscountAmount' => [
'title' => '折扣',
'description' => '折扣金额。',
'type' => 'number',
'format' => 'float',
'example' => '655.2',
],
'OriginalAmount' => [
'title' => '原价',
'description' => '原价。',
'type' => 'number',
'format' => 'float',
'example' => '4368',
],
'TradeAmount' => [
'title' => '最终价,为原价减去折扣。',
'description' => '最终价,为原价减去折扣金额。',
'type' => 'number',
'format' => 'float',
'example' => '3712.8',
],
'Code' => [
'title' => '错误码',
'description' => '错误码。',
'type' => 'string',
'example' => 'ORDER.INST_HAS_UNPAID_ORDER',
],
'Message' => [
'title' => '错误信息',
'description' => '错误信息。',
'type' => 'string',
'example' => '存在未支付订单,请先支付或取消原有订单。',
],
'OptionalPromotions' => [
'description' => '优惠券信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PromotionDesc' => [
'title' => '优惠券描述',
'description' => '优惠券描述。',
'type' => 'string',
'example' => '¥1,391.5优惠券 (有效期至 03/23/2022)',
],
'PromotionName' => [
'title' => '优惠券名称',
'description' => '优惠券名称。',
'type' => 'string',
'example' => '¥1,391.5优惠券',
],
'PromotionOptionNo' => [
'title' => '优惠券编号',
'description' => '优惠券编号。',
'type' => 'string',
'example' => '500011220010099',
],
'Selected' => [
'description' => '是否选用优惠券。取值如下:'."\n"
."\n"
.'- true:选用。'."\n"
."\n"
.'- false:未选用。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'Rules' => [
'title' => '活动规则。',
'description' => '活动规则。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => [
'title' => '活动规则描述。',
'description' => '活动规则描述。',
'type' => 'string',
'example' => '买满1年,立享官网价格8.5折优惠。',
],
'RuleId' => [
'title' => '活动ID。',
'description' => '活动ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1020071005141834',
],
],
],
],
'StandPrice' => [
'title' => '官网折扣价/直销合同折扣价',
'description' => '官网折扣价/直销合同折扣价',
'type' => 'string',
],
'StandDiscountPrice' => [
'title' => '基于官网折扣的优惠价格',
'description' => '基于官网折扣的优惠价格',
'type' => 'string',
],
'IsContractActivity' => [
'title' => '是否命中大客优惠',
'description' => '是否命中大客优惠',
'type' => 'boolean',
],
'DepreciateInfo' => [
'title' => '降价信息',
'description' => '降价信息',
'type' => 'object',
'properties' => [
'OriginalStandAmount' => [
'title' => '原始官网价总价',
'description' => '原始官网价总价',
'type' => 'string',
],
'CheapStandAmount' => [
'title' => '降价后官网价总价',
'description' => '降价后官网价总价',
'type' => 'string',
],
'CheapRate' => [
'title' => '降价比例',
'description' => '降价比例',
'type' => 'string',
],
'MonthPrice' => [
'title' => '折合月价',
'description' => '折合月价',
'type' => 'string',
],
'StartTime' => [
'title' => '降价开始时间',
'description' => '降价开始时间',
'type' => 'string',
],
'IsShow' => [
'title' => '是否展示降价幅度',
'description' => '是否展示降价幅度',
'type' => 'boolean',
],
],
],
'LxRequestId' => [
'title' => '调用的凌霄requestId',
'description' => '调用的凌霄requestId',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true,\\n \\"PriceInfo\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"DiscountAmount\\": 655.2,\\n \\"OriginalAmount\\": 4368,\\n \\"TradeAmount\\": 3712.8,\\n \\"Code\\": \\"ORDER.INST_HAS_UNPAID_ORDER\\",\\n \\"Message\\": \\"存在未支付订单,请先支付或取消原有订单。\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionDesc\\": \\"¥1,391.5优惠券 (有效期至 03/23/2022)\\",\\n \\"PromotionName\\": \\"¥1,391.5优惠券\\",\\n \\"PromotionOptionNo\\": \\"500011220010099\\",\\n \\"Selected\\": true\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年,立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 1020071005141834\\n }\\n ],\\n \\"StandPrice\\": \\"\\",\\n \\"StandDiscountPrice\\": \\"\\",\\n \\"IsContractActivity\\": true,\\n \\"DepreciateInfo\\": {\\n \\"OriginalStandAmount\\": \\"\\",\\n \\"CheapStandAmount\\": \\"\\",\\n \\"CheapRate\\": \\"\\",\\n \\"MonthPrice\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"IsShow\\": true\\n },\\n \\"LxRequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n \\n CNY\\n 655.2\\n 4368\\n 3712.8\\n ORDER.INST_HAS_UNPAID_ORDER\\n 存在未支付订单,请先支付或取消原有订单。\\n \\n ¥1,391.5优惠券 (有效期至 03/23/2022)\\n ¥1,391.5优惠券\\n 500011220010099\\n true\\n \\n \\n 买满1年,立享官网价格8.5折优惠。\\n 1020071005141834\\n \\n \\n","errorExample":""}]',
'title' => '查询续费实例价格',
],
'QueryConvertInstancePrice' => [
'summary' => '您可以查询转换实例时的价格。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '90957',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'ConvertPostpayInstanceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '查询转换工作空间时所需的请求参数。',
'type' => 'object',
'properties' => [
'Region' => [
'description' => '工作空间所属的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
'InstanceId' => [
'description' => '工作空间ID。',
'type' => 'string',
'required' => true,
'example' => 'sc_flinkserverlesspost_public_cn-******',
],
'PricingCycle' => [
'title' => '订购周期',
'description' => '订购周期。取值支持Day、Month、Year。'."\n",
'type' => 'string',
'required' => true,
'example' => 'Month',
'default' => 'Month',
'enum' => [
'Year',
'Month',
'Day',
'Hour',
],
],
'Duration' => [
'title' => '订购周期数量',
'description' => '订购周期数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
'IsAutoRenew' => [
'title' => '是否自动续费',
'description' => '是否自动续费,取值如下:'."\n"
."\n"
.'- true:自动续费。'."\n"
."\n"
.'- false:手续续费。',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
'NamespaceResourceSpecs' => [
'title' => '项目空间资源规格。',
'description' => '项目空间资源规格信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Namespace' => [
'title' => 'namespace名称,',
'description' => '项目空间名称。',
'type' => 'string',
'required' => true,
'example' => 'ns-1',
],
'ResourceSpec' => [
'title' => '资源规格。',
'description' => '资源规格。',
'type' => 'object',
'properties' => [
'Cpu' => [
'title' => 'cpu数量。',
'description' => 'CPU数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
'MemoryGB' => [
'title' => '内存大小。',
'description' => '内存大小。单位:GB。'."\n"
."\n"
.'> 内存大小必须为CPU数量大小的4倍。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '4',
],
],
'required' => true,
],
],
'required' => true,
],
'required' => true,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'description' => '查询是否成功,取值如下:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'PriceInfo' => [
'title' => '价格信息,包括价格和优惠规则。',
'description' => '价格信息,包括价格和优惠规则。',
'type' => 'object',
'properties' => [
'Currency' => [
'title' => '货币单位。',
'description' => '货币单位。',
'type' => 'string',
'example' => 'CNY',
],
'DiscountAmount' => [
'title' => '折扣',
'description' => '折扣金额。',
'type' => 'number',
'format' => 'float',
'example' => '655.2',
],
'OriginalAmount' => [
'title' => '原价',
'description' => '原价。',
'type' => 'number',
'format' => 'float',
'example' => '4368',
],
'TradeAmount' => [
'title' => '最终价,为原价减去折扣。',
'description' => '最终价,为原价减去折扣金额。',
'type' => 'number',
'format' => 'float',
'example' => '3712.8',
],
'Code' => [
'title' => '错误码',
'description' => '错误码。',
'type' => 'string',
'example' => 'ORDER.INST_HAS_UNPAID_ORDER',
],
'Message' => [
'title' => '错误信息',
'description' => '错误信息。',
'type' => 'string',
'example' => '存在未支付订单,请先支付或取消原有订单。',
],
'OptionalPromotions' => [
'description' => '优惠券信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PromotionDesc' => [
'title' => '优惠券描述',
'description' => '优惠券描述。',
'type' => 'string',
'example' => '¥1,391.5优惠券 (有效期至 03/23/2022)',
],
'PromotionName' => [
'title' => '优惠券名称',
'description' => '优惠券名称。',
'type' => 'string',
'example' => '¥1,391.5优惠券',
],
'PromotionOptionNo' => [
'title' => '优惠券编号',
'description' => '优惠券编号。',
'type' => 'string',
'example' => '500011220010099',
],
'Selected' => [
'description' => '是否选用优惠券,取值如下:'."\n"
."\n"
.'- true:选用。'."\n"
."\n"
.'- false:未选用。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'Rules' => [
'title' => '活动规则。',
'description' => '活动规则。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => [
'title' => '活动规则描述。',
'description' => '活动规则描述。',
'type' => 'string',
'example' => '买满1年,立享官网价格8.5折优惠。',
],
'RuleId' => [
'title' => '活动ID。',
'description' => '活动ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1020071005141834',
],
],
],
],
'StandPrice' => [
'title' => '官网折扣价/直销合同折扣价',
'description' => '官网折扣价/直销合同折扣价',
'type' => 'string',
],
'StandDiscountPrice' => [
'title' => '基于官网折扣的优惠价格',
'description' => '基于官网折扣的优惠价格',
'type' => 'string',
],
'IsContractActivity' => [
'title' => '是否命中大客优惠',
'description' => '是否命中大客优惠',
'type' => 'boolean',
],
'DepreciateInfo' => [
'title' => '降价信息',
'description' => '降价信息',
'type' => 'object',
'properties' => [
'OriginalStandAmount' => [
'title' => '原始官网价总价',
'description' => '原始官网价总价',
'type' => 'string',
],
'CheapStandAmount' => [
'title' => '降价后官网价总价',
'description' => '降价后官网价总价',
'type' => 'string',
],
'CheapRate' => [
'title' => '降价比例',
'description' => '降价比例',
'type' => 'string',
],
'MonthPrice' => [
'title' => '折合月价',
'description' => '折合月价',
'type' => 'string',
],
'StartTime' => [
'title' => '降价开始时间',
'description' => '降价开始时间',
'type' => 'string',
],
'IsShow' => [
'title' => '是否展示降价幅度',
'description' => '是否展示降价幅度',
'type' => 'boolean',
],
],
],
'LxRequestId' => [
'title' => '调用的凌霄requestId',
'description' => '调用的凌霄requestId',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\",\\n \\"Success\\": true,\\n \\"PriceInfo\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"DiscountAmount\\": 655.2,\\n \\"OriginalAmount\\": 4368,\\n \\"TradeAmount\\": 3712.8,\\n \\"Code\\": \\"ORDER.INST_HAS_UNPAID_ORDER\\",\\n \\"Message\\": \\"存在未支付订单,请先支付或取消原有订单。\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionDesc\\": \\"¥1,391.5优惠券 (有效期至 03/23/2022)\\",\\n \\"PromotionName\\": \\"¥1,391.5优惠券\\",\\n \\"PromotionOptionNo\\": \\"500011220010099\\",\\n \\"Selected\\": true\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年,立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 1020071005141834\\n }\\n ],\\n \\"StandPrice\\": \\"\\",\\n \\"StandDiscountPrice\\": \\"\\",\\n \\"IsContractActivity\\": true,\\n \\"DepreciateInfo\\": {\\n \\"OriginalStandAmount\\": \\"\\",\\n \\"CheapStandAmount\\": \\"\\",\\n \\"CheapRate\\": \\"\\",\\n \\"MonthPrice\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"IsShow\\": true\\n },\\n \\"LxRequestId\\": \\"67F33190-946B-1105-B6A1-E2DF0426DD51\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 67F33190-946B-1105-B6A1-E2DF0426DD51\\n true\\n \\n CNY\\n 655.2\\n 4368\\n 3712.8\\n ORDER.INST_HAS_UNPAID_ORDER\\n 存在未支付订单,请先支付或取消原有订单。\\n \\n ¥1,391.5优惠券 (有效期至 03/23/2022)\\n ¥1,391.5优惠券\\n 500011220010099\\n true\\n \\n \\n 买满1年,立享官网价格8.5折优惠。\\n 1020071005141834\\n \\n \\n","errorExample":""}]',
'title' => '查询转换实例价格',
],
'DescribeSupportedZones' => [
'summary' => '您可以获取支持购买的可用区信息。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '101076',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'Region',
'in' => 'query',
'schema' => [
'title' => 'regionId',
'description' => '地域ID。',
'type' => 'string',
'required' => false,
'example' => 'cn-beijing',
],
],
[
'name' => 'ArchitectureType',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => '23A9C718-DDAB-1696-B025-18FBC830F7C5',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功,取值如下:'."\n"
."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'ZoneIds' => [
'description' => '可用区信息。',
'type' => 'array',
'items' => [
'description' => '可用区。',
'type' => 'string',
'example' => 'cn-beijing-g',
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"23A9C718-DDAB-1696-B025-18FBC830F7C5\\",\\n \\"Success\\": true,\\n \\"ZoneIds\\": [\\n \\"cn-beijing-g\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 23A9C718-DDAB-1696-B025-18FBC830F7C5\\n true\\n cn-beijing-g\\n","errorExample":""}]',
'title' => '获取支持购买的可用区',
],
'DescribeSupportedRegions' => [
'summary' => '您可以获取支持购买的地域信息。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '101073',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '请求ID。',
'type' => 'string',
'example' => 'B21DC47E-8928-199A-9F32-36D45E4693B4',
],
'Success' => [
'title' => '是否成功',
'description' => '是否成功,取值如下:'."\n"
."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'Regions' => [
'description' => '地域信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Region' => [
'title' => 'regionId',
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-beijing',
],
'RegionName' => [
'title' => 'region名称',
'description' => '地域名称。',
'type' => 'string',
'example' => '华北2 (北京)',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B21DC47E-8928-199A-9F32-36D45E4693B4\\",\\n \\"Success\\": true,\\n \\"Regions\\": [\\n {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"RegionName\\": \\"华北2 (北京)\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B21DC47E-8928-199A-9F32-36D45E4693B4\\n true\\n \\n cn-beijing\\n 华北2 (北京)\\n \\n","errorExample":""}]',
'title' => '获取支持购买的地域',
],
'ListTagResources' => [
'summary' => '您可以调用ListTagResources查询资源标签。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '133931',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'title' => '下一个查询开始Token',
'description' => '下一个查询开始的Token。',
'type' => 'string',
'required' => false,
'example' => 'yt656',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '地域',
'description' => '地域。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '资源类型,固定值vvpinstance。',
'type' => 'string',
'required' => true,
'example' => 'vvpinstance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '资源ID,最多50个子项。',
'type' => 'array',
'items' => [
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'f-cn-tyts',
],
'required' => false,
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '工作空间标签,最多包含20个子项。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'Value' => [
'title' => '标签值',
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'tag',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => 'requestID。',
'type' => 'string',
'example' => '27AE00',
],
'TagReponseId' => [
'description' => 'tag请求ID。',
'type' => 'string',
'example' => '87AE00',
],
'NextToken' => [
'description' => '下一个查询开始的Token。',
'type' => 'string',
'example' => '27AE00',
],
'TagResources' => [
'title' => '资源列表',
'description' => '资源列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceType' => [
'title' => '资源类型',
'description' => '资源类型。',
'type' => 'string',
'example' => 'vvpinstance',
],
'TagValue' => [
'title' => '标签值',
'description' => '标签值。',
'type' => 'string',
'example' => 'tag',
],
'ResourceId' => [
'title' => '资源ID',
'description' => '资源ID。',
'type' => 'string',
'example' => 'f-cn-tyts',
],
'TagKey' => [
'title' => '标签键',
'description' => '标签键。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"27AE00\\",\\n \\"TagReponseId\\": \\"87AE00\\",\\n \\"NextToken\\": \\"27AE00\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"vvpinstance\\",\\n \\"TagValue\\": \\"tag\\",\\n \\"ResourceId\\": \\"f-cn-tyts\\",\\n \\"TagKey\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 27AE00\\n 87AE00\\n 27AE00\\n \\n vvpinstance\\n tag\\n f-cn-tyts\\n test\\n \\n","errorExample":""}]',
'title' => '查询资源标签',
],
'UntagResources' => [
'summary' => '您可以调用UntagResources删除资源标签。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '133930',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '地域',
'description' => '地域。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '资源类型,固定值为vvpinstance。',
'type' => 'string',
'required' => true,
'example' => 'vvpinstance',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'title' => '是否全部删除,只针对TagKey.N为空时有效。 取值范围: true false True False 默认是 false',
'description' => '是否全部删除资源标签,只针对TagKey为空时有效。默认是false。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多50个子项',
'description' => '资源ID,最多50个子项。',
'type' => 'array',
'items' => [
'description' => '资源ID。',
'type' => 'string',
'required' => false,
'example' => 'f-cn-tgy67',
],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签键,最多20个子项',
'description' => '标签键,最多20个子项。',
'type' => 'array',
'items' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '27AE00',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'TagResponseId' => [
'description' => 'tag请求ID。',
'type' => 'string',
'example' => '154FT',
],
'Message' => [
'description' => '请求信息。',
'type' => 'string',
'example' => '""',
],
'Code' => [
'description' => '返回码。',
'type' => 'string',
'example' => '200',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"27AE00\\",\\n \\"Success\\": true,\\n \\"TagResponseId\\": \\"154FT\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 27AE00\\n true\\n 154FT\\n \\"\\"\\n 200\\n","errorExample":""}]',
'title' => '删除资源标签',
],
'TagResources' => [
'summary' => '您可以调用TagResources创建资源标签。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '133929',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '地域',
'description' => '地域。',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '资源类型,固定值为vvpinstance。',
'type' => 'string',
'required' => true,
'example' => 'vvpinstance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '资源ID,最多50个子项。',
'type' => 'array',
'items' => [
'description' => '资源ID。',
'type' => 'string',
'required' => false,
'example' => 'f-cn-7e22rg',
],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '工作空间标签,最多包含20个子项。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'Value' => [
'title' => '标签值',
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'tag',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CBC799-****',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'TagResponseId' => [
'description' => 'tag请求ID。',
'type' => 'string',
'example' => '154FT',
],
'Message' => [
'description' => '请求信息。',
'type' => 'string',
'example' => '""',
],
'Code' => [
'description' => '返回码。',
'type' => 'string',
'example' => '200',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBC799-****\\",\\n \\"Success\\": true,\\n \\"TagResponseId\\": \\"154FT\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 27AE00\\n true\\n 154FT\\n \\"\\"\\n 200\\n","errorExample":""}]',
'title' => '创建资源标签',
],
'ConvertPrepayInstance' => [
'summary' => '包年包月转按量付费',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '150081',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'ConvertPrepayInstanceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'type' => 'object',
'properties' => [
'Region' => [
'type' => 'string',
'required' => true,
],
'InstanceId' => [
'type' => 'string',
'required' => true,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'type' => 'boolean',
],
'OrderId' => [
'title' => '订单id',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
'QueryConvertPrepayInstancePrice' => [
'summary' => '包年包月转按量付费询价',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '150082',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'ConvertPrepayInstanceRequest',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'type' => 'object',
'properties' => [
'Region' => [
'type' => 'string',
'required' => true,
],
'InstanceId' => [
'type' => 'string',
'required' => true,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
'Success' => [
'title' => '是否成功',
'type' => 'boolean',
],
'PriceInfo' => [
'title' => '价格信息,包括价格和优惠规则。',
'type' => 'object',
'properties' => [
'Currency' => [
'title' => '货币单位。',
'type' => 'string',
'example' => 'CNY',
],
'DiscountAmount' => [
'title' => '折扣',
'type' => 'number',
'format' => 'float',
'example' => '655.2',
],
'OriginalAmount' => [
'title' => '原价',
'type' => 'number',
'format' => 'float',
'example' => '4368',
],
'TradeAmount' => [
'title' => '最终价,为原价减去折扣。',
'type' => 'number',
'format' => 'float',
'example' => '3712.8',
],
'Code' => [
'title' => '错误码',
'type' => 'string',
'example' => 'ORDER.INST_HAS_UNPAID_ORDER',
],
'Message' => [
'title' => '错误信息',
'type' => 'string',
'example' => '存在未支付订单,请先支付或取消原有订单',
],
'OptionalPromotions' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PromotionDesc' => [
'title' => '优惠券描述',
'type' => 'string',
'example' => '¥1,391.5 优惠券 (有效期至 03/23/2022)',
],
'PromotionName' => [
'title' => '优惠券名称',
'type' => 'string',
'example' => '¥1,391.5 优惠券',
],
'PromotionOptionNo' => [
'title' => '优惠券编号',
'type' => 'string',
'example' => '500011220010099',
],
'Selected' => [
'type' => 'boolean',
],
],
],
],
'Rules' => [
'title' => '活动规则。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => [
'title' => '活动规则描述。',
'type' => 'string',
'example' => '买满1年,立享官网价格8.5折优惠。',
],
'RuleId' => [
'title' => '活动ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '587',
],
],
],
],
'StandPrice' => [
'title' => '官网折扣价/直销合同折扣价',
'type' => 'string',
],
'StandDiscountPrice' => [
'title' => '基于官网折扣的优惠价格',
'type' => 'string',
],
'IsContractActivity' => [
'title' => '是否命中大客优惠',
'type' => 'boolean',
],
'DepreciateInfo' => [
'title' => '降价信息',
'type' => 'object',
'properties' => [
'OriginalStandAmount' => [
'title' => '原始官网价总价',
'type' => 'string',
],
'CheapStandAmount' => [
'title' => '降价后官网价总价',
'type' => 'string',
],
'CheapRate' => [
'title' => '降价比例',
'type' => 'string',
],
'MonthPrice' => [
'title' => '折合月价',
'type' => 'string',
],
'StartTime' => [
'title' => '降价开始时间',
'type' => 'string',
],
'IsShow' => [
'title' => '是否展示降价幅度',
'type' => 'boolean',
],
],
],
'LxRequestId' => [
'title' => '调用的凌霄requestId',
'type' => 'string',
'example' => '67F33190-946B-1105-B6A1-E2DF0426DD51',
],
],
],
],
],
],
],
'responseDemo' => '',
],
'ChangeResourceGroup' => [
'summary' => '修改资源组',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '156646',
'abilityTreeNodes' => [
'FEATUREscYN6NTL',
'FEATUREscTKD5I3',
],
],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'title' => '资源Id',
'description' => '资源Id',
'type' => 'string',
'required' => true,
'example' => 'f-cn-7e22rg',
],
],
[
'name' => 'ResourceRegionId',
'in' => 'query',
'schema' => [
'title' => '地域Id',
'description' => '地域Id',
'type' => 'string',
'required' => true,
'example' => 'us-east-1',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'title' => '目标资源组',
'description' => '目标资源组',
'type' => 'string',
'required' => true,
'example' => 'rg-acfmxbavps3rpiy',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'B21DC47E-8928-199A-9F32-36D45E4693B4',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission.ChangeResourceGroup',
'errorMessage' => 'You are not authorized to change resourcegroup',
],
[
'errorCode' => 'MissingParameter.ResourceRegionId',
'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing',
],
[
'errorCode' => 'MissingParameter.ResourceId',
'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing',
],
[
'errorCode' => 'MissingParameter.ResourceGroupId',
'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing',
],
[
'errorCode' => 'InvalidResourceGroup',
'errorMessage' => 'The specified ResourceGroupId is invalid',
],
[
'errorCode' => 'SystemError',
'errorMessage' => 'A system error occurred while processing your request',
],
[
'errorCode' => 'ResourceNotFound',
'errorMessage' => ' The specified resource is not found',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B21DC47E-8928-199A-9F32-36D45E4693B4\\"\\n}","type":"json"}]',
'title' => '修改资源组',
'description' => '请确保在使用该接口前,已充分了解实时计算Flink产品的[收费方式](https://help.aliyun.com/zh/flink/user-guide/reconfigure-resources?spm=a2c4g.11186623.0.0.6ebd18ea0MCC3t#task-2507532)和价格。',
],
],
'endpoints' => [
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'foasconsole.cn-zhangjiakou.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'foasconsole.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'foasconsole.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'foasconsole.cn-shenzhen.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'foasconsole.cn-hongkong.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'foasconsole.ap-southeast-3.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'foasconsole.ap-northeast-1.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'foasconsole.eu-central-1.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'foasconsole.cn-shanghai-finance-1.aliyuncs.com',
],
[
'regionId' => 'cn-north-2-gov-1',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-2-pop',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'foasconsole.ap-southeast-5.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-pop',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-gov-1',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-nu16-b01',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-edge-1',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-fujian',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-haidian-cm12-c01',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-bj-b01',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-prod-1',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-1',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-2',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-3',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-test-306',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong-finance-pop',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote-nebula-1',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao-nebula',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et15-b01',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et2-b01',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-inner',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-internal-test-1',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-inner',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-st4-d01',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-su18-b01',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-wuhan',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-yushanfang',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei-na61-b01',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou-na62-a01',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'cn-zhengzhou-nebula-1',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'foasconsole.eu-west-1.aliyuncs.com',
],
[
'regionId' => 'eu-west-1-oxs',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'rus-west-1-pop',
'endpoint' => 'foasconsole.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'foasconsole.us-east-1.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'foasconsole.us-west-1.aliyuncs.com',
],
[
'regionId' => 'cn-wulanchabu',
'endpoint' => 'foasconsole.cn-wulanchabu.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'foasconsole.cn-shenzhen-finance-1.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'foasconsole.cn-beijing.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'foasconsole.cn-chengdu.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'foasconsole.ap-southeast-1.aliyuncs.com',
],
],
];