summaryrefslogtreecommitdiff
path: root/data/en_us/acm
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/acm
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/acm')
-rw-r--r--data/en_us/acm/2020-02-06/api-docs.php2272
1 files changed, 881 insertions, 1391 deletions
diff --git a/data/en_us/acm/2020-02-06/api-docs.php b/data/en_us/acm/2020-02-06/api-docs.php
index 259598e..da2ee3c 100644
--- a/data/en_us/acm/2020-02-06/api-docs.php
+++ b/data/en_us/acm/2020-02-06/api-docs.php
@@ -1,63 +1,31 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'acm',
- 'version' => '2020-02-06',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'acm', 'version' => '2020-02-06'],
'directories' => [
[
- 'id' => 56412,
- 'title' => null,
+ 'children' => ['DescribeImportFileUrl', 'DescribeTraceByConfiguration'],
'type' => 'directory',
- 'children' => [
- 'DescribeImportFileUrl',
- 'DescribeTraceByConfiguration',
- ],
+ 'title' => 'Data',
],
[
- 'id' => 56415,
- 'title' => null,
+ 'children' => ['CreateNamespace', 'DeleteNamespace', 'UpdateNamespace', 'DescribeNamespace', 'DescribeNamespaces', 'DescribeNamespacesWithCreate'],
'type' => 'directory',
- 'children' => [
- 'CreateNamespace',
- 'DeleteNamespace',
- 'UpdateNamespace',
- 'DescribeNamespace',
- 'DescribeNamespaces',
- 'DescribeNamespacesWithCreate',
- ],
+ 'title' => 'Namespace',
],
[
- 'id' => 56422,
- 'title' => null,
+ 'children' => ['CreateConfiguration', 'CloneConfiguration', 'DeleteConfiguration', 'DeployConfiguration', 'BatchExportConfigurations', 'BatchImportConfigurations', 'DescribeConfiguration', 'CheckConfigurationClone', 'CheckConfigurationExport'],
'type' => 'directory',
- 'children' => [
- 'CreateConfiguration',
- 'CloneConfiguration',
- 'DeleteConfiguration',
- 'DeployConfiguration',
- 'BatchExportConfigurations',
- 'BatchImportConfigurations',
- 'DescribeConfiguration',
- 'CheckConfigurationClone',
- 'CheckConfigurationExport',
- ],
+ 'title' => 'Configuration',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'DescribeImportFileUrl' => [
- 'path' => '/diamond-ops/pop/batch/importFileUrl',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BatchExportConfigurations' => [
+ 'path' => '/diamond-ops/pop/batch/export',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -65,18 +33,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ContentType',
+ 'name' => 'NamespaceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'Data',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -84,94 +51,60 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'FileUrl' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
+ 'FileUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
],
- 'responseDemo' => null,
- ],
- 'DescribeTraceByConfiguration' => [
- 'path' => '/diamond-ops/pop/trace/getByConfiguration',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FileUrl\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '',
+ 'summary' => '',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchExportConfigurations'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'BatchImportConfigurations' => [
+ 'path' => '/diamond-ops/pop/batch/import',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'DataId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
- 'name' => 'Group',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
'name' => 'NamespaceId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
- 'name' => 'StartTs',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'name' => 'Policy',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
- 'name' => 'EndTs',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'name' => 'FileUrl',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -179,210 +112,64 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Traces' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Timestamp' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'EventGroups' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'EventType' => [
- 'type' => 'string',
- ],
- 'EventDetails' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'type' => 'string',
- ],
- 'Delay' => [
- 'type' => 'string',
- ],
- 'Ts' => [
- 'type' => 'string',
- ],
- 'ResponseIp' => [
- 'type' => 'string',
- ],
- 'Event' => [
- 'type' => 'string',
- ],
- 'Ext' => [
- 'type' => 'string',
- ],
- 'DataId' => [
- 'type' => 'string',
- ],
- 'RequestIp' => [
- 'type' => 'string',
- ],
- 'LogDate' => [
- 'type' => 'string',
- ],
- 'HandleIp' => [
- 'type' => 'string',
- ],
- 'Group' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'Code' => [
- 'type' => 'string',
- ],
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
],
- 'responseDemo' => null,
- ],
- 'CreateNamespace' => [
- 'path' => '/diamond-ops/pop/namespace',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '',
+ 'summary' => '',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchImportConfigurations'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'CheckConfigurationClone' => [
+ 'path' => '/diamond-ops/pop/batch/checkForClone',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Name',
+ 'name' => 'Policy',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6F7CC94A-7711-4873-8848-****',
- ],
- 'NamespaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3115d2bf-1f44-47bf-a855-****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'NamespaceNameInvalid',
- 'errorMessage' => 'The specified namespace is invalid.',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'NamespaceQuotaExceed',
- 'errorMessage' => 'The maximum number of namespaces is exceeded.',
- ],
+ 'name' => 'NamespaceFrom',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"6F7CC94A-7711-4873-8848-****\\",\\n \\"NamespaceId\\": \\"3115d2bf-1f44-47bf-a855-****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6F7CC94A-7711-4873-8848-FCE2F1795625</RequestId>\\n<Message>Success</Message>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => 'CreateNamespace',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteNamespace' => [
- 'path' => '/diamond-ops/pop/namespace',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'NamespaceTo',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
[
- 'name' => 'NamespaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '112300d2-ca66-42ba-b706-****',
- ],
+ 'name' => 'Data',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -390,98 +177,80 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '611CC94A-7711-4873-8848-****',
- ],
- 'Code' => [
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'SuccessItems' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Group' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'OK',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'NamespacePermissionDenied',
- 'errorMessage' => 'You are not authorized to operate the namespace.',
- ],
- ],
- [
- [
- 'errorCode' => 'NamespaceNotExists',
- 'errorMessage' => 'The specified namespace does not exist.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
- 500 => [
- [
- 'errorCode' => 'NamespaceInUsage',
- 'errorMessage' => 'The specified namespace is being used.',
- ],
+ ],
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Result\\": {\\n \\"Success\\": false,\\n \\"SuccessItems\\": [\\n {\\n \\"DataId\\": \\"\\",\\n \\"Group\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => '',
+ 'summary' => '',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckConfigurationClone'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"611CC94A-7711-4873-8848-****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>612CC94A-7711-4873-8848-****</RequestId>\\n<Message>Success</Message>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => 'DeleteNamespace',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'UpdateNamespace' => [
- 'path' => '/diamond-ops/pop/namespace',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CheckConfigurationExport' => [
+ 'path' => '/diamond-ops/pop/batch/checkForExport',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NamespaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '710b2fbe-0da3-4388-****',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
- 'name' => 'NamespaceName',
+ 'name' => 'Data',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -489,342 +258,136 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '51193061-ED0D-4EC6-B160-****',
- ],
- 'Code' => [
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'OK',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'NamespaceNameInvalid',
- 'errorMessage' => 'The specified namespace is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ 401 => [
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
- 403 => [
- [
- 'errorCode' => 'NamespacePermissionDenied',
- 'errorMessage' => 'You are not authorized to operate the namespace.',
- ],
+ ],
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => '',
+ 'summary' => '',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckConfigurationExport'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"51193061-ED0D-4EC6-B160-****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>5E493061-ED0D-4EC6-B160-C069FCBF7941</RequestId>\\n<Message>Success</Message>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => 'UpdateNamespace',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'DescribeNamespace' => [
- 'path' => '/diamond-ops/pop/namespace',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CloneConfiguration' => [
+ 'path' => '/diamond-ops/pop/batch/clone',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'NamespaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3115d2bf-1f44-47bf-a855-****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3116581E-C664-4D3A-A055-****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Namespace' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SecretKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6/eQ0****',
- ],
- 'AccessKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2c017****',
- ],
- 'Endpoint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'acm.aliyun.com',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ 'name' => 'Policy',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
- 403 => [
- [
- 'errorCode' => 'NamespacePermissionDenied',
- 'errorMessage' => 'You are not authorized to operate the namespace.',
- ],
+ [
+ 'name' => 'NamespaceFrom',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
- [
- 'errorCode' => 'NamespaceNotExists',
- 'errorMessage' => 'The specified namespace does not exist.',
- ],
+ 'name' => 'NamespaceTo',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"3116581E-C664-4D3A-A055-****\\",\\n \\"Namespace\\": {\\n \\"SecretKey\\": \\"6/eQ0****\\",\\n \\"AccessKey\\": \\"2c017****\\",\\n \\"Name\\": \\"测试环境\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Endpoint\\": \\"acm.aliyun.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>51193061-ED0D-4EC6-B160-****</RequestId>\\n<Message>Success</Message>\\n<Code>OK</Code>\\n<Namespace>\\n <SecretKey>6/eQ****</SecretKey>\\n <Endpoint>addr-bj-internal.edas.aliyun.com</Endpoint>\\n <Name>测试环境</Name>\\n <RegionId>cn-beijing</RegionId>\\n <AccessKey>2c01****</AccessKey>\\n</Namespace>","errorExample":""}]',
- 'title' => 'DescribeNamespace',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeNamespaces' => [
- 'path' => '/diamond-ops/pop/namespace/list',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'Data',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'Namespaces' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Quota' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'NamespaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3115d2bf-1f44-47bf-a855-****',
- ],
- 'ConfigCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'NamespaceName' => [
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'SuccessItems' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Group' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
- ],
- 'Message' => [
'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3116581E-C664-4D3A-A055-****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OK',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"3116581E-C664-4D3A-A055-****\\",\\n \\"Namespaces\\": [\\n {\\n \\"Type\\": 1,\\n \\"ConfigCount\\": 20,\\n \\"Quota\\": 200,\\n \\"NamespaceId\\": \\"3115d2bf-1f44-47bf-a855-****\\",\\n \\"NamespaceName\\": \\"测试环境\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<Namespaces>\\n <NamespaceName>Default Space(EDAS)</NamespaceName>\\n <Type>1</Type>\\n <Quota>200</Quota>\\n <ConfigCount>48</ConfigCount>\\n <NamespaceId>0846c173-decf-4b47-8aa0-04b5a561****</NamespaceId>\\n</Namespaces>\\n<RequestId>EDA3B962-37DC-48EC-99FA-20ED0********</RequestId>\\n<Message>Success</Message>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => 'DescribeNamespaces',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeNamespacesWithCreate' => [
- 'path' => '/diamond-ops/pop/namespace/listWithCreate',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Namespaces' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Quota' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'NamespaceId' => [
- 'type' => 'string',
- ],
- 'ConfigCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'NamespaceName' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- ],
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
],
- 'errorCodes' => [
- 401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Result\\": {\\n \\"Success\\": false,\\n \\"SuccessItems\\": [\\n {\\n \\"DataId\\": \\"\\",\\n \\"Group\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => '',
+ 'summary' => '',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloneConfiguration'],
],
],
- 'responseDemo' => null,
],
'CreateConfiguration' => [
'path' => '/diamond-ops/pop/configuration',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -832,94 +395,63 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'DataId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'com.aliyun.acm.example',
- ],
+ 'schema' => ['description' => 'The ID of the configuration. Valid characters include letters, digits, periods (.), colons (:), asterisks (*), underscores (_), and hyphens (-). If the ID has one of the following prefixes, Application Configuration Management (ACM) automatically uses Key Management Service (KMS) to encrypt the configuration for storage:'."\n"
+ ."\n"
+ .'- Prefix `cipher-`: Calls KMS to encrypt and decrypt the configuration. The size of data to be encrypted or decrypted cannot exceed 4 KB and the maximum size is 6 KB. Special characters such as ampersands (&) may cause decryption errors. This method is not recommended.'."\n"
+ ."\n"
+ .'- Prefix `cipher-kms-aes-128-`: Uses the envelope encryption method of KMS. The configuration content can exceed 6 KB, up to a maximum of 100 KB. The plaintext data of the configuration content is not transmitted to the KMS system, which provides higher security. This method is recommended.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.aliyun.acm.example', 'title' => ''],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'app',
- ],
+ 'schema' => ['description' => 'The name of the application to which the configuration belongs.', 'type' => 'string', 'required' => false, 'example' => 'app', 'title' => ''],
],
[
'name' => 'Group',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'DEFAULT_GROUP',
- ],
+ 'schema' => ['description' => 'The group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP', 'title' => ''],
],
[
'name' => 'Desc',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The description of the configuration.', 'type' => 'string', 'required' => false, 'example' => '测试配置', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tag1,tag2',
- ],
+ 'schema' => ['description' => 'The tags of the configuration. Separate multiple tags with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'tag1,tag2', 'title' => ''],
],
[
'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'key=Hello;value=World',
- ],
+ 'schema' => ['description' => 'The content of the configuration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key=Hello;value=World', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'text',
- ],
+ 'schema' => ['description' => 'The format of the configuration content. Valid values:'."\n"
+ ."\n"
+ .'- text'."\n"
+ ."\n"
+ .'- json'."\n"
+ ."\n"
+ .'- xml'."\n"
+ ."\n"
+ .'- yaml'."\n"
+ ."\n"
+ .'- text/html'."\n"
+ ."\n"
+ .'- properties.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'text', 'title' => ''],
],
[
'name' => 'NamespaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '01146121-decf-4b47-****',
- ],
+ 'schema' => ['description' => 'The namespace ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '01146121-decf-4b47-****', 'title' => ''],
],
],
'responses' => [
@@ -927,66 +459,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '132BF104-A660-40C7-936B-F805967*****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => 'The response description.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '132BF104-A660-40C7-936B-F805967*****', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
500 => [
- [
- 'errorCode' => 'ConfigurationAlreadyExists',
- 'errorMessage' => 'The configuration item already exists.',
- ],
- [
- 'errorCode' => 'ConfigurationInvalidArgument',
- 'errorMessage' => 'The configuration parameter is invalid.',
- ],
- [
- 'errorCode' => 'ConfigurationQuotaOrSizeExceed',
- 'errorMessage' => 'The maximum number of configuration items or the maximum length of the configuration item is exceeded.',
- ],
- [
- 'errorCode' => 'ConfigurationSizeExceed',
- 'errorMessage' => 'The maximum length of the configuration item is exceeded.',
- ],
+ ['errorCode' => 'ConfigurationAlreadyExists', 'errorMessage' => 'The configuration item already exists.', 'description' => 'The configuration item already exists.'],
+ ['errorCode' => 'ConfigurationInvalidArgument', 'errorMessage' => 'The configuration parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'ConfigurationQuotaOrSizeExceed', 'errorMessage' => 'The maximum number of configuration items or the maximum length of the configuration item is exceeded.', 'description' => 'The maximum number of configuration items or the maximum length of the configuration item is exceeded.'],
+ ['errorCode' => 'ConfigurationSizeExceed', 'errorMessage' => 'The maximum length of the configuration item is exceeded.', 'description' => 'The maximum length of the configuration item is exceeded.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"132BF104-A660-40C7-936B-F805967*****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>132BF104-A660-40C7-936B-F805967*****</RequestId>\\n<Message>Success</Message>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => 'CreateConfiguration',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"132BF104-A660-40C7-936B-F805967*****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Create a configuration',
+ 'summary' => 'Creates a configuration.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CloneConfiguration' => [
- 'path' => '/diamond-ops/pop/batch/clone',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateConfiguration'],
+ ],
],
+ ],
+ 'CreateNamespace' => [
+ 'path' => '/diamond-ops/pop/namespace',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -994,45 +505,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'Policy',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
- 'name' => 'NamespaceFrom',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
- 'name' => 'NamespaceTo',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
- 'name' => 'Data',
+ 'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'The namespace name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试环境', 'title' => ''],
],
],
'responses' => [
@@ -1040,64 +518,46 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Result' => [
- 'type' => 'object',
- 'properties' => [
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'SuccessItems' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'DataId' => [
- 'type' => 'string',
- ],
- 'Group' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
+ 'Message' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F7CC94A-7711-4873-8848-****', 'title' => ''],
+ 'NamespaceId' => ['description' => 'The namespace ID.', 'type' => 'string', 'example' => '3115d2bf-1f44-47bf-a855-****', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ 400 => [
+ ['errorCode' => 'NamespaceNameInvalid', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The specified name of the namespace is invalid.'],
+ ],
+ [
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
+ ],
+ 500 => [
+ ['errorCode' => 'NamespaceQuotaExceed', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The maximum number of namespaces is exceeded.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"6F7CC94A-7711-4873-8848-****\\",\\n \\"NamespaceId\\": \\"3115d2bf-1f44-47bf-a855-****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Create a namespace',
+ 'summary' => 'Creates a namespace.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNamespace'],
],
],
- 'responseDemo' => null,
+ 'ramActions' => [],
],
'DeleteConfiguration' => [
'path' => '/diamond-ops/pop/configuration',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1105,113 +565,134 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'DataId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'com.aliyun.acm.example',
- ],
+ 'schema' => ['description' => 'The configuration ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.aliyun.acm.example', 'title' => ''],
],
[
'name' => 'Group',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'DEFAULT_GROUP',
- ],
+ 'schema' => ['description' => 'The group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP', 'title' => ''],
],
[
'name' => 'NamespaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The namespace ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10d1110d2-ca66-42ba-b706-****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '617CC94A-0019-4873-8848-****', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10d1110d2-ca66-42ba-b706-****',
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'errorCodes' => [
+ 401 => [
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
+ ],
+ 403 => [
+ ['errorCode' => 'PermissionDenied', 'errorMessage' => 'You are not authorized to operate on the specified resources.', 'description' => 'You are not authorized to operate on the specified resources.'],
+ ],
+ [
+ ['errorCode' => 'ConfigurationNotExists', 'errorMessage' => 'The configuration item does not exist.', 'description' => 'The configuration does not exist.'],
+ ],
+ 500 => [
+ ['errorCode' => 'ConfigurationDeleteFail', 'errorMessage' => 'Failed to delete the configuration item.', 'description' => 'Failed to delete the configuration item.'],
+ ['errorCode' => 'ConfigurationInvalidArgument', 'errorMessage' => 'The configuration parameter is invalid.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"617CC94A-0019-4873-8848-****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a configuration',
+ 'summary' => 'Deletes a configuration.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteConfiguration'],
+ ],
+ ],
+ ],
+ 'DeleteNamespace' => [
+ 'path' => '/diamond-ops/pop/namespace',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
+ [
+ 'name' => 'NamespaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The namespace ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '112300d2-ca66-42ba-b706-****', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '617CC94A-0019-4873-8848-****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '611CC94A-7711-4873-8848-****', 'title' => ''],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
403 => [
- [
- 'errorCode' => 'PermissionDenied',
- 'errorMessage' => 'You are not authorized to operate on the specified resources.',
- ],
+ ['errorCode' => 'NamespacePermissionDenied', 'errorMessage' => 'You are not authorized to operate the namespace.', 'description' => 'You are not authorized to operate the namespace.'],
],
[
- [
- 'errorCode' => 'ConfigurationNotExists',
- 'errorMessage' => 'The configuration item does not exist.',
- ],
+ ['errorCode' => 'NamespaceNotExists', 'errorMessage' => 'The specified namespace does not exist.', 'description' => 'The specified namespace does not exist.'],
],
500 => [
- [
- 'errorCode' => 'ConfigurationDeleteFail',
- 'errorMessage' => 'Failed to delete the configuration item.',
- ],
- [
- 'errorCode' => 'ConfigurationInvalidArgument',
- 'errorMessage' => 'The configuration parameter is invalid.',
- ],
+ ['errorCode' => 'NamespaceInUsage', 'errorMessage' => 'The specified namespace is being used.', 'description' => 'The specified namespace is being used.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"617CC94A-0019-4873-8848-****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6F7CC94A-7711-4873-8848-FCE2F1795625</RequestId>\\n<Message>Success</Message>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => 'DeleteConfiguration',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"611CC94A-7711-4873-8848-****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a namespace',
+ 'summary' => 'Deletes a namespace.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNamespace'],
+ ],
+ ],
+ 'ramActions' => [],
],
'DeployConfiguration' => [
'path' => '/diamond-ops/pop/configuration',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1219,104 +700,64 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'DataId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'com.aliyun.acm.example',
- ],
+ 'schema' => ['description' => 'The configuration ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.aliyun.acm.example', 'title' => ''],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'app',
- ],
+ 'schema' => ['description' => 'The name of the application to which the configuration belongs.', 'type' => 'string', 'required' => false, 'example' => 'app', 'title' => ''],
],
[
'name' => 'Group',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'DEFAULT_GROUP',
- ],
+ 'schema' => ['description' => 'The group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP', 'title' => ''],
],
[
'name' => 'Desc',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The description of the configuration.', 'type' => 'string', 'required' => false, 'example' => '测试配置', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tag1,tag2',
- ],
+ 'schema' => ['description' => 'The tags of the configuration. Separate multiple tags with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'tag1,tag2', 'title' => ''],
],
[
'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Hello World',
- ],
+ 'schema' => ['description' => 'The content of the configuration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Hello World', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'text',
- ],
+ 'schema' => ['description' => 'The format of the configuration content. Valid values:'."\n"
+ ."\n"
+ .'- text'."\n"
+ ."\n"
+ .'- json'."\n"
+ ."\n"
+ .'- xml'."\n"
+ ."\n"
+ .'- yaml'."\n"
+ ."\n"
+ .'- text/html'."\n"
+ ."\n"
+ .'- properties.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'text', 'title' => ''],
],
[
'name' => 'NamespaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '111000d2-ca66-42ba-b706-****',
- ],
+ 'schema' => ['description' => 'The namespace ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '111000d2-ca66-42ba-b706-****', 'title' => ''],
],
[
'name' => 'BetaIps',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '127.0.0.1',
- ],
+ 'schema' => ['description' => 'The list of IP addresses for the beta release.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''],
],
],
'responses' => [
@@ -1324,66 +765,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '611CC94A-7711-4873-8848-****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '611CC94A-7711-4873-8848-****', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
500 => [
- [
- 'errorCode' => 'ConfigurationDeployFail',
- 'errorMessage' => 'Failed to publish the configuration item.',
- ],
- [
- 'errorCode' => 'ConfigurationInvalidArgument',
- 'errorMessage' => 'The configuration parameter is invalid.',
- ],
- [
- 'errorCode' => 'ConfigurationQuotaOrSizeExceed',
- 'errorMessage' => 'The maximum number of configuration items or the maximum length of the configuration item is exceeded.',
- ],
- [
- 'errorCode' => 'ConfigurationSizeExceed',
- 'errorMessage' => 'The maximum length of the configuration item is exceeded.',
- ],
+ ['errorCode' => 'ConfigurationDeployFail', 'errorMessage' => 'Failed to publish the configuration item.', 'description' => 'Failed to publish the configuration item.'],
+ ['errorCode' => 'ConfigurationInvalidArgument', 'errorMessage' => 'The configuration parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'ConfigurationQuotaOrSizeExceed', 'errorMessage' => 'The maximum number of configuration items or the maximum length of the configuration item is exceeded.', 'description' => 'The maximum number of configuration items or the maximum length of the configuration item is exceeded.'],
+ ['errorCode' => 'ConfigurationSizeExceed', 'errorMessage' => 'The maximum length of the configuration item is exceeded.', 'description' => 'The maximum length of the configuration item is exceeded.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"611CC94A-7711-4873-8848-****\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6F7CC94A-7711-4873-8848-FCE2F1795625</RequestId>\\n<Message>Success</Message>\\n<Code>OK</Code>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"611CC94A-7711-4873-8848-****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => 'DeployConfiguration',
+ 'summary' => 'Publishes a configuration.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'BatchExportConfigurations' => [
- 'path' => '/diamond-ops/pop/batch/export',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeployConfiguration'],
+ ],
],
+ ],
+ 'DescribeConfiguration' => [
+ 'path' => '/diamond-ops/pop/configuration',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1391,27 +811,22 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'NamespaceId',
+ 'name' => 'DataId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'The configuration ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.aliyun.acm.example', 'title' => ''],
],
[
- 'name' => 'Data',
+ 'name' => 'Group',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'The group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP', 'title' => ''],
+ ],
+ [
+ 'name' => 'NamespaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The namespace ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '101100d2-ca66-42ba-b706-****', 'title' => ''],
],
],
'responses' => [
@@ -1419,78 +834,78 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'FileUrl' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
+ 'Message' => ['description' => 'The response description.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '611CC94A-7711-4873-8848-****', 'title' => ''],
+ 'Configuration' => [
+ 'description' => 'The configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The format of the configuration content.', 'type' => 'string', 'example' => 'text', 'title' => ''],
+ 'AppName' => ['description' => 'The name of the application to which the configuration belongs.', 'type' => 'string', 'example' => 'app', 'title' => ''],
+ 'Tags' => ['description' => 'The tags of the configuration.', 'type' => 'string', 'example' => 'tag1,tag2', 'title' => ''],
+ 'Md5' => ['description' => 'The message digest of the configuration.', 'type' => 'string', 'example' => '18d2e20****', 'title' => ''],
+ 'DataId' => ['description' => 'The configuration ID.', 'type' => 'string', 'example' => 'com.aliyun.acm.example', 'title' => ''],
+ 'Content' => ['description' => 'The configuration content.', 'type' => 'string', 'example' => 'Hello World', 'title' => ''],
+ 'Group' => ['description' => 'The group.', 'type' => 'string', 'example' => 'DEFAULT_GROUP', 'title' => ''],
+ 'Desc' => ['description' => 'The configuration description.', 'type' => 'string', 'example' => '测试配置', 'title' => ''],
+ 'GmtCreate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtModified' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
+ ],
+ 403 => [
+ ['errorCode' => 'PermissionDenied', 'errorMessage' => 'You are not authorized to operate on the specified resources.', 'description' => 'You are not authorized to operate on the specified resources.'],
+ ],
+ [
+ ['errorCode' => 'ConfigurationNotExists', 'errorMessage' => 'The configuration item does not exist.', 'description' => 'The configuration does not exist.'],
],
],
- 'responseDemo' => null,
- ],
- 'BatchImportConfigurations' => [
- 'path' => '/diamond-ops/pop/batch/import',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"611CC94A-7711-4873-8848-****\\",\\n \\"Configuration\\": {\\n \\"Type\\": \\"text\\",\\n \\"AppName\\": \\"app\\",\\n \\"Tags\\": \\"tag1,tag2\\",\\n \\"Md5\\": \\"18d2e20****\\",\\n \\"DataId\\": \\"com.aliyun.acm.example\\",\\n \\"Content\\": \\"Hello World\\",\\n \\"Group\\": \\"DEFAULT_GROUP\\",\\n \\"Desc\\": \\"测试配置\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"GmtModified\\": \\"\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve a configuration',
+ 'summary' => 'Retrieves a configuration.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-06-25T07:46:53.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeConfiguration'],
+ ],
],
+ ],
+ 'DescribeImportFileUrl' => [
+ 'path' => '/diamond-ops/pop/batch/importFileUrl',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'NamespaceId',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
- 'name' => 'Policy',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
- 'name' => 'FileUrl',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'ContentType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -1498,38 +913,37 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
+ 'FileUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
],
- 'responseDemo' => null,
- ],
- 'DescribeConfiguration' => [
- 'path' => '/diamond-ops/pop/configuration',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FileUrl\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '',
+ 'summary' => '',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImportFileUrl'],
+ ],
],
+ ],
+ 'DescribeNamespace' => [
+ 'path' => '/diamond-ops/pop/namespace',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1537,42 +951,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'DataId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'com.aliyun.acm.example',
- ],
- ],
- [
- 'name' => 'Group',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'DEFAULT_GROUP',
- ],
- ],
- [
'name' => 'NamespaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '101100d2-ca66-42ba-b706-****',
- ],
+ 'schema' => ['description' => 'The namespace ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3115d2bf-1f44-47bf-a855-****', 'title' => ''],
],
],
'responses' => [
@@ -1580,112 +964,189 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '611CC94A-7711-4873-8848-****',
- ],
- 'Configuration' => [
- 'description' => '',
+ 'Message' => ['description' => 'The response description.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3116581E-C664-4D3A-A055-****', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'Namespace' => [
+ 'description' => 'The namespace.',
'type' => 'object',
'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'text',
- ],
- 'AppName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'app',
- ],
- 'Tags' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'tag1,tag2',
- ],
- 'Md5' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '18d2e20****',
- ],
- 'DataId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'com.aliyun.acm.example',
- ],
- 'Content' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Hello World',
- ],
- 'Group' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DEFAULT_GROUP',
- ],
- 'Desc' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'GmtCreate' => [
- 'type' => 'string',
- ],
- 'GmtModified' => [
- 'type' => 'string',
- ],
+ 'SecretKey' => ['description' => 'The ACM-specific SecretKey (to be deprecated, not recommended).', 'type' => 'string', 'example' => '6/eQ0****', 'title' => ''],
+ 'AccessKey' => ['description' => 'The ACM-specific AccessKey (to be deprecated, not recommended).', 'type' => 'string', 'example' => '2c017****', 'title' => ''],
+ 'Endpoint' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'acm.aliyun.com', 'title' => ''],
+ 'Name' => ['description' => 'The namespace name.', 'type' => 'string', 'example' => '测试环境', 'title' => ''],
+ 'RegionId' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
],
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OK',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
403 => [
- [
- 'errorCode' => 'PermissionDenied',
- 'errorMessage' => 'You are not authorized to operate on the specified resources.',
- ],
+ ['errorCode' => 'NamespacePermissionDenied', 'errorMessage' => 'You are not authorized to operate the namespace.', 'description' => 'You are not authorized to operate the namespace.'],
],
[
- [
- 'errorCode' => 'ConfigurationNotExists',
- 'errorMessage' => 'The configuration item does not exist.',
+ ['errorCode' => 'NamespaceNotExists', 'errorMessage' => 'The specified namespace does not exist.', 'description' => 'The specified namespace does not exist.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"3116581E-C664-4D3A-A055-****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Namespace\\": {\\n \\"SecretKey\\": \\"6/eQ0****\\",\\n \\"AccessKey\\": \\"2c017****\\",\\n \\"Endpoint\\": \\"acm.aliyun.com\\",\\n \\"Name\\": \\"测试环境\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve namespace details',
+ 'summary' => 'Retrieves the details of a namespace.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNamespace'],
+ ],
+ ],
+ ],
+ 'DescribeNamespaces' => [
+ 'path' => '/diamond-ops/pop/namespace/list',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Namespaces' => [
+ 'description' => 'The list of namespaces.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The namespace type. Valid values:'."\n"
+ .'- 1: default namespace'."\n"
+ .'- 2: custom namespace.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Quota' => ['description' => 'The maximum number of configurations.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'NamespaceId' => ['description' => 'The namespace ID.', 'type' => 'string', 'example' => '3115d2bf-1f44-47bf-a855-****', 'title' => ''],
+ 'ConfigCount' => ['description' => 'The number of configurations.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'NamespaceName' => ['description' => 'The namespace name.', 'type' => 'string', 'example' => '测试环境', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The response description.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3116581E-C664-4D3A-A055-****', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"611CC94A-7711-4873-8848-****\\",\\n \\"Configuration\\": {\\n \\"Type\\": \\"text\\",\\n \\"AppName\\": \\"app\\",\\n \\"Tags\\": \\"tag1,tag2\\",\\n \\"Md5\\": \\"18d2e20****\\",\\n \\"DataId\\": \\"com.aliyun.acm.example\\",\\n \\"Content\\": \\"Hello World\\",\\n \\"Group\\": \\"DEFAULT_GROUP\\",\\n \\"Desc\\": \\"测试配置\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3116581E-C664-4D3A-A055-****</RequestId>\\n<Message>Success</Message>\\n<Configuration>\\n <Group>DEFAULT_GROUP</Group>\\n <Desc>测试配置</Desc>\\n <DataId>com.aliyun.acm.example</DataId>\\n <Content>Hello World</Content>\\n <Type>text</Type>\\n <Md5>078b****</Md5>\\n <AppName>app</AppName>\\n</Configuration>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => 'DescribeConfiguration',
+ 'errorCodes' => [
+ 401 => [
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Namespaces\\": [\\n {\\n \\"Type\\": 1,\\n \\"Quota\\": 200,\\n \\"NamespaceId\\": \\"3115d2bf-1f44-47bf-a855-****\\",\\n \\"ConfigCount\\": 20,\\n \\"NamespaceName\\": \\"测试环境\\"\\n }\\n ],\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"3116581E-C664-4D3A-A055-****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve namespace list',
+ 'summary' => 'Uses DescribeNamespaces to retrieve a list of namespaces.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNamespaces'],
+ ],
+ ],
],
- 'CheckConfigurationClone' => [
- 'path' => '/diamond-ops/pop/batch/checkForClone',
- 'methods' => [
- 'post',
+ 'DescribeNamespacesWithCreate' => [
+ 'path' => '/diamond-ops/pop/namespace/listWithCreate',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Namespaces' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'Quota' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'NamespaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ConfigCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'NamespaceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [
+ 401 => [
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
+ ],
+ ],
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Namespaces\\": [\\n {\\n \\"Type\\": 0,\\n \\"Quota\\": 0,\\n \\"NamespaceId\\": \\"\\",\\n \\"ConfigCount\\": 0,\\n \\"NamespaceName\\": \\"\\"\\n }\\n ],\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '',
+ 'summary' => '',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNamespacesWithCreate'],
+ ],
],
+ ],
+ 'DescribeTraceByConfiguration' => [
+ 'path' => '/diamond-ops/pop/trace/getByConfiguration',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1693,45 +1154,32 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Policy',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'DataId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
- 'name' => 'NamespaceFrom',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'Group',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
- 'name' => 'NamespaceTo',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'NamespaceId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
- 'name' => 'Data',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'StartTs',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'EndTs',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -1739,92 +1187,109 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Result' => [
- 'type' => 'object',
- 'properties' => [
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'SuccessItems' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'DataId' => [
- 'type' => 'string',
- ],
- 'Group' => [
- 'type' => 'string',
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Traces' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Timestamp' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'EventGroups' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EventType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EventDetails' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Delay' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Ts' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ResponseIp' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Event' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Ext' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DataId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestIp' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LogDate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'HandleIp' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Group' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
],
],
- 'responseDemo' => null,
- ],
- 'CheckConfigurationExport' => [
- 'path' => '/diamond-ops/pop/batch/checkForExport',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Traces\\": [\\n {\\n \\"Timestamp\\": 0,\\n \\"EventGroups\\": [\\n {\\n \\"EventType\\": \\"\\",\\n \\"EventDetails\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Delay\\": \\"\\",\\n \\"Ts\\": \\"\\",\\n \\"ResponseIp\\": \\"\\",\\n \\"Event\\": \\"\\",\\n \\"Ext\\": \\"\\",\\n \\"DataId\\": \\"\\",\\n \\"RequestIp\\": \\"\\",\\n \\"LogDate\\": \\"\\",\\n \\"HandleIp\\": \\"\\",\\n \\"Group\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Code\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '',
+ 'summary' => '',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeTraceByConfiguration'],
+ ],
],
+ ],
+ 'UpdateNamespace' => [
+ 'path' => '/diamond-ops/pop/namespace',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NamespaceId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'The namespace ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '710b2fbe-0da3-4388-****', 'title' => ''],
],
[
- 'name' => 'Data',
+ 'name' => 'NamespaceName',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'The namespace name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试环境', 'title' => ''],
],
],
'responses' => [
@@ -1832,107 +1297,132 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Result' => [
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
+ 'Message' => ['description' => 'The response description.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51193061-ED0D-4EC6-B160-****', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 401 => [
- [
- 'errorCode' => 'ServiceDisabled',
- 'errorMessage' => 'You have not activated the ACM service.',
- ],
+ 400 => [
+ ['errorCode' => 'NamespaceNameInvalid', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The specified name of the namespace is invalid.'],
+ ],
+ [
+ ['errorCode' => 'ServiceDisabled', 'errorMessage' => 'You have not activated the ACM service.', 'description' => 'You have not activated the ACM service.'],
+ ],
+ 403 => [
+ ['errorCode' => 'NamespacePermissionDenied', 'errorMessage' => 'You are not authorized to operate the namespace.', 'description' => 'You are not authorized to operate the namespace.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"51193061-ED0D-4EC6-B160-****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Update a namespace',
+ 'summary' => 'Updates a namespace.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateNamespace'],
],
],
- 'responseDemo' => null,
],
],
'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.ap-northeast-1.aliyuncs.com', 'endpoint' => 'acm.ap-northeast-1.aliyuncs.com', 'vpc' => 'acm-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.ap-southeast-1.aliyuncs.com', 'endpoint' => 'acm.ap-southeast-1.aliyuncs.com', 'vpc' => 'acm-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.ap-southeast-2.aliyuncs.com', 'endpoint' => 'acm.ap-southeast-2.aliyuncs.com', 'vpc' => 'acm-vpc.ap-southeast-2.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.cn-beijing.aliyuncs.com', 'endpoint' => 'acm.cn-beijing.aliyuncs.com', 'vpc' => 'acm-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.cn-hangzhou.aliyuncs.com', 'endpoint' => 'acm.cn-hangzhou.aliyuncs.com', 'vpc' => 'acm-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.cn-hongkong.aliyuncs.com', 'endpoint' => 'acm.cn-hongkong.aliyuncs.com', 'vpc' => 'acm-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.cn-qingdao.aliyuncs.com', 'endpoint' => 'acm.cn-qingdao.aliyuncs.com', 'vpc' => 'acm-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.cn-shanghai.aliyuncs.com', 'endpoint' => 'acm.cn-shanghai.aliyuncs.com', 'vpc' => 'acm-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.cn-shenzhen.aliyuncs.com', 'endpoint' => 'acm.cn-shenzhen.aliyuncs.com', 'vpc' => 'acm-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'acm.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'acm.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'acm-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'acm.us-west-1.aliyuncs.com', 'endpoint' => 'acm.us-west-1.aliyuncs.com', 'vpc' => 'acm-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'acm.us-east-1.aliyuncs.com', 'endpoint' => 'acm.us-east-1.aliyuncs.com', 'vpc' => 'acm-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'acm.eu-central-1.aliyuncs.com', 'endpoint' => 'acm.eu-central-1.aliyuncs.com', 'vpc' => 'acm-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'acm.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'acm.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'acm-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'acm.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'acm.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'acm-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'acm.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'acm.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'acm-vpc.cn-north-2-gov-1.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'acm.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'acm.cn-hangzhou-finance.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'BatchDeleteFail', 'message' => 'Failed to perform the batch delete operation.', 'http_code' => 500, 'description' => 'Failed to perform the batch delete operation.'],
+ ['code' => 'ConfigurationAlreadyExists', 'message' => 'The configuration item already exists.', 'http_code' => 500, 'description' => 'The configuration item already exists.'],
+ ['code' => 'ConfigurationBetaNotExists', 'message' => 'The configuration item does not exist in the Beta release.', 'http_code' => 404, 'description' => 'The configuration item does not exist in the Beta release.'],
+ ['code' => 'ConfigurationBetaStopFail', 'message' => 'Failed to stop the Beta release.', 'http_code' => 500, 'description' => 'Failed to stop the Beta release.'],
+ ['code' => 'ConfigurationDeleteFail', 'message' => 'Failed to delete the configuration item.', 'http_code' => 500, 'description' => 'Failed to delete the configuration item.'],
+ ['code' => 'ConfigurationDeployFail', 'message' => 'Failed to publish the configuration item.', 'http_code' => 500, 'description' => 'Failed to publish the configuration item.'],
+ ['code' => 'ConfigurationNotExists', 'message' => 'The configuration item does not exist.', 'http_code' => 404, 'description' => 'The configuration does not exist.'],
+ ['code' => 'ConfigurationQuotaOrSizeExceed', 'message' => 'The maximum number of configuration items or the maximum length of the configuration item is exceeded.', 'http_code' => 500, 'description' => 'The maximum number of configuration items or the maximum length of the configuration item is exceeded.'],
+ ['code' => 'ConfigurationSearchFail', 'message' => 'Failed to query the configuration item.', 'http_code' => 500, 'description' => 'Failed to query the configuration item.'],
+ ['code' => 'ConfigurationSizeExceed', 'message' => 'The maximum length of the configuration item is exceeded.', 'http_code' => 500, 'description' => 'The maximum length of the configuration item is exceeded.'],
+ ['code' => 'InvalidArgument', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'],
+ ['code' => 'InvalidParameter.Format', 'message' => 'The specified parameter is incorrectly formatted. The correct format includes XML and JSON. The default format is XML.', 'http_code' => 400, 'description' => 'The specified parameter is incorrectly formatted. The correct format includes XML and JSON. The default format is XML.'],
+ ['code' => 'NamespaceInUsage', 'message' => 'The specified namespace is being used.', 'http_code' => 500, 'description' => 'The specified namespace is being used.'],
+ ['code' => 'NamespaceNameInvalid', 'message' => 'The specified namespace is invalid.', 'http_code' => 400, 'description' => 'The specified name of the namespace is invalid.'],
+ ['code' => 'NamespaceNotExists', 'message' => 'The specified namespace does not exist.', 'http_code' => 404, 'description' => 'The specified namespace does not exist.'],
+ ['code' => 'NamespacePermissionDenied', 'message' => 'You are not authorized to operate the namespace.', 'http_code' => 403, 'description' => 'You are not authorized to operate the namespace.'],
+ ['code' => 'NamespaceQuotaExceed', 'message' => 'The maximum number of namespaces is exceeded.', 'http_code' => 500, 'description' => 'The maximum number of namespaces is exceeded.'],
+ ['code' => 'OperationInRisk', 'message' => 'Your operation has been suspended due to risk control. Please complete the operation on the console.', 'http_code' => 403, 'description' => 'Your operation has been suspended due to risk control. Please complete the operation on the console.'],
+ ['code' => 'PermissionDenied', 'message' => 'You are not authorized to operate on the specified resources.', 'http_code' => 403, 'description' => 'You are not authorized to operate on the specified resources.'],
+ ['code' => 'ResourceNotExists', 'message' => 'The specified resource does not exist.', 'http_code' => 404, 'description' => 'The specified resource does not exist.'],
+ ['code' => 'ServerError', 'message' => 'A server error occurred.', 'http_code' => 500, 'description' => 'A server error occurred.'],
+ ['code' => 'ServiceDisabled', 'message' => 'You have not activated the ACM service.', 'http_code' => 401, 'description' => 'You have not activated the ACM service.'],
+ ['code' => 'SignatureMismatched', 'message' => 'Failed to verify signature.', 'http_code' => 401, 'description' => 'Failed to verify signature.'],
+ ['code' => 'StsTokenInvalid', 'message' => 'The STS token is invalid.', 'http_code' => 401, 'description' => 'The STS token is invalid.'],
+ ['code' => 'UnknownError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => 'An error occurred while processing your request.'],
+ ['code' => 'UserTypeInvalid', 'message' => 'The specified user type is invalid.', 'http_code' => 401, 'description' => 'The specified user type is invalid.'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'acm.cn-qingdao.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'acm.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'acm.cn-zhangjiakou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'acm.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'acm.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'acm.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'acm.cn-hongkong.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'acm.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'acm.ap-southeast-2.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'acm.us-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'acm.us-east-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'acm.eu-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'acm.cn-hangzhou-finance.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'acm.cn-shanghai-finance-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'acm.cn-shenzhen-finance-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'DescribeConfiguration'],
+ ],
+ 'createdAt' => '2024-06-25T07:46:59.000Z',
+ 'description' => '',
],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'acm.cn-north-2-gov-1.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNamespace'],
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateNamespace'],
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckConfigurationExport'],
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNamespace'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloneConfiguration'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateConfiguration'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteConfiguration'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchExportConfigurations'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchImportConfigurations'],
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeConfiguration'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImportFileUrl'],
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckConfigurationClone'],
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNamespacesWithCreate'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNamespaces'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeployConfiguration'],
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeTraceByConfiguration'],
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNamespace'],
],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'acm.ap-northeast-1.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'ACM',
+ 'productName' => 'Application Configuration Management',
+ 'ramCodes' => ['acms'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [],
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'ConfigAcm', 'arn' => 'acs:acms:{#regionId}:{#accountId}:cfg/{#NamespaceId}/{#Group}/{#DataId}'],
+ ['validationType' => 'always', 'resourceType' => 'Configuration', 'arn' => 'acs:acms:{#regionId}:{#accountId}:cfg/{#NamespaceId}/{#Group}/{#DataId}'],
+ ['validationType' => 'always', 'resourceType' => 'ConfigAcm', 'arn' => 'acs:acms:{#regionId}:{#accountId}:cfg/*/*/*'],
+ ['validationType' => 'always', 'resourceType' => 'ConfigAcm', 'arn' => 'acs:acms:{#regionId}:{#accountId}:cfg/{#NamespaceId}/*/*'],
+ ['validationType' => 'always', 'resourceType' => 'Configuration', 'arn' => 'acs:acms:{#regionId}:{#accountId}:cfg/{#NamespaceId}/*/*'],
],
],
];