summaryrefslogtreecommitdiff
path: root/data/zh_cn/paiplugin
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/paiplugin
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/paiplugin')
-rw-r--r--data/zh_cn/paiplugin/2021-03-19/api-docs.php506
-rw-r--r--data/zh_cn/paiplugin/2021-03-24/api-docs.php510
-rw-r--r--data/zh_cn/paiplugin/2021-03-25/api-docs.php938
-rw-r--r--data/zh_cn/paiplugin/2022-01-12/api-docs.php8803
4 files changed, 2521 insertions, 8236 deletions
diff --git a/data/zh_cn/paiplugin/2021-03-19/api-docs.php b/data/zh_cn/paiplugin/2021-03-19/api-docs.php
deleted file mode 100644
index 00bb06a..0000000
--- a/data/zh_cn/paiplugin/2021-03-19/api-docs.php
+++ /dev/null
@@ -1,506 +0,0 @@
-<?php return [
- 'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'PaiPlugin',
- 'version' => '2021-03-19',
- ],
- 'directories' => [
- [
- 'id' => 0,
- 'title' => '其它',
- 'type' => 'directory',
- 'children' => [
- 'ListSchedules',
- 'ListTemplates',
- 'GetVersion',
- 'ListSignatures',
- 'GetHealth',
- ],
- ],
- ],
- 'components' => [
- 'schemas' => [],
- ],
- 'apis' => [
- 'ListSchedules' => [
- 'summary' => 'ListSchedules',
- 'path' => '/api/v1/schedules',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '发送计划名称，用于检查是否重复',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '成功',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'ID' => [
- 'title' => 'ID UUID',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '发送计划名称',
- 'type' => 'string',
- 'example' => '20200101发送',
- ],
- 'SendTime' => [
- 'title' => '发布时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'title' => '失败,原因见errmsg',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- 'ListTemplates' => [
- 'summary' => 'ListTemplates',
- 'path' => '/api/v1/templates',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板名称，用于检查模板唯一性',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '成功',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'ID' => [
- 'title' => 'ID UUID',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '签名名称',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- 'Status' => [
- 'title' => '审核状态'."\n"
- .'- 0 : Reviewing'."\n"
- .'- 1 : Passed'."\n"
- .'- 2 : Rejected',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TemplateCode' => [
- 'title' => '模板Code',
- 'type' => 'string',
- 'example' => 'SMS_123456',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'title' => '失败,原因见errmsg',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- 'GetVersion' => [
- 'summary' => 'GetVersion',
- 'path' => '/api/v1/version',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '1.0',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- 'ListSignatures' => [
- 'summary' => 'ListSignatures',
- 'path' => '/api/v1/signatures',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '签名名称，用于检查签名唯一性',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '成功',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'ID' => [
- 'title' => 'ID UUID',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '签名名称',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- 'Status' => [
- 'title' => '审核状态'."\n"
- .'- 0 : Reviewing'."\n"
- .'- 1 : Passed'."\n"
- .'- 2 : Rejected',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'title' => '失败,原因见errmsg',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- 'GetHealth' => [
- 'summary' => 'GetHealth',
- 'path' => '/api/v1/',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'alive',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'paiplugin.cn-hangzhou.aliyuncs.com',
- ],
- ],
-];
diff --git a/data/zh_cn/paiplugin/2021-03-24/api-docs.php b/data/zh_cn/paiplugin/2021-03-24/api-docs.php
deleted file mode 100644
index 60343c1..0000000
--- a/data/zh_cn/paiplugin/2021-03-24/api-docs.php
+++ /dev/null
@@ -1,510 +0,0 @@
-<?php return [
- 'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'PaiPlugin',
- 'version' => '2021-03-24',
- ],
- 'directories' => [
- [
- 'id' => 0,
- 'title' => '其它',
- 'type' => 'directory',
- 'children' => [
- 'GetHealth',
- 'ListSchedules',
- 'ListTemplates',
- 'ListSignatures',
- 'GetVersion',
- ],
- ],
- ],
- 'components' => [
- 'schemas' => [],
- ],
- 'apis' => [
- 'GetHealth' => [
- 'summary' => 'GetHealth',
- 'path' => '/api/v1/',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'alive',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- 'ListSchedules' => [
- 'summary' => 'ListSchedules',
- 'path' => '/api/v1/schedules',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '发送计划名称，用于检查是否重复',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '成功',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'ID' => [
- 'title' => 'ID UUID',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '发送计划名称',
- 'type' => 'string',
- 'example' => '20200101发送',
- ],
- 'SendTime' => [
- 'title' => '发布时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'title' => '失败,原因见errmsg',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- 'ListTemplates' => [
- 'summary' => 'ListTemplates',
- 'path' => '/api/v1/templates',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板名称，用于检查模板唯一性',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '成功',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'ID' => [
- 'title' => 'ID UUID',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '签名名称',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- 'Status' => [
- 'title' => '审核状态'."\n"
- .'- 0 : Reviewing'."\n"
- .'- 1 : Passed'."\n"
- .'- 2 : Rejected',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TemplateCode' => [
- 'title' => '模板Code',
- 'type' => 'string',
- 'example' => 'SMS_123456',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'title' => '失败,原因见errmsg',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- 'ListSignatures' => [
- 'summary' => 'ListSignatures',
- 'path' => '/api/v1/signatures',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '签名名称，用于检查签名唯一性',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '成功',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'ID' => [
- 'title' => 'ID UUID',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '签名名称',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- 'Status' => [
- 'title' => '审核状态'."\n"
- .'- 0 : Reviewing'."\n"
- .'- 1 : Passed'."\n"
- .'- 2 : Rejected',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC)',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'title' => '失败,原因见errmsg',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- 'GetVersion' => [
- 'summary' => 'GetVersion',
- 'path' => '/api/v1/version',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '1.0',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'paiplugin.cn-hangzhou.aliyuncs.com',
- ],
- ],
-];
diff --git a/data/zh_cn/paiplugin/2021-03-25/api-docs.php b/data/zh_cn/paiplugin/2021-03-25/api-docs.php
deleted file mode 100644
index 04bade7..0000000
--- a/data/zh_cn/paiplugin/2021-03-25/api-docs.php
+++ /dev/null
@@ -1,938 +0,0 @@
-<?php return [
- 'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'PaiPlugin',
- 'version' => '2021-03-25',
- ],
- 'directories' => [
- [
- 'id' => 0,
- 'title' => '其它',
- 'type' => 'directory',
- 'children' => [
- 'CreateSchedule',
- 'CreateSignature',
- 'DeleteSchedule',
- 'CreateTemplate',
- 'DeleteSignature',
- 'DeleteTemplate',
- 'GetSignature',
- 'GetTemplate',
- 'ListSchedules',
- 'ListTemplates',
- 'ListSignatures',
- 'UploadMediaByURL',
- ],
- ],
- ],
- 'components' => [
- 'schemas' => [],
- ],
- 'apis' => [
- 'CreateSchedule' => [
- 'path' => '/api/v1/schedules',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'body',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'UpdatedTime' => [
- 'type' => 'string',
- ],
- 'TemplateID' => [
- 'type' => 'string',
- ],
- 'SignatureID' => [
- 'type' => 'string',
- ],
- 'SendTime' => [
- 'type' => 'string',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'type' => 'string',
- ],
- 'ID' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'CreateSignature' => [
- 'path' => '/api/v1/signatures',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'body',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'UpdatedTime' => [
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'type' => 'string',
- ],
- 'ID' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'DeleteSchedule' => [
- 'path' => '/api/v1/schedules/{ID}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'ID',
- 'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'CreateTemplate' => [
- 'path' => '/api/v1/templates',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'body',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'TemplateCode' => [
- 'type' => 'string',
- ],
- 'UpdatedTime' => [
- 'type' => 'string',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'Content' => [
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'type' => 'string',
- ],
- 'ID' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'DeleteSignature' => [
- 'path' => '/api/v1/signatures/{ID}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'ID',
- 'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'DeleteTemplate' => [
- 'path' => '/api/v1/templates/{ID}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'ID',
- 'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'GetSignature' => [
- 'path' => '/api/v1/signatures/{ID}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'ID',
- 'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Certificates' => [
- 'type' => 'string',
- ],
- 'Description' => [
- 'type' => 'string',
- ],
- 'UpdatedTime' => [
- 'type' => 'string',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'type' => 'string',
- ],
- 'Reason' => [
- 'type' => 'string',
- ],
- 'PowerOfAttorney' => [
- 'type' => 'string',
- ],
- 'ID' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'GetTemplate' => [
- 'path' => '/api/v1/templates/{ID}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'ID',
- 'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'TemplateCode' => [
- 'type' => 'string',
- ],
- 'Description' => [
- 'type' => 'string',
- ],
- 'UpdatedTime' => [
- 'type' => 'string',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'type' => 'string',
- ],
- 'Content' => [
- 'type' => 'string',
- ],
- 'Reason' => [
- 'type' => 'string',
- ],
- 'ID' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'ListSchedules' => [
- 'path' => '/api/v1/schedules',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'PageSize' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Schedules' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'UpdatedTime' => [
- 'type' => 'string',
- ],
- 'TemplateID' => [
- 'type' => 'string',
- ],
- 'SignatureID' => [
- 'type' => 'string',
- ],
- 'SendTime' => [
- 'type' => 'string',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'type' => 'string',
- ],
- 'ID' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'ListTemplates' => [
- 'path' => '/api/v1/templates',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'PageSize' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Templates' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'TemplateCode' => [
- 'type' => 'string',
- ],
- 'UpdatedTime' => [
- 'type' => 'string',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'Content' => [
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'type' => 'string',
- ],
- 'ID' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'ListSignatures' => [
- 'path' => '/api/v1/signatures',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'PageSize' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Signatures' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'UpdatedTime' => [
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'type' => 'string',
- ],
- 'ID' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- 'UploadMediaByURL' => [
- 'path' => '/media/api/v1/video/upload',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'parameters' => [
- [
- 'name' => 'object',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'UploadJobs' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SourceURL' => [
- 'type' => 'string',
- ],
- 'JobId' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'paiplugin.cn-hangzhou.aliyuncs.com',
- ],
- ],
-];
diff --git a/data/zh_cn/paiplugin/2022-01-12/api-docs.php b/data/zh_cn/paiplugin/2022-01-12/api-docs.php
index 4dc9e62..5e60c10 100644
--- a/data/zh_cn/paiplugin/2022-01-12/api-docs.php
+++ b/data/zh_cn/paiplugin/2022-01-12/api-docs.php
@@ -1,259 +1,97 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'PaiPlugin',
- 'version' => '2022-01-12',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'PaiPlugin', 'version' => '2022-01-12'],
'directories' => [
[
- 'id' => 157210,
- 'title' => '基本信息',
+ 'children' => ['GetMessageConfig'],
'type' => 'directory',
- 'children' => [
- 'GetUser',
- 'GetMessageConfig',
- ],
+ 'title' => '基本信息',
+ 'id' => 320320,
],
[
- 'id' => 157213,
- 'title' => '短信签名',
+ 'children' => ['CreateSignature', 'DeleteSignature', 'ListSignatures', 'GetSignature'],
'type' => 'directory',
- 'children' => [
- 'CreateSignature',
- 'DeleteSignature',
- 'ListSignatures',
- 'GetSignature',
- ],
+ 'title' => '短信签名',
+ 'id' => 320323,
],
[
- 'id' => 157218,
- 'title' => '短信模板',
+ 'children' => ['DeleteTemplate', 'ListTemplates', 'GetTemplate'],
'type' => 'directory',
- 'children' => [
- 'CreateTemplate',
- 'DeleteTemplate',
- 'ListTemplates',
- 'GetTemplate',
- ],
+ 'title' => '短信模板',
+ 'id' => 320328,
],
[
- 'id' => 157223,
- 'title' => '发送短信',
+ 'children' => ['SendMessage', 'ListMessages', 'ListMessageMetrics'],
'type' => 'directory',
- 'children' => [
- 'SendMessage',
- 'ListMessages',
- 'ListMessageMetrics',
- ],
+ 'title' => '发送短信',
+ 'id' => 320333,
],
[
- 'id' => 167354,
- 'title' => '算法任务',
+ 'children' => ['CreateCampaign', 'DeleteCampaign', 'ListCampaigns', 'GetCampaign', 'UpdateCampaign'],
'type' => 'directory',
- 'children' => [
- 'CreateCampaign',
- 'DeleteCampaign',
- 'ListCampaigns',
- 'GetCampaign',
- 'UpdateCampaign',
- ],
+ 'title' => '算法任务',
+ 'id' => 320337,
],
[
- 'id' => 167360,
- 'title' => '人群管理',
+ 'children' => ['ListAlgorithms', 'GetAlgorithm', 'CreateTrainingJob', 'DeleteTrainingJob', 'ListTrainingJobs', 'GetTrainingJob', 'CreateInferenceJob', 'DeleteInferenceJob', 'ListInferenceJobs', 'GetInferenceJob'],
'type' => 'directory',
- 'children' => [
- 'ListAlgorithms',
- 'GetAlgorithm',
- 'CreateTrainingJob',
- 'DeleteTrainingJob',
- 'ListTrainingJobs',
- 'GetTrainingJob',
- 'CreateInferenceJob',
- 'DeleteInferenceJob',
- 'ListInferenceJobs',
- 'GetInferenceJob',
- ],
+ 'title' => '人群管理',
+ 'id' => 320343,
],
[
- 'id' => 167371,
- 'title' => '发送计划',
+ 'children' => ['CreateSchedule', 'DeleteSchedule', 'ListSchedules', 'GetSchedule', 'CreateGroup', 'CreateTemplate', 'DeleteGroup', 'GetGroup', 'GetUser', 'ListGroups'],
'type' => 'directory',
- 'children' => [
- 'CreateGroup',
- 'DeleteGroup',
- 'ListGroups',
- 'GetGroup',
- ],
- ],
- [
- 'id' => 167376,
'title' => '其他',
- 'type' => 'directory',
- 'children' => [
- 'CreateSchedule',
- 'DeleteSchedule',
- 'ListSchedules',
- 'GetSchedule',
- ],
+ 'id' => 320359,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetUser' => [
- 'summary' => '获取用户产品状态等基本信息。',
- 'path' => '/api/v2/users',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateCampaign' => [
+ 'summary' => '创建运营活动。',
+ 'path' => '/api/v2/campaigns',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '128719',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '131222',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '成功获取账号状态。',
- 'description' => '成功获取基本信息。',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'AccountStatus' => [
- 'title' => '账号状态。'."\n"
- .'- 0 : 正常使用。'."\n"
- .'- 1 : 因欠费等原因暂时停用。'."\n"
- .'- 2 : 已释放产品。',
- 'description' => '账号状态。'."\n"
- .'- 0 : 正常使用。'."\n"
- .'- 1 : 因欠费等原因暂时停用。'."\n"
- .'- 2 : 已释放产品。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
- ],
- ],
- ],
- 400 => [
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'title' => '请求参数的主体信息。',
+ 'description' => '请求参数的主体信息。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Name' => ['title' => '运营活动名称。', 'description' => '运营活动名称。', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'required' => false, 'example' => '双十一活动'],
],
+ 'required' => false,
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"AccountStatus\\": 0\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取基本信息',
- ],
- 'GetMessageConfig' => [
- 'summary' => '获取用户短信配置，如回执接口，上行短信接口等。',
- 'path' => '/api/v2/users/messageConfig',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '129012',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
- ],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取短信配置。',
- 'description' => '成功获取短信配置。',
+ 'title' => '成功创建运营活动。',
+ 'description' => '成功创建运营活动。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -261,39 +99,16 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'SmsReportUrl' => [
- 'title' => '短信发送状态回执接收服务地址。',
- 'description' => '短信发送状态回执接收服务地址。',
- 'type' => 'string',
- 'example' => 'http://example.com',
- ],
- 'SmsUpUrl' => [
- 'title' => '上行短信消息接收服务地址。',
- 'description' => '上行短信消息接收服务地址。',
- 'type' => 'string',
- 'example' => 'http://example.com',
- ],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Id' => ['title' => '运营活动Id。', 'description' => '运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '运营活动名称。', 'description' => '运营活动名称。', 'type' => 'string', 'example' => 'VIP客户'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => '双十一活动'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -303,68 +118,43 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SmsReportUrl\\": \\"http://example.com\\",\\n \\"SmsUpUrl\\": \\"http://example.com\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取短信配置',
- ],
- 'CreateSignature' => [
- 'summary' => '发起注册签名请求，可通过控制台或GetSignature查看签名审核状态。',
- 'path' => '/api/v2/signatures',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '创建运营活动',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'],
+ ],
],
+ ],
+ 'CreateGroup' => [
+ 'summary' => '创建人群。',
+ 'path' => '/api/v2/groups',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123190',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129051',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
@@ -376,20 +166,28 @@
'description' => '请求参数的主体信息。',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'title' => '申请说明。',
- 'description' => '申请说明。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '申请说明',
- ],
- 'Name' => [
- 'title' => '签名名称。',
- 'description' => '签名名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '用户增长',
- ],
+ 'Algorithm' => ['title' => '关联算法，人群来源为算法。', 'description' => '关联算法，人群来源为算法时需指定。', 'type' => 'string', 'required' => false, 'example' => 'user_recall'],
+ 'Column' => ['title' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。', 'description' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。', 'type' => 'string', 'required' => false, 'example' => 'phone'],
+ 'Filter' => ['title' => '过滤条件，人群来源为MaxCompute时可指定。', 'description' => '过滤条件，人群来源为MaxCompute时可指定。', 'type' => 'string', 'required' => false, 'example' => 'ds=20220101'],
+ 'InferenceJobId' => ['title' => '预测任务Id，人群来源为算法。', 'description' => '预测任务ID，人群来源为算法。', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '人群名称。', 'description' => '人群名称。', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'],
+ 'PhoneNumber' => ['title' => '是否包含手机号，包含手机号的人群可用于触达计划。', 'description' => '是否包含手机号，包含手机号的人群可用于触达计划。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Project' => ['title' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。', 'description' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。', 'type' => 'string', 'required' => false, 'example' => 'project'],
+ 'Remark' => ['title' => '人群备注。', 'description' => '人群备注。', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 100,000'],
+ 'Source' => ['title' => '人群来源。'."\n"
+ .'- 0: 文本，每行一个手机号，最多100个。'."\n"
+ .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
+ .'- 4: 算法。', 'description' => '人群来源。'."\n"
+ .'- 0: 文本，每行一个手机号，最多100个。'."\n"
+ .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
+ .'- 4: 算法。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'Table' => ['title' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。', 'description' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。', 'type' => 'string', 'required' => false, 'example' => 'vip_recall'],
+ 'Text' => ['title' => '文本，人群来源为文本时需指定。', 'description' => '文本，人群来源为文本时需指定。', 'type' => 'string', 'required' => false, 'example' => '1390000****'],
+ 'Uri' => ['title' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。', 'description' => '文件地址，人群来源为文本文件，CSV文件时需指定。', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.region.aliyuncs.com/folder/file'],
],
'required' => false,
],
@@ -397,10 +195,9 @@
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => '成功发起注册签名请求，可通过控制台或GetSignature获取审核状态。',
- 'description' => '成功发起注册签名请求，可通过控制台或GetSignature获取审核状态。',
+ 'title' => '成功发起注册人群请求，可通过控制台或GetGroup获取人群检查状态。',
+ 'description' => '成功发起注册人群请求，可通过控制台或GetGroup获取人群检查状态。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -408,307 +205,255 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Id' => [
- 'title' => '签名ID。',
- 'description' => '签名ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '签名名称。',
- 'description' => '签名名称。',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- 'Status' => [
- 'title' => '签名审核状态。'."\n"
- .'- 0：审核中。'."\n"
- .'- 1：审核通过。'."\n"
- .'- 2：审核不通过。',
- 'description' => '签名审核状态。'."\n"
- .'- 0：审核中。'."\n"
- .'- 1：审核通过。'."\n"
- .'- 2：审核不通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
+ 'Algorithm' => ['title' => '关联算法，人群来源为算法。', 'description' => '关联算法，人群来源为算法。', 'type' => 'string', 'example' => 'user_recall'],
+ 'Amount' => ['title' => '人群数量。', 'description' => '人群数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Column' => ['title' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。', 'description' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。', 'type' => 'string', 'example' => 'phone'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Filter' => ['title' => '过滤条件，人群来源为MaxCompute时可指定。', 'description' => '过滤条件，人群来源为MaxCompute时可指定。', 'type' => 'string', 'example' => 'ds=20220101'],
+ 'Id' => ['title' => '人群Id。', 'description' => '人群Id。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'InferenceJobId' => ['title' => '预测任务Id，人群来源为算法。', 'description' => '预测任务Id，人群来源为算法。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '人群名称。', 'description' => '人群名称。', 'type' => 'string', 'example' => 'VIP客户'],
+ 'PhoneNumber' => ['title' => '是否包含手机号，包含手机号的人群可用于触达计划。', 'description' => '是否包含手机号，包含手机号的人群可用于触达计划。', 'type' => 'boolean', 'example' => '1390000****'],
+ 'Project' => ['title' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。', 'description' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。', 'type' => 'string', 'example' => 'project'],
+ 'Remark' => ['title' => '人群备注。', 'description' => '人群备注。', 'type' => 'string', 'example' => '充值大于10万'],
+ 'Source' => ['title' => '人群来源。'."\n"
+ .'- 0: 文本，每行一个手机号，最多100个。'."\n"
+ .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
+ .'- 4: 算法。', 'description' => '人群来源。'."\n"
+ .'- 0: 文本，每行一个手机号，最多100个。'."\n"
+ .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
+ .'- 4: 算法。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Status' => ['title' => '人群状态。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 已通过。'."\n"
+ .'- 2: 未通过。', 'description' => '人群状态。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 已通过。'."\n"
+ .'- 2: 未通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Table' => ['title' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。', 'description' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。', 'type' => 'string', 'example' => 'recall'],
+ 'Text' => ['title' => '文本，人群来源为文本时需指定。', 'description' => '文本，人群来源为文本时需指定。', 'type' => 'string', 'example' => '1390000****'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Uri' => ['title' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。', 'description' => '文件地址，人群来源为文本文件，CSV文件时需指定。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/file'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败,原因见errmsg',
+ 'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '0',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"用户增长\\",\\n \\"Status\\": 0,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"0\\"\\n}","type":"json"}]',
- 'title' => '注册签名',
- ],
- 'DeleteSignature' => [
- 'summary' => '删除签名。',
- 'path' => '/api/v2/signatures/{Id}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"Amount\\": 0,\\n \\"Column\\": \\"phone\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Filter\\": \\"ds=20220101\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"InferenceJobId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"PhoneNumber\\": true,\\n \\"Project\\": \\"project\\",\\n \\"Remark\\": \\"充值大于10万\\",\\n \\"Source\\": 0,\\n \\"Status\\": 0,\\n \\"Table\\": \\"recall\\",\\n \\"Text\\": \\"1390000****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Uri\\": \\"https://bucket.region.aliyuncs.com/folder/file\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '创建人群',
+ 'description' => '在使用前需要在网页端一键授权OSS访问权限，并将需要访问的OSS Bucket添加pai=plugin的标签，请参考[OSS添加标签](https://help.aliyun.com/document_detail/133826.html)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'],
+ ],
],
+ ],
+ 'CreateInferenceJob' => [
+ 'summary' => '创建预测任务。',
+ 'path' => '/api/v2/inference/jobs',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123196',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129052',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'path',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '签名ID，可通过ListSignatures查询账号下的签名列表，获取签名ID。',
- 'description' => '签名ID，可通过ListSignatures查询账号下的签名列表，获取签名ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '996e466b-6808-49c7-998c-47b57bb85dd4',
+ 'title' => '请求参数的主体信息。',
+ 'description' => '请求参数的主体信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Algorithm' => ['title' => '关联算法。', 'description' => '关联算法ID。', 'type' => 'string', 'required' => false, 'example' => 'user_recall'],
+ 'CampaignId' => ['title' => '关联运营活动Id。', 'description' => '关联运营活动ID。', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'DataPath' => ['title' => '预测数据路径。', 'description' => '预测数据路径。', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'Name' => ['title' => '预测任务名称。', 'description' => '预测任务名称。', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'],
+ 'TargetPath' => ['title' => '输出数据路径，需要为空目录。', 'description' => '输出数据路径，需要为空目录。', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'TrainingJobId' => ['title' => '关联训练任务。', 'description' => '关联训练任务。', 'type' => 'string', 'required' => false, 'example' => '123'],
+ 'UserConfig' => ['title' => '用户配置。', 'description' => '用户配置。', 'type' => 'string', 'required' => false, 'example' => '{}'],
+ ],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功删除签名。',
- 'description' => '成功删除签名。',
+ 'title' => '成功发起注册预测任务请求，可通过控制台或GetInferenceJob获取任务执行状态。',
+ 'description' => '成功发起注册预测任务请求，可通过控制台或GetInferenceJob获取任务执行状态。',
'type' => 'object',
'properties' => [
'Data' => [
'title' => '返回数据。',
'description' => '返回数据。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
+ 'type' => 'object',
+ 'properties' => [
+ 'Algorithm' => ['title' => '关联算法。', 'description' => '关联算法ID。', 'type' => 'string', 'example' => 'user_recall'],
+ 'CampaignId' => ['title' => '关联运营活动Id。', 'description' => '关联运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'DataPath' => ['title' => '预测数据路径。', 'description' => '预测数据路径。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'GroupId' => ['title' => '关联人群Id，如果任务失败则人群无效。', 'description' => '关联人群ID，如果任务失败则人群无效。', 'type' => 'string', 'example' => 'bdb0b117-3354-4ceb-ba75-e022dd9370d8'],
+ 'History' => ['title' => '预测任务日志。', 'description' => '预测任务日志。', 'type' => 'string', 'example' => 'Error: Missing Column.'],
+ 'Id' => ['title' => '预测任务Id。', 'description' => '预测任务ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '预测任务名称。', 'description' => '预测任务名称。', 'type' => 'string', 'example' => 'VIP客户'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => '充值大于一万'],
+ 'Status' => ['title' => '预测任务状态。', 'description' => '预测任务状态。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'TargetPath' => ['title' => '输出数据路径，需要为空目录。', 'description' => '输出数据路径，需要为空目录。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'TrainingJobId' => ['title' => '关联训练任务。', 'description' => '关联训练任务。', 'type' => 'string', 'example' => '123'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'UserConfig' => ['title' => '用户配置。', 'description' => '用户配置。', 'type' => 'string', 'example' => '{}'],
+ ],
],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败,原因见errmsg',
+ 'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '删除签名',
- ],
- 'ListSignatures' => [
- 'summary' => '获取签名注册记录列表。',
- 'path' => '/api/v2/signatures',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"GroupId\\": \\"bdb0b117-3354-4ceb-ba75-e022dd9370d8\\",\\n \\"History\\": \\"Error: Missing Column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TargetPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"TrainingJobId\\": \\"123\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '创建预测任务',
+ 'description' => '在使用前需要在网页端一键授权OSS访问权限，并将需要访问的OSS Bucket添加pai=plugin的标签，请参考[OSS添加标签](https://help.aliyun.com/document_detail/133826.html)。 '."\n"
+ .'预测任务输出的csv文件不包含header，每列分别表示：user\\_id，item\\_id，phone，score。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInferenceJob'],
+ ],
],
+ ],
+ 'CreateSchedule' => [
+ 'summary' => '您可以根据本文提供的参数配置说明，创建触达计划，进行流失用户的触达和召回。',
+ 'path' => '/api/v2/schedules',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123212',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129053',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '签名名称过滤。',
- 'description' => '签名名称过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用户增长',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '签名审核状态过滤。'."\n"
- .'- 0：审核中。'."\n"
- .'- 1：审核通过。'."\n"
- .'- 2：审核不通过。',
- 'description' => '签名审核状态过滤。'."\n"
- .'- 0：审核中。'."\n"
- .'- 1：审核通过。'."\n"
- .'- 2：审核不通过。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '请求参数的主体信息。',
+ 'description' => '请求参数的主体信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndTime' => ['title' => '终止时间（UTC+8）。', 'description' => '终止时间（UTC+8）。', 'type' => 'string', 'format' => 'int32', 'required' => false, 'example' => '2020-01-01'],
+ 'ExecuteTime' => ['title' => '执行时间 (UTC+8)，为空立即执行。', 'description' => '执行时间 (UTC+8)：'."\n"
+ .'- 为空则立即执行。'."\n"
+ .'- 设置执行时间，则需要设置重复周期（RepeatCycle）。', 'type' => 'string', 'required' => false, 'example' => '2020-01-01 12:00:00'],
+ 'GroupId' => ['title' => '人群ID。', 'description' => '人群ID。如何获取人群ID，请参见[ListGroups](~~429068~~)。', 'type' => 'string', 'required' => true, 'example' => '0****195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '触达计划名称。', 'description' => '触达计划名称。长度为2~30个字符，支持字母、数字、汉字和下划线（_）。', 'type' => 'string', 'required' => true, 'example' => 'Growth-2021-0101'],
+ 'RepeatCycle' => ['title' => '重复周期，按重复周期与重复周期单位执行。', 'description' => '重复周期，按重复周期与重复周期单位执行。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'RepeatCycleUnit' => ['title' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
+ .'- 0: 从不（默认）。'."\n"
+ .'- 1: 小时。'."\n"
+ .'- 2: 天。'."\n"
+ .'- 3: 周。'."\n"
+ .'- 4: 月。', 'description' => '重复周期单位，若指定执行时间（ExecuteTime），则按重复周期单位执行。'."\n"
+ .'- 0：从不（默认）。'."\n"
+ .'- 1：小时。'."\n"
+ .'- 2：天。'."\n"
+ .'- 3：周。'."\n"
+ .'- 4：月。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'RepeatTimes' => ['title' => '重复次数。'."\n"
+ .'- 0: 不设终止时间（默认）。'."\n"
+ .'- N: 重复N次后终止。', 'description' => '重复次数，取值如下：'."\n"
+ .'- -1：不设终止时间（默认）。'."\n"
+ .'- 0：不重复。'."\n"
+ .'- N：重复N次后终止。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1'],
+ 'SignName' => ['title' => '签名。', 'description' => '签名名称，如何获取签名名称，请参见[ListSignatures ](~~413410~~)。', 'type' => 'string', 'required' => false, 'example' => 'PAI'],
+ 'SignatureId' => ['title' => '签名ID，或指定签名。', 'description' => '签名ID。如何获取签名ID，请参见[ListSignatures ](~~413410~~)。', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302****'],
+ 'TemplateCode' => ['title' => '模板Code。', 'description' => '模板Code。如何获取模板Code，请参见[ListTemplates](~~413414~~)。', 'type' => 'string', 'required' => false, 'example' => 'SMS_123***'],
+ 'TemplateId' => ['title' => '模板ID，或指定模板Code。', 'description' => '模板ID，或指定模板Code。如何获取模板ID，请参见[ListTemplates](~~413414~~)。', 'type' => 'string', 'required' => false, 'example' => '0a54e***-03e2-40bd-869d-b71cb30*****'],
+ 'AISendStartDate' => ['description' => '智能发送开始时间。', 'type' => 'string', 'required' => false, 'example' => '2020-01-01 12:00:00'."\n"],
+ 'AISendEndDate' => ['description' => '智能发送结束时间。', 'type' => 'string', 'required' => false, 'example' => '2020-01-01 12:00:00'."\n"],
+ 'PaymentType' => ['description' => '计费类型（为空时默认后付费），取值如下：'."\n"
+ ."\n"
+ .'- PayAsYouGo：后付费'."\n"
+ .'- Subscription：预付费'."\n"
+ .'- MixPay：组合付费', 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo'],
+ ],
'required' => false,
- 'example' => '0',
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => '成功获取签名列表。',
- 'description' => '成功获取签名列表。',
+ 'title' => '成功注册短信触达计划，可通过控制台或GetSchedule获取短信触达计划检查与触达情况。',
+ 'description' => '成功注册触达计划，可通过控制台或GetSchedule获取触达计划检查与触达情况。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -716,184 +461,126 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'Signatures' => [
- 'title' => '分页返回的签名列表。',
- 'description' => '分页返回的签名列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Id' => [
- 'title' => '签名Id。',
- 'description' => '签名ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '签名名称。',
- 'description' => '签名名称。',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- 'Status' => [
- 'title' => '签名审核状态。'."\n"
- .'- 0：审核中。'."\n"
- .'- 1：审核通过。'."\n"
- .'- 2：审核不通过。',
- 'description' => '签名审核状态。'."\n"
- .'- 0：审核中。'."\n"
- .'- 1：审核通过。'."\n"
- .'- 2：审核不通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'title' => '账号下全部签名注册记录数量。',
- 'description' => '账号下全部签名注册记录数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8）。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'EndTime' => ['title' => '终止时间（UTC+8）。', 'description' => '终止时间（UTC+8）。', 'type' => 'string', 'format' => 'int32', 'example' => '2020-01-01'],
+ 'ExecuteTime' => ['title' => '执行时间 (UTC+8)，为空立即执行。', 'description' => '执行时间 (UTC+8），为空立即执行。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'GroupId' => ['title' => '人群ID。', 'description' => '人群ID。', 'type' => 'string', 'example' => '0****195-03e2-40bd-869d-b71cb302783e'],
+ 'Id' => ['title' => '触达计划ID。', 'description' => '触达计划ID。', 'type' => 'string', 'example' => '0a54****-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '触达计划名称。', 'description' => '触达计划名称。', 'type' => 'string', 'example' => '增长-2021-0101'],
+ 'RepeatCycle' => ['title' => '重复周期，按重复周期与重复周期单位执行。', 'description' => '重复周期，按重复周期与重复周期单位执行。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RepeatCycleUnit' => ['title' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
+ .'- 0: 从不（默认）。'."\n"
+ .'- 1: 小时。'."\n"
+ .'- 2: 天。'."\n"
+ .'- 3: 周。'."\n"
+ .'- 4: 月。', 'description' => '重复周期单位，若指定执行时间，则按重复周期单位执行。可能值：'."\n"
+ .'- 0：从不（默认）。'."\n"
+ .'- 1：小时。'."\n"
+ .'- 2：天。'."\n"
+ .'- 3：周。'."\n"
+ .'- 4：月。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RepeatTimes' => ['title' => '重复次数。'."\n"
+ .'- 0: 不设终止时间（默认）。'."\n"
+ .'- N: 重复N次后终止。', 'description' => '重复次数，可能值：'."\n"
+ .'- -1：不设终止时间（默认）。'."\n"
+ .'- 0：不重复。'."\n"
+ .'- N：重复N次后终止。', 'type' => 'integer', 'format' => 'int32', 'example' => '-1'],
+ 'SignName' => ['title' => '签名。', 'description' => '签名。', 'type' => 'string', 'example' => 'PAI'],
+ 'SignatureId' => ['title' => '签名ID，或指定签名。', 'description' => '签名ID，或指定签名。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302****'],
+ 'Status' => ['title' => '状态。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 检查成功。'."\n"
+ .'- 2: 检查失败。'."\n"
+ .'- 3: 发送中。'."\n"
+ .'- 4: 发送成功。'."\n"
+ .'- 5: 发送失败。', 'description' => '状态。可能值：'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 检查成功。'."\n"
+ .'- 2: 检查失败。'."\n"
+ .'- 3: 发送中。'."\n"
+ .'- 4: 发送成功。'."\n"
+ .'- 5: 发送失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TemplateCode' => ['title' => '模板Code。', 'description' => '模板Code。', 'type' => 'string', 'example' => 'SMS_123***'],
+ 'TemplateId' => ['title' => '模板ID，或指定模板Code。', 'description' => '模板ID，或指定模板Code。', 'type' => 'string', 'example' => '0a54e***-03e2-40bd-869d-b71cb30*****'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85****'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败,原因见errmsg',
+ 'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Signatures\\": [\\n {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"用户增长\\",\\n \\"Status\\": 0,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取签名列表',
- ],
- 'GetSignature' => [
- 'summary' => '获取签名的详细信息。',
- 'path' => '/api/v2/signatures/{Id}',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"EndTime\\": \\"2020-01-01\\",\\n \\"ExecuteTime\\": \\"2020-01-01 12:00:00\\",\\n \\"GroupId\\": \\"0****195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Id\\": \\"0a54****-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"增长-2021-0101\\",\\n \\"RepeatCycle\\": 0,\\n \\"RepeatCycleUnit\\": 0,\\n \\"RepeatTimes\\": -1,\\n \\"SignName\\": \\"PAI\\",\\n \\"SignatureId\\": \\"0a54e195-03e2-40bd-869d-b71cb302****\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123***\\",\\n \\"TemplateId\\": \\"0a54e***-03e2-40bd-869d-b71cb30*****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85****\\"\\n}","type":"json"}]',
+ 'title' => '创建触达计划',
+ 'changeSet' => [
+ ['createdAt' => '2023-03-09T08:29:49.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-01-06T04:01:30.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSchedule'],
+ ],
],
+ ],
+ 'CreateSignature' => [
+ 'summary' => '发起注册签名请求，可通过控制台或GetSignature查看签名审核状态。',
+ 'path' => '/api/v2/signatures',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123202',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '123190',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'path',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '签名Id，可通过ListSignatures查询账号下的签名列表，获取签名Id。',
- 'description' => '签名Id，可通过ListSignatures查询账号下的签名列表，获取签名Id。',
- 'type' => 'string',
+ 'title' => '请求参数的主体信息。',
+ 'description' => '请求参数的主体信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['title' => '申请说明。', 'description' => '申请说明。', 'type' => 'string', 'required' => false, 'example' => 'Application description'],
+ 'Name' => ['title' => '签名名称。', 'description' => '签名名称。', 'type' => 'string', 'required' => true, 'example' => 'User growth'],
+ ],
'required' => false,
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => '成功获取签名详情。',
- 'description' => '成功获取签名详情。',
+ 'title' => '成功发起注册签名请求，可通过控制台或GetSignature获取审核状态。',
+ 'description' => '成功发起注册签名请求，可通过控制台或GetSignature获取审核状态。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -901,76 +588,22 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Description' => [
- 'title' => '申请说明。',
- 'description' => '申请说明。',
- 'type' => 'string',
- 'example' => '申请说明',
- ],
- 'Id' => [
- 'title' => '签名Id。',
- 'description' => '签名Id。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '签名名称。',
- 'description' => '签名名称。',
- 'type' => 'string',
- 'example' => '用户增长',
- ],
- 'Reason' => [
- 'title' => '审核建议。',
- 'description' => '审核建议。',
- 'type' => 'string',
- 'example' => '同意',
- ],
- 'Status' => [
- 'title' => '签名审核状态。'."\n"
- .'- 0：审核中。'."\n"
- .'- 1：审核通过。'."\n"
- .'- 2：审核不通过。',
- 'description' => '签名审核状态。'."\n"
- .'- 0：审核中。'."\n"
- .'- 1：审核通过。'."\n"
- .'- 2：审核不通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Id' => ['title' => '签名ID。', 'description' => '签名ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '签名名称。', 'description' => '签名名称。', 'type' => 'string', 'example' => '用户增长'],
+ 'Status' => ['title' => '签名审核状态。'."\n"
+ .'- 0：审核中。'."\n"
+ .'- 1：审核通过。'."\n"
+ .'- 2：审核不通过。', 'description' => '签名审核状态。'."\n"
+ .'- 0：审核中。'."\n"
+ .'- 1：审核通过。'."\n"
+ .'- 2：审核不通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '0'],
],
],
],
@@ -980,58 +613,41 @@
'description' => '失败,原因见errmsg',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID', 'type' => 'string', 'example' => '0'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"申请说明\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"用户增长\\",\\n \\"Reason\\": \\"同意\\",\\n \\"Status\\": 0,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取签名详情',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"用户增长\\",\\n \\"Status\\": 0,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"0\\"\\n}","type":"json"}]',
+ 'title' => '注册签名',
+ 'changeSet' => [
+ ['createdAt' => '2023-01-06T04:01:30.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSignature'],
+ ],
+ ],
],
'CreateTemplate' => [
'summary' => '调用CreateTemplate来创建模板。',
'path' => '/api/v2/templates',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
@@ -1039,9 +655,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '123191',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
@@ -1053,55 +667,18 @@
'description' => '请求参数的主体信息。',
'type' => 'object',
'properties' => [
- 'Content' => [
- 'title' => '模板内容，请注意控制总字数在70个字以内，超出部分按长短信收费，按67个字为单位记一条短信，营销短信必须在结尾添加“回T退订”。',
- 'description' => '模板内容，请注意控制总字数在70个字以内，超出部分按长短信收费，按67个字为单位记一条短信，必须在结尾添加”回T退订“。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '模板内容',
- ],
- 'Description' => [
- 'title' => '申请说明。',
- 'description' => '申请说明。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '申请说明',
- ],
- 'Name' => [
- 'title' => '模板名称。',
- 'description' => '模板名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '模板召回-20220101',
- ],
- 'Signature' => [
- 'title' => '签名名称，同时只能指定签名名称或签名ID其中之一。',
- 'description' => '签名名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PAI',
- ],
- 'SignatureId' => [
- 'title' => '签名ID，可通过ListSignatures获取审核状态为已通过的签名列表，获取签名ID。',
- 'description' => '签名ID，可通过ListSignatures获取审核状态为已通过的签名列表，获取签名ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6',
- ],
- 'Type' => [
- 'title' => '模板类型。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'description' => '模板类型。'."\n"
- .'- 0：验证码。'."\n"
- .'- 1：短信通知。'."\n"
- .'- 2：推广短信。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'Content' => ['title' => '模板内容，请注意控制总字数在70个字以内，超出部分按长短信收费，按67个字为单位记一条短信，营销短信必须在结尾添加“回T退订”。', 'description' => '模板内容，请注意控制总字数在70个字以内，超出部分按长短信收费，按67个字为单位记一条短信，必须在结尾添加”回T退订“。', 'type' => 'string', 'required' => false, 'example' => '模板内容'],
+ 'Description' => ['title' => '申请说明。', 'description' => '申请说明。', 'type' => 'string', 'required' => false, 'example' => 'Application description'],
+ 'Name' => ['title' => '模板名称。', 'description' => '模板名称。', 'type' => 'string', 'required' => false, 'example' => '模板召回-20220101'],
+ 'Signature' => ['title' => '签名名称，同时只能指定签名名称或签名ID其中之一。', 'description' => '签名名称。', 'type' => 'string', 'required' => false, 'example' => 'PAI'],
+ 'SignatureId' => ['title' => '签名ID，可通过ListSignatures获取审核状态为已通过的签名列表，获取签名ID。', 'description' => '签名ID，可通过ListSignatures获取审核状态为已通过的签名列表，获取签名ID。', 'type' => 'string', 'required' => false, 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'],
+ 'Type' => ['title' => '模板类型。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'description' => '模板类型。'."\n"
+ .'- 0：验证码。'."\n"
+ .'- 1：短信通知。'."\n"
+ .'- 2：推广短信。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
'required' => false,
],
@@ -1120,113 +697,35 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Content' => [
- 'title' => '模板内容。',
- 'description' => '模板内容。',
- 'type' => 'string',
- 'example' => '模板内容',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Description' => [
- 'title' => '申请说明。',
- 'description' => '申请说明。',
- 'type' => 'string',
- 'example' => '申请说明',
- ],
- 'Id' => [
- 'title' => '模板ID。',
- 'description' => '模板ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '模板名称。',
- 'description' => '模板名称。',
- 'type' => 'string',
- 'example' => '模板召回-20220101',
- ],
- 'Reason' => [
- 'title' => '审核意见。',
- 'description' => '审核意见。',
- 'type' => 'string',
- 'example' => '同意',
- ],
- 'Signature' => [
- 'title' => '签名。',
- 'description' => '签名。',
- 'type' => 'string',
- 'example' => 'PAI通知',
- ],
- 'SignatureId' => [
- 'title' => '签名ID。',
- 'description' => '签名ID。',
- 'type' => 'string',
- 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6',
- ],
- 'Status' => [
- 'title' => '审核状态。'."\n"
- .'- 0 : 审核中。'."\n"
- .'- 1 : 审核通过。'."\n"
- .'- 2 : 审核不通过。',
- 'description' => '审核状态。'."\n"
- .'- 0 : 审核中。'."\n"
- .'- 1 : 审核通过。'."\n"
- .'- 2 : 审核不通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TemplateCode' => [
- 'title' => '模板Code。',
- 'description' => '模板Code。',
- 'type' => 'string',
- 'example' => 'SMS_123456',
- ],
- 'Type' => [
- 'title' => '模板类型。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'description' => '模板类型。'."\n"
- .'- 0：验证码。'."\n"
- .'- 1：短信通知。'."\n"
- .'- 2：推广短信。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
+ 'Content' => ['title' => '模板内容。', 'description' => '模板内容。', 'type' => 'string', 'example' => '模板内容'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Description' => ['title' => '申请说明。', 'description' => '申请说明。', 'type' => 'string', 'example' => '申请说明'],
+ 'Id' => ['title' => '模板ID。', 'description' => '模板ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '模板名称。', 'description' => '模板名称。', 'type' => 'string', 'example' => '模板召回-20220101'],
+ 'Reason' => ['title' => '审核意见。', 'description' => '审核意见。', 'type' => 'string', 'example' => 'Agree'],
+ 'Signature' => ['title' => '签名。', 'description' => '签名。', 'type' => 'string', 'example' => 'PAI notification'],
+ 'SignatureId' => ['title' => '签名ID。', 'description' => '签名ID。', 'type' => 'string', 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'],
+ 'Status' => ['title' => '审核状态。'."\n"
+ .'- 0 : 审核中。'."\n"
+ .'- 1 : 审核通过。'."\n"
+ .'- 2 : 审核不通过。', 'description' => '审核状态。'."\n"
+ .'- 0 : 审核中。'."\n"
+ .'- 1 : 审核通过。'."\n"
+ .'- 2 : 审核不通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TemplateCode' => ['title' => '模板Code。', 'description' => '模板Code。', 'type' => 'string', 'example' => 'SMS_123456'],
+ 'Type' => ['title' => '模板类型。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'description' => '模板类型。'."\n"
+ .'- 0：验证码。'."\n"
+ .'- 1：短信通知。'."\n"
+ .'- 2：推广短信。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -1236,1768 +735,582 @@
'description' => '失败,原因见errmsg',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": \\"模板内容\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"申请说明\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"模板召回-20220101\\",\\n \\"Reason\\": \\"同意\\",\\n \\"Signature\\": \\"PAI通知\\",\\n \\"SignatureId\\": \\"5480e3e7-f578-42d2-8ce8-217dec75f2e6\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"Type\\": 1,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": \\"模板内容\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"申请说明\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"模板召回-20220101\\",\\n \\"Reason\\": \\"Agree\\",\\n \\"Signature\\": \\"PAI notification\\",\\n \\"SignatureId\\": \\"5480e3e7-f578-42d2-8ce8-217dec75f2e6\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"Type\\": 1,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
'title' => '注册模板',
- ],
- 'DeleteTemplate' => [
- 'summary' => '删除短信模板。',
- 'path' => '/api/v2/templates/{Id}',
- 'methods' => [
- 'delete',
+ 'changeSet' => [
+ ['createdAt' => '2023-01-06T06:53:58.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-01-06T04:01:30.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'],
+ ],
],
+ ],
+ 'CreateTrainingJob' => [
+ 'summary' => '创建训练任务。',
+ 'path' => '/api/v2/training/jobs',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123197',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129054',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'path',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '模板Id，可通过ListTemplates查询账号下的模板列表，获取模板Id。',
- 'description' => '模板ID，可通过ListTemplates查询账号下的模板列表，获取模板ID。',
- 'type' => 'string',
+ 'title' => '请求参数的主体信息。',
+ 'description' => '请求参数的主体信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Algorithm' => ['title' => '关联算法ID。', 'description' => '关联算法ID。', 'type' => 'string', 'required' => false, 'example' => 'user_recall'],
+ 'CampaignId' => ['title' => '关联运营活动ID。', 'description' => '关联运营活动ID。', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'DataPath' => ['title' => '训练数据路径，指定路径前需确保已在控制台完成一键授权。', 'description' => '训练数据路径。', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'Name' => ['title' => '训练任务名称。', 'description' => '训练任务名称。', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'],
+ 'UserConfig' => ['title' => '用户配置。', 'description' => '用户配置，用于设置start\\_date、end\\_date等参数，划定建模数据的时间范围。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "start_date": "20210101",'."\n"
+ .' "end_date": "20210131"'."\n"
+ .'}'],
+ ],
'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功删除模板。',
- 'description' => '成功删除模板。',
+ 'title' => '成功注册训练任务，可通过控制台或GetTrainingJob获取任务执行状态。',
+ 'description' => '成功注册训练任务，可通过控制台或GetTrainingJob获取任务执行状态。',
'type' => 'object',
'properties' => [
'Data' => [
'title' => '返回数据。',
'description' => '返回数据。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
+ 'type' => 'object',
+ 'properties' => [
+ 'Algorithm' => ['title' => '关联算法ID。', 'description' => '关联算法ID。', 'type' => 'string', 'example' => 'user_recall'],
+ 'CampaignId' => ['title' => '关联运营活动ID。', 'description' => '关联运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'DataPath' => ['title' => '训练数据路径，指定路径前需确保已在控制台完成一键授权。', 'description' => '训练数据路径。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'History' => ['title' => '训练任务日志。', 'description' => '训练任务日志。', 'type' => 'string', 'example' => 'Error: Parameter are not found.'],
+ 'Id' => ['title' => '训练任务ID。', 'description' => '训练任务ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '训练任务名称。', 'description' => '训练任务名称。', 'type' => 'string', 'example' => 'VIP客户'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => '充值大于一万'],
+ 'Status' => ['title' => '训练任务状态。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'description' => '训练任务状态。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'TrainingScheduleId' => ['title' => '关联训练计划ID。', 'description' => '关联训练计划ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'UserConfig' => ['title' => '用户配置。', 'description' => '用户配置。', 'type' => 'string', 'example' => '{'."\n"
+ .' "start_date": "20210101",'."\n"
+ .' "end_date": "20210131"'."\n"
+ .'}'],
+ 'HasModelInfo' => ['description' => '是否存有特征重要性、模式、决策树等特征信息。', 'type' => 'boolean', 'example' => 'false'],
+ ],
],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败,原因见errmsg',
+ 'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '删除模板',
- ],
- 'ListTemplates' => [
- 'summary' => '获取模板注册记录列表。',
- 'path' => '/api/v2/templates',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"History\\": \\"Error: Parameter are not found.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TrainingScheduleId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{\\\\n \\\\\\"start_date\\\\\\": \\\\\\"20210101\\\\\\",\\\\n \\\\\\"end_date\\\\\\": \\\\\\"20210131\\\\\\"\\\\n}\\",\\n \\"HasModelInfo\\": false\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '创建训练任务',
+ 'description' => '在使用前需要在网页端一键授权OSS访问权限，并将需要访问的OSS Bucket添加pai=plugin的标签，请参考[OSS添加标签](https://help.aliyun.com/document_detail/133826.html)。',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-23T03:09:30.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-12-22T06:31:13.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrainingJob'],
+ ],
],
+ ],
+ 'DeleteCampaign' => [
+ 'summary' => '删除运营活动。',
+ 'path' => '/api/v2/campaigns/{Id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123213',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '131223',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Content',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板内容过滤。',
- 'description' => '模板内容过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '七夕',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板名称过滤。',
- 'description' => '模板名称过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '召回',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'title' => '审核状态过滤。'."\n"
- .'- 0 : 审核中。'."\n"
- .'- 1 : 审核通过。'."\n"
- .'- 2 : 审核不通过。',
- 'description' => '审核状态过滤。'."\n"
- .'- 0 : 审核中。'."\n"
- .'- 1 : 审核通过。'."\n"
- .'- 2 : 审核不通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'Type',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板类型过滤。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'description' => '模板类型过滤。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'name' => 'Id',
+ 'in' => 'path',
+ 'schema' => ['title' => 'path', 'description' => '运营活动ID，可通过ListCampaigns获取运营活动列表获取相应ID。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取模板列表。',
- 'description' => '成功获取模板列表，可通过控制台或GetTemplate获取审核状态。',
+ 'title' => '成功删除运营活动。',
+ 'description' => '成功删除运营活动。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'Templates' => [
- 'title' => '分页返回的模板列表。',
- 'description' => '分页返回的模板列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '模板内容。',
- 'description' => '模板内容。',
- 'type' => 'string',
- 'example' => '模板内容',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Description' => [
- 'title' => '申请说明。',
- 'description' => '申请说明。',
- 'type' => 'string',
- 'example' => '申请说明',
- ],
- 'Id' => [
- 'title' => '模板Id。',
- 'description' => '模板ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '签名名称。',
- 'description' => '模板名称。',
- 'type' => 'string',
- 'example' => '模板召回-20220101',
- ],
- 'Reason' => [
- 'title' => '审核意见。',
- 'description' => '审核意见。',
- 'type' => 'string',
- 'example' => '同意',
- ],
- 'SignatureId' => [
- 'title' => '签名Id。',
- 'description' => '签名ID。',
- 'type' => 'string',
- 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6',
- ],
- 'Status' => [
- 'title' => '审核状态。'."\n"
- .'- 0 : 审核中。'."\n"
- .'- 1 : 审核通过。'."\n"
- .'- 2 : 审核不通过。',
- 'description' => '审核状态。'."\n"
- .'- 0 : 审核中。'."\n"
- .'- 1 : 审核通过。'."\n"
- .'- 2 : 审核不通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TemplateCode' => [
- 'title' => '模板Code。',
- 'description' => '模板Code。',
- 'type' => 'string',
- 'example' => 'SMS_123456',
- ],
- 'Type' => [
- 'title' => '模板类型。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'description' => '模板类型。'."\n"
- .'- 0：验证码。'."\n"
- .'- 1：短信通知。'."\n"
- .'- 2：推广短信。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'title' => '全部模板注册记录数量。',
- 'description' => '全部模板注册记录数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string', 'example' => 'OK'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败,原因见errmsg',
+ 'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Templates\\": [\\n {\\n \\"Content\\": \\"模板内容\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"申请说明\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"模板召回-20220101\\",\\n \\"Reason\\": \\"同意\\",\\n \\"SignatureId\\": \\"5480e3e7-f578-42d2-8ce8-217dec75f2e6\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"Type\\": 1,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取模板列表',
- ],
- 'GetTemplate' => [
- 'summary' => '获取模板详细内容。',
- 'path' => '/api/v2/templates/{Id}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '删除运营活动',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCampaign'],
+ ],
],
+ ],
+ 'DeleteGroup' => [
+ 'summary' => '删除人群。',
+ 'path' => '/api/v2/groups/{Id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123203',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129055',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'path',
- 'schema' => [
- 'title' => '模板Id，可通过ListTemplates查询账号下的模板列表，获取模板Id。',
- 'description' => '模板ID，可通过ListTemplates查询账号下的模板列表，获取模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
+ 'schema' => ['title' => 'path', 'description' => '人群ID，可通过ListGroups获取人群列表，获取相应ID。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取模板详情。',
- 'description' => '成功获取模板详情。',
+ 'title' => '成功。',
+ 'description' => '成功。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '模板内容。',
- 'description' => '模板内容。',
- 'type' => 'string',
- 'example' => '心仪的TA刚刚给你留言了',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Description' => [
- 'title' => '申请说明。',
- 'description' => '申请说明。',
- 'type' => 'string',
- 'example' => '申请说明',
- ],
- 'Id' => [
- 'title' => '模板Id。',
- 'description' => '模板ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '签名名称。',
- 'description' => '模板名称。',
- 'type' => 'string',
- 'example' => '模板召回-20220101',
- ],
- 'Reason' => [
- 'title' => '审核意见。',
- 'description' => '审核意见。',
- 'type' => 'string',
- 'example' => '同意',
- ],
- 'SignatureId' => [
- 'title' => '签名Id。',
- 'description' => '签名ID。',
- 'type' => 'string',
- 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6',
- ],
- 'Status' => [
- 'title' => '审核状态。'."\n"
- .'- 0 : 审核中。'."\n"
- .'- 1 : 审核通过。'."\n"
- .'- 2 : 审核不通过。',
- 'description' => '审核状态。'."\n"
- .'- 0 : 审核中。'."\n"
- .'- 1 : 审核通过。'."\n"
- .'- 2 : 审核不通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TemplateCode' => [
- 'title' => '模板Code。',
- 'description' => '模板Code。',
- 'type' => 'string',
- 'example' => 'SMS_123456',
- ],
- 'Type' => [
- 'title' => '模板类型。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'description' => '模板类型。'."\n"
- .'- 0：验证码。'."\n"
- .'- 1：短信通知。'."\n"
- .'- 2：推广短信。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string', 'example' => 'OK'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败,原因见errmsg',
+ 'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": \\"心仪的TA刚刚给你留言了\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"申请说明\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"模板召回-20220101\\",\\n \\"Reason\\": \\"同意\\",\\n \\"SignatureId\\": \\"5480e3e7-f578-42d2-8ce8-217dec75f2e6\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"Type\\": 1,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取模板详情',
- ],
- 'SendMessage' => [
- 'summary' => '发送短信，使用前须注册签名和模板。',
- 'path' => '/api/v2/messages',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '删除人群',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'],
+ ],
],
+ ],
+ 'DeleteInferenceJob' => [
+ 'summary' => '删除预测任务。',
+ 'path' => '/api/v2/inference/jobs/{Id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '123215',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '129056',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'Id',
+ 'in' => 'path',
+ 'schema' => ['title' => '预测任务Id，可通过ListInferenceJobs查询账号下的预测任务列表，获取预测任务Id。', 'description' => '预测任务ID，可通过ListInferenceJobs查询账号下的预测任务列表，获取预测任务ID。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '请求参数的主体信息。',
- 'description' => '请求参数的主体信息。',
+ 'title' => '成功删除预测任务Id。',
+ 'description' => '成功删除预测任务。',
'type' => 'object',
'properties' => [
- 'GroupId' => [
- 'title' => '人群Id，用于关联人群。',
- 'description' => '人群ID，用于关联人群。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10ed87f5-3ca8-4a43-9d83-b30519be7241',
- ],
- 'OutIds' => [
- 'title' => '外部拓展字段，示例：["1234567890"]。',
- 'description' => '外部拓展字段，示例：["1234567890"]。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '1234567890',
- ],
- 'required' => false,
- ],
- 'PhoneNumbers' => [
- 'title' => '手机号，每个手机号对应一个模板变量、上行拓展码和外部拓展字段，个数最大为1000，示例：["1234567890"]。',
- 'description' => '手机号，每个手机号对应一个模板变量、上行拓展码和外部拓展字段，号码个数最大为1000，示例：["1234567890"]。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '1234567890',
- ],
- 'required' => false,
- ],
- 'ScheduleId' => [
- 'title' => '触达计划Id，用于关联触达计划。',
- 'description' => '发送计划ID，用于关联发送计划。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '08d19262-bd76-48fd-80e8-6a225ac388c1',
- ],
- 'SignName' => [
- 'title' => '签名名称。',
- 'description' => '签名名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PAI通知',
- ],
- 'SignatureId' => [
- 'title' => '签名Id，同时只能指定签名名称或签名Id其中之一。',
- 'description' => '签名ID，同时只能指定签名名称或签名ID其中之一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6',
- ],
- 'SmsUpExtendCodes' => [
- 'title' => '短信上行拓展码，示例：["1234567890"]。',
- 'description' => '短信上行拓展码，示例：["1234567890"]。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '1234567890',
- ],
- 'required' => false,
- ],
- 'TemplateCode' => [
- 'title' => '模板Code。',
- 'description' => '模板Code。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SMS_123456',
- ],
- 'TemplateId' => [
- 'title' => '模板Id，同时只能指定模板Code或模板Id其中之一。',
- 'description' => '模板ID，同时只能指定模板Code或模板ID其中之一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3',
- ],
- 'TemplateParams' => [
- 'title' => '短信模板变量对应的实际值，JSON格式。支持传入多个参数，示例：[{"name":"张三","number":"15038****76"}]。',
- 'description' => '短信模板变量对应的实际值，JSON格式。支持传入多个参数，示例：[{"name":"张三","number":"15038****76"}]。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"name":"张三","number":"15038****76"}',
- ],
- 'required' => false,
- ],
- 'PaymentType' => [
- 'description' => '计费类型（为空时默认后付费）。'."\n"
- ."\n"
- .'- PayAsYouGo：后付费'."\n"
- .'- Subscription：预付费',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PayAsYouGo',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string', 'example' => 'OK'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
- 'required' => false,
],
],
- ],
- 'responses' => [
- 200 => [
- 'headers' => [],
+ 400 => [
'schema' => [
- 'title' => '成功发送短信。',
- 'description' => '成功发送短信。',
+ 'title' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Messages' => [
- 'title' => '短信结果列表，列表中手机号的顺序与输入请求手机号顺序一一对应。',
- 'description' => '短信结果列表，列表中手机号的顺序与输入请求手机号顺序一一对应。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '短信Id，可使用ListMessages查询短信状态。',
- 'description' => '短信ID，可使用ListMessages查询短信状态。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'PhoneNumber' => [
- 'title' => '手机号码。',
- 'description' => '手机号码。',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '短信批处理Id，可使用ListMessages查询短信状态。',
- 'description' => '短信批处理ID，可使用ListMessages查询短信状态。',
- 'type' => 'string',
- 'example' => '62a72a20-8a9b-4060-a510-0c30a9340cba',
- ],
- ],
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"PhoneNumber\\": \\"1234567890\\"\\n }\\n ],\\n \\"RequestId\\": \\"62a72a20-8a9b-4060-a510-0c30a9340cba\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '发送短信',
- ],
- 'ListMessages' => [
- 'summary' => '按指定过滤条件获取指定日期的短信发送状态。',
- 'path' => '/api/v2/messages',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '删除预测任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInferenceJob'],
+ ],
],
+ ],
+ 'DeleteSchedule' => [
+ 'summary' => '当业务调整或取消发送时，您可以删除发送计划。',
+ 'path' => '/api/v2/schedules/{Id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123210',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129057',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Datetime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '发送日期，格式为20220101。',
- 'description' => '发送日期，格式为yyyymmdd。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20220101',
- ],
- ],
- [
- 'name' => 'ErrorCode',
- 'in' => 'query',
- 'schema' => [
- 'title' => '短信错误码过滤。',
- 'description' => '短信错误码过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DELIVERED',
- ],
- ],
- [
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '关联人群Id过滤。',
- 'description' => '关联人群ID过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10ed87f5-3ca8-4a43-9d83-b30519be7241',
- ],
- ],
- [
- 'name' => 'MessageId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '短信Id过滤，短信Id为SendMessage成功返回的Id。',
- 'description' => '短信ID过滤，短信ID为SendMessage成功返回的ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'PhoneNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '手机号码过滤。',
- 'description' => '手机号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1234567890',
- ],
- ],
- [
- 'name' => 'RequestId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '短信批处理Id过滤，短信批处理Id为SendMessage成功返回的RequestId。',
- 'description' => '短信批处理ID过滤，短信批处理ID为SendMessage成功返回的RequestId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '62a72a20-8a9b-4060-a510-0c30a9340cba',
- ],
- ],
- [
- 'name' => 'ScheduleId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '关联触达计划Id过滤。',
- 'description' => '关联发送计划ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '08d19262-bd76-48fd-80e8-6a225ac388c1',
- ],
- ],
- [
- 'name' => 'Signature',
- 'in' => 'query',
- 'schema' => [
- 'title' => '签名名称过滤。',
- 'description' => '签名名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PAI通知',
- ],
- ],
- [
- 'name' => 'SignatureId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '签名Id过滤，同时只能指定签名名称或签名Id其中之一。',
- 'description' => '签名ID，同时只能指定签名名称或签名ID其中之一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'title' => '短信发送状态过滤。'."\n"
- .'- 0 : 发送中。'."\n"
- .'- 1 : 发送成功。'."\n"
- .'- 2 : 发送失败。',
- 'description' => '短信发送状态。'."\n"
- .'- 0 : 发送中。'."\n"
- .'- 1 : 发送成功。'."\n"
- .'- 2 : 发送失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'TemplateCode',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板号过滤。',
- 'description' => '模板号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SMS_123456',
- ],
- ],
- [
- 'name' => 'TemplateId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板Id过滤，同时只能指定模板Code或模板Id其中之一。',
- 'description' => '模板ID，同时只能指定模板Code或模板ID其中之一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3',
- ],
- ],
- [
- 'name' => 'TemplateType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板类型过滤。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'description' => '模板类型过滤。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'name' => 'Id',
+ 'in' => 'path',
+ 'schema' => ['title' => '触达计划Id，可通过ListSchedules查询账号下的触达计划列表，获取触达计划Id。', 'description' => '触达计划ID。如何获取触达计划ID，请参见[ListSchedules](~~429073~~)。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取短信发送详情列表。',
- 'description' => '成功。',
+ 'title' => '成功删除触达计划。',
+ 'description' => '成功删除触达计划。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Messages' => [
- 'title' => '短信列表。',
- 'description' => '短信列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '短信错误码。',
- 'description' => '短信错误码。',
- 'type' => 'string',
- 'example' => 'DELIVERED',
- ],
- 'GroupId' => [
- 'title' => '关联人群Id，未关联则为空。',
- 'description' => '关联人群ID。',
- 'type' => 'string',
- 'example' => '51d20163-1b10-4af2-8a23-58ad52201f2f',
- ],
- 'Id' => [
- 'title' => '短信序列号。',
- 'description' => '短信序列号。',
- 'type' => 'string',
- 'example' => '92d05e19-751b-4346-a7c5-8808bb49b8a2',
- ],
- 'OutId' => [
- 'title' => '外部拓展字段。',
- 'description' => '外部拓展字段。',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'PhoneNumber' => [
- 'title' => '手机号码。',
- 'description' => '手机号码。',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'ScheduleId' => [
- 'title' => '关联触达计划Id，未关联则为空。',
- 'description' => '关联发送计划ID。',
- 'type' => 'string',
- 'example' => '0604d49d-fd23-4515-bb26-9b537cbf1f6d',
- ],
- 'Signature' => [
- 'title' => '签名名称。',
- 'description' => '签名名称。',
- 'type' => 'string',
- 'example' => 'PAI通知',
- ],
- 'Status' => [
- 'title' => '短信发送状态。'."\n"
- .'- 0 : 发送中。'."\n"
- .'- 1 : 发送成功。'."\n"
- .'- 2 : 发送失败。',
- 'description' => '短信发送状态。'."\n"
- .'- 0 : 发送中。'."\n"
- .'- 1 : 发送成功。'."\n"
- .'- 2 : 发送失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TemplateCode' => [
- 'title' => '模板号。',
- 'description' => '模板号。',
- 'type' => 'string',
- 'example' => 'SMS_123456',
- ],
- 'TemplateParams' => [
- 'title' => '模板参数。',
- 'description' => '模板参数。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'TemplateType' => [
- 'title' => '模板类型。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'description' => '模板类型。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'TotalCount' => [
- 'title' => '短信数量。',
- 'description' => '短信数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string', 'example' => 'OK'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败,原因见errmsg',
+ 'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"ErrorCode\\": \\"DELIVERED\\",\\n \\"GroupId\\": \\"51d20163-1b10-4af2-8a23-58ad52201f2f\\",\\n \\"Id\\": \\"92d05e19-751b-4346-a7c5-8808bb49b8a2\\",\\n \\"OutId\\": \\"1234567890\\",\\n \\"PhoneNumber\\": \\"1234567890\\",\\n \\"ScheduleId\\": \\"0604d49d-fd23-4515-bb26-9b537cbf1f6d\\",\\n \\"Signature\\": \\"PAI通知\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"TemplateParams\\": \\"{}\\",\\n \\"TemplateType\\": 2\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取短信列表',
- ],
- 'ListMessageMetrics' => [
- 'summary' => '获取短信发送统计数据，可按指定条件获取分类别详细数据。',
- 'path' => '/api/v2/messages/metrics',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '删除发送计划',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSchedule'],
+ ],
],
+ ],
+ 'DeleteSignature' => [
+ 'summary' => '删除签名。',
+ 'path' => '/api/v2/signatures/{Id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123209',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '123196',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '结束日期，格式20220102。',
- 'description' => '结束日期，格式20220102。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20210321',
- ],
- ],
- [
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '关联人群Id。',
- 'description' => '关联人群ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10ed87f5-3ca8-4a43-9d83-b30519be7241',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'ScheduleId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '关联触达计划Id。',
- 'description' => '关联触达计划ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '08d19262-bd76-48fd-80e8-6a225ac388c1',
- ],
- ],
- [
- 'name' => 'Signature',
- 'in' => 'query',
- 'schema' => [
- 'title' => '签名名称。',
- 'description' => '签名名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PAI通知',
- ],
- ],
- [
- 'name' => 'SignatureId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '签名Id，同时只能指定签名名称或签名Id其中之一。',
- 'description' => '签名ID，同时只能指定签名名称或签名ID其中之一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3',
- ],
- ],
- [
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '开始日期，格式20220102。',
- 'description' => '开始日期，格式20220102。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20210321',
- ],
- ],
- [
- 'name' => 'TemplateCode',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板号。',
- 'description' => '模板号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SMS_123456',
- ],
- ],
- [
- 'name' => 'TemplateId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板Id，同时只能指定模板Code或模板Id其中之一。',
- 'description' => '模板ID，同时只能指定模板Code或模板ID其中之一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6',
- ],
- ],
- [
- 'name' => 'TemplateType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模板类型。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'description' => '模板类型。'."\n"
- .'- 0 : 验证码。'."\n"
- .'- 1 : 短信通知。'."\n"
- .'- 2 : 推广短信。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'name' => 'Id',
+ 'in' => 'path',
+ 'schema' => ['title' => '签名ID，可通过ListSignatures查询账号下的签名列表，获取签名ID。', 'description' => '签名ID，可通过ListSignatures查询账号下的签名列表，获取签名ID。', 'type' => 'string', 'required' => true, 'example' => '996e466b-6808-49c7-998c-47b57bb85dd4'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取短信发送统计列表。',
- 'description' => '成功获取短信发送统计列表。',
+ 'title' => '成功删除签名。',
+ 'description' => '成功删除签名。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Metrics' => [
- 'title' => '分页返回的统计数据条目列表。',
- 'description' => '分页返回的统计数据条目列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Date' => [
- 'title' => '发送日期。',
- 'description' => '发送日期。',
- 'type' => 'string',
- 'example' => '20210321',
- ],
- 'Fail' => [
- 'title' => '发送失败。',
- 'description' => '发送失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Pending' => [
- 'title' => '发送中。',
- 'description' => '发送中。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Rate' => [
- 'title' => '发送成功率。',
- 'description' => '发送成功率。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.8',
- ],
- 'Success' => [
- 'title' => '发送成功。',
- 'description' => '发送成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Total' => [
- 'title' => '总计短信数量。',
- 'description' => '总计短信数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总统计数据条目数量。',
- 'description' => '总统计数据条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string', 'example' => 'OK'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'title' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'description' => '失败,原因见errmsg',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Metrics\\": [\\n {\\n \\"Date\\": \\"20210321\\",\\n \\"Fail\\": 0,\\n \\"Pending\\": 0,\\n \\"Rate\\": 0.8,\\n \\"Success\\": 0,\\n \\"Total\\": 0\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 0\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取短信发送统计',
- 'description' => '获取 [开始日期, 结束日期] 闭区间内的数据，返回数据按日期升序排列，发送统计为空的日期不返回。'."\n"
- ."\n"
- .'发送数据在48小时内会随实际短信发送状态不断更新，最终数据以48小时后数据为准。',
- ],
- 'CreateCampaign' => [
- 'summary' => '创建运营活动。',
- 'path' => '/api/v2/campaigns',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '删除签名',
+ 'changeSet' => [
+ ['createdAt' => '2023-01-06T04:01:30.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSignature'],
+ ],
],
+ ],
+ 'DeleteTemplate' => [
+ 'summary' => '删除短信模板。',
+ 'path' => '/api/v2/templates/{Id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '131222',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '123197',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '请求参数的主体信息。',
- 'description' => '请求参数的主体信息。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '运营活动名称。',
- 'description' => '运营活动名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '双十一活动',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'Id',
+ 'in' => 'path',
+ 'schema' => ['title' => '模板Id，可通过ListTemplates查询账号下的模板列表，获取模板Id。', 'description' => '模板ID，可通过ListTemplates查询账号下的模板列表，获取模板ID。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功创建运营活动。',
- 'description' => '成功创建运营活动。',
+ 'title' => '成功删除模板。',
+ 'description' => '成功删除模板。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Id' => [
- 'title' => '运营活动Id。',
- 'description' => '运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '运营活动名称。',
- 'description' => '运营活动名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '双十一活动',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string', 'example' => 'OK'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'description' => '失败,原因见errmsg',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '创建运营活动',
- ],
- 'DeleteCampaign' => [
- 'summary' => '删除运营活动。',
- 'path' => '/api/v2/campaigns/{Id}',
- 'methods' => [
- 'delete',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '删除模板',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'],
+ ],
],
+ ],
+ 'DeleteTrainingJob' => [
+ 'summary' => '删除训练任务。',
+ 'path' => '/api/v2/training/jobs/{Id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '131223',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129058',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'path',
- 'schema' => [
- 'title' => 'path',
- 'description' => '运营活动ID，可通过ListCampaigns获取运营活动列表获取相应ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
+ 'schema' => ['title' => '训练任务Id，可通过ListTrainingJobs查询账号下的训练任务列表，获取训练任务Id。', 'description' => '训练任务ID，可通过ListTrainingJobs查询账号下的训练任务列表，获取训练任务ID。', 'type' => 'string', 'required' => false, 'example' => 'b8e300a1-ff80-4ae4-bdc5-0c33dbcd76db'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功删除运营活动。',
- 'description' => '成功删除运营活动。',
+ 'title' => '成功删除训练任务。',
+ 'description' => '成功删除训练任务。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string', 'example' => 'OK'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -3007,119 +1320,55 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '删除运营活动',
- ],
- 'ListCampaigns' => [
- 'summary' => '获取运营活动列表。',
- 'path' => '/api/v2/campaigns',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '删除训练任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJob'],
+ ],
],
+ ],
+ 'GetAlgorithm' => [
+ 'summary' => '获取算法详细参数信息。',
+ 'path' => '/api/v2/algorithms/{Id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '131225',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129059',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '运营活动名称过滤。',
- 'description' => '运营活动名称过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'VIP客户',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Remark',
- 'in' => 'query',
- 'schema' => [
- 'title' => '运营活动备注过滤。',
- 'description' => '运营活动备注过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '充值大于一万',
- ],
+ 'name' => 'Id',
+ 'in' => 'path',
+ 'schema' => ['title' => '模板Id，可通过ListAlgorithms查询当前可用算法，使用获取的算法Id。', 'description' => '算法ID，可通过ListAlgorithms查询当前可用算法，使用获取的算法ID。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取运营活动列表。',
- 'description' => '成功获取运营活动列表。',
+ 'title' => '成功获取算法详情。',
+ 'description' => '成功获取算法详情。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -3127,90 +1376,16 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Campaigns' => [
- 'title' => '运营活动列表。',
- 'description' => '运营活动列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Id' => [
- 'title' => '运营活动Id。',
- 'description' => '运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '运营活动名称。',
- 'description' => '运营活动名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '双十一活动',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总运营活动数量。',
- 'description' => '总运营活动数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'Description' => ['title' => '算法说明。', 'description' => '算法说明。', 'type' => 'string', 'example' => '算法说明'],
+ 'Id' => ['title' => '算法Id。', 'description' => '算法ID。', 'type' => 'string', 'example' => 'sms_recall'],
+ 'InferUserConfigMap' => ['title' => '预测所需参数名与对应的参数说明。', 'description' => '预测所需参数名与对应的参数说明。', 'type' => 'string', 'example' => '{}'],
+ 'Name' => ['title' => '算法名称。', 'description' => '算法名称。', 'type' => 'string', 'example' => '短信召回'],
+ 'TrainUserConfigMap' => ['title' => '训练所需参数名与对应的参数说明。', 'description' => '训练所需参数名与对应的参数说明。', 'type' => 'string', 'example' => '{}'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -3220,55 +1395,34 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Campaigns\\": [\\n {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取运营活动列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Description\\": \\"算法说明\\",\\n \\"Id\\": \\"sms_recall\\",\\n \\"InferUserConfigMap\\": \\"{}\\",\\n \\"Name\\": \\"短信召回\\",\\n \\"TrainUserConfigMap\\": \\"{}\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取算法详情',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithm'],
+ ],
+ ],
],
'GetCampaign' => [
'summary' => '获取运营活动详细内容。',
'path' => '/api/v2/campaigns/{Id}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
@@ -3276,21 +1430,13 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '131224',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'path',
- 'schema' => [
- 'title' => '运营活动Id，可通过ListCampaigns查询账号下的运营活动列表，获取运营活动Id。',
- 'description' => '运营活动ID，可通过ListCampaigns查询账号下的运营活动列表，获取运营活动ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
+ 'schema' => ['title' => '运营活动Id，可通过ListCampaigns查询账号下的运营活动列表，获取运营活动Id。', 'description' => '运营活动ID，可通过ListCampaigns查询账号下的运营活动列表，获取运营活动ID。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
@@ -3305,57 +1451,16 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Id' => [
- 'title' => '运营活动Id。',
- 'description' => '运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '运营活动名称。',
- 'description' => '运营活动名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '双十一活动',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Id' => ['title' => '运营活动Id。', 'description' => '运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '运营活动名称。', 'description' => '运营活动名称。', 'type' => 'string', 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => '双十一活动'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -3365,114 +1470,55 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
'title' => '获取运营活动详情',
- ],
- 'UpdateCampaign' => [
- 'summary' => '更新运营活动名称和备注。',
- 'path' => '/api/v2/campaigns/{Id}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'],
+ ],
],
+ ],
+ 'GetGroup' => [
+ 'summary' => '获取人群详情。',
+ 'path' => '/api/v2/groups/{Id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '131226',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129060',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'path',
- 'schema' => [
- 'title' => '运营活动Id，可通过ListCampaigns查询账号下的运营活动列表，获取运营活动Id。',
- 'description' => '运营活动ID，可通过ListCampaigns查询账号下的运营活动列表，获取运营活动ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '996e466b-6808-49c7-998c-47b57bb85dd4',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '请求参数的主体信息。',
- 'description' => '请求参数的主体信息。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '运营活动名称。',
- 'description' => '运营活动名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '双十一活动',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '人群Id，可通过ListGroups查询账号下的人群列表，获取人群Id。', 'description' => '人群ID，可通过ListGroups查询获取。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功更新运营活动。',
- 'description' => '成功更新运营活动。',
+ 'title' => '成功获取人群详情。',
+ 'description' => '成功获取人群详情。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -3480,57 +1526,46 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Id' => [
- 'title' => '运营活动Id。',
- 'description' => '运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '运营活动名称。',
- 'description' => '运营活动名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '双十一活动',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
+ 'Algorithm' => ['title' => '关联算法，人群来源为算法。', 'description' => '关联算法，人群来源为算法。', 'type' => 'string', 'example' => 'user_recall'],
+ 'Amount' => ['title' => '人群数量。', 'description' => '人群数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'CampaignId' => ['title' => '关联运营活动Id。', 'description' => '关联运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Column' => ['title' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。', 'description' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。', 'type' => 'string', 'example' => 'education'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间（UTC+8）。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Filter' => ['title' => '过滤条件，人群来源为MaxCompute时可指定。', 'description' => '过滤条件，人群来源为MaxCompute时可指定。', 'type' => 'string', 'example' => 'ds=2022'],
+ 'History' => ['title' => '历史记录。', 'description' => '历史记录。', 'type' => 'string', 'example' => 'Project not found - \'sms_test\''],
+ 'Id' => ['title' => '人群Id。', 'description' => '人群ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'InferenceJobId' => ['title' => '预测任务Id，人群来源为算法。', 'description' => '预测任务ID，人群来源为算法。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '人群名称。', 'description' => '人群名称。', 'type' => 'string', 'example' => 'VIP customer'],
+ 'PhoneNumber' => ['title' => '是否包含手机号，包含手机号的人群可用于触达计划。', 'description' => '是否包含手机号，包含手机号的人群可用于触达计划。', 'type' => 'boolean', 'example' => 'true'],
+ 'Project' => ['title' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。', 'description' => 'MaxCompute（ODPS）项目名，人群来源为MaxCompute时需指定。', 'type' => 'string', 'example' => 'project'],
+ 'Remark' => ['title' => '人群备注。', 'description' => '人群备注。', 'type' => 'string', 'example' => 'Recharge amount exceeds 100,000'],
+ 'Source' => ['title' => '人群来源。'."\n"
+ .'- 0: 文本，每行一个手机号，最多100个。'."\n"
+ .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 2: 多列CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 3: MaxCompute表，需指定手机号列名。'."\n"
+ .'- 4: 算法。', 'description' => '人群来源。'."\n"
+ .'- 0：文本，每行一个手机号，最多100个。'."\n"
+ .'- 1：文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 2：CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 3：MaxCompute(ODPS)表，需指定手机号列名。'."\n"
+ .'- 4：算法。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Status' => ['title' => '人群状态。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 已通过。'."\n"
+ .'- 2: 未通过。', 'description' => '人群状态。'."\n"
+ .'- 0：检查中。'."\n"
+ .'- 1：已通过。'."\n"
+ .'- 2：未通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Table' => ['title' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。', 'description' => 'MaxCompute（ODPS）表名，人群来源为MaxCompute时需指定。', 'type' => 'string', 'example' => 'recall'],
+ 'Text' => ['title' => '文本，人群来源为文本时需指定。', 'description' => '文本，人群来源为文本时需指定。', 'type' => 'string', 'example' => '1390000****'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间（UTC+8）。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Uri' => ['title' => '文件地址，人群来源为文本文件，CSV文件时需指定。', 'description' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/file'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -3540,119 +1575,57 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '更新运营活动',
- ],
- 'ListAlgorithms' => [
- 'summary' => '获取当前可用算法列表。',
- 'path' => '/api/v2/algorithms',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"Amount\\": 0,\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Column\\": \\"education\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Filter\\": \\"ds=2022\\",\\n \\"History\\": \\"Project not found - \'sms_test\'\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"InferenceJobId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"PhoneNumber\\": true,\\n \\"Project\\": \\"project\\",\\n \\"Remark\\": \\"Recharge amount exceeds 100,000\\",\\n \\"Source\\": 0,\\n \\"Status\\": 0,\\n \\"Table\\": \\"recall\\",\\n \\"Text\\": \\"1390000****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Uri\\": \\"https://bucket.region.aliyuncs.com/folder/file\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取人群详情',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-07T08:36:04.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'],
+ ],
],
+ ],
+ 'GetInferenceJob' => [
+ 'summary' => '获取预测任务详情。',
+ 'path' => '/api/v2/inference/jobs/{Id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129064',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129061',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
'name' => 'Id',
- 'in' => 'query',
- 'schema' => [
- 'title' => '算法Id过滤。',
- 'description' => '算法ID过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sms_recall',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '算法名称过滤。',
- 'description' => '算法名称过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '短信召回',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'in' => 'path',
+ 'schema' => ['title' => '预测任务Id，可通过ListInferenceJobs查询账号下的预测任务列表，获取预测任务Id。', 'description' => '预测任务Id，可通过ListInferenceJobs查询账号下的预测任务列表，获取预测任务Id。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取算法列表。',
- 'description' => '成功获取算法列表。',
+ 'title' => '成功获取预测任务详情。',
+ 'description' => '成功获取预测任务详情。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -3660,72 +1633,30 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Algorithms' => [
- 'title' => '算法列表。',
- 'description' => '算法列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '算法Id。',
- 'description' => '算法ID。',
- 'type' => 'string',
- 'example' => 'sms_recall',
- ],
- 'Name' => [
- 'title' => '算法名称。',
- 'description' => '算法名称。',
- 'type' => 'string',
- 'example' => '短信召回',
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总算法数量。',
- 'description' => '总算法数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'Algorithm' => ['title' => '关联算法。', 'description' => '关联算法。', 'type' => 'string', 'example' => 'user_recall'],
+ 'CampaignId' => ['title' => '关联运营活动Id。', 'description' => '关联运营活动Id。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'DataPath' => ['title' => '预测数据路径。', 'description' => '预测数据路径。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'GroupId' => ['title' => '关联人群Id，如果任务失败则人群无效。', 'description' => '关联人群Id，如果任务失败则人群无效。', 'type' => 'string', 'example' => '0197261b-30e6-467b-83d6-7f72af868b03'],
+ 'History' => ['title' => '预测任务日志。', 'description' => '预测任务日志。', 'type' => 'string', 'example' => 'Error: Missing Column.'],
+ 'Id' => ['title' => '预测任务Id。', 'description' => '预测任务Id。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '预测任务名称。', 'description' => '预测任务名称。', 'type' => 'string', 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => 'Recharge amount exceeds 10,000'],
+ 'Status' => ['title' => '预测任务状态。', 'description' => '预测任务状态。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'TargetPath' => ['title' => '输出数据路径，需要为空目录。', 'description' => '输出数据路径，需要为空目录。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'TrainingJobId' => ['title' => '关联训练任务。', 'description' => '关联训练任务。', 'type' => 'string', 'example' => '123'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'UserConfig' => ['title' => '用户配置。', 'description' => '用户配置。', 'type' => 'string', 'example' => '{}'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -3735,84 +1666,49 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithms\\": [\\n {\\n \\"Id\\": \\"sms_recall\\",\\n \\"Name\\": \\"短信召回\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取算法列表',
- ],
- 'GetAlgorithm' => [
- 'summary' => '获取算法详细参数信息。',
- 'path' => '/api/v2/algorithms/{Id}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"GroupId\\": \\"0197261b-30e6-467b-83d6-7f72af868b03\\",\\n \\"History\\": \\"Error: Missing Column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"Recharge amount exceeds 10,000\\",\\n \\"Status\\": 3,\\n \\"TargetPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"TrainingJobId\\": \\"123\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取预测任务详情',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInferenceJob'],
+ ],
],
+ ],
+ 'GetMessageConfig' => [
+ 'summary' => '获取用户短信配置，如回执接口，上行短信接口等。',
+ 'path' => '/api/v2/users/messageConfig',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129059',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'Id',
- 'in' => 'path',
- 'schema' => [
- 'title' => '模板Id，可通过ListAlgorithms查询当前可用算法，使用获取的算法Id。',
- 'description' => '算法ID，可通过ListAlgorithms查询当前可用算法，使用获取的算法ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
- ],
+ 'abilityTreeCode' => '129012',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取算法详情。',
- 'description' => '成功获取算法详情。',
+ 'title' => '成功获取短信配置。',
+ 'description' => '成功获取短信配置。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -3820,57 +1716,13 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'title' => '算法说明。',
- 'description' => '算法说明。',
- 'type' => 'string',
- 'example' => '算法说明',
- ],
- 'Id' => [
- 'title' => '算法Id。',
- 'description' => '算法ID。',
- 'type' => 'string',
- 'example' => 'sms_recall',
- ],
- 'InferUserConfigMap' => [
- 'title' => '预测所需参数名与对应的参数说明。',
- 'description' => '预测所需参数名与对应的参数说明。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Name' => [
- 'title' => '算法名称。',
- 'description' => '算法名称。',
- 'type' => 'string',
- 'example' => '短信召回',
- ],
- 'TrainUserConfigMap' => [
- 'title' => '训练所需参数名与对应的参数说明。',
- 'description' => '训练所需参数名与对应的参数说明。',
- 'type' => 'string',
- 'example' => '{}',
- ],
+ 'SmsReportUrl' => ['title' => '短信发送状态回执接收服务地址。', 'description' => '短信发送状态回执接收服务地址。', 'type' => 'string', 'example' => 'http://example.com'],
+ 'SmsUpUrl' => ['title' => '上行短信消息接收服务地址。', 'description' => '上行短信消息接收服务地址。', 'type' => 'string', 'example' => 'http://example.com'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -3880,134 +1732,56 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Description\\": \\"算法说明\\",\\n \\"Id\\": \\"sms_recall\\",\\n \\"InferUserConfigMap\\": \\"{}\\",\\n \\"Name\\": \\"短信召回\\",\\n \\"TrainUserConfigMap\\": \\"{}\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取算法详情',
- ],
- 'CreateTrainingJob' => [
- 'summary' => '创建训练任务。',
- 'path' => '/api/v2/training/jobs',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SmsReportUrl\\": \\"http://example.com\\",\\n \\"SmsUpUrl\\": \\"http://example.com\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取短信配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMessageConfig'],
+ ],
],
+ ],
+ 'GetSchedule' => [
+ 'summary' => '获取发送计划详细信息，包括计划时间、内容、状态等。',
+ 'path' => '/api/v2/schedules/{Id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129054',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129062',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '请求参数的主体信息。',
- 'description' => '请求参数的主体信息。',
- 'type' => 'object',
- 'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法ID。',
- 'description' => '关联算法ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user_recall',
- ],
- 'CampaignId' => [
- 'title' => '关联运营活动ID。',
- 'description' => '关联运营活动ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'DataPath' => [
- 'title' => '训练数据路径，指定路径前需确保已在控制台完成一键授权。',
- 'description' => '训练数据路径。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'Name' => [
- 'title' => '训练任务名称。',
- 'description' => '训练任务名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '充值大于一万',
- ],
- 'UserConfig' => [
- 'title' => '用户配置。',
- 'description' => '用户配置，用于设置start\\_date、end\\_date等参数，划定建模数据的时间范围。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "start_date": "20210101",'."\n"
- .' "end_date": "20210131"'."\n"
- .'}',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'Id',
+ 'in' => 'path',
+ 'schema' => ['title' => '短信触达计划ID，可通过ListSchedules查询账号下的短信触达计划列表，获取短信触达计划ID。', 'description' => '触达计划ID。如何获取触达计划ID，请参见[ListSchedules](~~429073~~)。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => '成功注册训练任务，可通过控制台或GetTrainingJob获取任务执行状态。',
- 'description' => '成功注册训练任务，可通过控制台或GetTrainingJob获取任务执行状态。',
+ 'title' => '成功获取短信触达计划详情。',
+ 'description' => '成功获取触达计划详情。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -4015,118 +1789,57 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法ID。',
- 'description' => '关联算法ID。',
- 'type' => 'string',
- 'example' => 'user_recall',
- ],
- 'CampaignId' => [
- 'title' => '关联运营活动ID。',
- 'description' => '关联运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'DataPath' => [
- 'title' => '训练数据路径，指定路径前需确保已在控制台完成一键授权。',
- 'description' => '训练数据路径。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'History' => [
- 'title' => '训练任务日志。',
- 'description' => '训练任务日志。',
- 'type' => 'string',
- 'example' => 'Error: Parameter are not found.',
- ],
- 'Id' => [
- 'title' => '训练任务ID。',
- 'description' => '训练任务ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '训练任务名称。',
- 'description' => '训练任务名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '充值大于一万',
- ],
- 'Status' => [
- 'title' => '训练任务状态。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'description' => '训练任务状态。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'TrainingScheduleId' => [
- 'title' => '关联训练计划ID。',
- 'description' => '关联训练计划ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'UserConfig' => [
- 'title' => '用户配置。',
- 'description' => '用户配置。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "start_date": "20210101",'."\n"
- .' "end_date": "20210131"'."\n"
- .'}',
- ],
- 'HasModelInfo' => [
- 'description' => '是否存有特征重要性、模式、决策树等特征信息。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'EndTime' => ['title' => '终止时间（UTC+8）。', 'description' => '终止时间（UTC+8）。', 'type' => 'string', 'format' => 'int32', 'example' => '2020-01-01'],
+ 'ExecuteTime' => ['title' => '执行时间 (UTC+8)，为空立即执行。', 'description' => '执行时间 (UTC+8)，为空立即执行。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'GroupId' => ['title' => '人群ID。', 'description' => '人群ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'History' => ['title' => '历史记录。', 'description' => '历史记录。', 'type' => 'string', 'example' => 'string'],
+ 'Id' => ['title' => '触达计划ID。', 'description' => '触达计划ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '触达计划名称。', 'description' => '触达计划名称。', 'type' => 'string', 'example' => 'Growth-2021-0101'],
+ 'RepeatCycle' => ['title' => '重复周期，按重复周期与重复周期单位执行。', 'description' => '重复周期，按重复周期与重复周期单位执行。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RepeatCycleUnit' => ['title' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
+ .'- 0: 从不（默认）。'."\n"
+ .'- 1: 小时。'."\n"
+ .'- 2: 天。'."\n"
+ .'- 3: 周。'."\n"
+ .'- 4: 月。', 'description' => '重复周期单位，若指定执行时间（ExecuteTime），则重复周期生效。可能值：'."\n"
+ .'- 0：从不（默认）。'."\n"
+ .'- 1：小时。'."\n"
+ .'- 2：天。'."\n"
+ .'- 3：周。'."\n"
+ .'- 4：月。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RepeatTimes' => ['title' => '重复次数。'."\n"
+ .'- 0: 不设终止时间（默认）。'."\n"
+ .'- N: 重复N次后终止。', 'description' => '重复次数，可能值：'."\n"
+ .'- -1：不设终止时间（默认）。'."\n"
+ .'- 0：不重复。'."\n"
+ .'- N：重复N次后终止。', 'type' => 'integer', 'format' => 'int32', 'example' => '-1'],
+ 'SignName' => ['title' => '签名。', 'description' => '签名。', 'type' => 'string', 'example' => 'PAI'],
+ 'SignatureId' => ['title' => '签名ID，或指定签名。', 'description' => '签名ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Status' => ['title' => '状态。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 检查成功。'."\n"
+ .'- 2: 检查失败。'."\n"
+ .'- 3: 发送中。'."\n"
+ .'- 4: 发送成功。'."\n"
+ .'- 5: 发送失败。', 'description' => '状态，可能值：'."\n"
+ .'- 0：检查中。'."\n"
+ .'- 1：检查成功。'."\n"
+ .'- 2：检查失败。'."\n"
+ .'- 3：发送中。'."\n"
+ .'- 4：发送成功。'."\n"
+ .'- 5：发送失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TemplateCode' => ['title' => '模板Code。', 'description' => '模板Code。', 'type' => 'string', 'example' => 'SMS_123456'],
+ 'TemplateId' => ['title' => '模板ID，或指定模板Code。', 'description' => '模板ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'PaymentType' => ['description' => '计费类型（为空时默认后付费），可能值为：'."\n"
+ .'- PayAsYouGo：后付费（按量付费）'."\n"
+ .'- Subscription：预付费（包年包月）', 'type' => 'string', 'example' => 'Subscription'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -4136,290 +1849,145 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"History\\": \\"Error: Parameter are not found.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TrainingScheduleId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{\\\\n \\\\\\"start_date\\\\\\": \\\\\\"20210101\\\\\\",\\\\n \\\\\\"end_date\\\\\\": \\\\\\"20210131\\\\\\"\\\\n}\\",\\n \\"HasModelInfo\\": false\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '创建训练任务',
- 'description' => '在使用前需要在网页端一键授权OSS访问权限，并将需要访问的OSS Bucket添加pai=plugin的标签，请参考[OSS添加标签](https://help.aliyun.com/document_detail/133826.html)。',
- ],
- 'DeleteTrainingJob' => [
- 'summary' => '删除训练任务。',
- 'path' => '/api/v2/training/jobs/{Id}',
- 'methods' => [
- 'delete',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"EndTime\\": \\"2020-01-01\\",\\n \\"ExecuteTime\\": \\"2020-01-01 12:00:00\\",\\n \\"GroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"History\\": \\"string\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"Growth-2021-0101\\",\\n \\"RepeatCycle\\": 0,\\n \\"RepeatCycleUnit\\": 0,\\n \\"RepeatTimes\\": -1,\\n \\"SignName\\": \\"PAI\\",\\n \\"SignatureId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"TemplateId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"PaymentType\\": \\"Subscription\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取发送计划详情',
+ 'changeSet' => [
+ ['createdAt' => '2023-03-09T08:29:49.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSchedule'],
+ ],
],
+ ],
+ 'GetSignature' => [
+ 'summary' => '获取签名的详细信息。',
+ 'path' => '/api/v2/signatures/{Id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129058',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '123202',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'path',
- 'schema' => [
- 'title' => '训练任务Id，可通过ListTrainingJobs查询账号下的训练任务列表，获取训练任务Id。',
- 'description' => '训练任务ID，可通过ListTrainingJobs查询账号下的训练任务列表，获取训练任务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'b8e300a1-ff80-4ae4-bdc5-0c33dbcd76db',
- ],
+ 'schema' => ['title' => '签名Id，可通过ListSignatures查询账号下的签名列表，获取签名Id。', 'description' => '签名Id，可通过ListSignatures查询账号下的签名列表，获取签名Id。', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功删除训练任务。',
- 'description' => '成功删除训练任务。',
+ 'title' => '成功获取签名详情。',
+ 'description' => '成功获取签名详情。',
'type' => 'object',
'properties' => [
'Data' => [
'title' => '返回数据。',
'description' => '返回数据。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Description' => ['title' => '申请说明。', 'description' => '申请说明。', 'type' => 'string', 'example' => 'Application description'],
+ 'Id' => ['title' => '签名Id。', 'description' => '签名Id。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '签名名称。', 'description' => '签名名称。', 'type' => 'string', 'example' => 'User growth'],
+ 'Reason' => ['title' => '审核建议。', 'description' => '审核建议。', 'type' => 'string', 'example' => 'Agree'],
+ 'Status' => ['title' => '签名审核状态。'."\n"
+ .'- 0：审核中。'."\n"
+ .'- 1：审核通过。'."\n"
+ .'- 2：审核不通过。', 'description' => '签名审核状态。'."\n"
+ .'- 0：审核中。'."\n"
+ .'- 1：审核通过。'."\n"
+ .'- 2：审核不通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ ],
],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'description' => '失败,原因见errmsg',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '删除训练任务',
- ],
- 'ListTrainingJobs' => [
- 'summary' => '获取训练任务列表。',
- 'path' => '/api/v2/training/jobs',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"Application description\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"User growth\\",\\n \\"Reason\\": \\"Agree\\",\\n \\"Status\\": 0,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取签名详情',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSignature'],
+ ],
],
+ ],
+ 'GetTemplate' => [
+ 'summary' => '获取模板详细内容。',
+ 'path' => '/api/v2/templates/{Id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129068',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '123203',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'CampaignId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '归属运营活动过滤。',
- 'description' => '归属运营活动过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '训练任务名称过滤。',
- 'description' => '训练任务名称过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'VIP客户',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '训练任务列表的页码。起始值为1，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页查询时设置的每页显示的训练任务数量，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Remark',
- 'in' => 'query',
- 'schema' => [
- 'title' => '训练任务备注过滤。',
- 'description' => '训练任务备注过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '充值大于一万',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'title' => '训练任务状态过滤。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'description' => '训练任务状态过滤，取值如下：'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'TrainingScheduleId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '归属训练计划过滤。',
- 'description' => '归属训练计划过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- ],
- [
- 'name' => 'CampaignName',
- 'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'title' => '关联运营活动名称',
- 'description' => '关联运营活动名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '双11活动',
- ],
+ 'name' => 'Id',
+ 'in' => 'path',
+ 'schema' => ['title' => '模板Id，可通过ListTemplates查询账号下的模板列表，获取模板Id。', 'description' => '模板ID，可通过ListTemplates查询账号下的模板列表，获取模板ID。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取训练任务列表。',
- 'description' => '成功获取训练任务列表。',
+ 'title' => '成功获取模板详情。',
+ 'description' => '成功获取模板详情。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -4427,207 +1995,76 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '返回查询的训练任务列表的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '返回每页显示的训练任务数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总训练任务数量。',
- 'description' => '总训练任务数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TrainingJobs' => [
- 'title' => '训练任务列表。',
- 'description' => '训练任务列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法ID。',
- 'description' => '关联算法ID。',
- 'type' => 'string',
- 'example' => 'user_recall',
- ],
- 'CampaignId' => [
- 'title' => '关联运营活动ID。',
- 'description' => '关联运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'DataPath' => [
- 'title' => '训练数据路径，指定路径前需确保已在控制台完成一键授权。',
- 'description' => '训练数据路径。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'History' => [
- 'title' => '训练任务日志。',
- 'description' => '训练任务日志。',
- 'type' => 'string',
- 'example' => 'Error: Unknown parameter.',
- ],
- 'Id' => [
- 'title' => '训练任务ID。',
- 'description' => '训练任务Id。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '训练任务名称。',
- 'description' => '训练任务名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '充值大于一万',
- ],
- 'Status' => [
- 'title' => '训练任务状态。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'description' => '训练任务状态，可能值：'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'TrainingScheduleId' => [
- 'title' => '关联训练计划ID。',
- 'description' => '关联训练计划ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'UserConfig' => [
- 'title' => '用户配置。',
- 'description' => '用户配置。',
- 'type' => 'string',
- 'example' => '{\\"end_date\\":\\"20220408\\",\\"op_target\\":\\"sms\\",\\"start_date\\":\\"20220101\\"}',
- ],
- 'HasModelInfo' => [
- 'description' => '是否存有特征重要性、模式、决策树等特征信息。',
- 'type' => 'boolean',
- 'example' => 'true',
- 'default' => 'true',
- ],
- ],
- ],
- ],
+ 'Content' => ['title' => '模板内容。', 'description' => '模板内容。', 'type' => 'string', 'example' => 'Your crush just left you a message.'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Description' => ['title' => '申请说明。', 'description' => '申请说明。', 'type' => 'string', 'example' => 'Application description'],
+ 'Id' => ['title' => '模板Id。', 'description' => '模板ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '签名名称。', 'description' => '模板名称。', 'type' => 'string', 'example' => '模板召回-20220101'],
+ 'Reason' => ['title' => '审核意见。', 'description' => '审核意见。', 'type' => 'string', 'example' => 'Agree'],
+ 'SignatureId' => ['title' => '签名Id。', 'description' => '签名ID。', 'type' => 'string', 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'],
+ 'Status' => ['title' => '审核状态。'."\n"
+ .'- 0 : 审核中。'."\n"
+ .'- 1 : 审核通过。'."\n"
+ .'- 2 : 审核不通过。', 'description' => '审核状态。'."\n"
+ .'- 0 : 审核中。'."\n"
+ .'- 1 : 审核通过。'."\n"
+ .'- 2 : 审核不通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TemplateCode' => ['title' => '模板Code。', 'description' => '模板Code。', 'type' => 'string', 'example' => 'SMS_123456'],
+ 'Type' => ['title' => '模板类型。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'description' => '模板类型。'."\n"
+ .'- 0：验证码。'."\n"
+ .'- 1：短信通知。'."\n"
+ .'- 2：推广短信。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'description' => '失败,原因见errmsg',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"TrainingJobs\\": [\\n {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"History\\": \\"Error: Unknown parameter.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TrainingScheduleId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{\\\\\\\\\\\\\\"end_date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20220408\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"op_target\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sms\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"start_date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20220101\\\\\\\\\\\\\\"}\\",\\n \\"HasModelInfo\\": true\\n }\\n ]\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取训练任务列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": \\"Your crush just left you a message.\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"Application description\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"模板召回-20220101\\",\\n \\"Reason\\": \\"Agree\\",\\n \\"SignatureId\\": \\"5480e3e7-f578-42d2-8ce8-217dec75f2e6\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"Type\\": 1,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取模板详情',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ],
+ ],
],
'GetTrainingJob' => [
'summary' => '获取训练任务详情。',
'path' => '/api/v2/training/jobs/{Id}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
@@ -4635,21 +2072,13 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '129063',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'path',
- 'schema' => [
- 'title' => '训练任务ID，可通过ListTrainingJobs查询账号下的训练任务列表，获取训练任务ID。',
- 'description' => '训练任务ID。如何获取训练任务ID，请参见[ListTrainingJobs](~~429059~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
+ 'schema' => ['title' => '训练任务ID，可通过ListTrainingJobs查询账号下的训练任务列表，获取训练任务ID。', 'description' => '训练任务ID。如何获取训练任务ID，请参见[ListTrainingJobs](~~429059~~)。', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'],
],
],
'responses' => [
@@ -4664,115 +2093,34 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法ID。',
- 'description' => '关联算法ID。',
- 'type' => 'string',
- 'example' => 'user_recall',
- ],
- 'CampaignId' => [
- 'title' => '关联运营活动ID。',
- 'description' => '关联运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'DataPath' => [
- 'title' => '训练数据路径，指定路径前需确保已在控制台完成一键授权。',
- 'description' => '训练数据路径。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'History' => [
- 'title' => '训练任务日志。',
- 'description' => '训练任务日志。',
- 'type' => 'string',
- 'example' => 'Error: Missing column.',
- ],
- 'Id' => [
- 'title' => '训练任务ID。',
- 'description' => '训练任务ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '训练任务名称。',
- 'description' => '训练任务名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '充值大于一万',
- ],
- 'Status' => [
- 'title' => '训练任务状态。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'description' => '训练任务状态，可能值：'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'TrainingScheduleId' => [
- 'title' => '关联训练计划ID。',
- 'description' => '关联训练计划ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'UserConfig' => [
- 'title' => '用户配置。',
- 'description' => '用户配置。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'HasModelInfo' => [
- 'description' => '是否存有特征重要性、模式、决策树等特征信息。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'Algorithm' => ['title' => '关联算法ID。', 'description' => '关联算法ID。', 'type' => 'string', 'example' => 'user_recall'],
+ 'CampaignId' => ['title' => '关联运营活动ID。', 'description' => '关联运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'DataPath' => ['title' => '训练数据路径，指定路径前需确保已在控制台完成一键授权。', 'description' => '训练数据路径。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'History' => ['title' => '训练任务日志。', 'description' => '训练任务日志。', 'type' => 'string', 'example' => 'Error: Missing column.'],
+ 'Id' => ['title' => '训练任务ID。', 'description' => '训练任务ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '训练任务名称。', 'description' => '训练任务名称。', 'type' => 'string', 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => 'Recharge amount exceeds 10,000'],
+ 'Status' => ['title' => '训练任务状态。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'description' => '训练任务状态，可能值：'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'TrainingScheduleId' => ['title' => '关联训练计划ID。', 'description' => '关联训练计划ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'UserConfig' => ['title' => '用户配置。', 'description' => '用户配置。', 'type' => 'string', 'example' => '{}'],
+ 'HasModelInfo' => ['description' => '是否存有特征重要性、模式、决策树等特征信息。', 'type' => 'boolean', 'example' => 'false'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -4782,145 +2130,51 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"History\\": \\"Error: Missing column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TrainingScheduleId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\",\\n \\"HasModelInfo\\": false\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"History\\": \\"Error: Missing column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"Recharge amount exceeds 10,000\\",\\n \\"Status\\": 3,\\n \\"TrainingScheduleId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\",\\n \\"HasModelInfo\\": false\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
'title' => '获取训练任务详情',
- ],
- 'CreateInferenceJob' => [
- 'summary' => '创建预测任务。',
- 'path' => '/api/v2/inference/jobs',
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-22T06:31:13.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJob'],
+ ],
],
+ ],
+ 'GetUser' => [
+ 'summary' => '获取用户产品状态等基本信息。',
+ 'path' => '/api/v2/users',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129052',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '请求参数的主体信息。',
- 'description' => '请求参数的主体信息。',
- 'type' => 'object',
- 'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法。',
- 'description' => '关联算法ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user_recall',
- ],
- 'CampaignId' => [
- 'title' => '关联运营活动Id。',
- 'description' => '关联运营活动ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'DataPath' => [
- 'title' => '预测数据路径。',
- 'description' => '预测数据路径。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'Name' => [
- 'title' => '预测任务名称。',
- 'description' => '预测任务名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '充值大于一万',
- ],
- 'TargetPath' => [
- 'title' => '输出数据路径，需要为空目录。',
- 'description' => '输出数据路径，需要为空目录。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'TrainingJobId' => [
- 'title' => '关联训练任务。',
- 'description' => '关联训练任务。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- 'UserConfig' => [
- 'title' => '用户配置。',
- 'description' => '用户配置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- ],
- 'required' => false,
- ],
- ],
+ 'abilityTreeCode' => '128719',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功发起注册预测任务请求，可通过控制台或GetInferenceJob获取任务执行状态。',
- 'description' => '成功发起注册预测任务请求，可通过控制台或GetInferenceJob获取任务执行状态。',
+ 'title' => '成功获取账号状态。',
+ 'description' => '成功获取基本信息。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -4928,117 +2182,18 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法。',
- 'description' => '关联算法ID。',
- 'type' => 'string',
- 'example' => 'user_recall',
- ],
- 'CampaignId' => [
- 'title' => '关联运营活动Id。',
- 'description' => '关联运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'DataPath' => [
- 'title' => '预测数据路径。',
- 'description' => '预测数据路径。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'GroupId' => [
- 'title' => '关联人群Id，如果任务失败则人群无效。',
- 'description' => '关联人群ID，如果任务失败则人群无效。',
- 'type' => 'string',
- 'example' => 'bdb0b117-3354-4ceb-ba75-e022dd9370d8',
- ],
- 'History' => [
- 'title' => '预测任务日志。',
- 'description' => '预测任务日志。',
- 'type' => 'string',
- 'example' => 'Error: Missing Column.',
- ],
- 'Id' => [
- 'title' => '预测任务Id。',
- 'description' => '预测任务ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '预测任务名称。',
- 'description' => '预测任务名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '充值大于一万',
- ],
- 'Status' => [
- 'title' => '预测任务状态。',
- 'description' => '预测任务状态。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'TargetPath' => [
- 'title' => '输出数据路径，需要为空目录。',
- 'description' => '输出数据路径，需要为空目录。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'TrainingJobId' => [
- 'title' => '关联训练任务。',
- 'description' => '关联训练任务。',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'UserConfig' => [
- 'title' => '用户配置。',
- 'description' => '用户配置。',
- 'type' => 'string',
- 'example' => '{}',
- ],
+ 'AccountStatus' => ['title' => '账号状态。'."\n"
+ .'- 0 : 正常使用。'."\n"
+ .'- 1 : 因欠费等原因暂时停用。'."\n"
+ .'- 2 : 已释放产品。', 'description' => '账号状态。'."\n"
+ .'- 0 : 正常使用。'."\n"
+ .'- 1 : 因欠费等原因暂时停用。'."\n"
+ .'- 2 : 已释放产品。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -5048,113 +2203,98 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"GroupId\\": \\"bdb0b117-3354-4ceb-ba75-e022dd9370d8\\",\\n \\"History\\": \\"Error: Missing Column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TargetPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"TrainingJobId\\": \\"123\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '创建预测任务',
- 'description' => '在使用前需要在网页端一键授权OSS访问权限，并将需要访问的OSS Bucket添加pai=plugin的标签，请参考[OSS添加标签](https://help.aliyun.com/document_detail/133826.html)。 '."\n"
- .'预测任务输出的csv文件不包含header，每列分别表示：user\\_id，item\\_id，phone，score。',
- ],
- 'DeleteInferenceJob' => [
- 'summary' => '删除预测任务。',
- 'path' => '/api/v2/inference/jobs/{Id}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"AccountStatus\\": 0\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取基本信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
+ ],
],
+ ],
+ 'ListAlgorithms' => [
+ 'summary' => '获取当前可用算法列表。',
+ 'path' => '/api/v2/algorithms',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129056',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129064',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
'name' => 'Id',
- 'in' => 'path',
- 'schema' => [
- 'title' => '预测任务Id，可通过ListInferenceJobs查询账号下的预测任务列表，获取预测任务Id。',
- 'description' => '预测任务ID，可通过ListInferenceJobs查询账号下的预测任务列表，获取预测任务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '算法Id过滤。', 'description' => '算法ID过滤。', 'type' => 'string', 'required' => false, 'example' => 'sms_recall'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '算法名称过滤。', 'description' => '算法名称过滤。', 'type' => 'string', 'required' => false, 'example' => '短信召回'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功删除预测任务Id。',
- 'description' => '成功删除预测任务。',
+ 'title' => '成功获取算法列表。',
+ 'description' => '成功获取算法列表。',
'type' => 'object',
'properties' => [
'Data' => [
'title' => '返回数据。',
'description' => '返回数据。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
+ 'type' => 'object',
+ 'properties' => [
+ 'Algorithms' => [
+ 'title' => '算法列表。',
+ 'description' => '算法列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '算法Id。', 'description' => '算法ID。', 'type' => 'string', 'example' => 'sms_recall'],
+ 'Name' => ['title' => '算法名称。', 'description' => '算法名称。', 'type' => 'string', 'example' => '短信召回'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'TotalCount' => ['title' => '总算法数量。', 'description' => '总算法数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -5164,170 +2304,70 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '删除预测任务',
- ],
- 'ListInferenceJobs' => [
- 'summary' => '获取预测任务列表。',
- 'path' => '/api/v2/inference/jobs',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithms\\": [\\n {\\n \\"Id\\": \\"sms_recall\\",\\n \\"Name\\": \\"短信召回\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取算法列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithms'],
+ ],
],
+ ],
+ 'ListCampaigns' => [
+ 'summary' => '获取运营活动列表。',
+ 'path' => '/api/v2/campaigns',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129066',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '131225',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'CampaignId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '归属运营活动过滤。',
- 'description' => '归属运营活动过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- ],
- [
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'title' => '预测任务名称过滤。',
- 'description' => '预测任务名称过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'VIP客户',
- ],
+ 'schema' => ['title' => '运营活动名称过滤。', 'description' => '运营活动名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'title' => '预测任务备注过滤。',
- 'description' => '预测任务备注过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '充值大于一万',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'title' => '预测任务状态过滤。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'description' => '预测任务状态过滤。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'CampaignName',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '双11活动',
- ],
- ],
- [
- 'name' => 'TrainingJobName',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_job',
- ],
+ 'schema' => ['title' => '运营活动备注过滤。', 'description' => '运营活动备注过滤。', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取预测任务列表。',
- 'description' => '成功获取预测任务列表。',
+ 'title' => '成功获取运营活动列表。',
+ 'description' => '成功获取运营活动列表。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -5335,161 +2375,30 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'InferenceJobs' => [
- 'title' => '预测任务列表。',
- 'description' => '预测任务列表。',
+ 'Campaigns' => [
+ 'title' => '运营活动列表。',
+ 'description' => '运营活动列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法。',
- 'description' => '关联算法。',
- 'type' => 'string',
- 'example' => 'user_recall',
- ],
- 'CampaignId' => [
- 'title' => '关联运营活动ID。',
- 'description' => '关联运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'DataPath' => [
- 'title' => '预测数据路径，当预测人群数据分布在多个csv文件时可指定目录，指定路径前需确保已在控制台完成一键授权。',
- 'description' => '预测数据路径。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'GroupId' => [
- 'title' => '预测人群，人群来源必须为多列csv，当同时指定DataPath与GroupId时，以GroupId为准。',
- 'description' => '关联人群ID，如果任务失败则人群无效。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'History' => [
- 'title' => '预测任务日志。',
- 'description' => '预测任务日志。',
- 'type' => 'string',
- 'example' => 'Error: Missing Column.',
- ],
- 'Id' => [
- 'title' => '预测任务ID。',
- 'description' => '预测任务ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '预测任务名称。',
- 'description' => '预测任务名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '充值大于一万',
- ],
- 'Status' => [
- 'title' => '预测任务状态。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'description' => '预测任务状态。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'TargetGroupId' => [
- 'title' => '关联目标人群ID，如果任务失败则人群无效。',
- 'description' => '关联目标人群ID，如果任务失败则人群无效。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'TargetPath' => [
- 'title' => '输出数据路径，需要为空目录，指定路径前需确保已在控制台完成一键授权。',
- 'description' => '输出数据路径，需要为空目录。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'TrainingJobId' => [
- 'title' => '关联训练任务。',
- 'description' => '关联训练任务。',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'UserConfig' => [
- 'title' => '用户配置。',
- 'description' => '用户配置。',
- 'type' => 'string',
- 'example' => '{}',
- ],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Id' => ['title' => '运营活动Id。', 'description' => '运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '运营活动名称。', 'description' => '运营活动名称。', 'type' => 'string', 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => '双十一活动'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
],
+ 'description' => '',
],
],
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总预测任务数量。',
- 'description' => '总预测任务数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'TotalCount' => ['title' => '总运营活动数量。', 'description' => '总运营活动数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -5499,84 +2408,85 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InferenceJobs\\": [\\n {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"GroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"History\\": \\"Error: Missing Column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TargetGroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"TargetPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"TrainingJobId\\": \\"123\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取预测任务列表',
- ],
- 'GetInferenceJob' => [
- 'summary' => '获取预测任务详情。',
- 'path' => '/api/v2/inference/jobs/{Id}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Campaigns\\": [\\n {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取运营活动列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'],
+ ],
],
+ ],
+ 'ListGroups' => [
+ 'summary' => '获取人群列表。',
+ 'path' => '/api/v2/groups',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129061',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129065',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'path',
- 'schema' => [
- 'title' => '预测任务Id，可通过ListInferenceJobs查询账号下的预测任务列表，获取预测任务Id。',
- 'description' => '预测任务Id，可通过ListInferenceJobs查询账号下的预测任务列表，获取预测任务Id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '人群名称过滤。', 'description' => '人群名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'PhoneNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否包含手机号过滤。', 'description' => '是否包含手机号过滤。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['title' => '人群备注过滤。', 'description' => '人群备注过滤。', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'],
+ ],
+ [
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['title' => '来源过滤。', 'description' => '来源过滤。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['title' => '审核状态过滤。', 'description' => '审核状态过滤。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取预测任务详情。',
- 'description' => '成功获取预测任务详情。',
+ 'title' => '成功获取人群列表。',
+ 'description' => '成功获取人群列表。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -5584,117 +2494,58 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法。',
- 'description' => '关联算法。',
- 'type' => 'string',
- 'example' => 'user_recall',
- ],
- 'CampaignId' => [
- 'title' => '关联运营活动Id。',
- 'description' => '关联运营活动Id。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'DataPath' => [
- 'title' => '预测数据路径。',
- 'description' => '预测数据路径。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'GroupId' => [
- 'title' => '关联人群Id，如果任务失败则人群无效。',
- 'description' => '关联人群Id，如果任务失败则人群无效。',
- 'type' => 'string',
- 'example' => '0197261b-30e6-467b-83d6-7f72af868b03',
- ],
- 'History' => [
- 'title' => '预测任务日志。',
- 'description' => '预测任务日志。',
- 'type' => 'string',
- 'example' => 'Error: Missing Column.',
- ],
- 'Id' => [
- 'title' => '预测任务Id。',
- 'description' => '预测任务Id。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '预测任务名称。',
- 'description' => '预测任务名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'Remark' => [
- 'title' => '备注。',
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '充值大于一万',
- ],
- 'Status' => [
- 'title' => '预测任务状态。',
- 'description' => '预测任务状态。'."\n"
- .'- 0: 队列中。'."\n"
- .'- 1: 已提交。'."\n"
- .'- 2: 运行中。'."\n"
- .'- 3: 成功。'."\n"
- .'- 4: 失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'TargetPath' => [
- 'title' => '输出数据路径，需要为空目录。',
- 'description' => '输出数据路径，需要为空目录。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/',
- ],
- 'TrainingJobId' => [
- 'title' => '关联训练任务。',
- 'description' => '关联训练任务。',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'UserConfig' => [
- 'title' => '用户配置。',
- 'description' => '用户配置。',
- 'type' => 'string',
- 'example' => '{}',
+ 'Groups' => [
+ 'title' => '人群列表。',
+ 'description' => '人群列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Algorithm' => ['title' => '关联算法，人群来源为算法。', 'description' => '关联算法，人群来源为算法。', 'type' => 'string', 'example' => 'user_recall'],
+ 'Amount' => ['title' => '人群数量。', 'description' => '人群数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Column' => ['title' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。', 'description' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。', 'type' => 'string', 'example' => 'phone'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Filter' => ['title' => '过滤条件，人群来源为MaxCompute时可指定。', 'description' => '过滤条件，人群来源为MaxCompute时可指定。', 'type' => 'string', 'example' => 'ds=2022'],
+ 'Id' => ['title' => '人群Id。', 'description' => '人群ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'InferenceJobId' => ['title' => '预测任务Id，人群来源为算法。', 'description' => '预测任务ID，人群来源为算法。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '人群名称。', 'description' => '人群名称。', 'type' => 'string', 'example' => 'VIP customer'],
+ 'PhoneNumber' => ['title' => '是否包含手机号，包含手机号的人群可用于触达计划。', 'description' => '是否包含手机号，包含手机号的人群可用于触达计划。', 'type' => 'boolean', 'example' => 'true'],
+ 'Project' => ['title' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。', 'description' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。', 'type' => 'string', 'example' => 'project'],
+ 'Remark' => ['title' => '人群备注。', 'description' => '人群备注。', 'type' => 'string', 'example' => 'Recharge amount exceeds 100,000'],
+ 'Source' => ['title' => '人群来源。'."\n"
+ .'- 0: 文本，每行一个手机号，最多100个。'."\n"
+ .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
+ .'- 4: 算法。', 'description' => '人群来源。'."\n"
+ .'- 0: 文本，每行一个手机号，最多100个。'."\n"
+ .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
+ .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
+ .'- 4: 算法。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Status' => ['title' => '人群状态。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 已通过。'."\n"
+ .'- 2: 未通过。', 'description' => '人群状态。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 已通过。'."\n"
+ .'- 2: 未通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Table' => ['title' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。', 'description' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。', 'type' => 'string', 'example' => 'recall'],
+ 'Text' => ['title' => '文本，人群来源为文本时需指定。', 'description' => '文本，人群来源为文本时需指定。', 'type' => 'string', 'example' => '1390000****'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Uri' => ['title' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。', 'description' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/file'],
+ ],
+ 'description' => '',
+ ],
],
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'TotalCount' => ['title' => '总人群数量。', 'description' => '总人群数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -5704,184 +2555,100 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"GroupId\\": \\"0197261b-30e6-467b-83d6-7f72af868b03\\",\\n \\"History\\": \\"Error: Missing Column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TargetPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"TrainingJobId\\": \\"123\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取预测任务详情',
- ],
- 'CreateGroup' => [
- 'summary' => '创建人群。',
- 'path' => '/api/v2/groups',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Groups\\": [\\n {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"Amount\\": 0,\\n \\"Column\\": \\"phone\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Filter\\": \\"ds=2022\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"InferenceJobId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"PhoneNumber\\": true,\\n \\"Project\\": \\"project\\",\\n \\"Remark\\": \\"Recharge amount exceeds 100,000\\",\\n \\"Source\\": 0,\\n \\"Status\\": 0,\\n \\"Table\\": \\"recall\\",\\n \\"Text\\": \\"1390000****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Uri\\": \\"https://bucket.region.aliyuncs.com/folder/file\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取人群列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroups'],
+ ],
],
+ ],
+ 'ListInferenceJobs' => [
+ 'summary' => '获取预测任务列表。',
+ 'path' => '/api/v2/inference/jobs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129051',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129066',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '请求参数的主体信息。',
- 'description' => '请求参数的主体信息。',
- 'type' => 'object',
- 'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法，人群来源为算法。',
- 'description' => '关联算法，人群来源为算法时需指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user_recall',
- ],
- 'Column' => [
- 'title' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。',
- 'description' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'phone',
- ],
- 'Filter' => [
- 'title' => '过滤条件，人群来源为MaxCompute时可指定。',
- 'description' => '过滤条件，人群来源为MaxCompute时可指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ds=20220101',
- ],
- 'InferenceJobId' => [
- 'title' => '预测任务Id，人群来源为算法。',
- 'description' => '预测任务ID，人群来源为算法。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '人群名称。',
- 'description' => '人群名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'VIP客户',
- ],
- 'PhoneNumber' => [
- 'title' => '是否包含手机号，包含手机号的人群可用于触达计划。',
- 'description' => '是否包含手机号，包含手机号的人群可用于触达计划。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Project' => [
- 'title' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。',
- 'description' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'project',
- ],
- 'Remark' => [
- 'title' => '人群备注。',
- 'description' => '人群备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '充值大于10万',
- ],
- 'Source' => [
- 'title' => '人群来源。'."\n"
- .'- 0: 文本，每行一个手机号，最多100个。'."\n"
- .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
- .'- 4: 算法。',
- 'description' => '人群来源。'."\n"
- .'- 0: 文本，每行一个手机号，最多100个。'."\n"
- .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
- .'- 4: 算法。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'Table' => [
- 'title' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。',
- 'description' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vip_recall',
- ],
- 'Text' => [
- 'title' => '文本，人群来源为文本时需指定。',
- 'description' => '文本，人群来源为文本时需指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1390000****',
- ],
- 'Uri' => [
- 'title' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。',
- 'description' => '文件地址，人群来源为文本文件，CSV文件时需指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://bucket.region.aliyuncs.com/folder/file',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'CampaignId',
+ 'in' => 'query',
+ 'schema' => ['title' => '归属运营活动过滤。', 'description' => '归属运营活动过滤。', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '预测任务名称过滤。', 'description' => '预测任务名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['title' => '预测任务备注过滤。', 'description' => '预测任务备注过滤。', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['title' => '预测任务状态过滤。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'description' => '预测任务状态过滤。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'CampaignName',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'example' => '双11活动', 'description' => ''],
+ ],
+ [
+ 'name' => 'TrainingJobName',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'example' => 'test_job', 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功发起注册人群请求，可通过控制台或GetGroup获取人群检查状态。',
- 'description' => '成功发起注册人群请求，可通过控制台或GetGroup获取人群检查状态。',
+ 'title' => '成功获取预测任务列表。',
+ 'description' => '成功获取预测任务列表。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -5889,148 +2656,50 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法，人群来源为算法。',
- 'description' => '关联算法，人群来源为算法。',
- 'type' => 'string',
- 'example' => 'user_recall',
- ],
- 'Amount' => [
- 'title' => '人群数量。',
- 'description' => '人群数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Column' => [
- 'title' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。',
- 'description' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。',
- 'type' => 'string',
- 'example' => 'phone',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Filter' => [
- 'title' => '过滤条件，人群来源为MaxCompute时可指定。',
- 'description' => '过滤条件，人群来源为MaxCompute时可指定。',
- 'type' => 'string',
- 'example' => 'ds=20220101',
- ],
- 'Id' => [
- 'title' => '人群Id。',
- 'description' => '人群Id。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'InferenceJobId' => [
- 'title' => '预测任务Id，人群来源为算法。',
- 'description' => '预测任务Id，人群来源为算法。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '人群名称。',
- 'description' => '人群名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'PhoneNumber' => [
- 'title' => '是否包含手机号，包含手机号的人群可用于触达计划。',
- 'description' => '是否包含手机号，包含手机号的人群可用于触达计划。',
- 'type' => 'boolean',
- 'example' => '1390000****',
- ],
- 'Project' => [
- 'title' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。',
- 'description' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。',
- 'type' => 'string',
- 'example' => 'project',
- ],
- 'Remark' => [
- 'title' => '人群备注。',
- 'description' => '人群备注。',
- 'type' => 'string',
- 'example' => '充值大于10万',
- ],
- 'Source' => [
- 'title' => '人群来源。'."\n"
- .'- 0: 文本，每行一个手机号，最多100个。'."\n"
- .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
- .'- 4: 算法。',
- 'description' => '人群来源。'."\n"
- .'- 0: 文本，每行一个手机号，最多100个。'."\n"
- .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
- .'- 4: 算法。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Status' => [
- 'title' => '人群状态。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 已通过。'."\n"
- .'- 2: 未通过。',
- 'description' => '人群状态。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 已通过。'."\n"
- .'- 2: 未通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Table' => [
- 'title' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。',
- 'description' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。',
- 'type' => 'string',
- 'example' => 'recall',
- ],
- 'Text' => [
- 'title' => '文本，人群来源为文本时需指定。',
- 'description' => '文本，人群来源为文本时需指定。',
- 'type' => 'string',
- 'example' => '1390000****',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Uri' => [
- 'title' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。',
- 'description' => '文件地址，人群来源为文本文件，CSV文件时需指定。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/file',
+ 'InferenceJobs' => [
+ 'title' => '预测任务列表。',
+ 'description' => '预测任务列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Algorithm' => ['title' => '关联算法。', 'description' => '关联算法。', 'type' => 'string', 'example' => 'user_recall'],
+ 'CampaignId' => ['title' => '关联运营活动ID。', 'description' => '关联运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'DataPath' => ['title' => '预测数据路径，当预测人群数据分布在多个csv文件时可指定目录，指定路径前需确保已在控制台完成一键授权。', 'description' => '预测数据路径。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'GroupId' => ['title' => '预测人群，人群来源必须为多列csv，当同时指定DataPath与GroupId时，以GroupId为准。', 'description' => '关联人群ID，如果任务失败则人群无效。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'History' => ['title' => '预测任务日志。', 'description' => '预测任务日志。', 'type' => 'string', 'example' => 'Error: Missing Column.'],
+ 'Id' => ['title' => '预测任务ID。', 'description' => '预测任务ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '预测任务名称。', 'description' => '预测任务名称。', 'type' => 'string', 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => 'Recharge amount exceeds 10,000'],
+ 'Status' => ['title' => '预测任务状态。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'description' => '预测任务状态。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'TargetGroupId' => ['title' => '关联目标人群ID，如果任务失败则人群无效。', 'description' => '关联目标人群ID，如果任务失败则人群无效。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'TargetPath' => ['title' => '输出数据路径，需要为空目录，指定路径前需确保已在控制台完成一键授权。', 'description' => '输出数据路径，需要为空目录。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'TrainingJobId' => ['title' => '关联训练任务。', 'description' => '关联训练任务。', 'type' => 'string', 'example' => '123'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'UserConfig' => ['title' => '用户配置。', 'description' => '用户配置。', 'type' => 'string', 'example' => '{}'],
+ ],
+ 'description' => '',
+ ],
],
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'TotalCount' => ['title' => '总预测任务数量。', 'description' => '总预测任务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -6040,269 +2709,280 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"Amount\\": 0,\\n \\"Column\\": \\"phone\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Filter\\": \\"ds=20220101\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"InferenceJobId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"PhoneNumber\\": true,\\n \\"Project\\": \\"project\\",\\n \\"Remark\\": \\"充值大于10万\\",\\n \\"Source\\": 0,\\n \\"Status\\": 0,\\n \\"Table\\": \\"recall\\",\\n \\"Text\\": \\"1390000****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Uri\\": \\"https://bucket.region.aliyuncs.com/folder/file\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '创建人群',
- 'description' => '在使用前需要在网页端一键授权OSS访问权限，并将需要访问的OSS Bucket添加pai=plugin的标签，请参考[OSS添加标签](https://help.aliyun.com/document_detail/133826.html)。',
- ],
- 'DeleteGroup' => [
- 'summary' => '删除人群。',
- 'path' => '/api/v2/groups/{Id}',
- 'methods' => [
- 'delete',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InferenceJobs\\": [\\n {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"GroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"History\\": \\"Error: Missing Column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"Recharge amount exceeds 10,000\\",\\n \\"Status\\": 3,\\n \\"TargetGroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"TargetPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"TrainingJobId\\": \\"123\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取预测任务列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-28T06:02:37.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInferenceJobs'],
+ ],
],
+ ],
+ 'ListMessageMetrics' => [
+ 'summary' => '获取短信发送统计数据，可按指定条件获取分类别详细数据。',
+ 'path' => '/api/v2/messages/metrics',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129055',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '123209',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'path',
- 'schema' => [
- 'title' => 'path',
- 'description' => '人群ID，可通过ListGroups获取人群列表，获取相应ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期，格式20220102。', 'description' => '结束日期，格式20220102。', 'type' => 'string', 'required' => true, 'example' => '20210321'],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => ['title' => '关联人群Id。', 'description' => '关联人群ID。', 'type' => 'string', 'required' => false, 'example' => '10ed87f5-3ca8-4a43-9d83-b30519be7241'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'ScheduleId',
+ 'in' => 'query',
+ 'schema' => ['title' => '关联触达计划Id。', 'description' => '关联触达计划ID。', 'type' => 'string', 'required' => false, 'example' => '08d19262-bd76-48fd-80e8-6a225ac388c1'],
+ ],
+ [
+ 'name' => 'Signature',
+ 'in' => 'query',
+ 'schema' => ['title' => '签名名称。', 'description' => '签名名称。', 'type' => 'string', 'required' => false, 'example' => 'PAI通知'],
+ ],
+ [
+ 'name' => 'SignatureId',
+ 'in' => 'query',
+ 'schema' => ['title' => '签名Id，同时只能指定签名名称或签名Id其中之一。', 'description' => '签名ID，同时只能指定签名名称或签名ID其中之一。', 'type' => 'string', 'required' => false, 'example' => 'b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3'],
+ ],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始日期，格式20220102。', 'description' => '开始日期，格式20220102。', 'type' => 'string', 'required' => true, 'example' => '20210321'],
+ ],
+ [
+ 'name' => 'TemplateCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '模板号。', 'description' => '模板号。', 'type' => 'string', 'required' => false, 'example' => 'SMS_123456'],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '模板Id，同时只能指定模板Code或模板Id其中之一。', 'description' => '模板ID，同时只能指定模板Code或模板ID其中之一。', 'type' => 'string', 'required' => false, 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'query',
+ 'schema' => ['title' => '模板类型。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'description' => '模板类型。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功。',
- 'description' => '成功。',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
- ],
- ],
- ],
- 400 => [
- 'schema' => [
- 'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'title' => '成功获取短信发送统计列表。',
+ 'description' => '成功获取短信发送统计列表。',
'type' => 'object',
'properties' => [
'Data' => [
'title' => '返回数据。',
'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
+ 'type' => 'object',
+ 'properties' => [
+ 'Metrics' => [
+ 'title' => '分页返回的统计数据条目列表。',
+ 'description' => '分页返回的统计数据条目列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Date' => ['title' => '发送日期。', 'description' => '发送日期。', 'type' => 'string', 'example' => '20210321'],
+ 'Fail' => ['title' => '发送失败。', 'description' => '发送失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Pending' => ['title' => '发送中。', 'description' => '发送中。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Rate' => ['title' => '发送成功率。', 'description' => '发送成功率。', 'type' => 'number', 'format' => 'float', 'example' => '0.8'],
+ 'Success' => ['title' => '发送成功。', 'description' => '发送成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Total' => ['title' => '总计短信数量。', 'description' => '总计短信数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'TotalCount' => ['title' => '总统计数据条目数量。', 'description' => '总统计数据条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '删除人群',
- ],
- 'ListGroups' => [
- 'summary' => '获取人群列表。',
- 'path' => '/api/v2/groups',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Metrics\\": [\\n {\\n \\"Date\\": \\"20210321\\",\\n \\"Fail\\": 0,\\n \\"Pending\\": 0,\\n \\"Rate\\": 0.8,\\n \\"Success\\": 0,\\n \\"Total\\": 0\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 0\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取短信发送统计',
+ 'description' => '获取 [开始日期, 结束日期] 闭区间内的数据，返回数据按日期升序排列，发送统计为空的日期不返回。'."\n"
+ ."\n"
+ .'发送数据在48小时内会随实际短信发送状态不断更新，最终数据以48小时后数据为准。',
+ 'changeSet' => [
+ ['createdAt' => '2022-03-01T09:43:48.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-03-01T09:43:48.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-03-01T09:43:48.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-03-01T09:43:48.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessageMetrics'],
+ ],
],
+ ],
+ 'ListMessages' => [
+ 'summary' => '按指定过滤条件获取指定日期的短信发送状态。',
+ 'path' => '/api/v2/messages',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129065',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '123210',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Name',
+ 'name' => 'Datetime',
'in' => 'query',
- 'schema' => [
- 'title' => '人群名称过滤。',
- 'description' => '人群名称过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'VIP客户',
- ],
+ 'schema' => ['title' => '发送日期，格式为20220101。', 'description' => '发送日期，格式为yyyymmdd。', 'type' => 'string', 'required' => true, 'example' => '20220101'],
+ ],
+ [
+ 'name' => 'ErrorCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '短信错误码过滤。', 'description' => '短信错误码过滤。', 'type' => 'string', 'required' => false, 'example' => 'DELIVERED'],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => ['title' => '关联人群Id过滤。', 'description' => '关联人群ID过滤。', 'type' => 'string', 'required' => false, 'example' => '10ed87f5-3ca8-4a43-9d83-b30519be7241'],
+ ],
+ [
+ 'name' => 'MessageId',
+ 'in' => 'query',
+ 'schema' => ['title' => '短信Id过滤，短信Id为SendMessage成功返回的Id。', 'description' => '短信ID过滤，短信ID为SendMessage成功返回的ID。', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '是否包含手机号过滤。',
- 'description' => '是否包含手机号过滤。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '手机号码过滤。', 'description' => '手机号码。', 'type' => 'string', 'required' => false, 'example' => '1234567890'],
],
[
- 'name' => 'Remark',
+ 'name' => 'RequestId',
'in' => 'query',
- 'schema' => [
- 'title' => '人群备注过滤。',
- 'description' => '人群备注过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '充值大于一万',
- ],
+ 'schema' => ['title' => '短信批处理Id过滤，短信批处理Id为SendMessage成功返回的RequestId。', 'description' => '短信批处理ID过滤，短信批处理ID为SendMessage成功返回的RequestId。', 'type' => 'string', 'required' => false, 'example' => '62a72a20-8a9b-4060-a510-0c30a9340cba'],
],
[
- 'name' => 'Source',
+ 'name' => 'ScheduleId',
'in' => 'query',
- 'schema' => [
- 'title' => '来源过滤。',
- 'description' => '来源过滤。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '关联触达计划Id过滤。', 'description' => '关联发送计划ID。', 'type' => 'string', 'required' => false, 'example' => '08d19262-bd76-48fd-80e8-6a225ac388c1'],
+ ],
+ [
+ 'name' => 'Signature',
+ 'in' => 'query',
+ 'schema' => ['title' => '签名名称过滤。', 'description' => '签名名称。', 'type' => 'string', 'required' => false, 'example' => 'PAI通知'],
+ ],
+ [
+ 'name' => 'SignatureId',
+ 'in' => 'query',
+ 'schema' => ['title' => '签名Id过滤，同时只能指定签名名称或签名Id其中之一。', 'description' => '签名ID，同时只能指定签名名称或签名ID其中之一。', 'type' => 'string', 'required' => false, 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'],
],
[
'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'title' => '审核状态过滤。',
- 'description' => '审核状态过滤。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '短信发送状态过滤。'."\n"
+ .'- 0 : 发送中。'."\n"
+ .'- 1 : 发送成功。'."\n"
+ .'- 2 : 发送失败。', 'description' => '短信发送状态。'."\n"
+ .'- 0 : 发送中。'."\n"
+ .'- 1 : 发送成功。'."\n"
+ .'- 2 : 发送失败。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'TemplateCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '模板号过滤。', 'description' => '模板号。', 'type' => 'string', 'required' => false, 'example' => 'SMS_123456'],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '模板Id过滤，同时只能指定模板Code或模板Id其中之一。', 'description' => '模板ID，同时只能指定模板Code或模板ID其中之一。', 'type' => 'string', 'required' => false, 'example' => 'b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3'],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'query',
+ 'schema' => ['title' => '模板类型过滤。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'description' => '模板类型过滤。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取人群列表。',
- 'description' => '成功获取人群列表。',
+ 'title' => '成功获取短信发送详情列表。',
+ 'description' => '成功。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -6310,268 +2990,138 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Groups' => [
- 'title' => '人群列表。',
- 'description' => '人群列表。',
+ 'Messages' => [
+ 'title' => '短信列表。',
+ 'description' => '短信列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法，人群来源为算法。',
- 'description' => '关联算法，人群来源为算法。',
- 'type' => 'string',
- 'example' => 'user_recall',
- ],
- 'Amount' => [
- 'title' => '人群数量。',
- 'description' => '人群数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Column' => [
- 'title' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。',
- 'description' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。',
- 'type' => 'string',
- 'example' => 'phone',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Filter' => [
- 'title' => '过滤条件，人群来源为MaxCompute时可指定。',
- 'description' => '过滤条件，人群来源为MaxCompute时可指定。',
- 'type' => 'string',
- 'example' => 'ds=2022',
- ],
- 'Id' => [
- 'title' => '人群Id。',
- 'description' => '人群ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'InferenceJobId' => [
- 'title' => '预测任务Id，人群来源为算法。',
- 'description' => '预测任务ID，人群来源为算法。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '人群名称。',
- 'description' => '人群名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'PhoneNumber' => [
- 'title' => '是否包含手机号，包含手机号的人群可用于触达计划。',
- 'description' => '是否包含手机号，包含手机号的人群可用于触达计划。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Project' => [
- 'title' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。',
- 'description' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。',
- 'type' => 'string',
- 'example' => 'project',
- ],
- 'Remark' => [
- 'title' => '人群备注。',
- 'description' => '人群备注。',
- 'type' => 'string',
- 'example' => '充值大于10万',
- ],
- 'Source' => [
- 'title' => '人群来源。'."\n"
- .'- 0: 文本，每行一个手机号，最多100个。'."\n"
- .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
- .'- 4: 算法。',
- 'description' => '人群来源。'."\n"
- .'- 0: 文本，每行一个手机号，最多100个。'."\n"
- .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 2: CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 3: MaxCompute(ODPS)表，需指定手机号列名。'."\n"
- .'- 4: 算法。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Status' => [
- 'title' => '人群状态。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 已通过。'."\n"
- .'- 2: 未通过。',
- 'description' => '人群状态。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 已通过。'."\n"
- .'- 2: 未通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Table' => [
- 'title' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。',
- 'description' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。',
- 'type' => 'string',
- 'example' => 'recall',
- ],
- 'Text' => [
- 'title' => '文本，人群来源为文本时需指定。',
- 'description' => '文本，人群来源为文本时需指定。',
- 'type' => 'string',
- 'example' => '1390000****',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Uri' => [
- 'title' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。',
- 'description' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/file',
- ],
+ 'ErrorCode' => ['title' => '短信错误码。', 'description' => '短信错误码。', 'type' => 'string', 'example' => 'DELIVERED'],
+ 'GroupId' => ['title' => '关联人群Id，未关联则为空。', 'description' => '关联人群ID。', 'type' => 'string', 'example' => '51d20163-1b10-4af2-8a23-58ad52201f2f'],
+ 'Id' => ['title' => '短信序列号。', 'description' => '短信序列号。', 'type' => 'string', 'example' => '92d05e19-751b-4346-a7c5-8808bb49b8a2'],
+ 'OutId' => ['title' => '外部拓展字段。', 'description' => '外部拓展字段。', 'type' => 'string', 'example' => '1234567890'],
+ 'PhoneNumber' => ['title' => '手机号码。', 'description' => '手机号码。', 'type' => 'string', 'example' => '1234567890'],
+ 'ScheduleId' => ['title' => '关联触达计划Id，未关联则为空。', 'description' => '关联发送计划ID。', 'type' => 'string', 'example' => '0604d49d-fd23-4515-bb26-9b537cbf1f6d'],
+ 'Signature' => ['title' => '签名名称。', 'description' => '签名名称。', 'type' => 'string', 'example' => 'PAI通知'],
+ 'Status' => ['title' => '短信发送状态。'."\n"
+ .'- 0 : 发送中。'."\n"
+ .'- 1 : 发送成功。'."\n"
+ .'- 2 : 发送失败。', 'description' => '短信发送状态。'."\n"
+ .'- 0 : 发送中。'."\n"
+ .'- 1 : 发送成功。'."\n"
+ .'- 2 : 发送失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TemplateCode' => ['title' => '模板号。', 'description' => '模板号。', 'type' => 'string', 'example' => 'SMS_123456'],
+ 'TemplateParams' => ['title' => '模板参数。', 'description' => '模板参数。', 'type' => 'string', 'example' => '{}'],
+ 'TemplateType' => ['title' => '模板类型。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'description' => '模板类型。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
+ 'description' => '',
],
],
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总人群数量。',
- 'description' => '总人群数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'TotalCount' => ['title' => '短信数量。', 'description' => '短信数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'description' => '失败,原因见errmsg',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Groups\\": [\\n {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"Amount\\": 0,\\n \\"Column\\": \\"phone\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Filter\\": \\"ds=2022\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"InferenceJobId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"PhoneNumber\\": true,\\n \\"Project\\": \\"project\\",\\n \\"Remark\\": \\"充值大于10万\\",\\n \\"Source\\": 0,\\n \\"Status\\": 0,\\n \\"Table\\": \\"recall\\",\\n \\"Text\\": \\"1390000****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Uri\\": \\"https://bucket.region.aliyuncs.com/folder/file\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取人群列表',
- ],
- 'GetGroup' => [
- 'summary' => '获取人群详情。',
- 'path' => '/api/v2/groups/{Id}',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"ErrorCode\\": \\"DELIVERED\\",\\n \\"GroupId\\": \\"51d20163-1b10-4af2-8a23-58ad52201f2f\\",\\n \\"Id\\": \\"92d05e19-751b-4346-a7c5-8808bb49b8a2\\",\\n \\"OutId\\": \\"1234567890\\",\\n \\"PhoneNumber\\": \\"1234567890\\",\\n \\"ScheduleId\\": \\"0604d49d-fd23-4515-bb26-9b537cbf1f6d\\",\\n \\"Signature\\": \\"PAI通知\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"TemplateParams\\": \\"{}\\",\\n \\"TemplateType\\": 2\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取短信列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-22T11:45:59.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-22T11:45:59.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-22T11:45:59.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-22T11:45:59.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessages'],
+ ],
],
+ ],
+ 'ListSchedules' => [
+ 'summary' => '获取发送计划列表。',
+ 'path' => '/api/v2/schedules',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129060',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129067',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'path',
- 'schema' => [
- 'title' => '人群Id，可通过ListGroups查询账号下的人群列表，获取人群Id。',
- 'description' => '人群ID，可通过ListGroups查询获取。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '触达计划名称过滤。', 'description' => '触达计划名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'User growth'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['title' => '发送状态过滤。'."\n"
+ .'- 0：检查中。'."\n"
+ .'- 1：检查成功。'."\n"
+ .'- 2：检查失败。'."\n"
+ .'- 3：发送中。'."\n"
+ .'- 4：发送成功。'."\n"
+ .'- 5：发送失败。', 'description' => '发送状态过滤。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 检查成功。'."\n"
+ .'- 2: 检查失败。'."\n"
+ .'- 3: 发送中。'."\n"
+ .'- 4: 发送成功。'."\n"
+ .'- 5: 发送失败。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取人群详情。',
- 'description' => '成功获取人群详情。',
+ 'title' => '成功获取短信触达计划列表。',
+ 'description' => '成功获取触达计划列表。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -6579,160 +3129,67 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Algorithm' => [
- 'title' => '关联算法，人群来源为算法。',
- 'description' => '关联算法，人群来源为算法。',
- 'type' => 'string',
- 'example' => 'user_recall',
- ],
- 'Amount' => [
- 'title' => '人群数量。',
- 'description' => '人群数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'CampaignId' => [
- 'title' => '关联运营活动Id。',
- 'description' => '关联运营活动ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Column' => [
- 'title' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。',
- 'description' => '手机号列名，人群来源为CSV文件，MaxCompute，并且包含手机号时需指定。',
- 'type' => 'string',
- 'example' => 'education',
- ],
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间（UTC+8）。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Filter' => [
- 'title' => '过滤条件，人群来源为MaxCompute时可指定。',
- 'description' => '过滤条件，人群来源为MaxCompute时可指定。',
- 'type' => 'string',
- 'example' => 'ds=2022',
- ],
- 'History' => [
- 'title' => '历史记录。',
- 'description' => '历史记录。',
- 'type' => 'string',
- 'example' => 'Project not found - \'sms_test\'',
- ],
- 'Id' => [
- 'title' => '人群Id。',
- 'description' => '人群ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'InferenceJobId' => [
- 'title' => '预测任务Id，人群来源为算法。',
- 'description' => '预测任务ID，人群来源为算法。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '人群名称。',
- 'description' => '人群名称。',
- 'type' => 'string',
- 'example' => 'VIP客户',
- ],
- 'PhoneNumber' => [
- 'title' => '是否包含手机号，包含手机号的人群可用于触达计划。',
- 'description' => '是否包含手机号，包含手机号的人群可用于触达计划。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Project' => [
- 'title' => 'MaxCompute(ODPS)项目名，人群来源为MaxCompute时需指定。',
- 'description' => 'MaxCompute（ODPS）项目名，人群来源为MaxCompute时需指定。',
- 'type' => 'string',
- 'example' => 'project',
- ],
- 'Remark' => [
- 'title' => '人群备注。',
- 'description' => '人群备注。',
- 'type' => 'string',
- 'example' => '充值大于10万',
- ],
- 'Source' => [
- 'title' => '人群来源。'."\n"
- .'- 0: 文本，每行一个手机号，最多100个。'."\n"
- .'- 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 2: 多列CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 3: MaxCompute表，需指定手机号列名。'."\n"
- .'- 4: 算法。',
- 'description' => '人群来源。'."\n"
- .'- 0：文本，每行一个手机号，最多100个。'."\n"
- .'- 1：文本文件，每行一个手机号，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 2：CSV文件，需指定手机号列名，可通过控制台上传或指定自定义OSS地址，指定自定义OSS地址前需确保已在控制台完成一键授权。'."\n"
- .'- 3：MaxCompute(ODPS)表，需指定手机号列名。'."\n"
- .'- 4：算法。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Status' => [
- 'title' => '人群状态。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 已通过。'."\n"
- .'- 2: 未通过。',
- 'description' => '人群状态。'."\n"
- .'- 0：检查中。'."\n"
- .'- 1：已通过。'."\n"
- .'- 2：未通过。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Table' => [
- 'title' => 'MaxCompute(ODPS)表名，人群来源为MaxCompute时需指定。',
- 'description' => 'MaxCompute（ODPS）表名，人群来源为MaxCompute时需指定。',
- 'type' => 'string',
- 'example' => 'recall',
- ],
- 'Text' => [
- 'title' => '文本，人群来源为文本时需指定。',
- 'description' => '文本，人群来源为文本时需指定。',
- 'type' => 'string',
- 'example' => '1390000****',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间（UTC+8）。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'Uri' => [
- 'title' => '文件地址，人群来源为文本文件，CSV文件时需指定。',
- 'description' => '文件地址，人群来源为文本文件，CSV文件，MaxCompute时需指定。',
- 'type' => 'string',
- 'example' => 'https://bucket.region.aliyuncs.com/folder/file',
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'Schedules' => [
+ 'title' => '触达计划列表。',
+ 'description' => '触达计划列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'EndTime' => ['title' => '终止时间（UTC+8）。', 'description' => '终止时间（UTC+8）。', 'type' => 'string', 'format' => 'int32', 'example' => '2020-01-01'],
+ 'ExecuteTime' => ['title' => '执行时间 (UTC+8)，为空立即执行。', 'description' => '执行时间 (UTC+8)，为空立即执行。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'GroupId' => ['title' => '人群ID。', 'description' => '人群ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Id' => ['title' => '触达计划ID。', 'description' => '触达计划ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '触达计划名称。', 'description' => '触达计划名称。', 'type' => 'string', 'example' => 'Growth-2021-0101'],
+ 'RepeatCycle' => ['title' => '重复周期，按重复周期与重复周期单位执行。', 'description' => '重复周期，按重复周期与重复周期单位执行。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RepeatCycleUnit' => ['title' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
+ .'- 0: 从不（默认）。'."\n"
+ .'- 1: 小时。'."\n"
+ .'- 2: 天。'."\n"
+ .'- 3: 周。'."\n"
+ .'- 4: 月。', 'description' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
+ .'- 0: 从不（默认）。'."\n"
+ .'- 1: 小时。'."\n"
+ .'- 2: 天。'."\n"
+ .'- 3: 周。'."\n"
+ .'- 4: 月。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RepeatTimes' => ['title' => '重复次数。'."\n"
+ .'- 0: 不设终止时间（默认）。'."\n"
+ .'- N: 重复N次后终止。', 'description' => '重复次数。'."\n"
+ .'- -1: 不设终止时间（默认）。'."\n"
+ .'- 0: 不重复。'."\n"
+ .'- N: 重复N次后终止。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'SignName' => ['title' => '签名。', 'description' => '签名。', 'type' => 'string', 'example' => 'PAI'],
+ 'SignatureId' => ['title' => '签名ID，或指定签名。', 'description' => '签名ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Status' => ['title' => '状态。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 检查成功。'."\n"
+ .'- 2: 检查失败。'."\n"
+ .'- 3: 发送中。'."\n"
+ .'- 4: 发送成功。'."\n"
+ .'- 5: 发送失败。', 'description' => '状态。'."\n"
+ .'- 0: 检查中。'."\n"
+ .'- 1: 检查成功。'."\n"
+ .'- 2: 检查失败。'."\n"
+ .'- 3: 发送中。'."\n"
+ .'- 4: 发送成功。'."\n"
+ .'- 5: 发送失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TemplateCode' => ['title' => '模板Code。', 'description' => '模板Code。', 'type' => 'string', 'example' => 'SMS_123456'],
+ 'TemplateId' => ['title' => '模板ID，或指定模板Code。', 'description' => '模板ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ ],
+ 'description' => '',
+ ],
],
+ 'TotalCount' => ['title' => '触达计划数量。', 'description' => '触达计划数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -6742,207 +3199,78 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"Amount\\": 0,\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Column\\": \\"education\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Filter\\": \\"ds=2022\\",\\n \\"History\\": \\"Project not found - \'sms_test\'\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"InferenceJobId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"PhoneNumber\\": true,\\n \\"Project\\": \\"project\\",\\n \\"Remark\\": \\"充值大于10万\\",\\n \\"Source\\": 0,\\n \\"Status\\": 0,\\n \\"Table\\": \\"recall\\",\\n \\"Text\\": \\"1390000****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Uri\\": \\"https://bucket.region.aliyuncs.com/folder/file\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取人群详情',
- ],
- 'CreateSchedule' => [
- 'summary' => '您可以根据本文提供的参数配置说明，创建触达计划，进行流失用户的触达和召回。',
- 'path' => '/api/v2/schedules',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Schedules\\": [\\n {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"EndTime\\": \\"2020-01-01\\",\\n \\"ExecuteTime\\": \\"2020-01-01 12:00:00\\",\\n \\"GroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"Growth-2021-0101\\",\\n \\"RepeatCycle\\": 0,\\n \\"RepeatCycleUnit\\": 0,\\n \\"RepeatTimes\\": 1,\\n \\"SignName\\": \\"PAI\\",\\n \\"SignatureId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"TemplateId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 0\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取发送计划列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-23T03:09:30.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSchedules'],
+ ],
],
+ ],
+ 'ListSignatures' => [
+ 'summary' => '获取签名注册记录列表。',
+ 'path' => '/api/v2/signatures',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129053',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '123212',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '请求参数的主体信息。',
- 'description' => '请求参数的主体信息。',
- 'type' => 'object',
- 'properties' => [
- 'EndTime' => [
- 'title' => '终止时间（UTC+8）。',
- 'description' => '终止时间（UTC+8）。',
- 'type' => 'string',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2020-01-01',
- ],
- 'ExecuteTime' => [
- 'title' => '执行时间 (UTC+8)，为空立即执行。',
- 'description' => '执行时间 (UTC+8)：'."\n"
- .'- 为空则立即执行。'."\n"
- .'- 设置执行时间，则需要设置重复周期（RepeatCycle）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-01-01 12:00:00',
- ],
- 'GroupId' => [
- 'title' => '人群ID。',
- 'description' => '人群ID。如何获取人群ID，请参见[ListGroups](~~429068~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0****195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '触达计划名称。',
- 'description' => '触达计划名称。长度为2~30个字符，支持字母、数字、汉字和下划线（_）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '增长-2021-0101',
- ],
- 'RepeatCycle' => [
- 'title' => '重复周期，按重复周期与重复周期单位执行。',
- 'description' => '重复周期，按重复周期与重复周期单位执行。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'RepeatCycleUnit' => [
- 'title' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
- .'- 0: 从不（默认）。'."\n"
- .'- 1: 小时。'."\n"
- .'- 2: 天。'."\n"
- .'- 3: 周。'."\n"
- .'- 4: 月。',
- 'description' => '重复周期单位，若指定执行时间（ExecuteTime），则按重复周期单位执行。'."\n"
- .'- 0：从不（默认）。'."\n"
- .'- 1：小时。'."\n"
- .'- 2：天。'."\n"
- .'- 3：周。'."\n"
- .'- 4：月。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'RepeatTimes' => [
- 'title' => '重复次数。'."\n"
- .'- 0: 不设终止时间（默认）。'."\n"
- .'- N: 重复N次后终止。',
- 'description' => '重复次数，取值如下：'."\n"
- .'- -1：不设终止时间（默认）。'."\n"
- .'- 0：不重复。'."\n"
- .'- N：重复N次后终止。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '-1',
- ],
- 'SignName' => [
- 'title' => '签名。',
- 'description' => '签名名称，如何获取签名名称，请参见[ListSignatures ](~~413410~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PAI',
- ],
- 'SignatureId' => [
- 'title' => '签名ID，或指定签名。',
- 'description' => '签名ID。如何获取签名ID，请参见[ListSignatures ](~~413410~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302****',
- ],
- 'TemplateCode' => [
- 'title' => '模板Code。',
- 'description' => '模板Code。如何获取模板Code，请参见[ListTemplates](~~413414~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SMS_123***',
- ],
- 'TemplateId' => [
- 'title' => '模板ID，或指定模板Code。',
- 'description' => '模板ID，或指定模板Code。如何获取模板ID，请参见[ListTemplates](~~413414~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0a54e***-03e2-40bd-869d-b71cb30*****',
- ],
- 'AISendStartDate' => [
- 'description' => '智能发送开始时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-01-01 12:00:00'."\n",
- ],
- 'AISendEndDate' => [
- 'description' => '智能发送结束时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-01-01 12:00:00'."\n",
- ],
- 'PaymentType' => [
- 'description' => '计费类型（为空时默认后付费），取值如下：'."\n"
- ."\n"
- .'- PayAsYouGo：后付费'."\n"
- .'- Subscription：预付费'."\n"
- .'- MixPay：组合付费',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PayAsYouGo',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '签名名称过滤。', 'description' => '签名名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'User growth'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['title' => '签名审核状态过滤。'."\n"
+ .'- 0：审核中。'."\n"
+ .'- 1：审核通过。'."\n"
+ .'- 2：审核不通过。', 'description' => '签名审核状态过滤。'."\n"
+ .'- 0：审核中。'."\n"
+ .'- 1：审核通过。'."\n"
+ .'- 2：审核不通过。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => '成功注册短信触达计划，可通过控制台或GetSchedule获取短信触达计划检查与触达情况。',
- 'description' => '成功注册触达计划，可通过控制台或GetSchedule获取触达计划检查与触达情况。',
+ 'title' => '成功获取签名列表。',
+ 'description' => '成功获取签名列表。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -6950,398 +3278,294 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8）。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'EndTime' => [
- 'title' => '终止时间（UTC+8）。',
- 'description' => '终止时间（UTC+8）。',
- 'type' => 'string',
- 'format' => 'int32',
- 'example' => '2020-01-01',
- ],
- 'ExecuteTime' => [
- 'title' => '执行时间 (UTC+8)，为空立即执行。',
- 'description' => '执行时间 (UTC+8），为空立即执行。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'GroupId' => [
- 'title' => '人群ID。',
- 'description' => '人群ID。',
- 'type' => 'string',
- 'example' => '0****195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Id' => [
- 'title' => '触达计划ID。',
- 'description' => '触达计划ID。',
- 'type' => 'string',
- 'example' => '0a54****-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '触达计划名称。',
- 'description' => '触达计划名称。',
- 'type' => 'string',
- 'example' => '增长-2021-0101',
- ],
- 'RepeatCycle' => [
- 'title' => '重复周期，按重复周期与重复周期单位执行。',
- 'description' => '重复周期，按重复周期与重复周期单位执行。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RepeatCycleUnit' => [
- 'title' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
- .'- 0: 从不（默认）。'."\n"
- .'- 1: 小时。'."\n"
- .'- 2: 天。'."\n"
- .'- 3: 周。'."\n"
- .'- 4: 月。',
- 'description' => '重复周期单位，若指定执行时间，则按重复周期单位执行。可能值：'."\n"
- .'- 0：从不（默认）。'."\n"
- .'- 1：小时。'."\n"
- .'- 2：天。'."\n"
- .'- 3：周。'."\n"
- .'- 4：月。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RepeatTimes' => [
- 'title' => '重复次数。'."\n"
- .'- 0: 不设终止时间（默认）。'."\n"
- .'- N: 重复N次后终止。',
- 'description' => '重复次数，可能值：'."\n"
- .'- -1：不设终止时间（默认）。'."\n"
- .'- 0：不重复。'."\n"
- .'- N：重复N次后终止。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '-1',
- ],
- 'SignName' => [
- 'title' => '签名。',
- 'description' => '签名。',
- 'type' => 'string',
- 'example' => 'PAI',
- ],
- 'SignatureId' => [
- 'title' => '签名ID，或指定签名。',
- 'description' => '签名ID，或指定签名。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302****',
- ],
- 'Status' => [
- 'title' => '状态。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 检查成功。'."\n"
- .'- 2: 检查失败。'."\n"
- .'- 3: 发送中。'."\n"
- .'- 4: 发送成功。'."\n"
- .'- 5: 发送失败。',
- 'description' => '状态。可能值：'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 检查成功。'."\n"
- .'- 2: 检查失败。'."\n"
- .'- 3: 发送中。'."\n"
- .'- 4: 发送成功。'."\n"
- .'- 5: 发送失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TemplateCode' => [
- 'title' => '模板Code。',
- 'description' => '模板Code。',
- 'type' => 'string',
- 'example' => 'SMS_123***',
- ],
- 'TemplateId' => [
- 'title' => '模板ID，或指定模板Code。',
- 'description' => '模板ID，或指定模板Code。',
- 'type' => 'string',
- 'example' => '0a54e***-03e2-40bd-869d-b71cb30*****',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'Signatures' => [
+ 'title' => '分页返回的签名列表。',
+ 'description' => '分页返回的签名列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Id' => ['title' => '签名Id。', 'description' => '签名ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '签名名称。', 'description' => '签名名称。', 'type' => 'string', 'example' => 'User growth'],
+ 'Status' => ['title' => '签名审核状态。'."\n"
+ .'- 0：审核中。'."\n"
+ .'- 1：审核通过。'."\n"
+ .'- 2：审核不通过。', 'description' => '签名审核状态。'."\n"
+ .'- 0：审核中。'."\n"
+ .'- 1：审核通过。'."\n"
+ .'- 2：审核不通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ ],
+ 'description' => '',
+ ],
],
+ 'TotalCount' => ['title' => '账号下全部签名注册记录数量。', 'description' => '账号下全部签名注册记录数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85****',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'description' => '失败,原因见errmsg',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"EndTime\\": \\"2020-01-01\\",\\n \\"ExecuteTime\\": \\"2020-01-01 12:00:00\\",\\n \\"GroupId\\": \\"0****195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Id\\": \\"0a54****-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"增长-2021-0101\\",\\n \\"RepeatCycle\\": 0,\\n \\"RepeatCycleUnit\\": 0,\\n \\"RepeatTimes\\": -1,\\n \\"SignName\\": \\"PAI\\",\\n \\"SignatureId\\": \\"0a54e195-03e2-40bd-869d-b71cb302****\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123***\\",\\n \\"TemplateId\\": \\"0a54e***-03e2-40bd-869d-b71cb30*****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85****\\"\\n}","type":"json"}]',
- 'title' => '创建触达计划',
- ],
- 'DeleteSchedule' => [
- 'summary' => '当业务调整或取消发送时，您可以删除发送计划。',
- 'path' => '/api/v2/schedules/{Id}',
- 'methods' => [
- 'delete',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Signatures\\": [\\n {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"User growth\\",\\n \\"Status\\": 0,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取签名列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSignatures'],
+ ],
],
+ ],
+ 'ListTemplates' => [
+ 'summary' => '获取模板注册记录列表。',
+ 'path' => '/api/v2/templates',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129057',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '123213',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'path',
- 'schema' => [
- 'title' => '触达计划Id，可通过ListSchedules查询账号下的触达计划列表，获取触达计划Id。',
- 'description' => '触达计划ID。如何获取触达计划ID，请参见[ListSchedules](~~429073~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
- ],
+ 'name' => 'Content',
+ 'in' => 'query',
+ 'schema' => ['title' => '模板内容过滤。', 'description' => '模板内容过滤。', 'type' => 'string', 'required' => false, 'example' => 'Qixi Festival'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '模板名称过滤。', 'description' => '模板名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'Recall'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['title' => '审核状态过滤。'."\n"
+ .'- 0 : 审核中。'."\n"
+ .'- 1 : 审核通过。'."\n"
+ .'- 2 : 审核不通过。', 'description' => '审核状态过滤。'."\n"
+ .'- 0 : 审核中。'."\n"
+ .'- 1 : 审核通过。'."\n"
+ .'- 2 : 审核不通过。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['title' => '模板类型过滤。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'description' => '模板类型过滤。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功删除触达计划。',
- 'description' => '成功删除触达计划。',
+ 'title' => '成功获取模板列表。',
+ 'description' => '成功获取模板列表，可通过控制台或GetTemplate获取审核状态。',
'type' => 'object',
'properties' => [
'Data' => [
'title' => '返回数据。',
'description' => '返回数据。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '分页数，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'Templates' => [
+ 'title' => '分页返回的模板列表。',
+ 'description' => '分页返回的模板列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '模板内容。', 'description' => '模板内容。', 'type' => 'string', 'example' => '模板内容'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Description' => ['title' => '申请说明。', 'description' => '申请说明。', 'type' => 'string', 'example' => 'Application description'],
+ 'Id' => ['title' => '模板Id。', 'description' => '模板ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '签名名称。', 'description' => '模板名称。', 'type' => 'string', 'example' => '模板召回-20220101'],
+ 'Reason' => ['title' => '审核意见。', 'description' => '审核意见。', 'type' => 'string', 'example' => 'Agree'],
+ 'SignatureId' => ['title' => '签名Id。', 'description' => '签名ID。', 'type' => 'string', 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'],
+ 'Status' => ['title' => '审核状态。'."\n"
+ .'- 0 : 审核中。'."\n"
+ .'- 1 : 审核通过。'."\n"
+ .'- 2 : 审核不通过。', 'description' => '审核状态。'."\n"
+ .'- 0 : 审核中。'."\n"
+ .'- 1 : 审核通过。'."\n"
+ .'- 2 : 审核不通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TemplateCode' => ['title' => '模板Code。', 'description' => '模板Code。', 'type' => 'string', 'example' => 'SMS_123456'],
+ 'Type' => ['title' => '模板类型。'."\n"
+ .'- 0 : 验证码。'."\n"
+ .'- 1 : 短信通知。'."\n"
+ .'- 2 : 推广短信。', 'description' => '模板类型。'."\n"
+ .'- 0：验证码。'."\n"
+ .'- 1：短信通知。'."\n"
+ .'- 2：推广短信。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'TotalCount' => ['title' => '全部模板注册记录数量。', 'description' => '全部模板注册记录数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
400 => [
'schema' => [
'title' => '失败，原因见ErrorMessage，错误码见Data。',
- 'description' => '失败，原因见ErrorMessage，错误码见Data。',
+ 'description' => '失败,原因见errmsg',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '删除发送计划',
- ],
- 'ListSchedules' => [
- 'summary' => '获取发送计划列表。',
- 'path' => '/api/v2/schedules',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Templates\\": [\\n {\\n \\"Content\\": \\"模板内容\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"Application description\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"模板召回-20220101\\",\\n \\"Reason\\": \\"Agree\\",\\n \\"SignatureId\\": \\"5480e3e7-f578-42d2-8ce8-217dec75f2e6\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"Type\\": 1,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取模板列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'],
+ ],
],
+ ],
+ 'ListTrainingJobs' => [
+ 'summary' => '获取训练任务列表。',
+ 'path' => '/api/v2/training/jobs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129067',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '129068',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
+ 'name' => 'CampaignId',
+ 'in' => 'query',
+ 'schema' => ['title' => '归属运营活动过滤。', 'description' => '归属运营活动过滤。', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ ],
+ [
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'title' => '触达计划名称过滤。',
- 'description' => '触达计划名称过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用户增长',
- ],
+ 'schema' => ['title' => '训练任务名称过滤。', 'description' => '训练任务名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '分页数，从1开始，默认为1。', 'description' => '训练任务列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '分页大小，默认为10。', 'description' => '分页查询时设置的每页显示的训练任务数量，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['title' => '训练任务备注过滤。', 'description' => '训练任务备注过滤。', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'],
],
[
'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'title' => '发送状态过滤。'."\n"
- .'- 0：检查中。'."\n"
- .'- 1：检查成功。'."\n"
- .'- 2：检查失败。'."\n"
- .'- 3：发送中。'."\n"
- .'- 4：发送成功。'."\n"
- .'- 5：发送失败。',
- 'description' => '发送状态过滤。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 检查成功。'."\n"
- .'- 2: 检查失败。'."\n"
- .'- 3: 发送中。'."\n"
- .'- 4: 发送成功。'."\n"
- .'- 5: 发送失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '训练任务状态过滤。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'description' => '训练任务状态过滤，取值如下：'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'TrainingScheduleId',
+ 'in' => 'query',
+ 'schema' => ['title' => '归属训练计划过滤。', 'description' => '归属训练计划过滤。', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ ],
+ [
+ 'name' => 'CampaignName',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['title' => '关联运营活动名称', 'description' => '关联运营活动名称', 'type' => 'string', 'required' => false, 'example' => '双11活动'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '成功获取短信触达计划列表。',
- 'description' => '成功获取触达计划列表。',
+ 'title' => '成功获取训练任务列表。',
+ 'description' => '成功获取训练任务列表。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -7349,182 +3573,48 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'title' => '分页数，从1开始，默认为1。',
- 'description' => '分页数，从1开始，默认为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小，默认为10。',
- 'description' => '分页大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
- 'Schedules' => [
- 'title' => '触达计划列表。',
- 'description' => '触达计划列表。',
+ 'PageNumber' => ['title' => '分页数，从1开始，默认为1。', 'description' => '返回查询的训练任务列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '分页大小，默认为10。', 'description' => '返回每页显示的训练任务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
+ 'TotalCount' => ['title' => '总训练任务数量。', 'description' => '总训练任务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TrainingJobs' => [
+ 'title' => '训练任务列表。',
+ 'description' => '训练任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'EndTime' => [
- 'title' => '终止时间（UTC+8）。',
- 'description' => '终止时间（UTC+8）。',
- 'type' => 'string',
- 'format' => 'int32',
- 'example' => '2020-01-01',
- ],
- 'ExecuteTime' => [
- 'title' => '执行时间 (UTC+8)，为空立即执行。',
- 'description' => '执行时间 (UTC+8)，为空立即执行。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'GroupId' => [
- 'title' => '人群ID。',
- 'description' => '人群ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Id' => [
- 'title' => '触达计划ID。',
- 'description' => '触达计划ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '触达计划名称。',
- 'description' => '触达计划名称。',
- 'type' => 'string',
- 'example' => '增长-2021-0101',
- ],
- 'RepeatCycle' => [
- 'title' => '重复周期，按重复周期与重复周期单位执行。',
- 'description' => '重复周期，按重复周期与重复周期单位执行。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RepeatCycleUnit' => [
- 'title' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
- .'- 0: 从不（默认）。'."\n"
- .'- 1: 小时。'."\n"
- .'- 2: 天。'."\n"
- .'- 3: 周。'."\n"
- .'- 4: 月。',
- 'description' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
- .'- 0: 从不（默认）。'."\n"
- .'- 1: 小时。'."\n"
- .'- 2: 天。'."\n"
- .'- 3: 周。'."\n"
- .'- 4: 月。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RepeatTimes' => [
- 'title' => '重复次数。'."\n"
- .'- 0: 不设终止时间（默认）。'."\n"
- .'- N: 重复N次后终止。',
- 'description' => '重复次数。'."\n"
- .'- -1: 不设终止时间（默认）。'."\n"
- .'- 0: 不重复。'."\n"
- .'- N: 重复N次后终止。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SignName' => [
- 'title' => '签名。',
- 'description' => '签名。',
- 'type' => 'string',
- 'example' => 'PAI',
- ],
- 'SignatureId' => [
- 'title' => '签名ID，或指定签名。',
- 'description' => '签名ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Status' => [
- 'title' => '状态。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 检查成功。'."\n"
- .'- 2: 检查失败。'."\n"
- .'- 3: 发送中。'."\n"
- .'- 4: 发送成功。'."\n"
- .'- 5: 发送失败。',
- 'description' => '状态。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 检查成功。'."\n"
- .'- 2: 检查失败。'."\n"
- .'- 3: 发送中。'."\n"
- .'- 4: 发送成功。'."\n"
- .'- 5: 发送失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TemplateCode' => [
- 'title' => '模板Code。',
- 'description' => '模板Code。',
- 'type' => 'string',
- 'example' => 'SMS_123456',
- ],
- 'TemplateId' => [
- 'title' => '模板ID，或指定模板Code。',
- 'description' => '模板ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
+ 'Algorithm' => ['title' => '关联算法ID。', 'description' => '关联算法ID。', 'type' => 'string', 'example' => 'user_recall'],
+ 'CampaignId' => ['title' => '关联运营活动ID。', 'description' => '关联运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'DataPath' => ['title' => '训练数据路径，指定路径前需确保已在控制台完成一键授权。', 'description' => '训练数据路径。', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'],
+ 'History' => ['title' => '训练任务日志。', 'description' => '训练任务日志。', 'type' => 'string', 'example' => 'Error: Unknown parameter.'],
+ 'Id' => ['title' => '训练任务ID。', 'description' => '训练任务Id。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '训练任务名称。', 'description' => '训练任务名称。', 'type' => 'string', 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => 'Recharge amount exceeds 10,000'],
+ 'Status' => ['title' => '训练任务状态。'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'description' => '训练任务状态，可能值：'."\n"
+ .'- 0: 队列中。'."\n"
+ .'- 1: 已提交。'."\n"
+ .'- 2: 运行中。'."\n"
+ .'- 3: 成功。'."\n"
+ .'- 4: 失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'TrainingScheduleId' => ['title' => '关联训练计划ID。', 'description' => '关联训练计划ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'UserConfig' => ['title' => '用户配置。', 'description' => '用户配置。', 'type' => 'string', 'example' => '{\\"end_date\\":\\"20220408\\",\\"op_target\\":\\"sms\\",\\"start_date\\":\\"20220101\\"}'],
+ 'HasModelInfo' => ['description' => '是否存有特征重要性、模式、决策树等特征信息。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
],
+ 'description' => '',
],
],
- 'TotalCount' => [
- 'title' => '触达计划数量。',
- 'description' => '触达计划数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => '""'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -7534,85 +3624,198 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"TrainingJobs\\": [\\n {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"History\\": \\"Error: Unknown parameter.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"Recharge amount exceeds 10,000\\",\\n \\"Status\\": 3,\\n \\"TrainingScheduleId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{\\\\\\\\\\\\\\"end_date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20220408\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"op_target\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sms\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"start_date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20220101\\\\\\\\\\\\\\"}\\",\\n \\"HasModelInfo\\": true\\n }\\n ]\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '获取训练任务列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-22T06:31:13.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-09-28T06:02:37.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobs'],
+ ],
+ ],
+ ],
+ 'SendMessage' => [
+ 'summary' => '发送短信，使用前须注册签名和模板。',
+ 'path' => '/api/v2/messages',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '123215',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '请求参数的主体信息。',
+ 'description' => '请求参数的主体信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupId' => ['title' => '人群Id，用于关联人群。', 'description' => '人群ID，用于关联人群。', 'type' => 'string', 'required' => false, 'example' => '10ed87f5-3ca8-4a43-9d83-b30519be7241'],
+ 'OutIds' => [
+ 'title' => '外部拓展字段，示例：["1234567890"]。',
+ 'description' => '外部拓展字段，示例：["1234567890"]。',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => '1234567890', 'description' => ''],
+ 'required' => false,
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
+ 'PhoneNumbers' => [
+ 'title' => '手机号，每个手机号对应一个模板变量、上行拓展码和外部拓展字段，个数最大为1000，示例：["1234567890"]。',
+ 'description' => '手机号，每个手机号对应一个模板变量、上行拓展码和外部拓展字段，号码个数最大为1000，示例：["1234567890"]。',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => '1234567890', 'description' => ''],
+ 'required' => false,
],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
+ 'ScheduleId' => ['title' => '触达计划Id，用于关联触达计划。', 'description' => '发送计划ID，用于关联发送计划。', 'type' => 'string', 'required' => false, 'example' => '08d19262-bd76-48fd-80e8-6a225ac388c1'],
+ 'SignName' => ['title' => '签名名称。', 'description' => '签名名称。', 'type' => 'string', 'required' => false, 'example' => 'PAI通知'],
+ 'SignatureId' => ['title' => '签名Id，同时只能指定签名名称或签名Id其中之一。', 'description' => '签名ID，同时只能指定签名名称或签名ID其中之一。', 'type' => 'string', 'required' => false, 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'],
+ 'SmsUpExtendCodes' => [
+ 'title' => '短信上行拓展码，示例：["1234567890"]。',
+ 'description' => '短信上行拓展码，示例：["1234567890"]。',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => '1234567890', 'description' => ''],
+ 'required' => false,
],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
+ 'TemplateCode' => ['title' => '模板Code。', 'description' => '模板Code。', 'type' => 'string', 'required' => false, 'example' => 'SMS_123456'],
+ 'TemplateId' => ['title' => '模板Id，同时只能指定模板Code或模板Id其中之一。', 'description' => '模板ID，同时只能指定模板Code或模板ID其中之一。', 'type' => 'string', 'required' => false, 'example' => 'b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3'],
+ 'TemplateParams' => [
+ 'title' => '短信模板变量对应的实际值，JSON格式。支持传入多个参数，示例：[{"name":"张三","number":"15038****76"}]。',
+ 'description' => '短信模板变量对应的实际值，JSON格式。支持传入多个参数，示例：[{"name":"张三","number":"15038****76"}]。',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => '{"name":"张三","number":"15038****76"}', 'description' => ''],
+ 'required' => false,
+ 'example' => '{"name":" John Doe","number":"15038****76"}',
],
+ 'PaymentType' => ['description' => '计费类型（为空时默认后付费）。'."\n"
+ ."\n"
+ .'- PayAsYouGo：后付费'."\n"
+ .'- Subscription：预付费', 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo'],
],
+ 'required' => false,
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Schedules\\": [\\n {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"EndTime\\": \\"2020-01-01\\",\\n \\"ExecuteTime\\": \\"2020-01-01 12:00:00\\",\\n \\"GroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"增长-2021-0101\\",\\n \\"RepeatCycle\\": 0,\\n \\"RepeatCycleUnit\\": 0,\\n \\"RepeatTimes\\": 1,\\n \\"SignName\\": \\"PAI\\",\\n \\"SignatureId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"TemplateId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 0\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取发送计划列表',
- ],
- 'GetSchedule' => [
- 'summary' => '获取发送计划详细信息，包括计划时间、内容、状态等。',
- 'path' => '/api/v2/schedules/{Id}',
- 'methods' => [
- 'get',
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'title' => '成功发送短信。',
+ 'description' => '成功发送短信。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'title' => '返回数据。',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Messages' => [
+ 'title' => '短信结果列表，列表中手机号的顺序与输入请求手机号顺序一一对应。',
+ 'description' => '短信结果列表，列表中手机号的顺序与输入请求手机号顺序一一对应。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '短信Id，可使用ListMessages查询短信状态。', 'description' => '短信ID，可使用ListMessages查询短信状态。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'PhoneNumber' => ['title' => '手机号码。', 'description' => '手机号码。', 'type' => 'string', 'example' => '1234567890'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'RequestId' => ['title' => '短信批处理Id，可使用ListMessages查询短信状态。', 'description' => '短信批处理ID，可使用ListMessages查询短信状态。', 'type' => 'string', 'example' => '62a72a20-8a9b-4060-a510-0c30a9340cba'],
+ ],
+ ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"PhoneNumber\\": \\"1234567890\\"\\n }\\n ],\\n \\"RequestId\\": \\"62a72a20-8a9b-4060-a510-0c30a9340cba\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '发送短信',
+ 'changeSet' => [
+ ['createdAt' => '2023-03-09T08:29:49.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-08-26T11:51:03.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-02-21T04:43:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T04:43:53.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T04:43:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendMessage'],
+ ],
],
+ ],
+ 'UpdateCampaign' => [
+ 'summary' => '更新运营活动名称和备注。',
+ 'path' => '/api/v2/campaigns/{Id}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '129062',
- 'abilityTreeNodes' => [
- 'FEATURElearn5SOS0Q',
- ],
+ 'abilityTreeCode' => '131226',
+ 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'path',
+ 'schema' => ['title' => '运营活动Id，可通过ListCampaigns查询账号下的运营活动列表，获取运营活动Id。', 'description' => '运营活动ID，可通过ListCampaigns查询账号下的运营活动列表，获取运营活动ID。', 'type' => 'string', 'required' => false, 'example' => '996e466b-6808-49c7-998c-47b57bb85dd4'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '短信触达计划ID，可通过ListSchedules查询账号下的短信触达计划列表，获取短信触达计划ID。',
- 'description' => '触达计划ID。如何获取触达计划ID，请参见[ListSchedules](~~429073~~)。',
- 'type' => 'string',
+ 'title' => '请求参数的主体信息。',
+ 'description' => '请求参数的主体信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '运营活动名称。', 'description' => '运营活动名称。', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'required' => false, 'example' => '双十一活动'],
+ ],
'required' => false,
- 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d',
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => '成功获取短信触达计划详情。',
- 'description' => '成功获取触达计划详情。',
+ 'title' => '成功更新运营活动。',
+ 'description' => '成功更新运营活动。',
'type' => 'object',
'properties' => [
'Data' => [
@@ -7620,162 +3823,16 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'CreatedTime' => [
- 'title' => '创建时间 (UTC+8)。',
- 'description' => '创建时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'EndTime' => [
- 'title' => '终止时间（UTC+8）。',
- 'description' => '终止时间（UTC+8）。',
- 'type' => 'string',
- 'format' => 'int32',
- 'example' => '2020-01-01',
- ],
- 'ExecuteTime' => [
- 'title' => '执行时间 (UTC+8)，为空立即执行。',
- 'description' => '执行时间 (UTC+8)，为空立即执行。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'GroupId' => [
- 'title' => '人群ID。',
- 'description' => '人群ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'History' => [
- 'title' => '历史记录。',
- 'description' => '历史记录。',
- 'type' => 'string',
- 'example' => 'string',
- ],
- 'Id' => [
- 'title' => '触达计划ID。',
- 'description' => '触达计划ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Name' => [
- 'title' => '触达计划名称。',
- 'description' => '触达计划名称。',
- 'type' => 'string',
- 'example' => '增长-2021-0101',
- ],
- 'RepeatCycle' => [
- 'title' => '重复周期，按重复周期与重复周期单位执行。',
- 'description' => '重复周期，按重复周期与重复周期单位执行。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RepeatCycleUnit' => [
- 'title' => '重复周期单位，若指定执行时间，则重复周期生效。'."\n"
- .'- 0: 从不（默认）。'."\n"
- .'- 1: 小时。'."\n"
- .'- 2: 天。'."\n"
- .'- 3: 周。'."\n"
- .'- 4: 月。',
- 'description' => '重复周期单位，若指定执行时间（ExecuteTime），则重复周期生效。可能值：'."\n"
- .'- 0：从不（默认）。'."\n"
- .'- 1：小时。'."\n"
- .'- 2：天。'."\n"
- .'- 3：周。'."\n"
- .'- 4：月。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RepeatTimes' => [
- 'title' => '重复次数。'."\n"
- .'- 0: 不设终止时间（默认）。'."\n"
- .'- N: 重复N次后终止。',
- 'description' => '重复次数，可能值：'."\n"
- .'- -1：不设终止时间（默认）。'."\n"
- .'- 0：不重复。'."\n"
- .'- N：重复N次后终止。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '-1',
- ],
- 'SignName' => [
- 'title' => '签名。',
- 'description' => '签名。',
- 'type' => 'string',
- 'example' => 'PAI',
- ],
- 'SignatureId' => [
- 'title' => '签名ID，或指定签名。',
- 'description' => '签名ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'Status' => [
- 'title' => '状态。'."\n"
- .'- 0: 检查中。'."\n"
- .'- 1: 检查成功。'."\n"
- .'- 2: 检查失败。'."\n"
- .'- 3: 发送中。'."\n"
- .'- 4: 发送成功。'."\n"
- .'- 5: 发送失败。',
- 'description' => '状态，可能值：'."\n"
- .'- 0：检查中。'."\n"
- .'- 1：检查成功。'."\n"
- .'- 2：检查失败。'."\n"
- .'- 3：发送中。'."\n"
- .'- 4：发送成功。'."\n"
- .'- 5：发送失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TemplateCode' => [
- 'title' => '模板Code。',
- 'description' => '模板Code。',
- 'type' => 'string',
- 'example' => 'SMS_123456',
- ],
- 'TemplateId' => [
- 'title' => '模板ID，或指定模板Code。',
- 'description' => '模板ID。',
- 'type' => 'string',
- 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
- ],
- 'UpdatedTime' => [
- 'title' => '更新时间 (UTC+8)。',
- 'description' => '更新时间 (UTC+8)。',
- 'type' => 'string',
- 'example' => '2020-01-01 12:00:00',
- ],
- 'PaymentType' => [
- 'description' => '计费类型（为空时默认后付费），可能值为：'."\n"
- .'- PayAsYouGo：后付费（按量付费）'."\n"
- .'- Subscription：预付费（包年包月）',
- 'type' => 'string',
- 'example' => 'Subscription',
- ],
+ 'CreatedTime' => ['title' => '创建时间 (UTC+8)。', 'description' => '创建时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
+ 'Id' => ['title' => '运营活动Id。', 'description' => '运营活动ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'],
+ 'Name' => ['title' => '运营活动名称。', 'description' => '运营活动名称。', 'type' => 'string', 'example' => 'VIP客户'],
+ 'Remark' => ['title' => '备注。', 'description' => '备注。', 'type' => 'string', 'example' => '双十一活动'],
+ 'UpdatedTime' => ['title' => '更新时间 (UTC+8)。', 'description' => '更新时间 (UTC+8)。', 'type' => 'string', 'example' => '2020-01-01 12:00:00'],
],
],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
@@ -7785,42 +3842,224 @@
'description' => '失败，原因见ErrorMessage，错误码见Data。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '返回数据。',
- 'description' => '返回数据。',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a',
- ],
+ 'Data' => ['title' => '返回数据。', 'description' => '返回数据。', 'type' => 'string'],
+ 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ErrorMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"EndTime\\": \\"2020-01-01\\",\\n \\"ExecuteTime\\": \\"2020-01-01 12:00:00\\",\\n \\"GroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"History\\": \\"string\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"增长-2021-0101\\",\\n \\"RepeatCycle\\": 0,\\n \\"RepeatCycleUnit\\": 0,\\n \\"RepeatTimes\\": -1,\\n \\"SignName\\": \\"PAI\\",\\n \\"SignatureId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"TemplateId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"PaymentType\\": \\"Subscription\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
- 'title' => '获取发送计划详情',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]',
+ 'title' => '更新运营活动',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCampaign'],
+ ],
+ ],
],
],
'endpoints' => [
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paiplugin.cn-hangzhou.aliyuncs.com', 'endpoint' => 'paiplugin.cn-hangzhou.aliyuncs.com', 'vpc' => 'paiplugin-vpc.cn-hangzhou.aliyuncs.com'],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'paiplugin.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateSchedule'],
+ ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'GetSchedule'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'SendMessage'],
+ ],
+ 'createdAt' => '2023-03-24T08:23:24.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateTemplate'],
+ ],
+ 'createdAt' => '2023-01-06T06:54:37.000Z',
+ 'description' => '修改CreateTemplate请求参数body的“必填”为否',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'CreateSchedule'],
+ ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'CreateSignature'],
+ ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'CreateTemplate'],
+ ['description' => '请求参数发生变更', 'api' => 'DeleteSignature'],
+ ],
+ 'createdAt' => '2023-01-06T04:03:32.000Z',
+ 'description' => '更正了DeleteSignature、CreateTemplate、CreateSignature 、CreateSchedule 等API中请求参数的必填选项',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListSchedules'],
+ ],
+ 'createdAt' => '2022-12-23T03:09:55.000Z',
+ 'description' => '完善API文档',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateTrainingJob'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetTrainingJob'],
+ ['description' => '响应参数发生变更', 'api' => 'ListTrainingJobs'],
+ ],
+ 'createdAt' => '2022-12-22T06:32:08.000Z',
+ 'description' => '增加模型可视化相关API',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListInferenceJobs'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListTrainingJobs'],
+ ],
+ 'createdAt' => '2022-09-28T06:03:10.000Z',
+ 'description' => 'ListTrainingJob、ListInferenceJob增加过滤参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'SendMessage'],
+ ],
+ 'createdAt' => '2022-08-26T11:51:44.000Z',
+ 'description' => '更新API sendMessage的参数说明',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetGroup'],
+ ],
+ 'createdAt' => '2022-06-07T11:37:40.000Z',
+ 'description' => 'GetGroup增加History字段',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateTemplate'],
+ ],
+ 'createdAt' => '2022-05-16T04:00:45.000Z',
+ 'description' => '发布接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListMessages'],
+ ],
+ 'createdAt' => '2022-03-08T05:24:07.000Z',
+ 'description' => 'ListMessages接口新增ErrorCode过滤',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'SmsReport'],
+ ['description' => 'OpenAPI 下线', 'api' => 'SmsUp'],
+ ],
+ 'createdAt' => '2022-03-07T06:20:17.000Z',
+ 'description' => '新增回执接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'CreateSignature'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'DeleteSignature'],
+ ['description' => '响应参数发生变更', 'api' => 'DeleteTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'GetSignature'],
+ ['description' => '响应参数发生变更', 'api' => 'GetTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'ListMessageMetrics'],
+ ['description' => '响应参数发生变更', 'api' => 'ListMessages'],
+ ['description' => '响应参数发生变更', 'api' => 'ListSignatures'],
+ ['description' => '响应参数发生变更', 'api' => 'ListTemplates'],
+ ],
+ 'createdAt' => '2022-03-02T08:35:20.000Z',
+ 'description' => '更新文档说明',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ListMessageMetrics'],
+ ],
+ 'createdAt' => '2022-03-01T16:09:12.000Z',
+ 'description' => '新增ListMessageMetrics',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'CreateSignature'],
+ ['description' => '响应参数发生变更', 'api' => 'CreateTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'DeleteSignature'],
+ ['description' => '响应参数发生变更', 'api' => 'DeleteTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'GetSignature'],
+ ['description' => '响应参数发生变更', 'api' => 'GetTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'ListMessageMetrics'],
+ ['description' => '响应参数发生变更', 'api' => 'ListMessages'],
+ ['description' => '响应参数发生变更', 'api' => 'ListSignatures'],
+ ['description' => '响应参数发生变更', 'api' => 'ListTemplates'],
+ ],
+ 'createdAt' => '2022-03-01T16:06:14.000Z',
+ 'description' => '更新API，新增RequestId字段',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'CreateSignature'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'DeleteSignature'],
+ ['description' => '响应参数发生变更', 'api' => 'DeleteTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'GetSignature'],
+ ['description' => '响应参数发生变更', 'api' => 'GetTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'ListMessageMetrics'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListMessages'],
+ ['description' => '响应参数发生变更', 'api' => 'ListSignatures'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListTemplates'],
+ ],
+ 'createdAt' => '2022-03-01T16:03:28.000Z',
+ 'description' => '更新文档说明',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateSignature'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateTemplate'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteSignature'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteTemplate'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetSignature'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetTemplate'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListSignatures'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListTemplates'],
+ ],
+ 'createdAt' => '2022-02-21T08:19:06.000Z',
+ 'description' => '发布短信、签名、模板API',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSignature'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSchedule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroups'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSchedule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInferenceJobs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSignatures'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSignature'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCampaign'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessageMetrics'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrainingJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSignature'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendMessage'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInferenceJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCampaign'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMessageConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithm'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessages'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInferenceJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSchedule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithms'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSchedules'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInferenceJob'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 20:59:25 +0000