summaryrefslogtreecommitdiff
path: root/data/zh_cn/paielasticdatasetaccelerator
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/paielasticdatasetaccelerator
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/paielasticdatasetaccelerator')
-rw-r--r--data/zh_cn/paielasticdatasetaccelerator/2022-08-01/api-docs.php6514
1 files changed, 2147 insertions, 4367 deletions
diff --git a/data/zh_cn/paielasticdatasetaccelerator/2022-08-01/api-docs.php b/data/zh_cn/paielasticdatasetaccelerator/2022-08-01/api-docs.php
index 823ba82..e7d566d 100644
--- a/data/zh_cn/paielasticdatasetaccelerator/2022-08-01/api-docs.php
+++ b/data/zh_cn/paielasticdatasetaccelerator/2022-08-01/api-docs.php
@@ -1,86 +1,48 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'PAIElasticDatasetAccelerator',
- 'version' => '2022-08-01',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'PAIElasticDatasetAccelerator', 'version' => '2022-08-01'],
'directories' => [
[
- 'id' => 176543,
- 'title' => '数据集加速实例',
+ 'children' => ['CreateInstance', 'DeleteInstance', 'UpdateInstance', 'ListInstances', 'QueryInstanceMetrics', 'DescribeInstance'],
'type' => 'directory',
- 'children' => [
- 'CreateInstance',
- 'DeleteInstance',
- 'UpdateInstance',
- 'ListInstances',
- 'QueryInstanceMetrics',
- 'DescribeInstance',
- ],
+ 'title' => '数据集加速实例',
+ 'id' => 314647,
],
[
- 'id' => 176550,
- 'title' => '数据集加速槽',
+ 'children' => ['CreateSlot', 'StopSlot', 'UpdateSlot', 'QuerySlotMetrics', 'ListSlots', 'DescribeSlot'],
'type' => 'directory',
- 'children' => [
- 'CreateSlot',
- 'DeleteSlot',
- 'StopSlot',
- 'UpdateSlot',
- 'QuerySlotMetrics',
- 'ListSlots',
- 'DescribeSlot',
- ],
+ 'title' => '数据集加速槽',
+ 'id' => 314654,
],
[
- 'id' => 176558,
- 'title' => '数据集加速端点',
+ 'children' => ['CreateEndpoint', 'DeleteEndpoint', 'BindEndpoint', 'UnbindEndpoint', 'ListEndpoints', 'DescribeEndpoint'],
'type' => 'directory',
- 'children' => [
- 'CreateEndpoint',
- 'DeleteEndpoint',
- 'BindEndpoint',
- 'UnbindEndpoint',
- 'ListEndpoints',
- 'DescribeEndpoint',
- ],
+ 'title' => '数据集加速端点',
+ 'id' => 314662,
],
[
- 'id' => 176565,
- 'title' => '组件',
+ 'children' => ['DescribeComponent', 'ListComponents'],
'type' => 'directory',
- 'children' => [
- 'DescribeComponent',
- 'ListComponents',
- ],
+ 'title' => '组件',
+ 'id' => 314669,
],
[
- 'id' => 176568,
- 'title' => '标签',
+ 'children' => ['CreateTag', 'DeleteTag', 'ListTags'],
'type' => 'directory',
- 'children' => [
- 'CreateTag',
- 'DeleteTag',
- 'ListTags',
- ],
+ 'title' => '标签',
+ 'id' => 314672,
],
[
- 'id' => 176572,
- 'title' => '统计信息',
+ 'children' => ['QueryStatistic'],
'type' => 'directory',
- 'children' => [
- 'QueryStatistic',
- ],
+ 'title' => '统计信息',
+ 'id' => 314676,
],
[
- 'id' => 190126,
- 'title' => '其他',
+ 'children' => ['ReloadSlot', 'CreateSlots', 'DeleteSlot'],
'type' => 'directory',
- 'children' => [
- 'ReloadSlot',
- 'CreateSlots',
- ],
+ 'title' => '其他',
+ 'id' => 314678,
],
],
'components' => [
@@ -103,33 +65,11 @@
.'- Stopped：已停止。',
'type' => 'string',
'example' => 'Ready',
- 'enum' => [
- 'Created',
- 'ResourceAllocating',
- 'ResourceAllocated',
- 'Ready',
- 'Stopping',
- 'Failed',
- 'Stopped',
- ],
- ],
- 'Code' => [
- 'title' => '数据集加速槽挂载点所处状态对应的状态码/错误码。',
- 'description' => '数据集加速槽挂载点所处状态对应的状态码或错误码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '数据集加速槽挂载点所处状态附带的信息/错误信息。',
- 'description' => '数据集加速槽挂载点所处状态附带的信息或错误信息。',
- 'type' => 'string',
- 'example' => 'Init Succeed',
- ],
- 'Detail' => [
- 'title' => '数据集加速端点状态的详细信息。',
- 'description' => '数据集加速端点的详细信息。',
- '$ref' => '#/components/schemas/EndpointStatusDetail',
+ 'enum' => ['Created', 'ResourceAllocating', 'ResourceAllocated', 'Ready', 'Stopping', 'Failed', 'Stopped'],
],
+ 'Code' => ['title' => '数据集加速槽挂载点所处状态对应的状态码/错误码。', 'description' => '数据集加速槽挂载点所处状态对应的状态码或错误码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '数据集加速槽挂载点所处状态附带的信息/错误信息。', 'description' => '数据集加速槽挂载点所处状态附带的信息或错误信息。', 'type' => 'string', 'example' => 'Init Succeed'],
+ 'Detail' => ['title' => '数据集加速端点状态的详细信息。', 'description' => '数据集加速端点的详细信息。', '$ref' => '#/components/schemas/EndpointStatusDetail'],
],
],
'EndpointStatusDetail' => [
@@ -143,10 +83,7 @@
.'- Key为提供服务的数据集加速槽的Uuid。'."\n"
.'- Value为IP-Port信息。',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => 'IP和端口信息。',
- '$ref' => '#/components/schemas/IpPort',
- ],
+ 'additionalProperties' => ['description' => 'IP和端口信息。', '$ref' => '#/components/schemas/IpPort'],
'example' => '{ "slot-j6co2fcd": { "Ip": "10.0.0.2", "Port": 7001 }, "slot-asdgys4d": { "Ip": "10.0.0.3", "Port": 7002 } }',
],
],
@@ -156,17 +93,8 @@
'description' => '实例生命周期。',
'type' => 'object',
'properties' => [
- 'Type' => [
- 'title' => '数据集加速实例生命周期类型',
- 'description' => '实例生命周期类型。',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'Config' => [
- 'title' => '数据集加速实例生命周期配置',
- 'description' => '实例生命周期配置。',
- 'type' => 'string',
- ],
+ 'Type' => ['title' => '数据集加速实例生命周期类型', 'description' => '实例生命周期类型。', 'type' => 'string', 'example' => 'Running'],
+ 'Config' => ['title' => '数据集加速实例生命周期配置', 'description' => '实例生命周期配置。', 'type' => 'string'],
],
],
'InstanceStatus' => [
@@ -183,52 +111,19 @@
.'- Stopped：已停止。',
'type' => 'string',
'example' => 'Running',
- 'enum' => [
- 'Created',
- 'Running',
- 'Stopped',
- ],
- ],
- 'Code' => [
- 'title' => '数据集加速实例所处状态对应的状态码/错误码。',
- 'description' => '数据集加速实例所处状态对应的状态码或错误码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '数据集加速实例所处状态附带的信息/错误信息。',
- 'description' => '数据集加速实例所处状态的附带信息或错误信息。',
- 'type' => 'string',
- 'example' => 'Init Succeed',
- ],
- 'UsedCapacity' => [
- 'title' => '数据集加速实例的已被占用的容量。实例下数据加速槽申请的容量均算在被占用范围内。 输入字符串的格式需要满足以下规范：Quantity',
- 'description' => '数据集加速实例已占用的容量。实例下数据集加速槽申请的容量均包括在被占用范围内。输入格式请参考[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。',
- 'type' => 'string',
- 'example' => '20.0G',
- ],
- 'SlotNum' => [
- 'title' => '数据集加速槽数量',
- 'description' => '数据集加速槽数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
+ 'enum' => ['Created', 'Running', 'Stopped'],
],
+ 'Code' => ['title' => '数据集加速实例所处状态对应的状态码/错误码。', 'description' => '数据集加速实例所处状态对应的状态码或错误码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '数据集加速实例所处状态附带的信息/错误信息。', 'description' => '数据集加速实例所处状态的附带信息或错误信息。', 'type' => 'string', 'example' => 'Init Succeed'],
+ 'UsedCapacity' => ['title' => '数据集加速实例的已被占用的容量。实例下数据加速槽申请的容量均算在被占用范围内。 输入字符串的格式需要满足以下规范：Quantity', 'description' => '数据集加速实例已占用的容量。实例下数据集加速槽申请的容量均包括在被占用范围内。输入格式请参考[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。', 'type' => 'string', 'example' => '20.0G'],
+ 'SlotNum' => ['title' => '数据集加速槽数量', 'description' => '数据集加速槽数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
'IpPort' => [
'type' => 'object',
'properties' => [
- 'Ip' => [
- 'title' => 'IP地址。',
- 'type' => 'string',
- 'example' => '10.0.0.5',
- ],
- 'Port' => [
- 'title' => '端口号。',
- 'type' => 'string',
- 'example' => '3306',
- ],
+ 'Ip' => ['title' => 'IP地址。', 'type' => 'string', 'example' => '10.0.0.5'],
+ 'Port' => ['title' => '端口号。', 'type' => 'string', 'example' => '3306'],
],
],
'Metric' => [
@@ -236,19 +131,8 @@
'description' => '指标信息。',
'type' => 'object',
'properties' => [
- 'Timestamp' => [
- 'title' => '监控指标采集到的时间戳。',
- 'description' => '监控指标采集到的时间戳。',
- 'type' => 'string',
- 'example' => '1655897743',
- ],
- 'Value' => [
- 'title' => '监控指标的具体值，缺失值会补0。',
- 'description' => '监控指标的具体值，缺失值会补0。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '98.35',
- ],
+ 'Timestamp' => ['title' => '监控指标采集到的时间戳。', 'description' => '监控指标采集到的时间戳。', 'type' => 'string', 'example' => '1655897743'],
+ 'Value' => ['title' => '监控指标的具体值，缺失值会补0。', 'description' => '监控指标的具体值，缺失值会补0。', 'type' => 'number', 'format' => 'double', 'example' => '98.35'],
],
],
'SlotLifeCycle' => [
@@ -266,19 +150,9 @@
.'- MaximumIdleTime：相对时间间隔，最后一次操作时间和当前时间差超过该间隔，即释放实例，单位为秒。',
'type' => 'string',
'example' => 'KeepAlive',
- 'enum' => [
- 'KeepAlive',
- 'RelativeTime',
- 'AbsoluteTime',
- 'MaximumIdleTime',
- ],
- ],
- 'Config' => [
- 'title' => '数据集加速槽生命周期配置，根据类型不同，配置结构也不同。 如果有更加复杂的配置需求，可以解析为Json String。',
- 'description' => '数据集加速槽生命周期配置，根据类型不同，配置结构也不同。 如果有更加复杂的配置需求，可以解析为Json String。',
- 'type' => 'string',
- 'example' => '{}',
+ 'enum' => ['KeepAlive', 'RelativeTime', 'AbsoluteTime', 'MaximumIdleTime'],
],
+ 'Config' => ['title' => '数据集加速槽生命周期配置，根据类型不同，配置结构也不同。 如果有更加复杂的配置需求，可以解析为Json String。', 'description' => '数据集加速槽生命周期配置，根据类型不同，配置结构也不同。 如果有更加复杂的配置需求，可以解析为Json String。', 'type' => 'string', 'example' => '{}'],
],
],
'SlotStatus' => [
@@ -301,34 +175,11 @@
.'- Stopped：已停止',
'type' => 'string',
'example' => 'Running',
- 'enum' => [
- 'Created',
- 'Preparing',
- 'Loading',
- 'Running',
- 'Succeed',
- 'Failed',
- 'Stopping',
- 'Stopped',
- ],
- ],
- 'Code' => [
- 'title' => '数据集加速槽所处状态对应的状态码/错误码。',
- 'description' => '数据集加速槽所处状态对应的状态码/错误码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '数据集加速槽所处状态附带的信息/错误信息。',
- 'description' => '数据集加速槽所处状态附带的信息/错误信息。',
- 'type' => 'string',
- 'example' => 'Init Succeed',
- ],
- 'Detail' => [
- 'title' => '数据集加速槽数据加载状态。',
- 'description' => '数据集加速槽数据加载状态。',
- '$ref' => '#/components/schemas/SlotStatusDetail',
+ 'enum' => ['Created', 'Preparing', 'Loading', 'Running', 'Succeed', 'Failed', 'Stopping', 'Stopped'],
],
+ 'Code' => ['title' => '数据集加速槽所处状态对应的状态码/错误码。', 'description' => '数据集加速槽所处状态对应的状态码/错误码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '数据集加速槽所处状态附带的信息/错误信息。', 'description' => '数据集加速槽所处状态附带的信息/错误信息。', 'type' => 'string', 'example' => 'Init Succeed'],
+ 'Detail' => ['title' => '数据集加速槽数据加载状态。', 'description' => '数据集加速槽数据加载状态。', '$ref' => '#/components/schemas/SlotStatusDetail'],
],
],
'SlotStatusDetail' => [
@@ -336,322 +187,49 @@
'description' => '数据集加速槽状态数据详细信息。',
'type' => 'object',
'properties' => [
- 'LoadedFileNum' => [
- 'title' => '数据集加速槽已加载的文件数量。',
- 'description' => '数据集加速槽已加载的文件数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000000',
- ],
- 'LoadedFileSize' => [
- 'title' => '数据集加速槽已加载的文件大小。 字符串的格式需要满足以下规范：Quantity',
- 'description' => '数据集加速槽已加载的文件大小。 输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。',
- 'type' => 'string',
- 'example' => '200G',
- ],
- 'LoadingTimeCost' => [
- 'title' => '数据集加速槽数据加载已花费的时间，单位为 ms（毫秒）。',
- 'description' => '数据集加速槽数据加载已花费的时间（毫秒）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1800000',
- ],
+ 'LoadedFileNum' => ['title' => '数据集加速槽已加载的文件数量。', 'description' => '数据集加速槽已加载的文件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000'],
+ 'LoadedFileSize' => ['title' => '数据集加速槽已加载的文件大小。 字符串的格式需要满足以下规范：Quantity', 'description' => '数据集加速槽已加载的文件大小。 输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。', 'type' => 'string', 'example' => '200G'],
+ 'LoadingTimeCost' => ['title' => '数据集加速槽数据加载已花费的时间，单位为 ms（毫秒）。', 'description' => '数据集加速槽数据加载已花费的时间（毫秒）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1800000'],
],
],
],
],
'apis' => [
- 'CreateInstance' => [
- 'summary' => '创建数据集加速实例。',
- 'path' => '/api/v1/instances',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Instance',
- ],
+ 'BindEndpoint' => [
+ 'path' => '/api/v1/endpoints/{EndpointId}/slots/{SlotId}',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Endpoint', 'Slot'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '数据集加速实例名称。'."\n"
- .'长度限制为64 Unicode 字符。'."\n"
- .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。',
- 'description' => '数据集加速实例名称，格式如下：'."\n"
- .'- 长度限制为64个字符。'."\n"
- .'- 如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acc_instance_1',
- 'maxLength' => 64,
- ],
- 'Description' => [
- 'title' => '数据集加速实例的描述与解释。'."\n"
- .'长度限制为1024 Unicode 字符。',
- 'description' => '数据集加速实例的描述与解释。'."\n"
- .'长度限制为1024个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xgboost数据集加速实例',
- 'maxLength' => 1024,
- ],
- 'Type' => [
- 'title' => '数据集加速实例的类型'."\n"
- .'basic：基础版'."\n"
- .'enhanced：增强版',
- 'description' => '数据集加速实例的类型，取值如下：'."\n"
- .'- basic：基础版。'."\n"
- .'- enhanced：增强版。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'basic',
- 'enum' => [
- 'basic',
- 'enhanced',
- 'lj.basic',
- ],
- ],
- 'Tags' => [
- 'title' => '用户为数据集加速实例添加的自定义标签。',
- 'description' => '用户为数据集加速实例添加的自定义标签。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签对象。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的键值。'."\n"
- .'长度限制为64个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
- 'Value' => [
- 'title' => '标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的值。'."\n"
- .'长度限制为64个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v0.1.0',
- 'maxLength' => 64,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'PaymentType' => [
- 'title' => '数据集加速实例的付费类型。'."\n"
- .'PayAsYouGo：后付费（后付费/按量付费）'."\n"
- .'Subscription：预付费（预付费/包年包月）',
- 'description' => '数据集加速实例的付费类型，取值如下：'."\n"
- .'- PayAsYouGo：后付费（按量付费）。'."\n"
- .'- Subscription：预付费（包年包月）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PayAsYouGo',
- 'enum' => [
- 'PayAsYouGo',
- 'Subscription',
- ],
- ],
- 'Capacity' => [
- 'title' => '数据集加速实例的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：Quantity (https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)',
- 'description' => '数据集加速实例的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '30.0G',
- ],
- 'MaxSlot' => [
- 'title' => '数据集加速实例的最大加速槽个数。',
- 'description' => '数据集加速实例的最大加速槽个数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20',
- 'default' => '100',
- ],
- 'MaxEndpoint' => [
- 'title' => '数据集加速实例的最大挂载点个数。',
- 'description' => '数据集加速实例的最大挂载点个数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20',
- 'default' => '100',
- ],
- 'StorageType' => [
- 'title' => '数据集加速实例的存储类型。',
- 'description' => '数据集加速实例的存储类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OSS',
- 'default' => 'OSS',
- ],
- 'ProviderType' => [
- 'title' => '数据集加速实例的资源提供者类型。',
- 'description' => '数据集加速实例的资源提供者类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Ecs',
- 'default' => 'Ecs',
- ],
- ],
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- 'InstanceId' => [
- 'title' => '数据集加速实例Id。',
- 'description' => '数据集加速实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inst-my1tk3jggooi5uwks5',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
- 'Detail' => [
- 'title' => '错误详细信息。',
- 'description' => '错误详细信息。',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
- ],
- 'example' => '-',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"InstanceId\\": \\"inst-my1tk3jggooi5uwks5\\"\\n}","type":"json"}]',
- 'title' => '创建数据集加速实例',
- ],
- 'DeleteInstance' => [
- 'summary' => '删除一个数据集加速实例。',
- 'path' => '/api/v1/instances/{InstanceId}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Instance',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'name' => 'EndpointId',
+ 'in' => 'path',
+ 'schema' => ['title' => '数据集加速槽挂载点Id。', 'description' => '数据集加速槽挂载点ID。如何获取挂载点ID，请参见[ListEndpoints](~~467913~~)。', 'type' => 'string', 'required' => true, 'example' => 'end-my1tk3jggooi5uwks5'],
],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'SlotId',
'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速实例Id。',
- 'description' => '数据集加速实例ID。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'inst-my1tk3jggooi5uwks5',
- ],
+ 'schema' => ['title' => '数据集加速槽Id。', 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'slot-my1tk3jggooi5uwks5'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
],
],
],
@@ -659,89 +237,54 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '删除数据集加速实例',
- 'description' => '调用改接口会首先进行检查，满足以下条件后方可被删除，否则删除失败。'."\n"
- .'- 该Instance下不存在仍处于非终态的Slot。',
- ],
- 'UpdateInstance' => [
- 'summary' => '更新一个数据集加速实例的信息。',
- 'path' => '/api/v1/instances/{InstanceId}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '关联数据集加速端点',
+ 'summary' => '将一个挂载点关联到一个数据集加速槽上。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Instance',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindEndpoint'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
+ ],
+ 'CreateEndpoint' => [
+ 'path' => '/api/v1/endpoints',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Endpoint'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速实例Id。',
- 'description' => '数据集加速实例ID。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'inst-my1tk3jggooi5uwks5',
- ],
- ],
- [
'name' => 'body',
'in' => 'body',
'style' => 'json',
@@ -749,36 +292,27 @@
'description' => '请求参数。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '数据集加速实例名称。'."\n"
- .'长度限制为64 Unicode 字符。'."\n"
- .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。',
- 'description' => '数据集加速实例名称，格式为：'."\n"
- .'- 长度限制为64Unicode字符。'."\n"
- .'- 如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acc_instance_1',
- 'maxLength' => 64,
- ],
- 'Description' => [
- 'title' => '数据集加速实例的描述与解释。'."\n"
- .'长度限制为1024 Unicode 字符。',
- 'description' => '数据集加速实例的描述与解释。'."\n"
- .'长度限制为1024Unicode字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xgboost数据集加速实例',
- 'maxLength' => 1024,
- ],
- 'MaxSlot' => [
- 'title' => '数据集加速实例的最大加速槽个数。',
- 'description' => '数据集加速实例的最大加速槽个数。',
+ 'Name' => ['title' => '挂载点的名称。'."\n"
+ .'长度限制为64 Unicode 字符。'."\n"
+ .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。', 'description' => '挂载点的名称。'."\n"
+ .'长度限制为64个字符。'."\n"
+ .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。', 'type' => 'string', 'required' => false, 'example' => 'endpoint-1'],
+ 'Type' => [
+ 'title' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
+ .'VPC：端点机器处于VPC网络',
+ 'description' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
+ .'- VPC：挂载点处于VPC网络。'."\n"
+ .'- INNER：挂载点处于PAI内部网络中，用于PAI其他产品进行访问。',
'type' => 'string',
'required' => false,
- 'example' => '20',
- 'default' => '20',
+ 'example' => 'VPC',
+ 'enum' => ['VPC'],
],
+ 'VpcId' => ['title' => '挂载点使用的专有网络 VPC Id。', 'description' => '挂载点使用的专有网络 VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-j6co2fcdsl1q0gnuc****'],
+ 'VswitchId' => ['title' => '挂载点使用的交换机 Vswitch Id。'."\n"
+ .'该Vswitch需要属于传入的 VPC。', 'description' => '挂载点使用的交换机vSwitch Id。'."\n"
+ .'该vSwitch需要属于传入的VPC。', 'type' => 'string', 'required' => false, 'example' => 'vsw-j6cmr00qjyrft6jo2****'],
+ 'InstanceId' => ['title' => '所属加速实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'inst-ivrq92qhbyrg4jctih', 'description' => ''],
],
'required' => false,
],
@@ -787,420 +321,12 @@
'responses' => [
200 => [
'schema' => [
- 'description' => '返回值。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
- 'Detail' => [
- 'title' => '错误详细信息。',
- 'description' => '错误详细信息。',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
- ],
- 'example' => '-',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '更新数据集加速实例',
- 'description' => '注意此接口为全量更新。',
- ],
- 'ListInstances' => [
- 'summary' => '获取数据集加速实例信息列表。',
- 'path' => '/api/v1/instances',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Instance',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'InstanceIds',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '实例Id的列表，以逗号分隔。',
- 'description' => '实例ID的列表，多个加速实例ID间，以半角逗号（,）分隔。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inst-my1tk3jggooi5uwks5, inst-n69468yvjz8d12as7d, inst-tga4omjrepklkg1onn',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '实例名称，支持模糊匹配',
- 'description' => '实例名称，支持模糊匹配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acc_instance_1',
- ],
- ],
- [
- 'name' => 'Type',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '数据集加速实例的类型，参考：产品规格'."\n"
- .'basic：基础版'."\n"
- .'enhanced：增强版',
- 'description' => '数据集加速实例的类型，参考：产品规格，取值如下：'."\n"
- .'- basic：基础版。'."\n"
- .'- enhanced：增强版。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'basic',
- 'enum' => [
- 'basic',
- 'enhanced',
- ],
- ],
- ],
- [
- 'name' => 'PaymentType',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '数据集加速实例的付费类型。'."\n"
- .'PayAsYouGo：后付费（后付费/按量付费）'."\n"
- .'Subscription：预付费（预付费/包年包月）',
- 'description' => '数据集加速实例的付费类型，取值如下：'."\n"
- .'- PayAsYouGo：后付费（按量付费）。'."\n"
- .'- Subscription：预付费（包年包月）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PayAsYouGo',
- 'enum' => [
- 'PayAsYouGo',
- 'Subscription',
- ],
- ],
- ],
- [
- 'name' => 'Phase',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '数据集加速实例所处状态。状态机参考：状态机'."\n"
- .'Created：初始化'."\n"
- .'Running：运行中'."\n"
- .'Stopped：已停止',
- 'description' => '数据集加速实例所处状态，取值如下：'."\n"
- .'- Created：初始化。'."\n"
- .'- Running：运行中。'."\n"
- .'- Stopped：已停止。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Running',
- 'enum' => [
- 'Created',
- 'Running',
- 'Stopped',
- ],
- ],
- ],
- [
- 'name' => 'SortBy',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GmtCreateTime',
- 'default' => 'GmtCreateTime',
- ],
- ],
- [
- 'name' => 'Order',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '排列顺序'."\n"
- .'Desc： 降序排列'."\n"
- .'Asc： 升序排列',
- 'description' => '排列顺序，取值如下：'."\n"
- .'- Desc： 降序排列。'."\n"
- .'- Asc： 升序排列。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
- 'default' => 'Desc',
- 'enum' => [
- 'Desc',
- 'Asc',
- ],
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '查询第几页数据，最小值1',
- 'description' => '数据集加速实例列表的页码。起始值为1，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '设置查询的分页大小,最小值为1',
- 'description' => '分页查询时设置的每页显示的数据集加速实例的数量，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'headers' => [],
- 'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- 'Instances' => [
- 'title' => '数据集加速实例列表。',
- 'description' => '数据集加速实例列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'UserId' => [
- 'title' => '数据集加速实例的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '数据集加速实例的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '276065346797410278',
- ],
- 'OwnerId' => [
- 'title' => '数据集加速实例资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '数据集加速实例资源拥有者的Uid，在阿里云内为阿里云账号ID。',
- 'type' => 'string',
- 'example' => '1557702098194904',
- ],
- 'GmtCreateTime' => [
- 'title' => '数据集加速实例创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速实例创建的时间。格式使用 ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '数据集加速实例最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速实例最后更新的时间。格式使用 ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'Uuid' => [
- 'title' => '数据集加速实例的唯一标识符。',
- 'description' => '数据集加速实例的唯一标识符。',
- 'type' => 'string',
- 'example' => 'inst-my1tk3jggooi5uwks5',
- ],
- 'Name' => [
- 'title' => '数据集加速实例名称。',
- 'description' => '数据集加速实例名称。',
- 'type' => 'string',
- 'example' => 'acc_instance_1',
- ],
- 'Description' => [
- 'title' => '数据集加速实例的描述与解释。',
- 'description' => '数据集加速实例的描述与解释。',
- 'type' => 'string',
- 'example' => 'xgboost数据集加速实例',
- ],
- 'Type' => [
- 'title' => '数据集加速实例的类型'."\n"
- .'Basic：基础版'."\n"
- .'Advanced：进阶版'."\n"
- .'Express：极速版',
- 'description' => '数据集加速实例的类型，可能值：'."\n"
- .'- Basic：基础版。'."\n"
- .'- Advanced：进阶版。'."\n"
- .'- Express：极速版。',
- 'type' => 'string',
- 'example' => 'Basic',
- ],
- 'Tags' => [
- 'title' => '用户为数据集加速实例添加的自定义标签。',
- 'description' => '用户为数据集加速实例添加的自定义标签。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的键值。'."\n"
- .'长度限制为64 Unicode字符。',
- 'type' => 'string',
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
- 'Value' => [
- 'title' => '标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的值。'."\n"
- .'长度限制为64 Unicode字符。',
- 'type' => 'string',
- 'example' => 'v0.1.0',
- 'maxLength' => 64,
- ],
- ],
- ],
- ],
- 'PaymentType' => [
- 'title' => 'PayAsYouGo 数据集加速实例的付费类型。'."\n"
- .'PayAsYouGo：后付费（后付费/按量付费）'."\n"
- .'Subscription：预付费（预付费/包年包月）',
- 'description' => '数据集加速实例的付费类型，可能值：'."\n"
- .'- PayAsYouGo：后付费（按量付费）。'."\n"
- .'- Subscription：预付费（包年包月）。',
- 'type' => 'string',
- 'example' => 'PayAsYouGo',
- 'enum' => [
- 'PayAsYouGo',
- 'Subscription',
- ],
- ],
- 'Capacity' => [
- 'title' => '数据集加速实例的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：Quantity',
- 'description' => '数据集加速实例的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。',
- 'type' => 'string',
- 'example' => '30.0G',
- ],
- 'IoType' => [
- 'title' => '数据集加速实例的读写类型。',
- 'description' => '数据集加速实例的读写类型。',
- 'type' => 'string',
- 'example' => 'readonly',
- ],
- 'MaxSlot' => [
- 'title' => '数据集加速实例的最大加速槽个数。',
- 'description' => '数据集加速实例的最大加速槽个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- 'default' => '20',
- ],
- 'MaxEndpoint' => [
- 'title' => '数据集加速实例的最大挂载点个数。',
- 'description' => '数据集加速实例的最大挂载点个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'default' => '100',
- ],
- 'StorageType' => [
- 'title' => '数据集加速实例的存储类型。',
- 'description' => '数据集加速实例的存储类型。',
- 'type' => 'string',
- 'example' => 'OSS',
- 'default' => 'OSS',
- ],
- 'ProviderType' => [
- 'title' => '数据集加速实例的资源提供者类型。',
- 'description' => '数据集加速实例的资源提供者类型。',
- 'type' => 'string',
- 'example' => 'Ecs',
- 'default' => 'Ecs',
- ],
- 'Status' => [
- 'title' => '数据集加速实例状态。',
- 'description' => '数据集加速实例状态。',
- '$ref' => '#/components/schemas/InstanceStatus',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'title' => '列表内元素数量总和。',
- 'description' => '列表内元素数量总和。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****'],
+ 'EndpointId' => ['title' => '数据集加速端点Id。', 'description' => '数据集加速端点ID。', 'type' => 'string', 'example' => 'end-5zk866779me51j****'],
],
],
],
@@ -1208,438 +334,137 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"Instances\\": [\\n {\\n \\"UserId\\": \\"276065346797410278\\",\\n \\"OwnerId\\": \\"1557702098194904\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"inst-my1tk3jggooi5uwks5\\",\\n \\"Name\\": \\"acc_instance_1\\",\\n \\"Description\\": \\"xgboost数据集加速实例\\",\\n \\"Type\\": \\"Basic\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"PaymentType\\": \\"PayAsYouGo\\",\\n \\"Capacity\\": \\"30.0G\\",\\n \\"IoType\\": \\"readonly\\",\\n \\"MaxSlot\\": 20,\\n \\"MaxEndpoint\\": 0,\\n \\"StorageType\\": \\"OSS\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Running\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"UsedCapacity\\": \\"20.0G\\",\\n \\"SlotNum\\": 10\\n }\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
- 'title' => '获取数据集加速实例列表',
- 'description' => '请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
- ],
- 'QueryInstanceMetrics' => [
- 'summary' => '查询并获取数据集加速实例监控指标信息。',
- 'path' => '/api/v1/instances/{InstanceId}/metrics/action/query',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Instance',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'InstanceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '监控指标所属的数据集加速实例Id。',
- 'description' => '监控指标所属的数据集加速实例ID。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'inst-abcdefgh12****',
- ],
- ],
- [
- 'name' => 'Dimensions',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '监控指标的标签集，参考 Prometheus Label'."\n"
- .'每种类型所包含的Labels不同，参考：类型详细信息'."\n"
- .'仅接受预定义的Label Key，不支持自定义'."\n"
- .'格式：key-value键值对形式的集合。',
- 'description' => '监控指标的标签集。',
- 'type' => 'object',
- 'required' => false,
- 'example' => 'SlotIDs: xxx',
- ],
- ],
- [
- 'name' => 'MetricType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '监控指标的类型：'."\n"
- .'StorageUsage：存储使用量'."\n"
- .'StorageUsageRatio：存储使用率'."\n"
- .'CachedFileTotal：已缓存文件数量'."\n"
- .'CachedTaskTotal：已缓存任务数',
- 'description' => '监控指标的类型，取值如下：'."\n"
- .'- NetworkReceiveBytesPerSecond：每秒网络请求接收量。'."\n"
- .'- NetworkTransmitBytesPerSecond：每秒网络请求发送量。'."\n"
- .'- FrontendThroughputBytes：前端服务吞吐。'."\n"
- .'- FrontendLatencyMicrosecond：前端服务延迟。'."\n"
- .'- FrontendIops：前端服务读取频率。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'NetworkReceiveBytesPerSecond',
- 'enum' => [
- 'NetworkReceiveBytesPerSecond',
- 'NetworkTransmitBytesPerSecond',
- 'FrontendThroughputBytes',
- 'FrontendLatencyMicrosecond',
- 'FrontendIops',
- ],
- ],
- ],
- [
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '起始时间.默认是1小时前。',
- 'description' => '起始时间，默认是1小时前。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-11-08T15:00:00Z',
- ],
- ],
- [
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '截止时间.默认是当前。',
- 'description' => '截止时间，默认是当前时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-11-08T16:00:00Z',
- ],
- ],
- [
- 'name' => 'TimeStep',
- 'in' => 'query',
- 'schema' => [
- 'title' => '时间间隔。',
- 'description' => '时间间隔，单位为分钟。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5m',
- 'default' => '5m',
- ],
- ],
+ 'title' => '创建数据集加速端点',
+ 'summary' => '创建并注册一个数据集加速槽端点。',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-22T06:42:28.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-01-03T13:27:34.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-22T06:16:12.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-08-12T07:22:59.000Z', 'description' => 'OpenAPI 下线'],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- 'Metrics' => [
- 'title' => '监控指标信息列表。',
- 'description' => '监控指标信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Metric信息详情。',
- '$ref' => '#/components/schemas/Metric',
- ],
- ],
- 'Period' => [
- 'title' => '时间间隔。',
- 'description' => '时间间隔。',
- 'type' => 'string',
- 'example' => '60s',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
- 'Detail' => [
- 'title' => '错误详细信息。',
- 'description' => '错误详细信息。',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
- ],
- 'example' => '-',
- ],
- ],
- ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEndpoint'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"1655897743\\",\\n \\"Value\\": 98.35\\n }\\n ],\\n \\"Period\\": \\"60s\\"\\n}","type":"json"}]',
- 'title' => '获取数据集加速实例监控指标',
- 'description' => '- 请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。'."\n"
- .'- 在查询时，管控层会将InstanceId默认加入到筛选条件中，因此需要监控指标采集时关联到InstanceId上，方可被查询出来。',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"EndpointId\\": \\"end-5zk866779me51j****\\"\\n}","type":"json"}]',
],
- 'DescribeInstance' => [
- 'summary' => '获取指定数据集加速实例信息。',
- 'path' => '/api/v1/instances/{InstanceId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Instance',
- ],
+ 'CreateInstance' => [
+ 'path' => '/api/v1/instances',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Instance'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速实例ID。',
- 'description' => '数据集加速实例ID。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'inst-my1tk3jggooi5u****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '返回值。',
+ 'description' => '请求参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****',
- ],
- 'UserId' => [
- 'title' => '数据集加速实例的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '数据集加速实例的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '27606534679741****',
- ],
- 'OwnerId' => [
- 'title' => '数据集加速实例资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '数据集加速实例资源拥有者的Uid，在阿里云内为阿里云账号ID。',
- 'type' => 'string',
- 'example' => '155770209819****',
- ],
- 'GmtCreateTime' => [
- 'title' => '数据集加速实例创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速实例创建的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '数据集加速实例最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速实例最后更新的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'Uuid' => [
- 'title' => '数据集加速实例的唯一标识符。',
- 'description' => '数据集加速实例的唯一标识符。',
- 'type' => 'string',
- 'example' => 'inst-my1tk3jggooi5u****',
- ],
- 'Name' => [
- 'title' => '数据集加速实例名称。',
- 'description' => '数据集加速实例名称。',
- 'type' => 'string',
- 'example' => 'acc_instance_1',
- ],
- 'Description' => [
- 'title' => '数据集加速实例的描述与解释。',
- 'description' => '数据集加速实例的描述与解释。',
- 'type' => 'string',
- 'example' => 'xgboost数据集加速实例',
- ],
+ 'Name' => ['title' => '数据集加速实例名称。'."\n"
+ .'长度限制为64 Unicode 字符。'."\n"
+ .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。', 'description' => '数据集加速实例名称，格式如下：'."\n"
+ .'- 长度限制为64个字符。'."\n"
+ .'- 如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。', 'type' => 'string', 'required' => false, 'example' => 'acc_instance_1', 'maxLength' => 64],
+ 'Description' => ['title' => '数据集加速实例的描述与解释。'."\n"
+ .'长度限制为1024 Unicode 字符。', 'description' => '数据集加速实例的描述与解释。'."\n"
+ .'长度限制为1024个字符。', 'type' => 'string', 'required' => false, 'example' => 'XGBoost dataset acceleration instance', 'maxLength' => 1024],
'Type' => [
'title' => '数据集加速实例的类型'."\n"
.'basic：基础版'."\n"
.'enhanced：增强版',
- 'description' => '数据集加速实例的类型，可能值：'."\n"
+ 'description' => '数据集加速实例的类型，取值如下：'."\n"
.'- basic：基础版。'."\n"
.'- enhanced：增强版。',
'type' => 'string',
+ 'required' => true,
'example' => 'basic',
+ 'enum' => ['basic', 'enhanced', 'lj.basic'],
],
'Tags' => [
'title' => '用户为数据集加速实例添加的自定义标签。',
'description' => '用户为数据集加速实例添加的自定义标签。',
'type' => 'array',
'items' => [
+ 'description' => '标签对象。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的键值。'."\n"
- .'长度限制为64Unicode字符。',
- 'type' => 'string',
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
- 'Value' => [
- 'title' => '标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的值。'."\n"
- .'长度限制为64Unicode字符。',
- 'type' => 'string',
- 'example' => 'v0.1.0',
- 'maxLength' => 64,
- ],
+ 'Key' => ['title' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的键值。'."\n"
+ .'长度限制为64个字符。', 'type' => 'string', 'required' => false, 'example' => 'dataset_version', 'maxLength' => 64],
+ 'Value' => ['title' => '标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的值。'."\n"
+ .'长度限制为64个字符。', 'type' => 'string', 'required' => false, 'example' => 'v0.1.0', 'maxLength' => 64],
],
+ 'required' => false,
],
+ 'required' => false,
],
'PaymentType' => [
- 'title' => 'PayAsYouGo 数据集加速实例的付费类型。'."\n"
+ 'title' => '数据集加速实例的付费类型。'."\n"
.'PayAsYouGo：后付费（后付费/按量付费）'."\n"
.'Subscription：预付费（预付费/包年包月）',
- 'description' => '数据集加速实例的付费类型，可能值：'."\n"
+ 'description' => '数据集加速实例的付费类型，取值如下：'."\n"
.'- PayAsYouGo：后付费（按量付费）。'."\n"
.'- Subscription：预付费（包年包月）。',
'type' => 'string',
+ 'required' => true,
'example' => 'PayAsYouGo',
- 'enum' => [
- 'PayAsYouGo',
- 'Subscription',
- ],
- ],
- 'Capacity' => [
- 'title' => '数据集加速实例的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：Quantity',
- 'description' => '数据集加速实例的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。',
- 'type' => 'string',
- 'example' => '30.0G',
- ],
- 'IoType' => [
- 'title' => '数据集加速实例的读写类型。',
- 'description' => '数据集加速实例的读写类型。',
- 'type' => 'string',
- 'example' => 'readonly',
- ],
- 'MaxSlot' => [
- 'title' => '数据集加速实例的最大加速槽个数。',
- 'description' => '数据集加速实例的最大加速槽个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- 'default' => '100',
- ],
- 'MaxEndpoint' => [
- 'title' => '数据集加速实例的最大挂载点个数。',
- 'description' => '数据集加速实例的最大挂载点个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'default' => '100',
- ],
- 'StorageType' => [
- 'title' => '数据集加速实例的存储类型。',
- 'description' => '数据集加速实例的存储类型。',
- 'type' => 'string',
- 'example' => 'OSS',
- 'default' => 'OSS',
- ],
- 'ProviderType' => [
- 'title' => '数据集加速实例的资源提供者类型。',
- 'description' => '数据集加速实例的资源提供者类型。',
- 'type' => 'string',
- 'example' => 'Ecs',
- 'default' => 'Ecs',
- ],
- 'Status' => [
- 'title' => '数据集加速实例状态。',
- 'description' => '数据集加速实例状态。',
- '$ref' => '#/components/schemas/InstanceStatus',
+ 'enum' => ['PayAsYouGo', 'Subscription'],
],
+ 'Capacity' => ['title' => '数据集加速实例的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：Quantity (https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)', 'description' => '数据集加速实例的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。', 'type' => 'string', 'required' => true, 'example' => '30.0G'],
+ 'MaxSlot' => ['title' => '数据集加速实例的最大加速槽个数。', 'description' => '数据集加速实例的最大加速槽个数。', 'type' => 'string', 'required' => false, 'example' => '20', 'default' => '100'],
+ 'MaxEndpoint' => ['title' => '数据集加速实例的最大挂载点个数。', 'description' => '数据集加速实例的最大挂载点个数。', 'type' => 'string', 'required' => false, 'example' => '20', 'default' => '100'],
+ 'StorageType' => ['title' => '数据集加速实例的存储类型。', 'description' => '数据集加速实例的存储类型。', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'default' => 'OSS'],
+ 'ProviderType' => ['title' => '数据集加速实例的资源提供者类型。', 'description' => '数据集加速实例的资源提供者类型。', 'type' => 'string', 'required' => false, 'example' => 'Ecs', 'default' => 'Ecs'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'required' => true, 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ 'InstanceId' => ['title' => '数据集加速实例Id。', 'description' => '数据集加速实例ID。', 'type' => 'string', 'required' => false, 'example' => 'inst-my1tk3jggooi5uwks5'],
],
],
],
@@ -1647,74 +472,55 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"inst-my1tk3jggooi5u****\\",\\n \\"Name\\": \\"acc_instance_1\\",\\n \\"Description\\": \\"xgboost数据集加速实例\\",\\n \\"Type\\": \\"basic\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"PaymentType\\": \\"PayAsYouGo\\",\\n \\"Capacity\\": \\"30.0G\\",\\n \\"IoType\\": \\"readonly\\",\\n \\"MaxSlot\\": 20,\\n \\"MaxEndpoint\\": 0,\\n \\"StorageType\\": \\"OSS\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Running\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"UsedCapacity\\": \\"20.0G\\",\\n \\"SlotNum\\": 10\\n }\\n}","type":"json"}]',
- 'title' => '获取数据集加速实例详情',
+ 'title' => '创建数据集加速实例',
+ 'summary' => '创建数据集加速实例。',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-22T12:06:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-10-14T08:37:35.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-08-13T16:52:28.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"InstanceId\\": \\"inst-my1tk3jggooi5uwks5\\"\\n}","type":"json"}]',
],
'CreateSlot' => [
- 'summary' => '创建并注册一个数据集加速槽。',
'path' => '/api/v1/slots',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Slot',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Slot'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'body',
@@ -1724,31 +530,11 @@
'description' => '请求参数。',
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'title' => '数据集加速槽所对应的数据集加速实例的唯一标识符。',
- 'description' => '数据集加速槽所对应的数据集加速实例的唯一标识符。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'inst-my1tk3jggooi5uwks5',
- ],
- 'Name' => [
- 'title' => '数据集加速槽名称。'."\n"
- .'长度限制为64 Unicode 字符。',
- 'description' => '数据集加速槽名称。长度限制为64个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'slot_1',
- 'maxLength' => 64,
- ],
- 'Description' => [
- 'title' => '数据集加速槽的描述与解释。'."\n"
- .'长度限制为1024 Unicode 字符。',
- 'description' => '数据集加速槽的描述与解释。长度限制为1024个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xgboost数据集加速槽',
- 'maxLength' => 1024,
- ],
+ 'InstanceId' => ['title' => '数据集加速槽所对应的数据集加速实例的唯一标识符。', 'description' => '数据集加速槽所对应的数据集加速实例的唯一标识符。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。', 'type' => 'string', 'required' => true, 'example' => 'inst-my1tk3jggooi5uwks5'],
+ 'Name' => ['title' => '数据集加速槽名称。'."\n"
+ .'长度限制为64 Unicode 字符。', 'description' => '数据集加速槽名称。长度限制为64个字符。', 'type' => 'string', 'required' => false, 'example' => 'slot_1', 'maxLength' => 64],
+ 'Description' => ['title' => '数据集加速槽的描述与解释。'."\n"
+ .'长度限制为1024 Unicode 字符。', 'description' => '数据集加速槽的描述与解释。长度限制为1024个字符。', 'type' => 'string', 'required' => false, 'example' => 'XGBoost dataset acceleration slot', 'maxLength' => 1024],
'Tags' => [
'title' => '用户为数据集加速槽添加的自定义标签。',
'description' => '用户为数据集加速槽添加的自定义标签。',
@@ -1757,24 +543,10 @@
'description' => '标签对象。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的键值。长度限制为64个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
- 'Value' => [
- 'title' => 'v0.1.0 标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的值。长度限制为 64 字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v0.1.0',
- 'maxLength' => 64,
- ],
+ 'Key' => ['title' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的键值。长度限制为64个字符。', 'type' => 'string', 'required' => false, 'example' => 'dataset_version', 'maxLength' => 64],
+ 'Value' => ['title' => 'v0.1.0 标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的值。长度限制为 64 字符。', 'type' => 'string', 'required' => false, 'example' => 'v0.1.0', 'maxLength' => 64],
],
'required' => false,
],
@@ -1790,42 +562,16 @@
'type' => 'string',
'required' => true,
'example' => 'OSS',
- 'enum' => [
- 'OSS',
- 'NAS',
- 'CPFS',
- ],
- ],
- 'StorageUri' => [
- 'title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://pai-vision-data-hz2.oss-cn-hangzhou-internal.aliyuncs.com/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt',
- ],
- 'Capacity' => [
- 'title' => '数据集加速槽的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：Quantity',
- 'description' => '数据集加速槽的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/) 。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '30.0G',
- ],
- 'LifeCycle' => [
- 'title' => '数据集加速槽的生命周期。',
- 'description' => '数据集加速槽的生命周期。',
- 'required' => false,
- '$ref' => '#/components/schemas/SlotLifeCycle',
- ],
- 'IoType' => [
- 'description' => '数据集加速槽的读写属性，取值如下：'."\n"
- .'- readonly：只读'."\n"
- .'- readwrite：可读写',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'readonly',
- ],
+ 'enum' => ['OSS', 'NAS', 'CPFS'],
+ ],
+ 'StorageUri' => ['title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'type' => 'string', 'required' => true, 'example' => 'oss://pai-vision-data-hz2.oss-cn-hangzhou-internal.aliyuncs.com/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt'],
+ 'Capacity' => ['title' => '数据集加速槽的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：Quantity', 'description' => '数据集加速槽的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/) 。', 'type' => 'string', 'required' => true, 'example' => '30.0G'],
+ 'LifeCycle' => ['title' => '数据集加速槽的生命周期。', 'description' => '数据集加速槽的生命周期。', 'required' => false, '$ref' => '#/components/schemas/SlotLifeCycle'],
+ 'IoType' => ['description' => '数据集加速槽的读写属性，取值如下：'."\n"
+ .'- readonly：只读'."\n"
+ .'- readwrite：可读写', 'type' => 'string', 'required' => false, 'example' => 'readonly'],
'Endpoints' => [
'title' => '创建数据集加速槽时，同时创建的挂载点列表。',
'description' => '创建数据集加速槽时，同时创建的挂载点列表。',
@@ -1833,17 +579,11 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '挂载点的名称。'."\n"
- .'长度限制为64 Unicode 字符。'."\n"
- .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。',
- 'description' => '挂载点的名称。'."\n"
- .'长度限制为64个字符。'."\n"
- .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'endpoint-1',
- ],
+ 'Name' => ['title' => '挂载点的名称。'."\n"
+ .'长度限制为64 Unicode 字符。'."\n"
+ .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。', 'description' => '挂载点的名称。'."\n"
+ .'长度限制为64个字符。'."\n"
+ .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。', 'type' => 'string', 'required' => false, 'example' => 'endpoint-1'],
'Type' => [
'title' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
.'VPC：端点机器处于VPC网络',
@@ -1852,38 +592,19 @@
'type' => 'string',
'required' => false,
'example' => 'VPC',
- 'enum' => [
- 'VPC',
- ],
- ],
- 'VpcId' => [
- 'title' => '挂载点使用的专有网络 VPC Id。',
- 'description' => '挂载点使用的专有网络 VPC ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc-j6co2fcdsl1q0gnuc3ym3',
- ],
- 'VswitchId' => [
- 'title' => '挂载点使用的交换机 Vswitch Id。'."\n"
- .'该Vswitch需要属于传入的 VPC。',
- 'description' => '挂载点使用的交换机vSwitch ID。'."\n"
- .'该vSwitch需要属于传入的VPC。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-j6cmr00qjyrft6jo2mg7g',
+ 'enum' => ['VPC'],
],
+ 'VpcId' => ['title' => '挂载点使用的专有网络 VPC Id。', 'description' => '挂载点使用的专有网络 VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-j6co2fcdsl1q0gnuc3ym3'],
+ 'VswitchId' => ['title' => '挂载点使用的交换机 Vswitch Id。'."\n"
+ .'该Vswitch需要属于传入的 VPC。', 'description' => '挂载点使用的交换机vSwitch ID。'."\n"
+ .'该vSwitch需要属于传入的VPC。', 'type' => 'string', 'required' => false, 'example' => 'vsw-j6cmr00qjyrft6jo2mg7g'],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
],
- 'EndpointIds' => [
- 'title' => '创建数据集加速槽时，同时挂载的数据集加速槽挂载点Id的列表，以逗号分隔。',
- 'description' => '创建数据集加速槽时，同时挂载的数据集加速槽挂载点ID的列表，多个挂载点ID以半角逗号（,）分隔。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'end-my1tk3jggooi5uwks5,end-n69468yvjz8d12as7d,end-tga4omjrepklkg1onn',
- ],
+ 'EndpointIds' => ['title' => '创建数据集加速槽时，同时挂载的数据集加速槽挂载点Id的列表，以逗号分隔。', 'description' => '创建数据集加速槽时，同时挂载的数据集加速槽挂载点ID的列表，多个挂载点ID以半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'end-my1tk3jggooi5uwks5,end-n69468yvjz8d12as7d,end-tga4omjrepklkg1onn'],
],
'required' => false,
],
@@ -1896,24 +617,9 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- 'SlotId' => [
- 'title' => '数据集加速槽Id。',
- 'description' => '数据集加速槽ID。',
- 'type' => 'string',
- 'example' => 'slot-5zk866779me51jgu3w',
- ],
- 'EndpointIds' => [
- 'title' => '数据集挂载点Id。',
- 'description' => '数据集挂载点ID。',
- 'type' => 'string',
- 'example' => 'end-5zk866779me51jgu3w,end-5zk866779me51jgu3w',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ 'SlotId' => ['title' => '数据集加速槽Id。', 'description' => '数据集加速槽ID。', 'type' => 'string', 'example' => 'slot-5zk866779me51jgu3w'],
+ 'EndpointIds' => ['title' => '数据集挂载点Id。', 'description' => '数据集挂载点ID。', 'type' => 'string', 'example' => 'end-5zk866779me51jgu3w,end-5zk866779me51jgu3w'],
],
],
],
@@ -1921,111 +627,150 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"SlotId\\": \\"slot-5zk866779me51jgu3w\\",\\n \\"EndpointIds\\": \\"end-5zk866779me51jgu3w,end-5zk866779me51jgu3w\\"\\n}","type":"json"}]',
'title' => '创建数据集加速槽',
- ],
- 'DeleteSlot' => [
- 'summary' => '删除一个数据集加速槽。',
- 'path' => '/api/v1/slots/{SlotId}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'summary' => '创建并注册一个数据集加速槽。',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-26T07:51:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2023-01-03T13:27:35.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Slot',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSlot'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"SlotId\\": \\"slot-5zk866779me51jgu3w\\",\\n \\"EndpointIds\\": \\"end-5zk866779me51jgu3w,end-5zk866779me51jgu3w\\"\\n}","type":"json"}]',
+ ],
+ 'CreateSlots' => [
+ 'summary' => '批量创建数据集加速槽。',
+ 'path' => '/api/v1/batch/slots/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Slot'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'SlotId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速槽Id。',
- 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'slot-my1tk3jggooi5uwks5',
- ],
- ],
- [
- 'name' => 'Force',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '是否不等待加速槽停止，强制删除。',
- 'description' => '是否不等待加速槽停止，强制删除。',
- 'type' => 'boolean',
+ 'description' => '请求参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Slots' => [
+ 'description' => '数据集加速槽列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据集加速槽。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['title' => '数据集加速槽所对应的数据集加速实例的唯一标识符。', 'description' => '数据集加速槽所对应的数据集加速实例的唯一标识符。', 'type' => 'string', 'required' => true, 'example' => 'inst-my1tk3jggooi5u****'],
+ 'Name' => ['title' => '数据集加速槽名称。'."\n"
+ .'长度限制为64 Unicode 字符。', 'description' => '数据集加速槽名称。'."\n"
+ .'长度限制为64 Unicode 字符。', 'type' => 'string', 'required' => false, 'example' => 'slot_1', 'maxLength' => 64],
+ 'Description' => ['title' => '数据集加速槽的描述与解释。'."\n"
+ .'长度限制为1024 Unicode 字符。', 'description' => '数据集加速槽的描述与解释。'."\n"
+ .'长度限制为1024 Unicode 字符。', 'type' => 'string', 'required' => false, 'example' => 'XGBoost dataset acceleration slot', 'maxLength' => 1024],
+ 'Tags' => [
+ 'title' => '用户为数据集加速槽添加的自定义标签。',
+ 'description' => '用户为数据集加速槽添加的自定义标签。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'type' => 'string', 'required' => false, 'example' => 'dataset_version', 'maxLength' => 64],
+ 'Value' => ['title' => 'v0.1.0 标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => 'v0.1.0 标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'type' => 'string', 'required' => false, 'example' => 'v0.1.0', 'maxLength' => 64],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ 'LifeCycle' => ['title' => '数据集加速槽的生命周期。', 'description' => '数据集加速槽的生命周期。', 'required' => false, '$ref' => '#/components/schemas/SlotLifeCycle'],
+ 'IoType' => ['description' => '数据集加速槽的读写类型。取值如下：'."\n"
+ .'- readwrite：可读写。'."\n"
+ .'- readonly：只读。', 'type' => 'string', 'required' => false, 'example' => 'readonly'],
+ 'StorageType' => [
+ 'title' => '数据集加速槽的数据存储类型。'."\n"
+ .'OSS：OSS文件存储'."\n"
+ .'NAS：NAS文件存储',
+ 'description' => '数据集加速槽的数据存储类型。'."\n"
+ .'OSS：OSS文件存储'."\n"
+ .'NAS：NAS文件存储',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OSS',
+ 'enum' => ['OSS', 'NAS', 'CPFS'],
+ ],
+ 'StorageUri' => ['title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'type' => 'string', 'required' => true, 'example' => 'oss://examplebucket.oss-cn-hangzhou-internal.aliyuncs.com/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt'],
+ 'Capacity' => ['title' => '数据集加速槽的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：Quantity', 'description' => '（必填）数据集加速槽的最大容量。'."\n"
+ .'输入字符串的格式需要满足[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)规范。', 'type' => 'string', 'required' => false, 'example' => '500Gi'],
+ 'EndpointIds' => ['title' => '创建数据集加速槽时，同时挂载的数据集加速槽挂载点Id的列表，以逗号分隔。', 'description' => '创建数据集加速槽时，同时挂载的数据集加速槽挂载点Id的列表，以逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'end-my1tk3jggooi5***s5,end-n69468yvjz8d12a***,end-tga4omjrepklkg1***'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'DryRun' => ['description' => '是否对此次创建请求执行预检。'."\n"
+ ."\n"
+ .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n"
+ ."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- true：发送检查请求，不会创建实例。'."\n"
+ ."\n"
+ .'- false（默认）：发送正常请求，通过检查后直接创建实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ ],
'required' => false,
- 'example' => 'false',
- 'default' => 'false',
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'description' => '返回值。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ 'SlotIds' => ['title' => '数据集加速槽Id。', 'description' => '数据集加速槽ID。', 'type' => 'string', 'example' => 'slot-5zk866779me51j****'],
+ 'Summary' => [
+ 'description' => '摘要信息。',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => '摘要信息。', 'example' => '{\'SlotsTotalSize\': \'0.0Gi\', \'SlotsTotalNum\': \'1\', \'DataSourceTotalSize\': \'0\'}'],
],
],
],
@@ -2034,86 +779,83 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '删除数据集加速槽',
- 'description' => '调用该接口会首先进行检查，满足以下条件后方可被删除，否则删除失败。'."\n"
- .'- 该 Slot 处于终态。',
- ],
- 'StopSlot' => [
- 'summary' => '停止一个数据集加速槽。',
- 'path' => '/api/v1/slots/{SlotId}/action/stop',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '批量创建加速槽',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-26T07:51:52.000Z', 'description' => '请求参数发生变更'],
],
- 'tags' => [
- 'Slot',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSlots'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"SlotIds\\": \\"slot-5zk866779me51j****\\",\\n \\"Summary\\": {\\n \\"key\\": \\"{\'SlotsTotalSize\': \'0.0Gi\', \'SlotsTotalNum\': \'1\', \'DataSourceTotalSize\': \'0\'}\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateTag' => [
+ 'path' => '/api/v1/tags',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Tag'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'SlotId',
- 'in' => 'path',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '数据集加速槽Id。',
- 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'slot-my1tk3jggooi5uwks5',
+ 'description' => '请求参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => [
+ 'title' => '标签所属的资源的类型。'."\n"
+ .'Instance：数据集加速实例'."\n"
+ .'Slot：数据集加速槽',
+ 'description' => '标签所属的资源的类型，取值如下：'."\n"
+ .'- Instance：数据集加速实例。'."\n"
+ .'- Slot：数据集加速槽。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Slot'],
+ ],
+ 'ResourceId' => ['title' => '标签所属的资源的Id。', 'description' => '标签所属的资源的ID。'."\n"
+ .'- 当ResourceType为Instance时，需要配置为数据集加速实例ID，如何获取加速实例ID，请参见[ListInstances](~~467899~~)。'."\n"
+ .'- 当ResourceType为Slot时，需要配置为数据集加速槽ID，如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'inst-my1tk3jggooi5uwks'],
+ 'Key' => ['title' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的键值。'."\n"
+ .'长度限制为64 Unicode字符。', 'type' => 'string', 'required' => true, 'example' => 'dataset_version', 'maxLength' => 64],
+ 'Value' => ['title' => '标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的值。'."\n"
+ .'长度限制为64 Unicode字符。', 'type' => 'string', 'required' => true, 'example' => 'v0.1.0', 'maxLength' => 64],
+ ],
+ 'required' => false,
],
],
],
@@ -2124,12 +866,7 @@
'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
],
],
],
@@ -2137,188 +874,59 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '停止数据集加速槽',
- 'description' => '- 该接口为异步接口，请求后会直接返回，返回结果代表请求操作是否成功。数据集加速槽的停止状态需要后续由 DescribeSlot 接口具体获取。'."\n"
- .'- 调用StopSlot接口后，无法再恢复或重启，缓存资源将被删除。',
- ],
- 'UpdateSlot' => [
- 'summary' => '更新一个数据集加速槽的信息。',
- 'path' => '/api/v1/slots/{SlotId}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '创建标签',
+ 'summary' => '针对一个资源，创建一个标签。',
+ 'description' => '- 如果针对这个资源已经存在相同键值的标签，则会对标签的值进行覆盖。'."\n"
+ .'- 如果未存在键值相同的标签，则创建一个新的标签。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Slot',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTag'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteEndpoint' => [
+ 'path' => '/api/v1/endpoints/{EndpointId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Endpoint'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'SlotId',
+ 'name' => 'EndpointId',
'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速槽Id。',
- 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'slot-my1tk3jggooi5uwks5',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求体参数。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '数据集加速槽名称。'."\n"
- .'长度限制为64 Unicode 字符。',
- 'description' => '数据集加速槽名称。'."\n"
- .'长度限制为64个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'slot_1',
- 'maxLength' => 64,
- ],
- 'Description' => [
- 'title' => '数据集加速槽的描述与解释。'."\n"
- .'长度限制为1024 Unicode 字符。',
- 'description' => '数据集加速槽的描述与解释。'."\n"
- .'长度限制为1024个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xgboost数据集加速槽',
- 'maxLength' => 1024,
- ],
- 'Tags' => [
- 'title' => '用户为数据集加速槽添加的自定义标签。',
- 'description' => '用户为数据集加速槽添加的自定义标签。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的键值。'."\n"
- .'长度限制为64个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
- 'Value' => [
- 'title' => 'v0.1.0 标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的值。'."\n"
- .'长度限制为64个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v0.1.0',
- 'maxLength' => 64,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'StorageType' => [
- 'title' => '数据集加速槽的数据存储类型。'."\n"
- .'OSS：OSS文件存储'."\n"
- .'NAS：NAS文件存储',
- 'description' => '数据集加速槽的数据存储类型，取值如下：'."\n"
- .'- OSS：OSS文件存储。'."\n"
- .'- NAS：NAS文件存储。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OSS',
- 'enum' => [
- 'OSS',
- 'NAS',
- ],
- ],
- 'StorageUri' => [
- 'title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://pai-vision-data-hz2.oss-cn-hangzhou-internal.aliyuncs.com/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt',
- ],
- 'Capacity' => [
- 'title' => '数据集加速槽的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：Quantity',
- 'description' => '数据集加速槽的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/) 。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '30.0G',
- ],
- 'LifeCycle' => [
- 'title' => '数据集加速槽的生命周期。',
- 'description' => '数据集加速槽的生命周期。',
- 'required' => false,
- '$ref' => '#/components/schemas/SlotLifeCycle',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '数据集加速槽挂载点Id。', 'description' => '数据集加速槽挂载点Id。', 'type' => 'string', 'required' => true, 'example' => 'end-my1tk3jggooi5uwks5'],
],
],
'responses' => [
@@ -2328,12 +936,7 @@
'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
],
],
],
@@ -2341,193 +944,64 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
+ 'title' => '删除数据集加速端点',
+ 'summary' => '删除一个数据集加速槽挂载点。',
+ 'description' => '调用该接口后，会删除用户网络打通相关的资源，可能导致用户侧访问缓存服务失败，请在确定无访问后再进行删除。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEndpoint'],
+ ],
+ ],
+ 'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '更新数据集加速槽',
- 'description' => '注意接口为全量更新，除了只读字段外，其余字段都更新为传入值。',
],
- 'QuerySlotMetrics' => [
- 'summary' => '查询并获取数据集加速槽监控指标信息。',
- 'path' => '/api/v1/slots/{SlotId}/metrics/action/query',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Slot',
- ],
+ 'DeleteInstance' => [
+ 'path' => '/api/v1/instances/{InstanceId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Instance'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'SlotId',
+ 'name' => 'InstanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '监控指标所属的数据集加速槽ID。',
- 'description' => '监控指标所属的数据集加速槽ID。如何获取加速槽ID，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'slot-abcdefgh12****',
- ],
- ],
- [
- 'name' => 'Dimensions',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '监控指标的标签集，参考 Prometheus Label'."\n"
- .'每种类型所包含的Labels不同，参考：类型详细信息'."\n"
- .'仅接受预定义的Label Key，不支持自定义'."\n"
- .'格式：key-value键值对形式的集合。',
- 'description' => '监控指标的标签集。',
- 'type' => 'object',
- 'required' => false,
- 'example' => 'SlotIDs: xxx',
- ],
- ],
- [
- 'name' => 'MetricType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '监控指标的类型：'."\n"
- .'StorageUsage：存储使用量'."\n"
- .'StorageUsageRatio：存储使用率'."\n"
- .'CachedFileTotal：已缓存文件数量'."\n"
- .'CachedTaskTotal：已缓存任务数',
- 'description' => '监控指标的类型，取值如下：'."\n"
- .'- NetworkReceiveBytesPerSecond：每秒网络请求接收量。'."\n"
- .'- NetworkTransmitBytesPerSecond：每秒网络请求发送量。'."\n"
- .'- FrontendThroughputBytes：前端服务吞吐。'."\n"
- .'- FrontendLatencyMicrosecond：前端服务延迟。'."\n"
- .'- FrontendIops：前端服务读取频率。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'NetworkReceiveBytesPerSecond',
- 'enum' => [
- 'NetworkTransmitBytesPerSecond',
- 'NetworkReceiveBytesPerSecond',
- 'FrontendThroughputBytes',
- 'FrontendLatencyMicrosecond',
- 'FrontendIops',
- ],
- ],
- ],
- [
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '起始时间.默认是1小时前。',
- 'description' => '起始时间，默认是1小时前。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-11-08T15:00:00Z',
- ],
- ],
- [
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '截止时间.默认是当前。',
- 'description' => '截止时间，默认是当前时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-11-08T16:00:00Z',
- ],
- ],
- [
- 'name' => 'TimeStep',
- 'in' => 'query',
- 'schema' => [
- 'title' => '时间间隔。',
- 'description' => '时间间隔，单位为分钟。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5m',
- 'default' => '5m',
- ],
+ 'schema' => ['title' => '数据集加速实例Id。', 'description' => '数据集加速实例ID。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。', 'type' => 'string', 'required' => true, 'example' => 'inst-my1tk3jggooi5uwks5'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回结果。',
+ 'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- 'Metrics' => [
- 'title' => '监控指标信息列表。',
- 'description' => '监控指标信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Metric信息。',
- '$ref' => '#/components/schemas/Metric',
- ],
- ],
- 'Period' => [
- 'title' => '时间间隔。',
- 'description' => '时间间隔。',
- 'type' => 'string',
- 'example' => '60s',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
],
],
],
@@ -2535,471 +1009,168 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"1655897743\\",\\n \\"Value\\": 98.35\\n }\\n ],\\n \\"Period\\": \\"60s\\"\\n}","type":"json"}]',
- 'title' => '获取加速槽监控指标',
- 'description' => '- 请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。'."\n"
- .'- 在查询时，管控层会将SlotId默认加入到筛选条件中，因此需要监控指标采集时关联到SlotId上，方可被查询出来。',
- ],
- 'ListSlots' => [
- 'summary' => '获取数据集加速槽的信息列表。',
- 'path' => '/api/v1/slots',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '删除数据集加速实例',
+ 'summary' => '删除一个数据集加速实例。',
+ 'description' => '调用改接口会首先进行检查，满足以下条件后方可被删除，否则删除失败。'."\n"
+ .'- 该Instance下不存在仍处于非终态的Slot。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Slot',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteSlot' => [
+ 'path' => '/api/v1/slots/{SlotId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Slot'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'SlotIds',
- 'in' => 'query',
- 'schema' => [
- 'title' => '数据集加速槽ID的列表，以逗号分隔。',
- 'description' => '数据集加速槽ID的列表，多个加速槽ID以半角逗号（,）分隔。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'slot-my1tk3jggooi5u****,slot-n69468yvjz8d12****,slot-tga4omjrepklkg****',
- ],
- ],
- [
- 'name' => 'InstanceIds',
- 'in' => 'query',
- 'schema' => [
- 'title' => '加速槽所对应的数据集加速实例的唯一标识符。',
- 'description' => '加速槽所对应的数据集加速实例的唯一标识符。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inst-my1tk3jggooi5u****',
- ],
+ 'name' => 'SlotId',
+ 'in' => 'path',
+ 'schema' => ['title' => '数据集加速槽Id。', 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'slot-my1tk3jggooi5uwks5'],
],
[
- 'name' => 'Name',
+ 'name' => 'Force',
'in' => 'query',
- 'schema' => [
- 'title' => '数据集加速槽名称，支持模糊匹配',
- 'description' => '数据集加速槽名称，支持模糊匹配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acc_instance_slot_1',
- ],
+ 'schema' => ['title' => '是否不等待加速槽停止，强制删除。', 'description' => '是否不等待加速槽停止，强制删除。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
- [
- 'name' => 'StorageType',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
'schema' => [
- 'title' => '数据集加速槽的数据存储类型。'."\n"
- .'OSS：OSS文件存储'."\n"
- .'NAS：NAS文件存储',
- 'description' => '数据集加速槽的数据存储类型，取值如下：'."\n"
- .'- OSS：OSS文件存储。'."\n"
- .'- NAS：NAS文件存储。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OSS',
- 'enum' => [
- 'OSS',
- 'NAS',
+ 'description' => '返回值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
],
],
],
- [
- 'name' => 'Phase',
- 'in' => 'query',
+ 400 => [
'schema' => [
- 'title' => '数据集加速槽所处状态。'."\n"
- .'Created：已创建'."\n"
- .'Preparing：正在准备资源'."\n"
- .'Loading：正在加载数据'."\n"
- .'Running：正在运行，提供服务'."\n"
- .'Reloading：正在重新加载数据'."\n"
- .'Succeed：成功完成'."\n"
- .'Failed：已失败'."\n"
- .'Stopping：正在停止'."\n"
- .'Stopped：已停止',
- 'description' => '数据集加速槽所处状态，取值如下：'."\n"
- .'- Created：已创建。'."\n"
- .'- Preparing：正在准备资源。'."\n"
- .'- Loading：正在加载数据。'."\n"
- .'- Running：正在运行，提供服务。'."\n"
- .'- Reloading：正在重新加载数据。'."\n"
- .'- Succeed：成功完成。'."\n"
- .'- Failed：已失败。'."\n"
- .'- Stopping：正在停止。'."\n"
- .'- Stopped：已停止。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Running',
- 'enum' => [
- 'Created',
- 'Preparing',
- 'Loading',
- 'Running',
- 'Succeed',
- 'Failed',
- 'Stopping',
- 'Stopped',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
+ 'Detail' => [
+ 'title' => '错误详细信息。',
+ 'description' => '错误详细信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
+ ],
+ 'example' => '-',
+ ],
],
+ 'description' => '',
],
],
- [
- 'name' => 'SortBy',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GmtCreateTime',
- 'default' => 'GmtCreateTime',
- ],
- ],
- [
- 'name' => 'Order',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '排列顺序'."\n"
- .'Desc： 降序排列'."\n"
- .'Asc： 升序排列',
- 'description' => '排列顺序，取值如下：'."\n"
- .'- Desc： 降序排列。'."\n"
- .'- Asc： 升序排列。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
- 'default' => 'Desc',
- 'enum' => [
- 'Desc',
- 'Asc',
- ],
- ],
+ ],
+ 'title' => '删除数据集加速槽',
+ 'summary' => '删除一个数据集加速槽。',
+ 'description' => '调用该接口会首先进行检查，满足以下条件后方可被删除，否则删除失败。'."\n"
+ .'- 该 Slot 处于终态。',
+ 'changeSet' => [
+ ['createdAt' => '2023-01-03T13:27:34.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSlot'],
],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteTag' => [
+ 'path' => '/api/v1/tags',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Tag'],
+ 'security' => [
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '查询第几页数据，最小值1',
- 'description' => '加速槽列表的页码。起始值为1，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
[
- 'name' => 'PageSize',
+ 'name' => 'ResourceType',
'in' => 'query',
- 'allowEmptyValue' => true,
'schema' => [
- 'title' => '设置查询的分页大小,最小值为1',
- 'description' => '分页查询时设置的每页显示的加速槽数量，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
+ 'title' => '标签所属的资源的类型。'."\n"
+ .'Instance：数据集加速实例'."\n"
+ .'Slot：数据集加速槽',
+ 'description' => '标签所属的资源的类型，取值如下：'."\n"
+ .'- Instance：数据集加速实例。'."\n"
+ .'- Slot：数据集加速槽。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Slot'],
],
],
[
- 'name' => 'EndpointIds',
+ 'name' => 'ResourceId',
'in' => 'query',
- 'schema' => [
- 'title' => '加速槽所对应的数据集加速挂载点的唯一标识符。',
- 'description' => '加速槽所对应的数据集加速挂载点的唯一标识符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'endp-my1tk3jggooi5uwks5',
- ],
+ 'schema' => ['title' => '标签所属的资源的Id。', 'description' => '标签所属的资源的ID。'."\n"
+ .'- 当ResourceType为Instance时，需要配置为数据集加速实例ID，如何获取加速实例ID，请参见[ListInstances](~~467899~~)。'."\n"
+ .'- 当ResourceType为Slot时，需要配置为数据集加速槽ID，如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'inst-my1tk3jggooi5uwks'],
],
[
- 'name' => 'StorageUri',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'title' => '数据集加速槽的数据存储路径（URI）。',
- 'description' => '数据集加速槽的数据存储路径（URI）。',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '标签的键值。', 'description' => '标签的键值。', 'type' => 'string', 'required' => true, 'example' => 'dataset_version', 'maxLength' => 64],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => '',
'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****',
- ],
- 'Slots' => [
- 'title' => '数据集加速列表',
- 'description' => '数据集加速列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'UserId' => [
- 'title' => '数据集加速槽的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '数据集加速槽的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '27606534679741****',
- ],
- 'OwnerId' => [
- 'title' => '数据集加速槽资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '数据集加速槽资源拥有者的Uid，在阿里云内为阿里云账号ID。',
- 'type' => 'string',
- 'example' => '155770209819****',
- ],
- 'GmtCreateTime' => [
- 'title' => '数据集加速槽创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速槽创建的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '数据集加速槽最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速槽最后更新的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'Uuid' => [
- 'title' => '数据集加速槽的唯一标识符。',
- 'description' => '数据集加速槽的唯一标识符。',
- 'type' => 'string',
- 'example' => 'slot-5zk866779me51j****',
- ],
- 'InstanceId' => [
- 'title' => '加速槽所对应的数据集加速实例的唯一标识符。',
- 'description' => '加速槽所对应的数据集加速实例的唯一标识符。',
- 'type' => 'string',
- 'example' => 'inst-my1tk3jggooi5u****',
- ],
- 'Name' => [
- 'title' => '数据集加速槽名称。',
- 'description' => '数据集加速槽名称。',
- 'type' => 'string',
- 'example' => 'slot_1',
- ],
- 'Description' => [
- 'title' => '数据集加速槽的描述与解释。',
- 'description' => '数据集加速槽的描述与解释。',
- 'type' => 'string',
- 'example' => 'xgboost数据集加速槽',
- ],
- 'Tags' => [
- 'title' => '用户为数据集加速槽添加的自定义标签。',
- 'description' => '用户为数据集加速槽添加的自定义标签。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签的键值。',
- 'description' => '标签的键值。',
- 'type' => 'string',
- 'example' => 'dataset_version',
- ],
- 'Value' => [
- 'title' => '标签的值。',
- 'description' => '标签的值。',
- 'type' => 'string',
- 'example' => 'v0.1.0',
- ],
- ],
- ],
- ],
- 'StorageType' => [
- 'title' => '数据集加速槽的数据存储类型。'."\n"
- .'OSS：OSS文件存储'."\n"
- .'NAS：NAS文件存储',
- 'description' => '数据集加速槽的数据存储类型，可能值：'."\n"
- .'- OSS：OSS文件存储。'."\n"
- .'- NAS：NAS文件存储。',
- 'type' => 'string',
- 'example' => 'OSS',
- 'enum' => [
- 'OSS',
- 'NAS',
- ],
- ],
- 'StorageUri' => [
- 'title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'type' => 'string',
- 'example' => 'oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt',
- ],
- 'Capacity' => [
- 'title' => '数据集加速槽的最大容量。输入字符串的格式需要满足以下规范：Quantity',
- 'description' => '数据集加速槽的最大容量。输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。',
- 'type' => 'string',
- 'example' => '30.0G',
- ],
- 'IoType' => [
- 'title' => '数据集加速槽的读写类型。',
- 'description' => '数据集加速槽的读写类型。',
- 'type' => 'string',
- 'example' => 'readonly',
- ],
- 'LifeCycle' => [
- 'title' => '数据集加速槽的生命周期。',
- 'description' => '数据集加速槽的生命周期。',
- '$ref' => '#/components/schemas/SlotLifeCycle',
- ],
- 'Status' => [
- 'title' => '数据集加速槽状态。',
- 'description' => '数据集加速槽状态。',
- '$ref' => '#/components/schemas/SlotStatus',
- ],
- 'Endpoints' => [
- 'title' => '数据集加速槽关联的端点列表。',
- 'description' => '数据集加速槽关联的端点列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'UserId' => [
- 'title' => '数据集加速端点的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '数据集加速端点的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '27606534679741****',
- ],
- 'OwnerId' => [
- 'title' => '数据集加速端点的资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '数据集加速端点的资源拥有者的Uid，在阿里云内为阿里云账号ID。',
- 'type' => 'string',
- 'example' => '155770209819****',
- ],
- 'GmtCreateTime' => [
- 'title' => '数据集加速端点创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速端点创建的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '数据集加速端点最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速端点最后更新的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'Uuid' => [
- 'title' => '挂载点的唯一标识符。',
- 'description' => '挂载点的唯一标识符。',
- 'type' => 'string',
- 'example' => 'end-ivrq92qhbyrg4j****',
- ],
- 'Name' => [
- 'title' => '挂载点的名称。',
- 'description' => '挂载点的名称。',
- 'type' => 'string',
- 'example' => 'endpoint-1',
- ],
- 'Type' => [
- 'title' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
- .'VPC：端点机器处于VPC网络',
- 'description' => '挂载点的网络类型，可能值：'."\n"
- .'- VPC：挂载点处于VPC网络。'."\n"
- .'- INNER：挂载点处于PAI内部网络中，用于PAI其他产品进行访问。',
- 'type' => 'string',
- 'example' => 'VPC',
- 'enum' => [
- 'VPC',
- ],
- ],
- 'VpcId' => [
- 'title' => '挂载点使用的专有网络 VPC Id。',
- 'description' => '挂载点使用的专有网络 VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-j6co2fcdsl1q0gnuc****',
- ],
- 'VswitchId' => [
- 'title' => '挂载点使用的交换机 Vswitch Id。',
- 'description' => '挂载点使用的交换机vSwitch ID。',
- 'type' => 'string',
- 'example' => 'vsw-j6cmr00qjyrft6jo2****',
- ],
- 'Status' => [
- 'title' => '数据集加速槽挂载点的状态。',
- 'description' => '数据集加速槽挂载点的状态。',
- '$ref' => '#/components/schemas/EndpointStatus',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'title' => '列表内元素数量总和。',
- 'description' => '列表内元素数量总和。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
],
],
],
@@ -3007,213 +1178,119 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"Slots\\": [\\n {\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"slot-5zk866779me51j****\\",\\n \\"InstanceId\\": \\"inst-my1tk3jggooi5u****\\",\\n \\"Name\\": \\"slot_1\\",\\n \\"Description\\": \\"xgboost数据集加速槽\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"StorageType\\": \\"OSS\\",\\n \\"StorageUri\\": \\"oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt\\",\\n \\"Capacity\\": \\"30.0G\\",\\n \\"IoType\\": \\"readonly\\",\\n \\"LifeCycle\\": {\\n \\"Type\\": \\"Running\\",\\n \\"Config\\": \\"{}\\"\\n },\\n \\"Status\\": {\\n \\"Phase\\": \\"Running\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"LoadedFileNum\\": 1000000,\\n \\"LoadedFileSize\\": \\"200G\\",\\n \\"LoadingTimeCost\\": 1800000\\n }\\n },\\n \\"Endpoints\\": [\\n {\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"end-ivrq92qhbyrg4j****\\",\\n \\"Name\\": \\"endpoint-1\\",\\n \\"Type\\": \\"VPC\\",\\n \\"VpcId\\": \\"vpc-j6co2fcdsl1q0gnuc****\\",\\n \\"VswitchId\\": \\"vsw-j6cmr00qjyrft6jo2****\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Ready\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"IpPortMapping\\": {\\n \\"key\\": {\\n \\"Ip\\": \\"10.0.0.5\\",\\n \\"Port\\": \\"3306\\"\\n }\\n }\\n }\\n }\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
- 'title' => '获取数据集加速槽列表',
- 'description' => '请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
- ],
- 'DescribeSlot' => [
- 'summary' => '获取指定数据集加速槽的信息。',
- 'path' => '/api/v1/slots/{SlotId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '删除标签',
+ 'summary' => '删除一个资源上的一个标签。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Slot',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTag'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeComponent' => [
+ 'path' => '/api/v1/components/{ComponentId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Component'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'SlotId',
+ 'name' => 'ComponentId',
'in' => 'path',
+ 'schema' => ['title' => '数据集加速组件ID。', 'description' => '数据集加速组件ID。如何获取组件ID，请参见[ListComponents](~~467918~~)。', 'type' => 'string', 'required' => true, 'example' => 'cmpt-my1tk3jggooi5uwks5'],
+ ],
+ [
+ 'name' => 'RenderTemplate',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否对组件模板进行渲染并展示。'."\n"
+ .'如果值为true，则返回中包含模板渲染后的内容。'."\n"
+ .'注：'."\n"
+ .'只支持指定组件列表：'."\n"
+ .' dataset-accelerator'."\n"
+ .'返回的组件模板内容最大长度为4096，超过最大长度会对模板进行截断。', 'description' => '是否对组件模板进行渲染并展示。'."\n"
+ .'如果值为true，则返回中包含模板渲染后的内容。'."\n"
+ .'> 只支持指定组件列表：'."\n"
+ .' dataset-accelerator'."\n"
+ .'返回的组件模板内容最大长度为4096 Byte，超过最大长度会对模板进行截断。'."\n"
+ .'>', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'Values',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '数据集加速槽ID。',
- 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'slot-my1tk3jggooi5u****',
+ 'title' => '组件模板渲染时使用的参数。',
+ 'description' => '组件模板渲染时使用的参数。',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'any', 'description' => '组件的属性值。', 'example' => '{\\"frontEndPort\\":\\"24457\\",\\"endpointId\\":\\"end-mlpo5mrygduwl9lm31\\",\\"frontEndAddr\\":\\"192.168.0.3\\",\\"slotId\\":\\"slot-vas3b1ygg22sxbq972\\",\\"region\\":\\"cn-shanghai\\"}'],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回值。',
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****',
- ],
- 'UserId' => [
- 'title' => '数据集加速槽的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '数据集加速槽的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '27606534679741****',
- ],
- 'OwnerId' => [
- 'title' => '数据集加速槽资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '数据集加速槽资源拥有者的Uid，在阿里云内为阿里云账号ID。',
- 'type' => 'string',
- 'example' => '155770209819****',
- ],
- 'GmtCreateTime' => [
- 'title' => '数据集加速槽创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速槽创建的时间。格式使用 ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '数据集加速槽最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速槽最后更新的时间。格式使用 ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'Uuid' => [
- 'title' => '数据集加速槽的唯一标识符。',
- 'description' => '数据集加速槽的唯一标识符。',
- 'type' => 'string',
- 'example' => 'slot-5zk866779me51j****',
- ],
- 'InstanceId' => [
- 'title' => '加速槽所对应的数据集加速实例的唯一标识符。',
- 'description' => '加速槽所对应的数据集加速实例的唯一标识符。',
- 'type' => 'string',
- 'example' => 'inst-my1tk3jggooi5u****',
- ],
- 'Name' => [
- 'title' => '数据集加速槽名称。',
- 'description' => '数据集加速槽名称。',
- 'type' => 'string',
- 'example' => 'slot_1',
- ],
- 'Description' => [
- 'title' => '数据集加速槽的描述与解释。',
- 'description' => '数据集加速槽的描述与解释。',
- 'type' => 'string',
- 'example' => 'xgboost数据集加速槽',
- ],
- 'Tags' => [
- 'title' => '用户为数据集加速槽添加的自定义标签。',
- 'description' => '用户为数据集加速槽添加的自定义标签。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签的键值。',
- 'description' => '标签的键值。',
- 'type' => 'string',
- 'example' => 'dataset_version',
- ],
- 'Value' => [
- 'title' => '标签的值。',
- 'description' => '标签的值。',
- 'type' => 'string',
- 'example' => 'v0.1.0',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ 'UserId' => ['title' => '数据集加速组件的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '数据集加速组件的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '276065346797410278'],
+ 'OwnerId' => ['title' => '数据集加速组件资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '数据集加速组件资源拥有者的Uid，在阿里云内为阿里云账号ID。', 'type' => 'string', 'example' => '1557702098194904'],
+ 'GmtCreateTime' => ['title' => '数据集加速组件创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速组件创建的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '数据集加速组件最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速组件最后更新的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'Uuid' => ['title' => '数据集加速组件的唯一标识符。', 'description' => '数据集加速组件的唯一标识符。', 'type' => 'string', 'example' => 'cmpt-5zk866779me51jgu3w'],
+ 'Name' => ['title' => '数据集加速组件名称。', 'description' => '数据集加速组件名称。', 'type' => 'string', 'example' => 'dataset-accelerator'],
+ 'Version' => ['title' => '数据集加速组件版本。', 'description' => '数据集加速组件版本。', 'type' => 'string', 'example' => 'v1.0.0'],
+ 'Template' => [
+ 'title' => '数据集加速组件模板信息。',
+ 'description' => '数据集加速组件模板信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'title' => '数据集加速组件模板的类型。'."\n"
+ .'OSS：从OSS中读取模板Helm包。',
+ 'description' => '数据集加速组件模板的类型。'."\n"
+ .'OSS：从OSS中读取模板Helm包。',
+ 'type' => 'string',
+ 'example' => 'OSS',
+ 'enum' => ['OSS'],
],
+ 'Uri' => ['title' => '数据集加速组件模板的资源标识符，数据类型不同存在不同格式。', 'description' => '数据集加速组件模板的资源标识符，数据类型不同存在不同格式。', 'type' => 'string', 'example' => 'data/VOCdevkit/VOC2007/ImageSets/Main/val.txt'],
],
],
- 'StorageType' => [
- 'title' => '数据集加速槽的数据存储类型。'."\n"
- .'OSS：OSS文件存储'."\n"
- .'NAS：NAS文件存储',
- 'description' => '数据集加速槽的数据存储类型，可能值：'."\n"
- .'- OSS：OSS文件存储。'."\n"
- .'- NAS：NAS文件存储。',
- 'type' => 'string',
- 'example' => 'OSS',
- 'enum' => [
- 'OSS',
- 'NAS',
- ],
- ],
- 'StorageUri' => [
- 'title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'type' => 'string',
- 'example' => 'oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt',
- ],
- 'Capacity' => [
- 'title' => '数据集加速槽的最大容量。输入字符串的格式需要满足以下规范：Quantity',
- 'description' => '数据集加速槽的最大容量。输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/) 。',
- 'type' => 'string',
- 'example' => '30.0G',
- ],
- 'IoType' => [
- 'title' => '数据集加速槽的读写类型。',
- 'description' => '数据集加速槽的读写类型。',
- 'type' => 'string',
- 'example' => 'readonly',
- ],
- 'LifeCycle' => [
- 'title' => '数据集加速槽的生命周期。',
- 'description' => '数据集加速槽的生命周期。',
- '$ref' => '#/components/schemas/SlotLifeCycle',
- ],
- 'Status' => [
- 'title' => '数据集加速槽状态。',
- 'description' => '数据集加速槽状态。',
- '$ref' => '#/components/schemas/SlotStatus',
- ],
+ 'RenderedContent' => ['title' => '渲染后的数据集加速组件部署文件。', 'description' => '渲染后的数据集加速组件部署文件。', 'type' => 'string', 'example' => '---\\n# Source: dataset-accelerator/templates/dataset-accelerator\\napiVersion: data.datasetacc.io/v1\\nkind: DataSetAccelerator\\nmetadata:\\n name: dataset-accelerator\\nspec:\\n frontEndAddr: 10.0.0.2\\n frontEndPort: 7001\\n'],
],
],
],
@@ -3221,153 +1298,84 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"slot-5zk866779me51j****\\",\\n \\"InstanceId\\": \\"inst-my1tk3jggooi5u****\\",\\n \\"Name\\": \\"slot_1\\",\\n \\"Description\\": \\"xgboost数据集加速槽\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"StorageType\\": \\"OSS\\",\\n \\"StorageUri\\": \\"oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt\\",\\n \\"Capacity\\": \\"30.0G\\",\\n \\"IoType\\": \\"readonly\\",\\n \\"LifeCycle\\": {\\n \\"Type\\": \\"Running\\",\\n \\"Config\\": \\"{}\\"\\n },\\n \\"Status\\": {\\n \\"Phase\\": \\"Running\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"LoadedFileNum\\": 1000000,\\n \\"LoadedFileSize\\": \\"200G\\",\\n \\"LoadingTimeCost\\": 1800000\\n }\\n }\\n}","type":"json"}]',
- 'title' => '获取数据集加速槽详情',
- ],
- 'CreateEndpoint' => [
- 'summary' => '创建并注册一个数据集加速槽端点。',
- 'path' => '/api/v1/endpoints',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取数据集加速组件详情',
+ 'summary' => '获取指定数据集加速组件的信息。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-21T12:59:16.000Z', 'description' => '响应参数发生变更'],
],
- 'tags' => [
- 'Endpoint',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponent'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"UserId\\": \\"276065346797410278\\",\\n \\"OwnerId\\": \\"1557702098194904\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"cmpt-5zk866779me51jgu3w\\",\\n \\"Name\\": \\"dataset-accelerator\\",\\n \\"Version\\": \\"v1.0.0\\",\\n \\"Template\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"data/VOCdevkit/VOC2007/ImageSets/Main/val.txt\\"\\n },\\n \\"RenderedContent\\": \\"---\\\\\\\\n# Source: dataset-accelerator/templates/dataset-accelerator\\\\\\\\napiVersion: data.datasetacc.io/v1\\\\\\\\nkind: DataSetAccelerator\\\\\\\\nmetadata:\\\\\\\\n name: dataset-accelerator\\\\\\\\nspec:\\\\\\\\n frontEndAddr: 10.0.0.2\\\\\\\\n frontEndPort: 7001\\\\\\\\n\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeEndpoint' => [
+ 'summary' => '获取指定数据集加速槽挂载点的信息。',
+ 'path' => '/api/v1/endpoints/{EndpointId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Endpoint'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'EndpointId',
+ 'in' => 'path',
+ 'schema' => ['title' => '数据集加速槽挂载点ID。', 'description' => '数据集加速槽挂载点ID。如何获取挂载点ID，请参见[ListEndpoints](~~467913~~)。', 'type' => 'string', 'required' => true, 'example' => 'end-my1tk3jggooi5uwks5'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '请求参数。',
+ 'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '挂载点的名称。'."\n"
- .'长度限制为64 Unicode 字符。'."\n"
- .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。',
- 'description' => '挂载点的名称。'."\n"
- .'长度限制为64个字符。'."\n"
- .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'endpoint-1',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ 'UserId' => ['title' => '数据集加速端点的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '数据集加速端点的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '276065346797410278'],
+ 'OwnerId' => ['title' => '数据集加速端点的资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '数据集加速端点的资源拥有者的Uid，在阿里云内为阿里云账号ID。', 'type' => 'string', 'example' => '1557702098194904'],
+ 'GmtCreateTime' => ['title' => '数据集加速端点创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速端点创建的时间。格式使用 ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '数据集加速端点最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速端点最后更新的时间。格式使用 ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'Uuid' => ['title' => '挂载点的唯一标识符。', 'description' => '挂载点的唯一标识符。', 'type' => 'string', 'example' => 'end-ivrq92qhbyrg4jctih'],
+ 'Name' => ['title' => '挂载点的名称。', 'description' => '挂载点的名称。', 'type' => 'string', 'example' => 'endpoint-1'],
'Type' => [
'title' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
.'VPC：端点机器处于VPC网络',
'description' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
- .'- VPC：挂载点处于VPC网络。'."\n"
- .'- INNER：挂载点处于PAI内部网络中，用于PAI其他产品进行访问。',
+ .'VPC：端点机器处于VPC网络。',
'type' => 'string',
- 'required' => false,
'example' => 'VPC',
- 'enum' => [
- 'VPC',
- ],
- ],
- 'VpcId' => [
- 'title' => '挂载点使用的专有网络 VPC Id。',
- 'description' => '挂载点使用的专有网络 VPC ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc-j6co2fcdsl1q0gnuc****',
- ],
- 'VswitchId' => [
- 'title' => '挂载点使用的交换机 Vswitch Id。'."\n"
- .'该Vswitch需要属于传入的 VPC。',
- 'description' => '挂载点使用的交换机vSwitch Id。'."\n"
- .'该vSwitch需要属于传入的VPC。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-j6cmr00qjyrft6jo2****',
- ],
- 'InstanceId' => [
- 'title' => '所属加速实例的ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'inst-ivrq92qhbyrg4jctih',
- ],
- ],
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****',
- ],
- 'EndpointId' => [
- 'title' => '数据集加速端点Id。',
- 'description' => '数据集加速端点ID。',
- 'type' => 'string',
- 'example' => 'end-5zk866779me51j****',
+ 'enum' => ['VPC'],
],
+ 'VpcId' => ['title' => '挂载点使用的专有网络 VPC Id。', 'description' => '挂载点使用的专有网络 VPC ID。', 'type' => 'string', 'example' => 'vpc-j6co2fcdsl1q0gnuc3ym3'],
+ 'VswitchId' => ['title' => '挂载点使用的交换机 Vswitch Id。', 'description' => '挂载点使用的交换机vSwitch ID。', 'type' => 'string', 'example' => 'vsw-j6cmr00qjyrft6jo2mg7g'],
+ 'Status' => ['title' => '数据集加速槽挂载点的状态。', 'description' => '数据集加速槽挂载点的状态。', '$ref' => '#/components/schemas/EndpointStatus'],
],
],
],
@@ -3375,98 +1383,115 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"EndpointId\\": \\"end-5zk866779me51j****\\"\\n}","type":"json"}]',
- 'title' => '创建数据集加速端点',
- ],
- 'DeleteEndpoint' => [
- 'summary' => '删除一个数据集加速槽挂载点。',
- 'path' => '/api/v1/endpoints/{EndpointId}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取数据集加速端点详情',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Endpoint',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEndpoint'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"UserId\\": \\"276065346797410278\\",\\n \\"OwnerId\\": \\"1557702098194904\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"end-ivrq92qhbyrg4jctih\\",\\n \\"Name\\": \\"endpoint-1\\",\\n \\"Type\\": \\"VPC\\",\\n \\"VpcId\\": \\"vpc-j6co2fcdsl1q0gnuc3ym3\\",\\n \\"VswitchId\\": \\"vsw-j6cmr00qjyrft6jo2mg7g\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Ready\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"IpPortMapping\\": {\\n \\"key\\": {\\n \\"Ip\\": \\"10.0.0.5\\",\\n \\"Port\\": \\"3306\\"\\n }\\n }\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeInstance' => [
+ 'summary' => '获取指定数据集加速实例信息。',
+ 'path' => '/api/v1/instances/{InstanceId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Instance'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'EndpointId',
+ 'name' => 'InstanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速槽挂载点Id。',
- 'description' => '数据集加速槽挂载点Id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'end-my1tk3jggooi5uwks5',
- ],
+ 'schema' => ['title' => '数据集加速实例ID。', 'description' => '数据集加速实例ID。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。', 'type' => 'string', 'required' => true, 'example' => 'inst-my1tk3jggooi5u****'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'required' => true, 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****'],
+ 'UserId' => ['title' => '数据集加速实例的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '数据集加速实例的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '27606534679741****'],
+ 'OwnerId' => ['title' => '数据集加速实例资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '数据集加速实例资源拥有者的Uid，在阿里云内为阿里云账号ID。', 'type' => 'string', 'example' => '155770209819****'],
+ 'GmtCreateTime' => ['title' => '数据集加速实例创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速实例创建的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '数据集加速实例最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速实例最后更新的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'Uuid' => ['title' => '数据集加速实例的唯一标识符。', 'description' => '数据集加速实例的唯一标识符。', 'type' => 'string', 'example' => 'inst-my1tk3jggooi5u****'],
+ 'Name' => ['title' => '数据集加速实例名称。', 'description' => '数据集加速实例名称。', 'type' => 'string', 'example' => 'acc_instance_1'],
+ 'Description' => ['title' => '数据集加速实例的描述与解释。', 'description' => '数据集加速实例的描述与解释。', 'type' => 'string', 'example' => 'XGBoost dataset acceleration instance'],
+ 'Type' => ['title' => '数据集加速实例的类型'."\n"
+ .'basic：基础版'."\n"
+ .'enhanced：增强版', 'description' => '数据集加速实例的类型，可能值：'."\n"
+ .'- basic：基础版。'."\n"
+ .'- enhanced：增强版。', 'type' => 'string', 'example' => 'basic'],
+ 'Tags' => [
+ 'title' => '用户为数据集加速实例添加的自定义标签。',
+ 'description' => '用户为数据集加速实例添加的自定义标签。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的键值。'."\n"
+ .'长度限制为64Unicode字符。', 'type' => 'string', 'example' => 'dataset_version', 'maxLength' => 64],
+ 'Value' => ['title' => '标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的值。'."\n"
+ .'长度限制为64Unicode字符。', 'type' => 'string', 'example' => 'v0.1.0', 'maxLength' => 64],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'PaymentType' => [
+ 'title' => 'PayAsYouGo 数据集加速实例的付费类型。'."\n"
+ .'PayAsYouGo：后付费（后付费/按量付费）'."\n"
+ .'Subscription：预付费（预付费/包年包月）',
+ 'description' => '数据集加速实例的付费类型，可能值：'."\n"
+ .'- PayAsYouGo：后付费（按量付费）。'."\n"
+ .'- Subscription：预付费（包年包月）。',
'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
+ 'example' => 'PayAsYouGo',
+ 'enum' => ['PayAsYouGo', 'Subscription'],
],
+ 'Capacity' => ['title' => '数据集加速实例的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：Quantity', 'description' => '数据集加速实例的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。', 'type' => 'string', 'example' => '30.0G'],
+ 'IoType' => ['title' => '数据集加速实例的读写类型。', 'description' => '数据集加速实例的读写类型。', 'type' => 'string', 'example' => 'readonly'],
+ 'MaxSlot' => ['title' => '数据集加速实例的最大加速槽个数。', 'description' => '数据集加速实例的最大加速槽个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '100'],
+ 'MaxEndpoint' => ['title' => '数据集加速实例的最大挂载点个数。', 'description' => '数据集加速实例的最大挂载点个数。', 'type' => 'integer', 'format' => 'int32', 'default' => '100'],
+ 'StorageType' => ['title' => '数据集加速实例的存储类型。', 'description' => '数据集加速实例的存储类型。', 'type' => 'string', 'example' => 'OSS', 'default' => 'OSS'],
+ 'ProviderType' => ['title' => '数据集加速实例的资源提供者类型。', 'description' => '数据集加速实例的资源提供者类型。', 'type' => 'string', 'example' => 'Ecs', 'default' => 'Ecs'],
+ 'Status' => ['title' => '数据集加速实例状态。', 'description' => '数据集加速实例状态。', '$ref' => '#/components/schemas/InstanceStatus'],
],
],
],
@@ -3474,113 +1499,106 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '删除数据集加速端点',
- 'description' => '调用该接口后，会删除用户网络打通相关的资源，可能导致用户侧访问缓存服务失败，请在确定无访问后再进行删除。',
- ],
- 'BindEndpoint' => [
- 'summary' => '将一个挂载点关联到一个数据集加速槽上。',
- 'path' => '/api/v1/endpoints/{EndpointId}/slots/{SlotId}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取数据集加速实例详情',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-22T12:08:54.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2023-05-22T12:06:13.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-10-14T08:37:35.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:24.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:24.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Endpoint',
- 'Slot',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"inst-my1tk3jggooi5u****\\",\\n \\"Name\\": \\"acc_instance_1\\",\\n \\"Description\\": \\"XGBoost dataset acceleration instance\\",\\n \\"Type\\": \\"basic\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"PaymentType\\": \\"PayAsYouGo\\",\\n \\"Capacity\\": \\"30.0G\\",\\n \\"IoType\\": \\"readonly\\",\\n \\"MaxSlot\\": 20,\\n \\"MaxEndpoint\\": 0,\\n \\"StorageType\\": \\"OSS\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Running\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"UsedCapacity\\": \\"20.0G\\",\\n \\"SlotNum\\": 10\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeSlot' => [
+ 'summary' => '获取指定数据集加速槽的信息。',
+ 'path' => '/api/v1/slots/{SlotId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Slot'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'EndpointId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速槽挂载点Id。',
- 'description' => '数据集加速槽挂载点ID。如何获取挂载点ID，请参见[ListEndpoints](~~467913~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'end-my1tk3jggooi5uwks5',
- ],
- ],
- [
'name' => 'SlotId',
'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速槽Id。',
- 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'slot-my1tk3jggooi5uwks5',
- ],
+ 'schema' => ['title' => '数据集加速槽ID。', 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'slot-my1tk3jggooi5u****'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'required' => true, 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****'],
+ 'UserId' => ['title' => '数据集加速槽的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '数据集加速槽的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '27606534679741****'],
+ 'OwnerId' => ['title' => '数据集加速槽资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '数据集加速槽资源拥有者的Uid，在阿里云内为阿里云账号ID。', 'type' => 'string', 'example' => '155770209819****'],
+ 'GmtCreateTime' => ['title' => '数据集加速槽创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速槽创建的时间。格式使用 ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '数据集加速槽最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速槽最后更新的时间。格式使用 ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'Uuid' => ['title' => '数据集加速槽的唯一标识符。', 'description' => '数据集加速槽的唯一标识符。', 'type' => 'string', 'example' => 'slot-5zk866779me51j****'],
+ 'InstanceId' => ['title' => '加速槽所对应的数据集加速实例的唯一标识符。', 'description' => '加速槽所对应的数据集加速实例的唯一标识符。', 'type' => 'string', 'example' => 'inst-my1tk3jggooi5u****'],
+ 'Name' => ['title' => '数据集加速槽名称。', 'description' => '数据集加速槽名称。', 'type' => 'string', 'example' => 'slot_1'],
+ 'Description' => ['title' => '数据集加速槽的描述与解释。', 'description' => '数据集加速槽的描述与解释。', 'type' => 'string', 'example' => 'XGBoost dataset acceleration slot'],
+ 'Tags' => [
+ 'title' => '用户为数据集加速槽添加的自定义标签。',
+ 'description' => '用户为数据集加速槽添加的自定义标签。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '标签的键值。', 'description' => '标签的键值。', 'type' => 'string', 'example' => 'dataset_version'],
+ 'Value' => ['title' => '标签的值。', 'description' => '标签的值。', 'type' => 'string', 'example' => 'v0.1.0'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'StorageType' => [
+ 'title' => '数据集加速槽的数据存储类型。'."\n"
+ .'OSS：OSS文件存储'."\n"
+ .'NAS：NAS文件存储',
+ 'description' => '数据集加速槽的数据存储类型，可能值：'."\n"
+ .'- OSS：OSS文件存储。'."\n"
+ .'- NAS：NAS文件存储。',
'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
+ 'example' => 'OSS',
+ 'enum' => ['OSS', 'NAS'],
],
+ 'StorageUri' => ['title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'type' => 'string', 'example' => 'oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt'],
+ 'Capacity' => ['title' => '数据集加速槽的最大容量。输入字符串的格式需要满足以下规范：Quantity', 'description' => '数据集加速槽的最大容量。输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/) 。', 'type' => 'string', 'example' => '30.0G'],
+ 'IoType' => ['title' => '数据集加速槽的读写类型。', 'description' => '数据集加速槽的读写类型。', 'type' => 'string', 'example' => 'readonly'],
+ 'LifeCycle' => ['title' => '数据集加速槽的生命周期。', 'description' => '数据集加速槽的生命周期。', '$ref' => '#/components/schemas/SlotLifeCycle'],
+ 'Status' => ['title' => '数据集加速槽状态。', 'description' => '数据集加速槽状态。', '$ref' => '#/components/schemas/SlotStatus'],
],
],
],
@@ -3588,112 +1606,149 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '关联数据集加速端点',
- ],
- 'UnbindEndpoint' => [
- 'summary' => '取消挂载点关联和指定数据集加速槽的关联关系。',
- 'path' => '/api/v1/endpoints/{EndpointId}/slots/{SlotId}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取数据集加速槽详情',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-22T11:41:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Endpoint',
- 'Slot',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlot'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"slot-5zk866779me51j****\\",\\n \\"InstanceId\\": \\"inst-my1tk3jggooi5u****\\",\\n \\"Name\\": \\"slot_1\\",\\n \\"Description\\": \\"XGBoost dataset acceleration slot\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"StorageType\\": \\"OSS\\",\\n \\"StorageUri\\": \\"oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt\\",\\n \\"Capacity\\": \\"30.0G\\",\\n \\"IoType\\": \\"readonly\\",\\n \\"LifeCycle\\": {\\n \\"Type\\": \\"KeepAlive\\",\\n \\"Config\\": \\"{}\\"\\n },\\n \\"Status\\": {\\n \\"Phase\\": \\"Running\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"LoadedFileNum\\": 1000000,\\n \\"LoadedFileSize\\": \\"200G\\",\\n \\"LoadingTimeCost\\": 1800000\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'ListComponents' => [
+ 'path' => '/api/v1/components',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Component'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'EndpointId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速槽挂载点Id。',
- 'description' => '数据集加速槽挂载点ID。如何获取挂载点ID，请参见[ListEndpoints](~~467913~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'end-my1tk3jggooi5uwks5',
- ],
+ 'name' => 'ComponentIds',
+ 'in' => 'query',
+ 'schema' => ['title' => '数据集加速组件ID的列表，以逗号分隔。', 'description' => '数据集加速组件ID的列表，多个组件ID以半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'cmpt-my1tk3jggooi5u****,cmpt-n69468yvjz8d12****,cmpt-tga4omjrepklkg****'],
],
[
- 'name' => 'SlotId',
- 'in' => 'path',
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '数据集加速组件名称，支持模糊匹配。', 'description' => '数据集加速组件名称，支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'dataset-accelerator'],
+ ],
+ [
+ 'name' => 'Version',
+ 'in' => 'query',
+ 'schema' => ['title' => '数据集加速组件版本。', 'description' => '数据集加速组件版本。', 'type' => 'string', 'required' => false, 'example' => 'v1.0.0'],
+ ],
+ [
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'default' => 'GmtCreateTime'],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
'schema' => [
- 'title' => '数据集加速槽Id。',
- 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
+ 'title' => '排列顺序'."\n"
+ .'Desc： 降序排列'."\n"
+ .'Asc： 升序排列',
+ 'description' => '排列顺序，取值如下：'."\n"
+ .'- Desc： 降序排列。'."\n"
+ .'- Asc： 升序排列。',
'type' => 'string',
- 'required' => true,
- 'example' => 'slot-my1tk3jggooi5uwks5',
+ 'required' => false,
+ 'example' => 'Desc',
+ 'default' => 'Desc',
+ 'enum' => ['Desc', 'Asc'],
],
],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '查询第几页数据，最小值1', 'description' => '组件列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '设置查询的分页大小,最小值为1', 'description' => '分页查询时设置的每页显示的组件数量，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10', 'default' => '10'],
+ ],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'description' => '返回值。',
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****'],
+ 'Components' => [
+ 'title' => '数据集加速槽列表。',
+ 'description' => '数据集加速槽列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['title' => '数据集加速组件的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '数据集加速组件的创建者的Uid，在阿里云内为RAM用户ID （阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '27606534679741****'],
+ 'OwnerId' => ['title' => '数据集加速组件资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '数据集加速组件资源拥有者的Uid，在阿里云内为阿里云账号ID 。', 'type' => 'string', 'example' => '155770209819****'],
+ 'GmtCreateTime' => ['title' => '数据集加速组件创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速组件创建的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '数据集加速组件最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速组件最后更新的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'Uuid' => ['title' => '数据集加速组件的唯一标识符。', 'description' => '数据集加速组件的唯一标识符。', 'type' => 'string', 'example' => 'cmpt-5zk866779me51j****'],
+ 'Name' => ['title' => '数据集加速组件名称。', 'description' => '数据集加速组件名称。', 'type' => 'string', 'example' => 'dataset-accelerator'],
+ 'Version' => ['title' => '数据集加速组件版本。', 'description' => '数据集加速组件版本。', 'type' => 'string', 'example' => 'v1.0.0'],
+ 'Template' => [
+ 'title' => '数据集加速组件模板信息。',
+ 'description' => '数据集加速组件模板信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'title' => '数据集加速组件模板的类型。'."\n"
+ .'OSS：从OSS中读取模板Helm包。',
+ 'description' => '数据集加速组件模板的类型。'."\n"
+ .'OSS：从OSS中读取模板Helm包。',
+ 'type' => 'string',
+ 'example' => 'OSS',
+ 'enum' => ['OSS'],
+ ],
+ 'Uri' => ['title' => '数据集加速组件模板的资源标识符，数据类型不同存在不同格式。', 'description' => '数据集加速组件模板的资源标识符，数据类型不同存在不同格式。', 'type' => 'string', 'example' => 'data/VOCdevkit/VOC2007/ImageSets/Main/val.txt'],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
],
+ 'TotalCount' => ['title' => '列表内元素数量总和。', 'description' => '列表内元素数量总和。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
@@ -3701,107 +1756,67 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '取消关联数据集加速端点',
+ 'title' => '获取数据集加速组件列表',
+ 'summary' => '获取数据集加速组件的信息列表。',
+ 'description' => '请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-21T12:59:15.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListComponents'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"Components\\": [\\n {\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"cmpt-5zk866779me51j****\\",\\n \\"Name\\": \\"dataset-accelerator\\",\\n \\"Version\\": \\"v1.0.0\\",\\n \\"Template\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"data/VOCdevkit/VOC2007/ImageSets/Main/val.txt\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
],
'ListEndpoints' => [
- 'summary' => '获取数据集加速槽挂载点的信息列表。',
'path' => '/api/v1/endpoints',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Endpoint',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Endpoint'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'EndpointIds',
'in' => 'query',
- 'schema' => [
- 'title' => '数据集加速槽挂载点Id的列表，以逗号分隔。',
- 'description' => '数据集加速槽挂载点ID的列表，多个挂载点ID，以半角逗号（,）分隔。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'end-my1tk3jggooi5u****,end-n69468yvjz8d12****,end-tga4omjrepklkg****',
- ],
+ 'schema' => ['title' => '数据集加速槽挂载点Id的列表，以逗号分隔。', 'description' => '数据集加速槽挂载点ID的列表，多个挂载点ID，以半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'end-my1tk3jggooi5u****,end-n69468yvjz8d12****,end-tga4omjrepklkg****'],
],
[
'name' => 'SlotIds',
'in' => 'query',
- 'schema' => [
- 'title' => '所属的数据集加速槽Id。',
- 'description' => '所属的数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'slot-my1tk3jggooi5u****',
- ],
+ 'schema' => ['title' => '所属的数据集加速槽Id。', 'description' => '所属的数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => false, 'example' => 'slot-my1tk3jggooi5u****'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'title' => '数据集加速槽挂载点名称，支持模糊匹配。',
- 'description' => '数据集加速槽挂载点名称，支持模糊匹配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acc_instance_slot_mount_1',
- ],
+ 'schema' => ['title' => '数据集加速槽挂载点名称，支持模糊匹配。', 'description' => '数据集加速槽挂载点名称，支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'acc_instance_slot_mount_1'],
],
[
'name' => 'Type',
@@ -3816,23 +1831,14 @@
'type' => 'string',
'required' => false,
'example' => 'VPC',
- 'enum' => [
- 'VPC',
- ],
+ 'enum' => ['VPC'],
],
],
[
'name' => 'SortBy',
'in' => 'query',
'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GmtCreateTime',
- 'default' => 'GmtCreateTime',
- ],
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'default' => 'GmtCreateTime'],
],
[
'name' => 'Order',
@@ -3849,53 +1855,26 @@
'required' => false,
'example' => 'Desc',
'default' => 'Desc',
- 'enum' => [
- 'Desc',
- 'Asc',
- ],
+ 'enum' => ['Desc', 'Asc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '查询第几页数据，最小值1',
- 'description' => '加速端点列表的页码。起始值为1，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '查询第几页数据，最小值1', 'description' => '加速端点列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '设置查询的分页大小,最小值为1',
- 'description' => '分页查询时设置的每页显示的加速端点数量，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '设置查询的分页大小,最小值为1', 'description' => '分页查询时设置的每页显示的加速端点数量，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '所属加速实例的ID。',
- 'description' => '所属加速实例的ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inst-ivrq92qhbyrg4jctih',
- ],
+ 'schema' => ['title' => '所属加速实例的ID。', 'description' => '所属加速实例的ID。', 'type' => 'string', 'required' => false, 'example' => 'inst-ivrq92qhbyrg4jctih'],
],
],
'responses' => [
@@ -3905,12 +1884,7 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****'],
'Endpoints' => [
'title' => '数据集加速端点列表。',
'description' => '数据集加速端点列表。',
@@ -3918,42 +1892,12 @@
'items' => [
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'title' => '数据集加速端点的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '数据集加速端点的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '27606534679741****',
- ],
- 'OwnerId' => [
- 'title' => '数据集加速端点的资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '数据集加速端点的资源拥有者的Uid，在阿里云内为阿里云账号ID。',
- 'type' => 'string',
- 'example' => '155770209819****',
- ],
- 'GmtCreateTime' => [
- 'title' => '数据集加速端点创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速端点创建的时间。格式使用 ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '数据集加速端点最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速端点最后更新的时间。格式使用 ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'Uuid' => [
- 'title' => '挂载点的唯一标识符。',
- 'description' => '挂载点的唯一标识符。',
- 'type' => 'string',
- 'example' => 'end-ivrq92qhbyrg4j****',
- ],
- 'Name' => [
- 'title' => '挂载点的名称。',
- 'description' => '挂载点的名称。',
- 'type' => 'string',
- 'example' => 'endpoint-1',
- ],
+ 'UserId' => ['title' => '数据集加速端点的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '数据集加速端点的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '27606534679741****'],
+ 'OwnerId' => ['title' => '数据集加速端点的资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '数据集加速端点的资源拥有者的Uid，在阿里云内为阿里云账号ID。', 'type' => 'string', 'example' => '155770209819****'],
+ 'GmtCreateTime' => ['title' => '数据集加速端点创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速端点创建的时间。格式使用 ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '数据集加速端点最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速端点最后更新的时间。格式使用 ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'Uuid' => ['title' => '挂载点的唯一标识符。', 'description' => '挂载点的唯一标识符。', 'type' => 'string', 'example' => 'end-ivrq92qhbyrg4j****'],
+ 'Name' => ['title' => '挂载点的名称。', 'description' => '挂载点的名称。', 'type' => 'string', 'example' => 'endpoint-1'],
'Type' => [
'title' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
.'VPC：端点机器处于VPC网络',
@@ -3962,43 +1906,17 @@
.'- INNER：挂载点处于PAI内部网络中，用于PAI其他产品进行访问。',
'type' => 'string',
'example' => 'VPC',
- 'enum' => [
- 'VPC',
- ],
- ],
- 'VpcId' => [
- 'title' => '挂载点使用的专有网络 VPC Id。',
- 'description' => '挂载点使用的专有网络 VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-j6co2fcdsl1q0gnuc****',
- ],
- 'VswitchId' => [
- 'title' => '挂载点使用的交换机 Vswitch Id。',
- 'description' => '挂载点使用的交换机vSwitch ID。',
- 'type' => 'string',
- 'example' => 'vsw-j6cmr00qjyrft6jo2****',
- ],
- 'Status' => [
- 'title' => '数据集加速槽挂载点的状态。',
- 'description' => '数据集加速槽挂载点的状态。',
- '$ref' => '#/components/schemas/EndpointStatus',
- ],
- 'InstanceId' => [
- 'title' => '所属加速实例的ID。',
- 'description' => '所属加速实例的ID。',
- 'type' => 'string',
- 'example' => 'inst-ivrq92qhbyrg4jctih',
+ 'enum' => ['VPC'],
],
+ 'VpcId' => ['title' => '挂载点使用的专有网络 VPC Id。', 'description' => '挂载点使用的专有网络 VPC ID。', 'type' => 'string', 'example' => 'vpc-j6co2fcdsl1q0gnuc****'],
+ 'VswitchId' => ['title' => '挂载点使用的交换机 Vswitch Id。', 'description' => '挂载点使用的交换机vSwitch ID。', 'type' => 'string', 'example' => 'vsw-j6cmr00qjyrft6jo2****'],
+ 'Status' => ['title' => '数据集加速槽挂载点的状态。', 'description' => '数据集加速槽挂载点的状态。', '$ref' => '#/components/schemas/EndpointStatus'],
+ 'InstanceId' => ['title' => '所属加速实例的ID。', 'description' => '所属加速实例的ID。', 'type' => 'string', 'example' => 'inst-ivrq92qhbyrg4jctih'],
],
+ 'description' => '',
],
],
- 'TotalCount' => [
- 'title' => '列表内元素数量总和。',
- 'description' => '列表内元素数量总和。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'TotalCount' => ['title' => '列表内元素数量总和。', 'description' => '列表内元素数量总和。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
@@ -4006,375 +1924,229 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"Endpoints\\": [\\n {\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"end-ivrq92qhbyrg4j****\\",\\n \\"Name\\": \\"endpoint-1\\",\\n \\"Type\\": \\"VPC\\",\\n \\"VpcId\\": \\"vpc-j6co2fcdsl1q0gnuc****\\",\\n \\"VswitchId\\": \\"vsw-j6cmr00qjyrft6jo2****\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Ready\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"IpPortMapping\\": {\\n \\"key\\": {\\n \\"Ip\\": \\"10.0.0.5\\",\\n \\"Port\\": \\"3306\\"\\n }\\n }\\n }\\n },\\n \\"InstanceId\\": \\"inst-ivrq92qhbyrg4jctih\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
'title' => '获取数据集加速端点列表',
+ 'summary' => '获取数据集加速槽挂载点的信息列表。',
'description' => '请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
- ],
- 'DescribeEndpoint' => [
- 'summary' => '获取指定数据集加速槽挂载点的信息。',
- 'path' => '/api/v1/endpoints/{EndpointId}',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-22T06:42:27.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Endpoint',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEndpoints'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"Endpoints\\": [\\n {\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"end-ivrq92qhbyrg4j****\\",\\n \\"Name\\": \\"endpoint-1\\",\\n \\"Type\\": \\"VPC\\",\\n \\"VpcId\\": \\"vpc-j6co2fcdsl1q0gnuc****\\",\\n \\"VswitchId\\": \\"vsw-j6cmr00qjyrft6jo2****\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Ready\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"IpPortMapping\\": {\\n \\"key\\": {\\n \\"Ip\\": \\"10.0.0.5\\",\\n \\"Port\\": \\"3306\\"\\n }\\n }\\n }\\n },\\n \\"InstanceId\\": \\"inst-ivrq92qhbyrg4jctih\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
+ ],
+ 'ListInstances' => [
+ 'path' => '/api/v1/instances',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Instance'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'EndpointId',
- 'in' => 'path',
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '实例Id的列表，以逗号分隔。', 'description' => '实例ID的列表，多个加速实例ID间，以半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'inst-my1tk3jggooi5uwks5, inst-n69468yvjz8d12as7d, inst-tga4omjrepklkg1onn'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '实例名称，支持模糊匹配', 'description' => '实例名称，支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'acc_instance_1'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
'schema' => [
- 'title' => '数据集加速槽挂载点ID。',
- 'description' => '数据集加速槽挂载点ID。如何获取挂载点ID，请参见[ListEndpoints](~~467913~~)。',
+ 'title' => '数据集加速实例的类型，参考：产品规格'."\n"
+ .'basic：基础版'."\n"
+ .'enhanced：增强版',
+ 'description' => '数据集加速实例的类型，参考：产品规格，取值如下：'."\n"
+ .'- basic：基础版。'."\n"
+ .'- enhanced：增强版。',
'type' => 'string',
- 'required' => true,
- 'example' => 'end-my1tk3jggooi5uwks5',
+ 'required' => false,
+ 'example' => 'basic',
+ 'enum' => ['basic', 'enhanced'],
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'PaymentType',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
'schema' => [
- 'description' => '返回值。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- 'UserId' => [
- 'title' => '数据集加速端点的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '数据集加速端点的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '276065346797410278',
- ],
- 'OwnerId' => [
- 'title' => '数据集加速端点的资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '数据集加速端点的资源拥有者的Uid，在阿里云内为阿里云账号ID。',
- 'type' => 'string',
- 'example' => '1557702098194904',
- ],
- 'GmtCreateTime' => [
- 'title' => '数据集加速端点创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速端点创建的时间。格式使用 ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '数据集加速端点最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速端点最后更新的时间。格式使用 ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'Uuid' => [
- 'title' => '挂载点的唯一标识符。',
- 'description' => '挂载点的唯一标识符。',
- 'type' => 'string',
- 'example' => 'end-ivrq92qhbyrg4jctih',
- ],
- 'Name' => [
- 'title' => '挂载点的名称。',
- 'description' => '挂载点的名称。',
- 'type' => 'string',
- 'example' => 'endpoint-1',
- ],
- 'Type' => [
- 'title' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
- .'VPC：端点机器处于VPC网络',
- 'description' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
- .'VPC：端点机器处于VPC网络。',
- 'type' => 'string',
- 'example' => 'VPC',
- 'enum' => [
- 'VPC',
- ],
- ],
- 'VpcId' => [
- 'title' => '挂载点使用的专有网络 VPC Id。',
- 'description' => '挂载点使用的专有网络 VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-j6co2fcdsl1q0gnuc3ym3',
- ],
- 'VswitchId' => [
- 'title' => '挂载点使用的交换机 Vswitch Id。',
- 'description' => '挂载点使用的交换机vSwitch ID。',
- 'type' => 'string',
- 'example' => 'vsw-j6cmr00qjyrft6jo2mg7g',
- ],
- 'Status' => [
- 'title' => '数据集加速槽挂载点的状态。',
- 'description' => '数据集加速槽挂载点的状态。',
- '$ref' => '#/components/schemas/EndpointStatus',
- ],
- ],
+ 'title' => '数据集加速实例的付费类型。'."\n"
+ .'PayAsYouGo：后付费（后付费/按量付费）'."\n"
+ .'Subscription：预付费（预付费/包年包月）',
+ 'description' => '数据集加速实例的付费类型，取值如下：'."\n"
+ .'- PayAsYouGo：后付费（按量付费）。'."\n"
+ .'- Subscription：预付费（包年包月）。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PayAsYouGo',
+ 'enum' => ['PayAsYouGo', 'Subscription'],
],
],
- 400 => [
+ [
+ 'name' => 'Phase',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
- 'Detail' => [
- 'title' => '错误详细信息。',
- 'description' => '错误详细信息。',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
- ],
- 'example' => '-',
- ],
- ],
+ 'title' => '数据集加速实例所处状态。状态机参考：状态机'."\n"
+ .'Created：初始化'."\n"
+ .'Running：运行中'."\n"
+ .'Stopped：已停止',
+ 'description' => '数据集加速实例所处状态，取值如下：'."\n"
+ .'- Created：初始化。'."\n"
+ .'- Running：运行中。'."\n"
+ .'- Stopped：已停止。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Running',
+ 'enum' => ['Created', 'Running', 'Stopped'],
],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"UserId\\": \\"276065346797410278\\",\\n \\"OwnerId\\": \\"1557702098194904\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"end-ivrq92qhbyrg4jctih\\",\\n \\"Name\\": \\"endpoint-1\\",\\n \\"Type\\": \\"VPC\\",\\n \\"VpcId\\": \\"vpc-j6co2fcdsl1q0gnuc3ym3\\",\\n \\"VswitchId\\": \\"vsw-j6cmr00qjyrft6jo2mg7g\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Ready\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"IpPortMapping\\": {\\n \\"key\\": {\\n \\"Ip\\": \\"10.0.0.5\\",\\n \\"Port\\": \\"3306\\"\\n }\\n }\\n }\\n }\\n}","type":"json"}]',
- 'title' => '获取数据集加速端点详情',
- ],
- 'DescribeComponent' => [
- 'summary' => '获取指定数据集加速组件的信息。',
- 'path' => '/api/v1/components/{ComponentId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Component',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'default' => 'GmtCreateTime'],
],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ComponentId',
- 'in' => 'path',
+ 'name' => 'Order',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
'schema' => [
- 'title' => '数据集加速组件ID。',
- 'description' => '数据集加速组件ID。如何获取组件ID，请参见[ListComponents](~~467918~~)。',
+ 'title' => '排列顺序'."\n"
+ .'Desc： 降序排列'."\n"
+ .'Asc： 升序排列',
+ 'description' => '排列顺序，取值如下：'."\n"
+ .'- Desc： 降序排列。'."\n"
+ .'- Asc： 升序排列。',
'type' => 'string',
- 'required' => true,
- 'example' => 'cmpt-my1tk3jggooi5uwks5',
+ 'required' => false,
+ 'example' => 'Desc',
+ 'default' => 'Desc',
+ 'enum' => ['Desc', 'Asc'],
],
],
[
- 'name' => 'RenderTemplate',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '是否对组件模板进行渲染并展示。'."\n"
- .'如果值为true，则返回中包含模板渲染后的内容。'."\n"
- .'注：'."\n"
- .'只支持指定组件列表：'."\n"
- .' dataset-accelerator'."\n"
- .'返回的组件模板内容最大长度为4096，超过最大长度会对模板进行截断。',
- 'description' => '是否对组件模板进行渲染并展示。'."\n"
- .'如果值为true，则返回中包含模板渲染后的内容。'."\n"
- .'> 只支持指定组件列表：'."\n"
- .' dataset-accelerator'."\n"
- .'返回的组件模板内容最大长度为4096 Byte，超过最大长度会对模板进行截断。'."\n"
- .'>',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '查询第几页数据，最小值1', 'description' => '数据集加速实例列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'Values',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '组件模板渲染时使用的参数。',
- 'description' => '组件模板渲染时使用的参数。',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '组件的属性值。',
- 'example' => '{\\"frontEndPort\\":\\"24457\\",\\"endpointId\\":\\"end-mlpo5mrygduwl9lm31\\",\\"frontEndAddr\\":\\"192.168.0.3\\",\\"slotId\\":\\"slot-vas3b1ygg22sxbq972\\",\\"region\\":\\"cn-shanghai\\"}',
- ],
- ],
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '设置查询的分页大小,最小值为1', 'description' => '分页查询时设置的每页显示的数据集加速实例的数量，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- 'UserId' => [
- 'title' => '数据集加速组件的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '数据集加速组件的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '276065346797410278',
- ],
- 'OwnerId' => [
- 'title' => '数据集加速组件资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '数据集加速组件资源拥有者的Uid，在阿里云内为阿里云账号ID。',
- 'type' => 'string',
- 'example' => '1557702098194904',
- ],
- 'GmtCreateTime' => [
- 'title' => '数据集加速组件创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速组件创建的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '数据集加速组件最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速组件最后更新的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'Uuid' => [
- 'title' => '数据集加速组件的唯一标识符。',
- 'description' => '数据集加速组件的唯一标识符。',
- 'type' => 'string',
- 'example' => 'cmpt-5zk866779me51jgu3w',
- ],
- 'Name' => [
- 'title' => '数据集加速组件名称。',
- 'description' => '数据集加速组件名称。',
- 'type' => 'string',
- 'example' => 'dataset-accelerator',
- ],
- 'Version' => [
- 'title' => '数据集加速组件版本。',
- 'description' => '数据集加速组件版本。',
- 'type' => 'string',
- 'example' => 'v1.0.0',
- ],
- 'Template' => [
- 'title' => '数据集加速组件模板信息。',
- 'description' => '数据集加速组件模板信息。',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '数据集加速组件模板的类型。'."\n"
- .'OSS：从OSS中读取模板Helm包。',
- 'description' => '数据集加速组件模板的类型。'."\n"
- .'OSS：从OSS中读取模板Helm包。',
- 'type' => 'string',
- 'example' => 'OSS',
- 'enum' => [
- 'OSS',
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'required' => true, 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ 'Instances' => [
+ 'title' => '数据集加速实例列表。',
+ 'description' => '数据集加速实例列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['title' => '数据集加速实例的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '数据集加速实例的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '276065346797410278'],
+ 'OwnerId' => ['title' => '数据集加速实例资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '数据集加速实例资源拥有者的Uid，在阿里云内为阿里云账号ID。', 'type' => 'string', 'example' => '1557702098194904'],
+ 'GmtCreateTime' => ['title' => '数据集加速实例创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速实例创建的时间。格式使用 ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '数据集加速实例最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速实例最后更新的时间。格式使用 ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'Uuid' => ['title' => '数据集加速实例的唯一标识符。', 'description' => '数据集加速实例的唯一标识符。', 'type' => 'string', 'example' => 'inst-my1tk3jggooi5uwks5'],
+ 'Name' => ['title' => '数据集加速实例名称。', 'description' => '数据集加速实例名称。', 'type' => 'string', 'example' => 'acc_instance_1'],
+ 'Description' => ['title' => '数据集加速实例的描述与解释。', 'description' => '数据集加速实例的描述与解释。', 'type' => 'string', 'example' => 'XGBoost dataset acceleration instance'],
+ 'Type' => ['title' => '数据集加速实例的类型'."\n"
+ .'Basic：基础版'."\n"
+ .'Advanced：进阶版'."\n"
+ .'Express：极速版', 'description' => '数据集加速实例的类型，可能值：'."\n"
+ .'- Basic：基础版。'."\n"
+ .'- Advanced：进阶版。'."\n"
+ .'- Express：极速版。', 'type' => 'string', 'example' => 'Basic'],
+ 'Tags' => [
+ 'title' => '用户为数据集加速实例添加的自定义标签。',
+ 'description' => '用户为数据集加速实例添加的自定义标签。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的键值。'."\n"
+ .'长度限制为64 Unicode字符。', 'type' => 'string', 'example' => 'dataset_version', 'maxLength' => 64],
+ 'Value' => ['title' => '标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的值。'."\n"
+ .'长度限制为64 Unicode字符。', 'type' => 'string', 'example' => 'v0.1.0', 'maxLength' => 64],
+ ],
+ 'description' => '',
+ ],
],
+ 'PaymentType' => [
+ 'title' => 'PayAsYouGo 数据集加速实例的付费类型。'."\n"
+ .'PayAsYouGo：后付费（后付费/按量付费）'."\n"
+ .'Subscription：预付费（预付费/包年包月）',
+ 'description' => '数据集加速实例的付费类型，可能值：'."\n"
+ .'- PayAsYouGo：后付费（按量付费）。'."\n"
+ .'- Subscription：预付费（包年包月）。',
+ 'type' => 'string',
+ 'example' => 'PayAsYouGo',
+ 'enum' => ['PayAsYouGo', 'Subscription'],
+ ],
+ 'Capacity' => ['title' => '数据集加速实例的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：Quantity', 'description' => '数据集加速实例的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。', 'type' => 'string', 'example' => '30.0G'],
+ 'IoType' => ['title' => '数据集加速实例的读写类型。', 'description' => '数据集加速实例的读写类型。', 'type' => 'string', 'example' => 'readonly'],
+ 'MaxSlot' => ['title' => '数据集加速实例的最大加速槽个数。', 'description' => '数据集加速实例的最大加速槽个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20'],
+ 'MaxEndpoint' => ['title' => '数据集加速实例的最大挂载点个数。', 'description' => '数据集加速实例的最大挂载点个数。', 'type' => 'integer', 'format' => 'int32', 'default' => '100'],
+ 'StorageType' => ['title' => '数据集加速实例的存储类型。', 'description' => '数据集加速实例的存储类型。', 'type' => 'string', 'example' => 'OSS', 'default' => 'OSS'],
+ 'ProviderType' => ['title' => '数据集加速实例的资源提供者类型。', 'description' => '数据集加速实例的资源提供者类型。', 'type' => 'string', 'example' => 'Ecs', 'default' => 'Ecs'],
+ 'Status' => ['title' => '数据集加速实例状态。', 'description' => '数据集加速实例状态。', '$ref' => '#/components/schemas/InstanceStatus'],
],
- 'Uri' => [
- 'title' => '数据集加速组件模板的资源标识符，数据类型不同存在不同格式。',
- 'description' => '数据集加速组件模板的资源标识符，数据类型不同存在不同格式。',
- 'type' => 'string',
- 'example' => 'data/VOCdevkit/VOC2007/ImageSets/Main/val.txt',
- ],
+ 'description' => '',
],
],
- 'RenderedContent' => [
- 'title' => '渲染后的数据集加速组件部署文件。',
- 'description' => '渲染后的数据集加速组件部署文件。',
- 'type' => 'string',
- 'example' => '---\\n# Source: dataset-accelerator/templates/dataset-accelerator\\napiVersion: data.datasetacc.io/v1\\nkind: DataSetAccelerator\\nmetadata:\\n name: dataset-accelerator\\nspec:\\n frontEndAddr: 10.0.0.2\\n frontEndPort: 7001\\n',
- ],
+ 'TotalCount' => ['title' => '列表内元素数量总和。', 'description' => '列表内元素数量总和。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
@@ -4382,120 +2154,124 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"UserId\\": \\"276065346797410278\\",\\n \\"OwnerId\\": \\"1557702098194904\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"cmpt-5zk866779me51jgu3w\\",\\n \\"Name\\": \\"dataset-accelerator\\",\\n \\"Version\\": \\"v1.0.0\\",\\n \\"Template\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"data/VOCdevkit/VOC2007/ImageSets/Main/val.txt\\"\\n },\\n \\"RenderedContent\\": \\"---\\\\\\\\n# Source: dataset-accelerator/templates/dataset-accelerator\\\\\\\\napiVersion: data.datasetacc.io/v1\\\\\\\\nkind: DataSetAccelerator\\\\\\\\nmetadata:\\\\\\\\n name: dataset-accelerator\\\\\\\\nspec:\\\\\\\\n frontEndAddr: 10.0.0.2\\\\\\\\n frontEndPort: 7001\\\\\\\\n\\"\\n}","type":"json"}]',
- 'title' => '获取数据集加速组件详情',
- ],
- 'ListComponents' => [
- 'summary' => '获取数据集加速组件的信息列表。',
- 'path' => '/api/v1/components',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取数据集加速实例列表',
+ 'summary' => '获取数据集加速实例信息列表。',
+ 'description' => '请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-22T12:08:54.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2023-05-22T12:06:12.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-10-14T08:37:35.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-08-13T16:52:28.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Component',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"Instances\\": [\\n {\\n \\"UserId\\": \\"276065346797410278\\",\\n \\"OwnerId\\": \\"1557702098194904\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"inst-my1tk3jggooi5uwks5\\",\\n \\"Name\\": \\"acc_instance_1\\",\\n \\"Description\\": \\"XGBoost dataset acceleration instance\\",\\n \\"Type\\": \\"Basic\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"PaymentType\\": \\"PayAsYouGo\\",\\n \\"Capacity\\": \\"30.0G\\",\\n \\"IoType\\": \\"readonly\\",\\n \\"MaxSlot\\": 20,\\n \\"MaxEndpoint\\": 0,\\n \\"StorageType\\": \\"OSS\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Running\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"UsedCapacity\\": \\"20.0G\\",\\n \\"SlotNum\\": 10\\n }\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
+ ],
+ 'ListSlots' => [
+ 'path' => '/api/v1/slots',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Slot'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ComponentIds',
+ 'name' => 'SlotIds',
'in' => 'query',
- 'schema' => [
- 'title' => '数据集加速组件ID的列表，以逗号分隔。',
- 'description' => '数据集加速组件ID的列表，多个组件ID以半角逗号（,）分隔。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cmpt-my1tk3jggooi5u****,cmpt-n69468yvjz8d12****,cmpt-tga4omjrepklkg****',
- ],
+ 'schema' => ['title' => '数据集加速槽ID的列表，以逗号分隔。', 'description' => '数据集加速槽ID的列表，多个加速槽ID以半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'slot-my1tk3jggooi5u****,slot-n69468yvjz8d12****,slot-tga4omjrepklkg****'],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'schema' => ['title' => '加速槽所对应的数据集加速实例的唯一标识符。', 'description' => '加速槽所对应的数据集加速实例的唯一标识符。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。', 'type' => 'string', 'required' => false, 'example' => 'inst-my1tk3jggooi5u****'],
],
[
'name' => 'Name',
'in' => 'query',
+ 'schema' => ['title' => '数据集加速槽名称，支持模糊匹配', 'description' => '数据集加速槽名称，支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'acc_instance_slot_1'],
+ ],
+ [
+ 'name' => 'StorageType',
+ 'in' => 'query',
'schema' => [
- 'title' => '数据集加速组件名称，支持模糊匹配。',
- 'description' => '数据集加速组件名称，支持模糊匹配。',
+ 'title' => '数据集加速槽的数据存储类型。'."\n"
+ .'OSS：OSS文件存储'."\n"
+ .'NAS：NAS文件存储',
+ 'description' => '数据集加速槽的数据存储类型，取值如下：'."\n"
+ .'- OSS：OSS文件存储。'."\n"
+ .'- NAS：NAS文件存储。',
'type' => 'string',
'required' => false,
- 'example' => 'dataset-accelerator',
+ 'example' => 'OSS',
+ 'enum' => ['OSS', 'NAS'],
],
],
[
- 'name' => 'Version',
+ 'name' => 'Phase',
'in' => 'query',
'schema' => [
- 'title' => '数据集加速组件版本。',
- 'description' => '数据集加速组件版本。',
+ 'title' => '数据集加速槽所处状态。'."\n"
+ .'Created：已创建'."\n"
+ .'Preparing：正在准备资源'."\n"
+ .'Loading：正在加载数据'."\n"
+ .'Running：正在运行，提供服务'."\n"
+ .'Reloading：正在重新加载数据'."\n"
+ .'Succeed：成功完成'."\n"
+ .'Failed：已失败'."\n"
+ .'Stopping：正在停止'."\n"
+ .'Stopped：已停止',
+ 'description' => '数据集加速槽所处状态，取值如下：'."\n"
+ .'- Created：已创建。'."\n"
+ .'- Preparing：正在准备资源。'."\n"
+ .'- Loading：正在加载数据。'."\n"
+ .'- Running：正在运行，提供服务。'."\n"
+ .'- Reloading：正在重新加载数据。'."\n"
+ .'- Succeed：成功完成。'."\n"
+ .'- Failed：已失败。'."\n"
+ .'- Stopping：正在停止。'."\n"
+ .'- Stopped：已停止。',
'type' => 'string',
'required' => false,
- 'example' => 'v1.0.0',
+ 'example' => 'Running',
+ 'enum' => ['Created', 'Preparing', 'Loading', 'Running', 'Succeed', 'Failed', 'Stopping', 'Stopped'],
],
],
[
'name' => 'SortBy',
'in' => 'query',
'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GmtCreateTime',
- 'default' => 'GmtCreateTime',
- ],
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'default' => 'GmtCreateTime'],
],
[
'name' => 'Order',
@@ -4512,139 +2288,119 @@
'required' => false,
'example' => 'Desc',
'default' => 'Desc',
- 'enum' => [
- 'Desc',
- 'Asc',
- ],
+ 'enum' => ['Desc', 'Asc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '查询第几页数据，最小值1',
- 'description' => '组件列表的页码。起始值为1，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '查询第几页数据，最小值1', 'description' => '加速槽列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '设置查询的分页大小,最小值为1',
- 'description' => '分页查询时设置的每页显示的组件数量，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '设置查询的分页大小,最小值为1', 'description' => '分页查询时设置的每页显示的加速槽数量，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'EndpointIds',
+ 'in' => 'query',
+ 'schema' => ['title' => '加速槽所对应的数据集加速挂载点的唯一标识符。', 'description' => '加速槽所对应的数据集加速挂载点的唯一标识符。', 'type' => 'string', 'required' => false, 'example' => 'endp-my1tk3jggooi5uwks5'],
+ ],
+ [
+ 'name' => 'StorageUri',
+ 'in' => 'query',
+ 'schema' => ['title' => '数据集加速槽的数据存储路径（URI）。', 'description' => '数据集加速槽的数据存储路径（URI）。', 'type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回结果。',
+ 'title' => '',
+ 'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****',
- ],
- 'Components' => [
- 'title' => '数据集加速槽列表。',
- 'description' => '数据集加速槽列表。',
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF1****'],
+ 'Slots' => [
+ 'title' => '数据集加速列表',
+ 'description' => '数据集加速列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'title' => '数据集加速组件的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '数据集加速组件的创建者的Uid，在阿里云内为RAM用户ID （阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '27606534679741****',
- ],
- 'OwnerId' => [
- 'title' => '数据集加速组件资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '数据集加速组件资源拥有者的Uid，在阿里云内为阿里云账号ID 。',
- 'type' => 'string',
- 'example' => '155770209819****',
- ],
- 'GmtCreateTime' => [
- 'title' => '数据集加速组件创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速组件创建的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '数据集加速组件最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '数据集加速组件最后更新的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'Uuid' => [
- 'title' => '数据集加速组件的唯一标识符。',
- 'description' => '数据集加速组件的唯一标识符。',
- 'type' => 'string',
- 'example' => 'cmpt-5zk866779me51j****',
- ],
- 'Name' => [
- 'title' => '数据集加速组件名称。',
- 'description' => '数据集加速组件名称。',
- 'type' => 'string',
- 'example' => 'dataset-accelerator',
+ 'UserId' => ['title' => '数据集加速槽的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '数据集加速槽的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '27606534679741****'],
+ 'OwnerId' => ['title' => '数据集加速槽资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '数据集加速槽资源拥有者的Uid，在阿里云内为阿里云账号ID。', 'type' => 'string', 'example' => '155770209819****'],
+ 'GmtCreateTime' => ['title' => '数据集加速槽创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速槽创建的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '数据集加速槽最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速槽最后更新的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'Uuid' => ['title' => '数据集加速槽的唯一标识符。', 'description' => '数据集加速槽的唯一标识符。', 'type' => 'string', 'example' => 'slot-5zk866779me51j****'],
+ 'InstanceId' => ['title' => '加速槽所对应的数据集加速实例的唯一标识符。', 'description' => '加速槽所对应的数据集加速实例的唯一标识符。', 'type' => 'string', 'example' => 'inst-my1tk3jggooi5u****'],
+ 'Name' => ['title' => '数据集加速槽名称。', 'description' => '数据集加速槽名称。', 'type' => 'string', 'example' => 'slot_1'],
+ 'Description' => ['title' => '数据集加速槽的描述与解释。', 'description' => '数据集加速槽的描述与解释。', 'type' => 'string', 'example' => 'XGBoost dataset acceleration slot'],
+ 'Tags' => [
+ 'title' => '用户为数据集加速槽添加的自定义标签。',
+ 'description' => '用户为数据集加速槽添加的自定义标签。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '标签的键值。', 'description' => '标签的键值。', 'type' => 'string', 'example' => 'dataset_version'],
+ 'Value' => ['title' => '标签的值。', 'description' => '标签的值。', 'type' => 'string', 'example' => 'v0.1.0'],
+ ],
+ 'description' => '',
+ ],
],
- 'Version' => [
- 'title' => '数据集加速组件版本。',
- 'description' => '数据集加速组件版本。',
+ 'StorageType' => [
+ 'title' => '数据集加速槽的数据存储类型。'."\n"
+ .'OSS：OSS文件存储'."\n"
+ .'NAS：NAS文件存储',
+ 'description' => '数据集加速槽的数据存储类型，可能值：'."\n"
+ .'- OSS：OSS文件存储。'."\n"
+ .'- NAS：NAS文件存储。',
'type' => 'string',
- 'example' => 'v1.0.0',
+ 'example' => 'OSS',
+ 'enum' => ['OSS', 'NAS'],
],
- 'Template' => [
- 'title' => '数据集加速组件模板信息。',
- 'description' => '数据集加速组件模板信息。',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '数据集加速组件模板的类型。'."\n"
- .'OSS：从OSS中读取模板Helm包。',
- 'description' => '数据集加速组件模板的类型。'."\n"
- .'OSS：从OSS中读取模板Helm包。',
- 'type' => 'string',
- 'example' => 'OSS',
- 'enum' => [
- 'OSS',
+ 'StorageUri' => ['title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'type' => 'string', 'example' => 'oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt'],
+ 'Capacity' => ['title' => '数据集加速槽的最大容量。输入字符串的格式需要满足以下规范：Quantity', 'description' => '数据集加速槽的最大容量。输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)。', 'type' => 'string', 'example' => '30.0G'],
+ 'IoType' => ['title' => '数据集加速槽的读写类型。', 'description' => '数据集加速槽的读写类型。', 'type' => 'string', 'example' => 'readonly'],
+ 'LifeCycle' => ['title' => '数据集加速槽的生命周期。', 'description' => '数据集加速槽的生命周期。', '$ref' => '#/components/schemas/SlotLifeCycle'],
+ 'Status' => ['title' => '数据集加速槽状态。', 'description' => '数据集加速槽状态。', '$ref' => '#/components/schemas/SlotStatus'],
+ 'Endpoints' => [
+ 'title' => '数据集加速槽关联的端点列表。',
+ 'description' => '数据集加速槽关联的端点列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['title' => '数据集加速端点的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '数据集加速端点的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '27606534679741****'],
+ 'OwnerId' => ['title' => '数据集加速端点的资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '数据集加速端点的资源拥有者的Uid，在阿里云内为阿里云账号ID。', 'type' => 'string', 'example' => '155770209819****'],
+ 'GmtCreateTime' => ['title' => '数据集加速端点创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速端点创建的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '数据集加速端点最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '数据集加速端点最后更新的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'Uuid' => ['title' => '挂载点的唯一标识符。', 'description' => '挂载点的唯一标识符。', 'type' => 'string', 'example' => 'end-ivrq92qhbyrg4j****'],
+ 'Name' => ['title' => '挂载点的名称。', 'description' => '挂载点的名称。', 'type' => 'string', 'example' => 'endpoint-1'],
+ 'Type' => [
+ 'title' => '挂载点的网络类型，根据网络类型不同，下列中需要传入的参数也有所不同。'."\n"
+ .'VPC：端点机器处于VPC网络',
+ 'description' => '挂载点的网络类型，可能值：'."\n"
+ .'- VPC：挂载点处于VPC网络。'."\n"
+ .'- INNER：挂载点处于PAI内部网络中，用于PAI其他产品进行访问。',
+ 'type' => 'string',
+ 'example' => 'VPC',
+ 'enum' => ['VPC'],
],
+ 'VpcId' => ['title' => '挂载点使用的专有网络 VPC Id。', 'description' => '挂载点使用的专有网络 VPC ID。', 'type' => 'string', 'example' => 'vpc-j6co2fcdsl1q0gnuc****'],
+ 'VswitchId' => ['title' => '挂载点使用的交换机 Vswitch Id。', 'description' => '挂载点使用的交换机vSwitch ID。', 'type' => 'string', 'example' => 'vsw-j6cmr00qjyrft6jo2****'],
+ 'Status' => ['title' => '数据集加速槽挂载点的状态。', 'description' => '数据集加速槽挂载点的状态。', '$ref' => '#/components/schemas/EndpointStatus'],
],
- 'Uri' => [
- 'title' => '数据集加速组件模板的资源标识符，数据类型不同存在不同格式。',
- 'description' => '数据集加速组件模板的资源标识符，数据类型不同存在不同格式。',
- 'type' => 'string',
- 'example' => 'data/VOCdevkit/VOC2007/ImageSets/Main/val.txt',
- ],
+ 'description' => '',
],
],
],
+ 'description' => '',
],
],
- 'TotalCount' => [
- 'title' => '列表内元素数量总和。',
- 'description' => '列表内元素数量总和。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'TotalCount' => ['title' => '列表内元素数量总和。', 'description' => '列表内元素数量总和。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
@@ -4652,146 +2408,173 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"Components\\": [\\n {\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"cmpt-5zk866779me51j****\\",\\n \\"Name\\": \\"dataset-accelerator\\",\\n \\"Version\\": \\"v1.0.0\\",\\n \\"Template\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"data/VOCdevkit/VOC2007/ImageSets/Main/val.txt\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
- 'title' => '获取数据集加速组件列表',
+ 'title' => '获取数据集加速槽列表',
+ 'summary' => '获取数据集加速槽的信息列表。',
'description' => '请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
- ],
- 'CreateTag' => [
- 'summary' => '针对一个资源，创建一个标签。',
- 'path' => '/api/v1/tags',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-22T11:41:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2023-05-22T06:42:27.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Tag',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSlots'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF1****\\",\\n \\"Slots\\": [\\n {\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"slot-5zk866779me51j****\\",\\n \\"InstanceId\\": \\"inst-my1tk3jggooi5u****\\",\\n \\"Name\\": \\"slot_1\\",\\n \\"Description\\": \\"XGBoost dataset acceleration slot\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"StorageType\\": \\"OSS\\",\\n \\"StorageUri\\": \\"oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt\\",\\n \\"Capacity\\": \\"30.0G\\",\\n \\"IoType\\": \\"readonly\\",\\n \\"LifeCycle\\": {\\n \\"Type\\": \\"KeepAlive\\",\\n \\"Config\\": \\"{}\\"\\n },\\n \\"Status\\": {\\n \\"Phase\\": \\"Running\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"LoadedFileNum\\": 1000000,\\n \\"LoadedFileSize\\": \\"200G\\",\\n \\"LoadingTimeCost\\": 1800000\\n }\\n },\\n \\"Endpoints\\": [\\n {\\n \\"UserId\\": \\"27606534679741****\\",\\n \\"OwnerId\\": \\"155770209819****\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"Uuid\\": \\"end-ivrq92qhbyrg4j****\\",\\n \\"Name\\": \\"endpoint-1\\",\\n \\"Type\\": \\"VPC\\",\\n \\"VpcId\\": \\"vpc-j6co2fcdsl1q0gnuc****\\",\\n \\"VswitchId\\": \\"vsw-j6cmr00qjyrft6jo2****\\",\\n \\"Status\\": {\\n \\"Phase\\": \\"Ready\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Init Succeed\\",\\n \\"Detail\\": {\\n \\"IpPortMapping\\": {\\n \\"key\\": {\\n \\"Ip\\": \\"10.0.0.5\\",\\n \\"Port\\": \\"3306\\"\\n }\\n }\\n }\\n }\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
+ ],
+ 'ListTags' => [
+ 'summary' => '获取标签列表。',
+ 'path' => '/api/v1/tags',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Tag'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'ResourceType',
+ 'in' => 'query',
'schema' => [
- 'description' => '请求参数。',
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'title' => '标签所属的资源的类型。'."\n"
- .'Instance：数据集加速实例'."\n"
- .'Slot：数据集加速槽',
- 'description' => '标签所属的资源的类型，取值如下：'."\n"
- .'- Instance：数据集加速实例。'."\n"
- .'- Slot：数据集加速槽。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Slot',
- ],
- ],
- 'ResourceId' => [
- 'title' => '标签所属的资源的Id。',
- 'description' => '标签所属的资源的ID。'."\n"
- .'- 当ResourceType为Instance时，需要配置为数据集加速实例ID，如何获取加速实例ID，请参见[ListInstances](~~467899~~)。'."\n"
- .'- 当ResourceType为Slot时，需要配置为数据集加速槽ID，如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'inst-my1tk3jggooi5uwks',
- ],
- 'Key' => [
- 'title' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的键值。'."\n"
- .'长度限制为64 Unicode字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
- 'Value' => [
- 'title' => '标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的值。'."\n"
- .'长度限制为64 Unicode字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v0.1.0',
- 'maxLength' => 64,
- ],
- ],
+ 'title' => '标签所属的资源的类型。'."\n"
+ .'Instance：数据集加速实例'."\n"
+ .'Slot：数据集加速槽',
+ 'description' => '标签所属的资源的类型，取值如下：'."\n"
+ .'- Instance：数据集加速实例。'."\n"
+ .'- Slot：数据集加速槽。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'instance',
+ 'enum' => ['Instance', 'Slot'],
+ ],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'schema' => ['title' => '标签所属的资源的Id。', 'description' => '标签所属的资源的ID。'."\n"
+ .'- 当ResourceType为Instance时，需要配置为数据集加速实例ID，如何获取加速实例ID，请参见[ListInstances](~~467899~~)。'."\n"
+ .'- 当ResourceType为Slot时，需要配置为数据集加速槽ID，如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => false, 'example' => 'inst-my1tk3jggooi5uwks5'],
+ ],
+ [
+ 'name' => 'Key',
+ 'in' => 'query',
+ 'schema' => ['title' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的键值。'."\n"
+ .'长度限制为64 Unicode字符。', 'type' => 'string', 'required' => false, 'example' => 'dataset_version', 'maxLength' => 64],
+ ],
+ [
+ 'name' => 'Value',
+ 'in' => 'query',
+ 'schema' => ['title' => '标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的值。'."\n"
+ .'长度限制为64 Unicode字符。', 'type' => 'string', 'required' => false, 'example' => 'v0.1.0', 'maxLength' => 64],
+ ],
+ [
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'default' => 'GmtCreateTime'],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => [
+ 'title' => '排列顺序'."\n"
+ .'Desc： 降序排列'."\n"
+ .'Asc： 升序排列',
+ 'description' => '排列顺序，取值如下：'."\n"
+ .'- Desc： 降序排列。'."\n"
+ .'- Asc： 升序排列。',
+ 'type' => 'string',
'required' => false,
+ 'example' => 'Desc',
+ 'default' => 'Desc',
+ 'enum' => ['Desc', 'Asc'],
],
],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '查询第几页数据，最小值1', 'description' => '标签列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '设置查询的分页大小,最小值为1', 'description' => '分页查询时设置的每页显示的标签数量，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10', 'default' => '10'],
+ ],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'description' => '返回值。',
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ 'Tags' => [
+ 'title' => '标签列表。',
+ 'description' => '标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['title' => '标签的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。', 'description' => '标签的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。', 'type' => 'string', 'example' => '276065346797410278'],
+ 'OwnerId' => ['title' => '标签的资源拥有者的Uid，在阿里云内为主账号Id 。', 'description' => '标签的资源拥有者的Uid，在阿里云内为阿里云账号ID。', 'type' => 'string', 'example' => '1557702098194904'],
+ 'GmtCreateTime' => ['title' => '标签创建的时间。格式使用 ISO8601(RFC3339)。', 'description' => '标签创建的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'GmtModifiedTime' => ['title' => '标签最后更新的时间。格式使用 ISO8601(RFC3339)。', 'description' => '标签最后更新的时间。格式使用ISO8601（RFC3339）。', 'type' => 'string', 'example' => '2014-10-02T15:01:23Z'],
+ 'ResourceType' => [
+ 'title' => '标签所属的资源的类型。'."\n"
+ .'Instance：数据集加速实例'."\n"
+ .'Slot：数据集加速槽',
+ 'description' => '标签所属的资源的类型，可能值：'."\n"
+ .'- Instance：数据集加速实例。'."\n"
+ .'- Slot：数据集加速槽。',
+ 'type' => 'string',
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Slot'],
+ ],
+ 'ResourceId' => ['title' => '标签所属的资源的Id。', 'description' => '标签所属的资源的ID。', 'type' => 'string', 'example' => 'inst-my1tk3jggooi5uwks'],
+ 'Key' => ['title' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的键值。'."\n"
+ .'长度限制为64 Unicode字符。', 'type' => 'string', 'example' => 'dataset_version', 'maxLength' => 64],
+ 'Value' => ['title' => '标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的值。'."\n"
+ .'长度限制为64 Unicode字符。', 'type' => 'string', 'example' => 'v0.1.0', 'maxLength' => 64],
+ ],
+ 'description' => '',
+ ],
],
+ 'TotalCount' => ['title' => '列表内元素数量总和。', 'description' => '列表内元素数量总和。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
@@ -4799,135 +2582,119 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '创建标签',
- 'description' => '- 如果针对这个资源已经存在相同键值的标签，则会对标签的值进行覆盖。'."\n"
- .'- 如果未存在键值相同的标签，则创建一个新的标签。',
- ],
- 'DeleteTag' => [
- 'summary' => '删除一个资源上的一个标签。',
- 'path' => '/api/v1/tags',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取标签列表',
+ 'description' => '请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Tag',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTags'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"Tags\\": [\\n {\\n \\"UserId\\": \\"276065346797410278\\",\\n \\"OwnerId\\": \\"1557702098194904\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"ResourceType\\": \\"Instance\\",\\n \\"ResourceId\\": \\"inst-my1tk3jggooi5uwks\\",\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
+ ],
+ 'QueryInstanceMetrics' => [
+ 'path' => '/api/v1/instances/{InstanceId}/metrics/action/query',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Instance'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '监控指标所属的数据集加速实例Id。', 'description' => '监控指标所属的数据集加速实例ID。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。', 'type' => 'string', 'required' => true, 'example' => 'inst-abcdefgh12****'],
+ ],
+ [
+ 'name' => 'Dimensions',
'in' => 'query',
- 'schema' => [
- 'title' => '标签所属的资源的类型。'."\n"
- .'Instance：数据集加速实例'."\n"
- .'Slot：数据集加速槽',
- 'description' => '标签所属的资源的类型，取值如下：'."\n"
- .'- Instance：数据集加速实例。'."\n"
- .'- Slot：数据集加速槽。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Slot',
- ],
- ],
+ 'style' => 'json',
+ 'schema' => ['title' => '监控指标的标签集，参考 Prometheus Label'."\n"
+ .'每种类型所包含的Labels不同，参考：类型详细信息'."\n"
+ .'仅接受预定义的Label Key，不支持自定义'."\n"
+ .'格式：key-value键值对形式的集合。', 'description' => '监控指标的标签集。', 'type' => 'object', 'required' => false, 'example' => 'SlotIDs: xxx'],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'MetricType',
'in' => 'query',
'schema' => [
- 'title' => '标签所属的资源的Id。',
- 'description' => '标签所属的资源的ID。'."\n"
- .'- 当ResourceType为Instance时，需要配置为数据集加速实例ID，如何获取加速实例ID，请参见[ListInstances](~~467899~~)。'."\n"
- .'- 当ResourceType为Slot时，需要配置为数据集加速槽ID，如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
+ 'title' => '监控指标的类型：'."\n"
+ .'StorageUsage：存储使用量'."\n"
+ .'StorageUsageRatio：存储使用率'."\n"
+ .'CachedFileTotal：已缓存文件数量'."\n"
+ .'CachedTaskTotal：已缓存任务数',
+ 'description' => '监控指标的类型，取值如下：'."\n"
+ .'- NetworkReceiveBytesPerSecond：每秒网络请求接收量。'."\n"
+ .'- NetworkTransmitBytesPerSecond：每秒网络请求发送量。'."\n"
+ .'- FrontendThroughputBytes：前端服务吞吐。'."\n"
+ .'- FrontendLatencyMicrosecond：前端服务延迟。'."\n"
+ .'- FrontendIops：前端服务读取频率。',
'type' => 'string',
'required' => true,
- 'example' => 'inst-my1tk3jggooi5uwks',
+ 'example' => 'NetworkReceiveBytesPerSecond',
+ 'enum' => ['NetworkReceiveBytesPerSecond', 'NetworkTransmitBytesPerSecond', 'FrontendThroughputBytes', 'FrontendLatencyMicrosecond', 'FrontendIops'],
],
],
[
- 'name' => 'Key',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'title' => '标签的键值。',
- 'description' => '标签的键值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
+ 'schema' => ['title' => '起始时间.默认是1小时前。', 'description' => '起始时间，默认是1小时前。', 'type' => 'string', 'required' => false, 'example' => '2020-11-08T15:00:00Z'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '截止时间.默认是当前。', 'description' => '截止时间，默认是当前时间。', 'type' => 'string', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
+ ],
+ [
+ 'name' => 'TimeStep',
+ 'in' => 'query',
+ 'schema' => ['title' => '时间间隔。', 'description' => '时间间隔，单位为分钟。', 'type' => 'string', 'required' => false, 'example' => '5m', 'default' => '5m'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'description' => '返回值。',
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'required' => true, 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ 'Metrics' => [
+ 'title' => '监控指标信息列表。',
+ 'description' => '监控指标信息列表。',
+ 'type' => 'array',
+ 'items' => ['description' => 'Metric信息详情。', '$ref' => '#/components/schemas/Metric'],
],
+ 'Period' => ['title' => '时间间隔。', 'description' => '时间间隔。', 'type' => 'string', 'example' => '60s'],
],
],
],
@@ -4935,198 +2702,106 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '删除标签',
- ],
- 'ListTags' => [
- 'summary' => '获取标签列表。',
- 'path' => '/api/v1/tags',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取数据集加速实例监控指标',
+ 'summary' => '查询并获取数据集加速实例监控指标信息。',
+ 'description' => '- 请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。'."\n"
+ .'- 在查询时，管控层会将InstanceId默认加入到筛选条件中，因此需要监控指标采集时关联到InstanceId上，方可被查询出来。',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-14T03:16:26.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-10-28T02:58:36.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
],
- 'tags' => [
- 'Tag',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryInstanceMetrics'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"1655897743\\",\\n \\"Value\\": 98.35\\n }\\n ],\\n \\"Period\\": \\"60s\\"\\n}","type":"json"}]',
+ ],
+ 'QuerySlotMetrics' => [
+ 'path' => '/api/v1/slots/{SlotId}/metrics/action/query',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Slot'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ResourceType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '标签所属的资源的类型。'."\n"
- .'Instance：数据集加速实例'."\n"
- .'Slot：数据集加速槽',
- 'description' => '标签所属的资源的类型，取值如下：'."\n"
- .'- Instance：数据集加速实例。'."\n"
- .'- Slot：数据集加速槽。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'instance',
- 'enum' => [
- 'Instance',
- 'Slot',
- ],
- ],
- ],
- [
- 'name' => 'ResourceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '标签所属的资源的Id。',
- 'description' => '标签所属的资源的ID。'."\n"
- .'- 当ResourceType为Instance时，需要配置为数据集加速实例ID，如何获取加速实例ID，请参见[ListInstances](~~467899~~)。'."\n"
- .'- 当ResourceType为Slot时，需要配置为数据集加速槽ID，如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inst-my1tk3jggooi5uwks5',
- ],
- ],
- [
- 'name' => 'Key',
- 'in' => 'query',
- 'schema' => [
- 'title' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的键值。'."\n"
- .'长度限制为64 Unicode字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
+ 'name' => 'SlotId',
+ 'in' => 'path',
+ 'schema' => ['title' => '监控指标所属的数据集加速槽ID。', 'description' => '监控指标所属的数据集加速槽ID。如何获取加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'slot-abcdefgh12****'],
],
[
- 'name' => 'Value',
+ 'name' => 'Dimensions',
'in' => 'query',
- 'schema' => [
- 'title' => '标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的值。'."\n"
- .'长度限制为64 Unicode字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v0.1.0',
- 'maxLength' => 64,
- ],
+ 'style' => 'json',
+ 'schema' => ['title' => '监控指标的标签集，参考 Prometheus Label'."\n"
+ .'每种类型所包含的Labels不同，参考：类型详细信息'."\n"
+ .'仅接受预定义的Label Key，不支持自定义'."\n"
+ .'格式：key-value键值对形式的集合。', 'description' => '监控指标的标签集。', 'type' => 'object', 'required' => false, 'example' => 'SlotIDs: xxx'],
],
[
- 'name' => 'SortBy',
+ 'name' => 'MetricType',
'in' => 'query',
- 'allowEmptyValue' => true,
'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。',
+ 'title' => '监控指标的类型：'."\n"
+ .'StorageUsage：存储使用量'."\n"
+ .'StorageUsageRatio：存储使用率'."\n"
+ .'CachedFileTotal：已缓存文件数量'."\n"
+ .'CachedTaskTotal：已缓存任务数',
+ 'description' => '监控指标的类型，取值如下：'."\n"
+ .'- NetworkReceiveBytesPerSecond：每秒网络请求接收量。'."\n"
+ .'- NetworkTransmitBytesPerSecond：每秒网络请求发送量。'."\n"
+ .'- FrontendThroughputBytes：前端服务吞吐。'."\n"
+ .'- FrontendLatencyMicrosecond：前端服务延迟。'."\n"
+ .'- FrontendIops：前端服务读取频率。',
'type' => 'string',
- 'required' => false,
- 'example' => 'GmtCreateTime',
- 'default' => 'GmtCreateTime',
+ 'required' => true,
+ 'example' => 'NetworkReceiveBytesPerSecond',
+ 'enum' => ['NetworkTransmitBytesPerSecond', 'NetworkReceiveBytesPerSecond', 'FrontendThroughputBytes', 'FrontendLatencyMicrosecond', 'FrontendIops'],
],
],
[
- 'name' => 'Order',
+ 'name' => 'StartTime',
'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '排列顺序'."\n"
- .'Desc： 降序排列'."\n"
- .'Asc： 升序排列',
- 'description' => '排列顺序，取值如下：'."\n"
- .'- Desc： 降序排列。'."\n"
- .'- Asc： 升序排列。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
- 'default' => 'Desc',
- 'enum' => [
- 'Desc',
- 'Asc',
- ],
- ],
+ 'schema' => ['title' => '起始时间.默认是1小时前。', 'description' => '起始时间，默认是1小时前。', 'type' => 'string', 'required' => false, 'example' => '2020-11-08T15:00:00Z'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'EndTime',
'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '查询第几页数据，最小值1',
- 'description' => '标签列表的页码。起始值为1，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '截止时间.默认是当前。', 'description' => '截止时间，默认是当前时间。', 'type' => 'string', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'TimeStep',
'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '设置查询的分页大小,最小值为1',
- 'description' => '分页查询时设置的每页显示的标签数量，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '时间间隔。', 'description' => '时间间隔，单位为分钟。', 'type' => 'string', 'required' => false, 'example' => '5m', 'default' => '5m'],
],
],
'responses' => [
@@ -5136,91 +2811,14 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- 'Tags' => [
- 'title' => '标签列表。',
- 'description' => '标签列表。',
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'required' => true, 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ 'Metrics' => [
+ 'title' => '监控指标信息列表。',
+ 'description' => '监控指标信息列表。',
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'UserId' => [
- 'title' => '标签的创建者的Uid，在阿里云内为子账号Id （主账号创建则直接为主账号Id）。',
- 'description' => '标签的创建者的Uid，在阿里云内为RAM用户ID（阿里云账号创建则直接为阿里云账号ID）。',
- 'type' => 'string',
- 'example' => '276065346797410278',
- ],
- 'OwnerId' => [
- 'title' => '标签的资源拥有者的Uid，在阿里云内为主账号Id 。',
- 'description' => '标签的资源拥有者的Uid，在阿里云内为阿里云账号ID。',
- 'type' => 'string',
- 'example' => '1557702098194904',
- ],
- 'GmtCreateTime' => [
- 'title' => '标签创建的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '标签创建的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '标签最后更新的时间。格式使用 ISO8601(RFC3339)。',
- 'description' => '标签最后更新的时间。格式使用ISO8601（RFC3339）。',
- 'type' => 'string',
- 'example' => '2014-10-02T15:01:23Z',
- ],
- 'ResourceType' => [
- 'title' => '标签所属的资源的类型。'."\n"
- .'Instance：数据集加速实例'."\n"
- .'Slot：数据集加速槽',
- 'description' => '标签所属的资源的类型，可能值：'."\n"
- .'- Instance：数据集加速实例。'."\n"
- .'- Slot：数据集加速槽。',
- 'type' => 'string',
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Slot',
- ],
- ],
- 'ResourceId' => [
- 'title' => '标签所属的资源的Id。',
- 'description' => '标签所属的资源的ID。',
- 'type' => 'string',
- 'example' => 'inst-my1tk3jggooi5uwks',
- ],
- 'Key' => [
- 'title' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的键值。'."\n"
- .'长度限制为64 Unicode字符。',
- 'type' => 'string',
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
- 'Value' => [
- 'title' => '标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的值。'."\n"
- .'长度限制为64 Unicode字符。',
- 'type' => 'string',
- 'example' => 'v0.1.0',
- 'maxLength' => 64,
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'title' => '列表内元素数量总和。',
- 'description' => '列表内元素数量总和。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
+ 'items' => ['description' => 'Metric信息。', '$ref' => '#/components/schemas/Metric'],
],
+ 'Period' => ['title' => '时间间隔。', 'description' => '时间间隔。', 'type' => 'string', 'example' => '60s'],
],
],
],
@@ -5228,115 +2826,77 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"Tags\\": [\\n {\\n \\"UserId\\": \\"276065346797410278\\",\\n \\"OwnerId\\": \\"1557702098194904\\",\\n \\"GmtCreateTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"GmtModifiedTime\\": \\"2014-10-02T15:01:23Z\\",\\n \\"ResourceType\\": \\"Instance\\",\\n \\"ResourceId\\": \\"inst-my1tk3jggooi5uwks\\",\\n \\"Key\\": \\"dataset_version\\",\\n \\"Value\\": \\"v0.1.0\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
- 'title' => '获取标签列表',
- 'description' => '请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
+ 'title' => '获取加速槽监控指标',
+ 'summary' => '查询并获取数据集加速槽监控指标信息。',
+ 'description' => '- 请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。'."\n"
+ .'- 在查询时，管控层会将SlotId默认加入到筛选条件中，因此需要监控指标采集时关联到SlotId上，方可被查询出来。',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-14T03:16:27.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-10-28T02:58:35.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySlotMetrics'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"1655897743\\",\\n \\"Value\\": 98.35\\n }\\n ],\\n \\"Period\\": \\"60s\\"\\n}","type":"json"}]',
],
'QueryStatistic' => [
- 'summary' => '查询当前账号下数据集加速相关的统计信息。',
'path' => '/api/v1/statistics/action/query',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'tags' => [
- 'Statistic',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Statistic'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Fields',
'in' => 'query',
- 'schema' => [
- 'title' => '需要查询的统计信息类型，以逗号分割。'."\n"
- .'InstanceTypeCapacity：每个数据集加速实例类别所对应的总容量占比。'."\n"
- .'InstanceTypeNum：每个数据集加速实例类别的数量。'."\n"
- .'SlotTypeNum：每个数据集加速槽类别的数量。',
- 'description' => '需要查询的统计信息类型，以半角逗号（,）分隔。'."\n"
- .'- InstanceCapacityEachType：每个数据集加速实例类别所对应的总容量占比。'."\n"
- .'- InstanceNumEachType：每个数据集加速实例类别的数量。'."\n"
- .'- SlotNumEachType：每个数据集加速槽类别的数量。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'InstanceCapacityEachType',
- 'default' => 'InstanceCapacityEachType',
- ],
+ 'schema' => ['title' => '需要查询的统计信息类型，以逗号分割。'."\n"
+ .'InstanceTypeCapacity：每个数据集加速实例类别所对应的总容量占比。'."\n"
+ .'InstanceTypeNum：每个数据集加速实例类别的数量。'."\n"
+ .'SlotTypeNum：每个数据集加速槽类别的数量。', 'description' => '需要查询的统计信息类型，以半角逗号（,）分隔。'."\n"
+ .'- InstanceCapacityEachType：每个数据集加速实例类别所对应的总容量占比。'."\n"
+ .'- InstanceNumEachType：每个数据集加速实例类别的数量。'."\n"
+ .'- SlotNumEachType：每个数据集加速槽类别的数量。', 'type' => 'string', 'required' => false, 'example' => 'InstanceCapacityEachType', 'default' => 'InstanceCapacityEachType'],
],
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'title' => '起始时间.默认是1小时前。',
- 'description' => '起始时间，默认是1小时前。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-11-08T15:00:00Z',
- ],
+ 'schema' => ['title' => '起始时间.默认是1小时前。', 'description' => '起始时间，默认是1小时前。', 'type' => 'string', 'required' => false, 'example' => '2020-11-08T15:00:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'title' => '截止时间.默认是当前。',
- 'description' => '截止时间，默认是当前时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-11-08T16:00:00Z',
- ],
+ 'schema' => ['title' => '截止时间.默认是当前。', 'description' => '截止时间，默认是当前时间。', 'type' => 'string', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
],
'responses' => [
@@ -5345,42 +2905,24 @@
'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
'InstanceCapacityEachType' => [
'title' => '每个数据集加速实例类别所对应的总容量占比，Map中的Key包含所有数据集加速实例的类别。',
'description' => '每个数据集加速实例类别所对应的总容量占比，Map中的Key包含所有数据集加速实例的类别。',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '每个数据集加速实例类别所对应的总容量占比信息。',
- 'example' => '{\'basic\': {\'Usage\': \'0\', \'Total\': \'10T\'}, \'enhanced\': {\'Usage\': \'0\', \'Total\': \'900G\'}}',
- ],
+ 'additionalProperties' => ['type' => 'any', 'description' => '每个数据集加速实例类别所对应的总容量占比信息。', 'example' => '{\'basic\': {\'Usage\': \'0\', \'Total\': \'10T\'}, \'enhanced\': {\'Usage\': \'0\', \'Total\': \'900G\'}}'],
],
'InstanceNumEachType' => [
'title' => '每个数据集加速实例类别的数量，Map中的Key包含所有数据集加速实例的类别。',
'description' => '每个数据集加速实例类别的数量，Map中的Key包含所有数据集加速实例的类别。',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '每个数据集加速实例类别的数量信息。',
- 'example' => '{\'basic\': {\'Value\': 1}, \'enhanced\': {\'Value\': 5}}',
- ],
+ 'additionalProperties' => ['type' => 'any', 'description' => '每个数据集加速实例类别的数量信息。', 'example' => '{\'basic\': {\'Value\': 1}, \'enhanced\': {\'Value\': 5}}'],
],
'SlotNumEachType' => [
'title' => '每个数据集加速槽类别的数量，Map中的Key包含所有数据集加速槽的类别。',
'description' => '每个数据集加速槽类别的数量，Map中的Key包含所有数据集加速槽的类别。',
'type' => 'object',
- 'additionalProperties' => [
- 'title' => '每个数据集加速槽类别的数量，Map中的Key包含所有数据集加速槽的类别。',
- 'description' => '每个数据集加速槽类别的数量的信息。',
- 'type' => 'any',
- 'example' => '{\'OSS\': {\'Value\': 13}}',
- ],
+ 'additionalProperties' => ['title' => '每个数据集加速槽类别的数量，Map中的Key包含所有数据集加速槽的类别。', 'description' => '每个数据集加速槽类别的数量的信息。', 'type' => 'any', 'example' => '{\'OSS\': {\'Value\': 13}}'],
],
],
],
@@ -5389,100 +2931,133 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"InstanceCapacityEachType\\": {\\n \\"key\\": \\"{\'basic\': {\'Usage\': \'0\', \'Total\': \'10T\'}, \'enhanced\': {\'Usage\': \'0\', \'Total\': \'900G\'}}\\"\\n },\\n \\"InstanceNumEachType\\": {\\n \\"key\\": \\"{\'basic\': {\'Value\': 1}, \'enhanced\': {\'Value\': 5}}\\"\\n },\\n \\"SlotNumEachType\\": {\\n \\"key\\": \\"{\'OSS\': {\'Value\': 13}}\\"\\n }\\n}","type":"json"}]',
'title' => '查询统计信息',
+ 'summary' => '查询当前账号下数据集加速相关的统计信息。',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-30T04:12:44.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-09-21T08:51:04.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStatistic'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"InstanceCapacityEachType\\": {\\n \\"key\\": \\"{\'basic\': {\'Usage\': \'0\', \'Total\': \'10T\'}, \'enhanced\': {\'Usage\': \'0\', \'Total\': \'900G\'}}\\"\\n },\\n \\"InstanceNumEachType\\": {\\n \\"key\\": \\"{\'basic\': {\'Value\': 1}, \'enhanced\': {\'Value\': 5}}\\"\\n },\\n \\"SlotNumEachType\\": {\\n \\"key\\": \\"{\'OSS\': {\'Value\': 13}}\\"\\n }\\n}","type":"json"}]',
],
'ReloadSlot' => [
- 'summary' => '重载数据加速槽的数据。',
'path' => '/api/v1/slots/{SlotId}/action/reload',
- 'methods' => [
- 'post',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Slot'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'SlotId',
+ 'in' => 'path',
+ 'schema' => ['title' => '数据集加速槽Id。', 'description' => '数据集加速槽Id。如何获取数据集加速槽Id，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'slot-my1tk3jggooi5uwks5'],
+ ],
],
- 'tags' => [
- 'Slot',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
+ 'Detail' => [
+ 'title' => '错误详细信息。',
+ 'description' => '错误详细信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
+ ],
+ 'example' => '-',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
],
+ 'title' => '重载加速槽',
+ 'summary' => '重载数据加速槽的数据。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReloadSlot'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
+ ],
+ 'StopSlot' => [
+ 'path' => '/api/v1/slots/{SlotId}/action/stop',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Slot'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'SlotId',
'in' => 'path',
- 'schema' => [
- 'title' => '数据集加速槽Id。',
- 'description' => '数据集加速槽Id。如何获取数据集加速槽Id，请参见[ListSlots](~~467905~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'slot-my1tk3jggooi5uwks5',
- ],
+ 'schema' => ['title' => '数据集加速槽Id。', 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'slot-my1tk3jggooi5uwks5'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
+ 'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
],
],
],
@@ -5490,220 +3065,272 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
+ 'title' => '停止数据集加速槽',
+ 'summary' => '停止一个数据集加速槽。',
+ 'description' => '- 该接口为异步接口，请求后会直接返回，返回结果代表请求操作是否成功。数据集加速槽的停止状态需要后续由 DescribeSlot 接口具体获取。'."\n"
+ .'- 调用StopSlot接口后，无法再恢复或重启，缓存资源将被删除。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopSlot'],
+ ],
+ ],
+ 'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
- 'title' => '重载加速槽',
],
- 'CreateSlots' => [
- 'summary' => '批量创建数据集加速槽。',
- 'path' => '/api/v1/batch/slots/create',
- 'methods' => [
- 'post',
+ 'UnbindEndpoint' => [
+ 'path' => '/api/v1/endpoints/{EndpointId}/slots/{SlotId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Endpoint', 'Slot'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'EndpointId',
+ 'in' => 'path',
+ 'schema' => ['title' => '数据集加速槽挂载点Id。', 'description' => '数据集加速槽挂载点ID。如何获取挂载点ID，请参见[ListEndpoints](~~467913~~)。', 'type' => 'string', 'required' => true, 'example' => 'end-my1tk3jggooi5uwks5'],
+ ],
+ [
+ 'name' => 'SlotId',
+ 'in' => 'path',
+ 'schema' => ['title' => '数据集加速槽Id。', 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'slot-my1tk3jggooi5uwks5'],
+ ],
],
- 'tags' => [
- 'Slot',
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'description' => '返回值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
+ 'Detail' => [
+ 'title' => '错误详细信息。',
+ 'description' => '错误详细信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
+ ],
+ 'example' => '-',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
],
+ 'title' => '取消关联数据集加速端点',
+ 'summary' => '取消挂载点关联和指定数据集加速槽的关联关系。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindEndpoint'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateInstance' => [
+ 'path' => '/api/v1/instances/{InstanceId}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Instance'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '数据集加速实例Id。', 'description' => '数据集加速实例ID。如何获取加速实例ID，请参见[ListInstances](~~467899~~)。', 'type' => 'string', 'required' => true, 'example' => 'inst-my1tk3jggooi5uwks5'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '数据集加速实例名称。'."\n"
+ .'长度限制为64 Unicode 字符。'."\n"
+ .'如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。', 'description' => '数据集加速实例名称，格式为：'."\n"
+ .'- 长度限制为64Unicode字符。'."\n"
+ .'- 如果传入值为空（包含空字符串），系统会使用Uuid字段的值作为默认名称。', 'type' => 'string', 'required' => false, 'example' => 'acc_instance_1', 'maxLength' => 64],
+ 'Description' => ['title' => '数据集加速实例的描述与解释。'."\n"
+ .'长度限制为1024 Unicode 字符。', 'description' => '数据集加速实例的描述与解释。'."\n"
+ .'长度限制为1024Unicode字符。', 'type' => 'string', 'required' => false, 'example' => 'XGBoost dataset acceleration instance', 'maxLength' => 1024],
+ 'MaxSlot' => ['title' => '数据集加速实例的最大加速槽个数。', 'description' => '数据集加速实例的最大加速槽个数。', 'type' => 'string', 'required' => false, 'example' => '20', 'default' => '20'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '返回值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
+ 'Detail' => [
+ 'title' => '错误详细信息。',
+ 'description' => '错误详细信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
+ ],
+ 'example' => '-',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '更新数据集加速实例',
+ 'summary' => '更新一个数据集加速实例的信息。',
+ 'description' => '注意此接口为全量更新。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:18.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'],
+ ],
],
- 'produces' => [
- 'application/json',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateSlot' => [
+ 'path' => '/api/v1/slots/{SlotId}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'tags' => ['Slot'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
+ 'name' => 'SlotId',
+ 'in' => 'path',
+ 'schema' => ['title' => '数据集加速槽Id。', 'description' => '数据集加速槽ID。如何获取数据集加速槽ID，请参见[ListSlots](~~467905~~)。', 'type' => 'string', 'required' => true, 'example' => 'slot-my1tk3jggooi5uwks5'],
+ ],
+ [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求参数。',
+ 'description' => '请求体参数。',
'type' => 'object',
'properties' => [
- 'Slots' => [
- 'description' => '数据集加速槽列表。',
+ 'Name' => ['title' => '数据集加速槽名称。'."\n"
+ .'长度限制为64 Unicode 字符。', 'description' => '数据集加速槽名称。'."\n"
+ .'长度限制为64个字符。', 'type' => 'string', 'required' => false, 'example' => 'slot_1', 'maxLength' => 64],
+ 'Description' => ['title' => '数据集加速槽的描述与解释。'."\n"
+ .'长度限制为1024 Unicode 字符。', 'description' => '数据集加速槽的描述与解释。'."\n"
+ .'长度限制为1024个字符。', 'type' => 'string', 'required' => false, 'example' => 'XGBoost dataset acceleration slot', 'maxLength' => 1024],
+ 'Tags' => [
+ 'title' => '用户为数据集加速槽添加的自定义标签。',
+ 'description' => '用户为数据集加速槽添加的自定义标签。',
'type' => 'array',
'items' => [
- 'description' => '数据集加速槽。',
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'title' => '数据集加速槽所对应的数据集加速实例的唯一标识符。',
- 'description' => '数据集加速槽所对应的数据集加速实例的唯一标识符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'inst-my1tk3jggooi5u****',
- ],
- 'Name' => [
- 'title' => '数据集加速槽名称。'."\n"
- .'长度限制为64 Unicode 字符。',
- 'description' => '数据集加速槽名称。'."\n"
- .'长度限制为64 Unicode 字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'slot_1',
- 'maxLength' => 64,
- ],
- 'Description' => [
- 'title' => '数据集加速槽的描述与解释。'."\n"
- .'长度限制为1024 Unicode 字符。',
- 'description' => '数据集加速槽的描述与解释。'."\n"
- .'长度限制为1024 Unicode 字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xgboost数据集加速槽',
- 'maxLength' => 1024,
- ],
- 'Tags' => [
- 'title' => '用户为数据集加速槽添加的自定义标签。',
- 'description' => '用户为数据集加速槽添加的自定义标签。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => '标签的键值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dataset_version',
- 'maxLength' => 64,
- ],
- 'Value' => [
- 'title' => 'v0.1.0 标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'description' => 'v0.1.0 标签的值。'."\n"
- .'长度限制为 64 Unicode 字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v0.1.0',
- 'maxLength' => 64,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'LifeCycle' => [
- 'title' => '数据集加速槽的生命周期。',
- 'description' => '数据集加速槽的生命周期。',
- 'required' => false,
- '$ref' => '#/components/schemas/SlotLifeCycle',
- ],
- 'IoType' => [
- 'description' => '数据集加速槽的读写类型。取值如下：'."\n"
- .'- readwrite：可读写。'."\n"
- .'- readonly：只读。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'readonly',
- ],
- 'StorageType' => [
- 'title' => '数据集加速槽的数据存储类型。'."\n"
- .'OSS：OSS文件存储'."\n"
- .'NAS：NAS文件存储',
- 'description' => '数据集加速槽的数据存储类型。'."\n"
- .'OSS：OSS文件存储'."\n"
- .'NAS：NAS文件存储',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OSS',
- 'enum' => [
- 'OSS',
- 'NAS',
- 'CPFS',
- ],
- ],
- 'StorageUri' => [
- 'title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://examplebucket.oss-cn-hangzhou-internal.aliyuncs.com/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt',
- ],
- 'Capacity' => [
- 'title' => '数据集加速槽的最大容量。'."\n"
- .'输入字符串的格式需要满足以下规范：Quantity',
- 'description' => '（必填）数据集加速槽的最大容量。'."\n"
- .'输入字符串的格式需要满足[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/)规范。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '500Gi',
- ],
- 'EndpointIds' => [
- 'title' => '创建数据集加速槽时，同时挂载的数据集加速槽挂载点Id的列表，以逗号分隔。',
- 'description' => '创建数据集加速槽时，同时挂载的数据集加速槽挂载点Id的列表，以逗号分隔。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'end-my1tk3jggooi5***s5,end-n69468yvjz8d12a***,end-tga4omjrepklkg1***',
- ],
+ 'Key' => ['title' => '标签的键值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的键值。'."\n"
+ .'长度限制为64个字符。', 'type' => 'string', 'required' => false, 'example' => 'dataset_version', 'maxLength' => 64],
+ 'Value' => ['title' => 'v0.1.0 标签的值。'."\n"
+ .'长度限制为 64 Unicode 字符。', 'description' => '标签的值。'."\n"
+ .'长度限制为64个字符。', 'type' => 'string', 'required' => false, 'example' => 'v0.1.0', 'maxLength' => 64],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
],
- 'DryRun' => [
- 'description' => '是否对此次创建请求执行预检。'."\n"
- ."\n"
- .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n"
- ."\n"
- .'取值：'."\n"
- ."\n"
- .'- true：发送检查请求，不会创建实例。'."\n"
- ."\n"
- .'- false（默认）：发送正常请求，通过检查后直接创建实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
+ 'StorageType' => [
+ 'title' => '数据集加速槽的数据存储类型。'."\n"
+ .'OSS：OSS文件存储'."\n"
+ .'NAS：NAS文件存储',
+ 'description' => '数据集加速槽的数据存储类型，取值如下：'."\n"
+ .'- OSS：OSS文件存储。'."\n"
+ .'- NAS：NAS文件存储。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OSS',
+ 'enum' => ['OSS', 'NAS'],
],
+ 'StorageUri' => ['title' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'description' => '数据集加速槽的数据的资源标识符，数据类型不同存在不同格式。', 'type' => 'string', 'required' => true, 'example' => 'oss://pai-vision-data-hz2.oss-cn-hangzhou-internal.aliyuncs.com/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt'],
+ 'Capacity' => ['title' => '数据集加速槽的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：Quantity', 'description' => '数据集加速槽的最大容量。'."\n"
+ .'输入字符串的格式需要满足以下规范：[Quantity](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/common-definitions/quantity/) 。', 'type' => 'string', 'required' => true, 'example' => '30.0G'],
+ 'LifeCycle' => ['title' => '数据集加速槽的生命周期。', 'description' => '数据集加速槽的生命周期。', 'required' => false, '$ref' => '#/components/schemas/SlotLifeCycle'],
],
'required' => false,
],
@@ -5711,32 +3338,12 @@
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197',
- ],
- 'SlotIds' => [
- 'title' => '数据集加速槽Id。',
- 'description' => '数据集加速槽ID。',
- 'type' => 'string',
- 'example' => 'slot-5zk866779me51j****',
- ],
- 'Summary' => [
- 'description' => '摘要信息。',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '摘要信息。',
- 'example' => '{\'SlotsTotalSize\': \'0.0Gi\', \'SlotsTotalNum\': \'1\', \'DataSourceTotalSize\': \'0\'}',
- ],
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A731A84D-55C9-44F7-99BB-E1CF0CF19197'],
],
],
],
@@ -5744,65 +3351,238 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '请求Id。',
- 'type' => 'string',
- 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F',
- ],
- 'Code' => [
- 'title' => '语义化错误码。',
- 'description' => '语义化错误码。',
- 'type' => 'string',
- 'example' => 'ValidationError',
- ],
- 'Message' => [
- 'title' => '错误消息描述。',
- 'description' => '错误消息描述。',
- 'type' => 'string',
- 'example' => 'Dataset Not Found: 1234',
- ],
+ 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => '9C5AEC16-CBD1-5E68-A92C-75D1D346E57F'],
+ 'Code' => ['title' => '语义化错误码。', 'description' => '语义化错误码。', 'type' => 'string', 'example' => 'ValidationError'],
+ 'Message' => ['title' => '错误消息描述。', 'description' => '错误消息描述。', 'type' => 'string', 'example' => 'Dataset Not Found: 1234'],
'Detail' => [
'title' => '错误详细信息。',
'description' => '错误详细信息。',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '数字化错误码。',
- 'description' => '数字化错误码。',
- 'type' => 'string',
- 'example' => '5218847334401572965',
- ],
+ 'ErrorCode' => ['title' => '数字化错误码。', 'description' => '数字化错误码。', 'type' => 'string', 'example' => '5218847334401572965'],
],
'example' => '-',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '更新数据集加速槽',
+ 'summary' => '更新一个数据集加速槽的信息。',
+ 'description' => '注意接口为全量更新，除了只读字段外，其余字段都更新为传入值。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-09-13T09:10:12.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSlot'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\",\\n \\"SlotIds\\": \\"slot-5zk866779me51j****\\",\\n \\"Summary\\": {\\n \\"key\\": \\"{\'SlotsTotalSize\': \'0.0Gi\', \'SlotsTotalNum\': \'1\', \'DataSourceTotalSize\': \'0\'}\\"\\n }\\n}","type":"json"}]',
- 'title' => '批量创建加速槽',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A731A84D-55C9-44F7-99BB-E1CF0CF19197\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paidatasetacc.cn-beijing.aliyuncs.com', 'endpoint' => 'paidatasetacc.cn-beijing.aliyuncs.com', 'vpc' => 'paidatasetacc-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paidatasetacc.cn-hangzhou.aliyuncs.com', 'endpoint' => 'paidatasetacc.cn-hangzhou.aliyuncs.com', 'vpc' => 'paidatasetacc-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paidatasetacc.cn-shanghai.aliyuncs.com', 'endpoint' => 'paidatasetacc.cn-shanghai.aliyuncs.com', 'vpc' => 'paidatasetacc-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paidatasetacc.cn-shenzhen.aliyuncs.com', 'endpoint' => 'paidatasetacc.cn-shenzhen.aliyuncs.com', 'vpc' => 'paidatasetacc-vpc.cn-shenzhen.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'BadRequestError', 'message' => 'Bad request', 'http_code' => 400, 'description' => '用户请求错误，请按照错误信息中的提示修改请求信息。'],
+ ['code' => 'EcsAuthorizeSecurityGroupEgressError', 'message' => 'Ecs authorize securityGroup egress failed', 'http_code' => 400, 'description' => '授权ECS安全组出规则失败，请检查ECS安全组授权出规则接口是否正常，并联系管理员进行排查。'],
+ ['code' => 'EcsAuthorizeSecurityGroupError', 'message' => 'Ecs authorize securityGroup ingress failed', 'http_code' => 400, 'description' => '授权ECS安全组入规则失败，请检查ECS安全组授权入规则接口是否正常，并联系管理员进行排查。'],
+ ['code' => 'EcsCreateSecurityGroupError', 'message' => 'Ecs create security group failed', 'http_code' => 400, 'description' => '创建ECS安全组失败，请检查ECS安全组创建接口是否正常，并联系管理员进行排查。'],
+ ['code' => 'EcsDeleteSecurityGroupError', 'message' => 'Ecs delete security group failed', 'http_code' => 400, 'description' => '删除ECS安全组失败，请检查ECS安全组删除接口是否正常，并联系管理员进行排查。'],
+ ['code' => 'EcsDescribeSecurityGroupsError', 'message' => 'Ecs describe security group failed', 'http_code' => 400, 'description' => '查询ECS安全组信息失败，请检查ECS安全组查询信息接口是否正常，并联系管理员进行排查。'],
+ ['code' => 'InternalServerError', 'message' => 'Unexpected error occur when processing this request, please try again later.', 'http_code' => 500, 'description' => '服务内部错误，请将该错误信息发送给管理员进行排查。'],
+ ['code' => 'InvalidParameterError', 'message' => 'Invalid parameter', 'http_code' => 400, 'description' => '请求参数错误，请按照错误信息中的提示修改请求参数。'],
+ ['code' => 'JsonMarshalError', 'message' => 'Json marshal failed', 'http_code' => 400, 'description' => '请求Json序列化错误，请检查请求结构体格式是否正确。'],
+ ['code' => 'JsonUnmarshalError', 'message' => 'Json unmarshal failed', 'http_code' => 400, 'description' => '请求Json反序列化错误，请检查请求结构体格式是否正确。'],
+ ['code' => 'NoPermissionError', 'message' => 'No permission for this action', 'http_code' => 403, 'description' => '无权限进行此操作，请联系主账号或管理员。'],
+ ['code' => 'NotFoundError', 'message' => 'Object not found', 'http_code' => 404, 'description' => '请求的对象不存在，请检查请求参数是否正确，或对象是否存在。'],
+ ['code' => 'QuantityParseError', 'message' => 'Quantity parsed failed', 'http_code' => 400, 'description' => '请求参数中的资源量解析错误，请检查该参数是否满足Quantity规范。'],
+ ['code' => 'RamRoleNotExistsError', 'message' => 'Ram role not exist', 'http_code' => 400, 'description' => 'RAM角色不存在，请检查RAM角色是否存在。'],
+ ['code' => 'SlotCapacityExceedQuotaError', 'message' => 'Slot capacity allocation exceeds instance quota', 'http_code' => 400, 'description' => '数据集加速槽申请后的总容量超过了所属的数据集加速实例的容量上限。'],
+ ['code' => 'SlotNotInFinalStateError', 'message' => 'Slot is not in final state', 'http_code' => 400, 'description' => '数据集加速槽未处于终态，请检查该数据集加速槽的状态，需要处于终态才可以进行当前操作。'],
+ ['code' => 'SlotNumExceedQuotaError', 'message' => 'Slot exceeds instance max slot num', 'http_code' => 400, 'description' => '数据集加速槽数量超过了所属数据集加速实例定义的最大数量。'],
+ ['code' => 'StsAssumeRoleError', 'message' => 'Sts assume role failed', 'http_code' => 400, 'description' => '服务扮演角色失败，请检查授权角色是否存在且具备正确权限。'],
+ ['code' => 'UpstreamServiceError', 'message' => 'Upstream service failed', 'http_code' => 400, 'description' => '上游依赖的服务失败，请参考错误信息检查上游服务是否可用。'],
+ ['code' => 'UserNotExistsError', 'message' => 'User not exist with userId', 'http_code' => 400, 'description' => '用户不存在，查询不到发起请求的用户，请检查请求头是否正确并联系管理员排查。'],
+ ['code' => 'VpcDescribeInfoError', 'message' => 'Vpc describe info failed', 'http_code' => 400, 'description' => '查询VPC信息失败，请检查VPC查询信息接口是否正常，并联系管理员进行排查。'],
+ ['code' => 'ZoneIDNotInWhiteListError', 'message' => 'ZoneID is not in white list', 'http_code' => 400, 'description' => '可用区不在白名单范围内，服务在不同地区仅提供指定可用区的资源。'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateSlot'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateSlots'],
+ ],
+ 'createdAt' => '2024-02-26T07:51:11.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribeInstance'],
+ ['description' => '响应参数发生变更', 'api' => 'ListInstances'],
+ ],
+ 'createdAt' => '2023-05-22T12:08:49.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateInstance'],
+ ['description' => '响应参数发生变更', 'api' => 'DescribeInstance'],
+ ['description' => '响应参数发生变更', 'api' => 'ListInstances'],
+ ],
+ 'createdAt' => '2023-05-22T12:06:07.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribeSlot'],
+ ['description' => '响应参数发生变更', 'api' => 'ListSlots'],
+ ],
+ 'createdAt' => '2023-05-22T11:41:13.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'paidatasetacc.cn-beijing.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateEndpoint'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListEndpoints'],
+ ['description' => '请求参数发生变更', 'api' => 'ListSlots'],
+ ],
+ 'createdAt' => '2023-05-22T06:42:22.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'paidatasetacc.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateEndpoint'],
+ ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'CreateSlot'],
+ ['description' => '请求参数发生变更', 'api' => 'DeleteSlot'],
+ ],
+ 'createdAt' => '2023-01-03T13:27:32.000Z',
+ 'description' => '创建加速槽返回增加挂载点ID信息。支持创建内部类型挂载点。',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'paidatasetacc.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'QueryStatistic'],
+ ],
+ 'createdAt' => '2022-11-30T04:13:57.000Z',
+ 'description' => '增加说明。',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'paidatasetacc.cn-shenzhen.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'QueryInstanceMetrics'],
+ ['description' => '请求参数发生变更', 'api' => 'QuerySlotMetrics'],
+ ],
+ 'createdAt' => '2022-11-14T03:17:49.000Z',
+ 'description' => '更新Metric相关API',
],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'QueryInstanceMetrics'],
+ ['description' => '请求参数发生变更', 'api' => 'QuerySlotMetrics'],
+ ],
+ 'createdAt' => '2022-10-28T02:59:05.000Z',
+ 'description' => '增加查询指标',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateInstance'],
+ ['description' => '响应参数发生变更', 'api' => 'DescribeInstance'],
+ ['description' => '请求参数发生变更', 'api' => 'ListInstances'],
+ ],
+ 'createdAt' => '2022-10-14T08:37:54.000Z',
+ 'description' => '更新加速实例枚举值',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'CreateEndpoint'],
+ ],
+ 'createdAt' => '2022-09-22T06:16:28.000Z',
+ 'description' => '增加资源类型',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribeComponent'],
+ ['description' => '响应参数发生变更', 'api' => 'ListComponents'],
+ ],
+ 'createdAt' => '2022-09-21T12:59:30.000Z',
+ 'description' => '增加Uuid返回参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'BindEndpoint'],
+ ['description' => 'OpenAPI 下线', 'api' => 'BindEndpoint'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateEndpoint'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateEndpoint'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateInstance'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateInstance'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateSlot'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateSlot'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateTag'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateTag'],
+ ],
+ 'createdAt' => '2022-09-13T09:11:10.000Z',
+ 'description' => 'API更新',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateInstance'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListInstances'],
+ ],
+ 'createdAt' => '2022-08-13T16:52:58.000Z',
+ 'description' => '新增API',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateEndpoint'],
+ ],
+ 'createdAt' => '2022-08-12T07:23:43.000Z',
+ 'description' => 'CreateEndpoint初始化发布',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryInstanceMetrics'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindEndpoint'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTag'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlot'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopSlot'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReloadSlot'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindEndpoint'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSlot'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSlot'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSlots'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEndpoint'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySlotMetrics'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListComponents'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTag'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStatistic'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEndpoint'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSlots'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSlot'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponent'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEndpoint'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEndpoints'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTags'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'PAI',
+ 'productName' => '人工智能平台 PAI',
+ 'ramCodes' => ['paiplugin', 'eas', 'pai', 'datasetacc', 'featurestore', 'paidlc', 'paiitag', 'paidesigner', 'paitraining', 'paiartlab', 'paicomponentmanagement'],
+ 'ramLevel' => '服务级',
+ 'ramConditions' => [],
+ 'ramActions' => [],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:52:44 +0000