summaryrefslogtreecommitdiff
path: root/data/en_us/cas/2020-04-07
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/cas/2020-04-07
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/cas/2020-04-07')
-rw-r--r--data/en_us/cas/2020-04-07/api-docs.php13154
1 files changed, 6627 insertions, 6527 deletions
diff --git a/data/en_us/cas/2020-04-07/api-docs.php b/data/en_us/cas/2020-04-07/api-docs.php
index a4e6938..520db25 100644
--- a/data/en_us/cas/2020-04-07/api-docs.php
+++ b/data/en_us/cas/2020-04-07/api-docs.php
@@ -1,420 +1,441 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'cas',
- 'version' => '2020-04-07',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'cas', 'version' => '2020-04-07'],
'directories' => [
[
- 'id' => 390690,
- 'title' => null,
+ 'children' => ['ListInstances', 'UpdateInstance', 'GetInstanceDetail', 'DeleteInstance', 'RefundInstance', 'GetInstanceSummary', 'ApplyCertificate', 'GetTaskAttribute', 'CancelPendingCertificate', 'ListCertificates', 'RevokeCertificate', 'GetCertificateDetail', 'GetUserCertificateDetail', 'DeleteUserCertificate', 'UploadUserCertificate'],
'type' => 'directory',
- 'children' => [
- 'ListInstances',
- 'UpdateInstance',
- 'GetInstanceDetail',
- 'DeleteInstance',
- 'RefundInstance',
- 'GetInstanceSummary',
- 'ApplyCertificate',
- 'GetTaskAttribute',
- 'CancelPendingCertificate',
- 'ListCertificates',
- 'GetCertificateDetail',
- 'RevokeCertificate',
- 'DeleteUserCertificate',
- ],
+ 'title' => 'Subscription instances',
],
[
- 'id' => 390704,
- 'title' => null,
+ 'children' => ['ListContact'],
'type' => 'directory',
- 'children' => [
- 'MoveResourceGroup',
- ],
+ 'title' => 'Certificate contacts.',
],
[
- 'id' => 390706,
- 'title' => null,
+ 'children' => ['MoveResourceGroup'],
'type' => 'directory',
- 'children' => [
- 'CreateDeploymentJob',
- 'UpdateDeploymentJobStatus',
- 'ListDeploymentJob',
- 'UpdateDeploymentJob',
- 'DescribeDeploymentJob',
- 'ListWorkerResource',
- 'DescribeDeploymentJobStatus',
- 'ListDeploymentJobResource',
- 'ListContact',
- 'ListDeploymentJobCert',
- 'UpdateWorkerResourceStatus',
- 'DeleteWorkerResource',
- 'DeleteDeploymentJob',
- 'DescribeCloudResourceStatus',
- 'ListCloudResources',
- 'ListCloudAccess',
- ],
+ 'title' => 'Resource groups',
],
[
- 'id' => 390723,
- 'title' => null,
+ 'children' => ['CreateDeploymentJob', 'UpdateDeploymentJobStatus', 'ListDeploymentJob', 'UpdateDeploymentJob', 'DescribeDeploymentJob', 'ListWorkerResource', 'DescribeDeploymentJobStatus', 'ListDeploymentJobResource', 'ListDeploymentJobCert', 'UpdateWorkerResourceStatus', 'DeleteWorkerResource', 'DeleteDeploymentJob', 'DescribeCloudResourceStatus', 'ListCloudResources', 'ListCloudAccess'],
'type' => 'directory',
- 'children' => [
- 'DescribeCertificateState',
- 'CreateCertificateWithCsrRequest',
- 'CreateCertificateRequest',
- 'DeleteCertificateRequest',
- 'UploadUserCertificate',
- 'GetUserCertificateDetail',
- ],
+ 'title' => 'Deployment tasks',
],
[
- 'id' => 390730,
- 'title' => null,
+ 'children' => ['GetCertWarehouseQuota', 'ListCertWarehouse', 'ListCert', 'Sign', 'Verify', 'Encrypt', 'Decrypt', 'UploadPCACert', 'DeletePCACert', 'CreateWHClientCertificate', 'RevokeWHClientCertificate'],
'type' => 'directory',
- 'children' => [
- 'DescribePackageState',
- 'ListUserCertificateOrder',
- 'CreateCertificateForPackageRequest',
- 'CancelCertificateForPackageRequest',
- 'CancelOrderRequest',
- 'RenewCertificateOrderForPackageRequest',
- ],
+ 'title' => 'Certificate repository',
],
[
- 'id' => 390737,
- 'title' => null,
+ 'children' => ['ListCsr', 'CreateCsr', 'UploadCsr', 'GetCsrDetail', 'UpdateCsr', 'DeleteCsr'],
'type' => 'directory',
- 'children' => [
- 'GetCertWarehouseQuota',
- 'ListCertWarehouse',
- 'ListCert',
- 'Sign',
- 'Verify',
- 'Encrypt',
- 'Decrypt',
- 'DeletePCACert',
- ],
+ 'title' => 'CSR management',
],
[
- 'id' => 390749,
- 'title' => null,
+ 'children' => ['DescribePackageState', 'ListUserCertificateOrder', 'CreateCertificateForPackageRequest', 'CancelCertificateForPackageRequest', 'CancelOrderRequest', 'RenewCertificateOrderForPackageRequest'],
'type' => 'directory',
- 'children' => [
- 'ListCsr',
- 'CreateCsr',
- 'UploadCsr',
- 'GetCsrDetail',
- 'UpdateCsr',
- 'DeleteCsr',
- ],
+ 'title' => 'Orders (V1.0)',
+ ],
+ [
+ 'children' => ['DescribeCertificateState', 'CreateCertificateWithCsrRequest', 'CreateCertificateRequest', 'DeleteCertificateRequest'],
+ 'type' => 'directory',
+ 'title' => 'Certificate requests (V1.0)',
+ ],
+ [
+ 'children' => ['AddCloudAccess', 'CreateWarehouse', 'DeleteCloudAccess', 'DeleteWarehouse', 'DescribeWarehouseCert', 'GetAssetCount', 'GetRiskCount', 'ListAssetCount', 'ListWarehouse', 'BatchUpdateNoticeStatus', 'GetMatchedResources'],
+ 'type' => 'directory',
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'ListInstances' => [
- 'summary' => '获取实例列表',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AddCloudAccess' => [
+ 'summary' => 'Adds an AccessKey for authorization.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214629',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => true,
+ 'abilityTreeCode' => '214630',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Keyword',
+ 'name' => 'CloudName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The cloud service provider. This API supports multiple providers as detailed in the SecretKey parameter description. For example, to add credentials for Tencent Cloud, set this parameter to **Tencent**.', 'type' => 'string', 'required' => false, 'example' => 'Tencent', 'title' => ''],
],
[
- 'name' => 'Status',
+ 'name' => 'SecretId',
'in' => 'query',
+ 'schema' => ['description' => 'The Secret ID for accessing the cloud resource set.', 'type' => 'string', 'required' => false, 'example' => 'xcxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'SecretKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The secret corresponding to the AccessKey. The value is determined by the `AkType` parameter as follows:'."\n"
+ ."\n"
+ .'1\\. If `AkType` is set to `primary`:'."\n"
+ ."\n"
+ .'- **Tencent**: The SecretAccessKey of the primary account.'."\n"
+ ."\n"
+ .'- **HUAWEI CLOUD**: The SecretAccessKey of the primary account.'."\n"
+ ."\n"
+ .'- **Azure**: The ClientSecret.'."\n"
+ ."\n"
+ .'- **AWS**: The SecretAccessKey of the primary account.'."\n"
+ ."\n"
+ .'2\\. If `AkType` is set to `sub`:'."\n"
+ ."\n"
+ .'- **Tencent**: The SecretAccessKey of the sub-account.'."\n"
+ ."\n"
+ .'- **HUAWEI CLOUD**: The SecretAccessKey of the sub-account.'."\n"
+ ."\n"
+ .'- **Azure**: The ClientSecret.'."\n"
+ ."\n"
+ .'- **AWS**: The SecretAccessKey of the sub-account.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inactive',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '285BBE08-F12B-5A04-97BC-09EA7FF18646'],
+ ],
+ 'title' => '',
+ 'description' => 'Response schema',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'AddCloudAccess',
+ 'description' => 'The single-user QPS limit for this API is 100 queries per second (QPS). Calls that exceed this limit are throttled, which can affect your business operations. Call this API at a reasonable rate to avoid throttling.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:AddCloudAccess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"285BBE08-F12B-5A04-97BC-09EA7FF18646\\"\\n}","type":"json"}]',
+ ],
+ 'ApplyCertificate' => [
+ 'summary' => 'Submits a certificate application for a Certificate Management Service instance.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Brand',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '213377',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the instance. Before you request a certificate, call the UpdateInstance operation to update and complete the application information for the instance.', 'type' => 'string', 'required' => true, 'example' => 'cas_dv-cn-rp643r82d0i1', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Digicert',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'ApplyCertificate',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ApplyCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
+ ],
+ 'BatchUpdateNoticeStatus' => [
+ 'summary' => 'Updates the notification status in batches',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'CertificateType',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '179499',
+ 'abilityTreeNodes' => ['FEATUREcasNI0F3L'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SourceIp',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DV',
- ],
+ 'schema' => ['description' => 'The source IP address of the request.', 'type' => 'string', 'required' => false, 'example' => '47.98.242.200', 'title' => ''],
],
[
- 'name' => 'CertificateStatus',
+ 'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'issued',
- ],
+ 'schema' => ['description' => 'The language type for the request and the received message. Valid values:'."\n"
+ ."\n"
+ .'- **zh**: Chinese'."\n"
+ ."\n"
+ .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
- 'name' => 'InstanceType',
+ 'name' => 'Ids',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BUY',
- ],
+ 'schema' => ['description' => 'The list of primary key identifiers to be synchronized to Certificate Management Service. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '888', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'NoticeStatus',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-ae******4wia',
- ],
+ 'schema' => ['description' => 'Specifies whether to enable message notification.'."\n"
+ .'\\--enable: enables message notification.'."\n"
+ .'\\--disable: disables message notification.', 'type' => 'string', 'required' => true, 'example' => 'disable', 'title' => ''],
],
[
- 'name' => 'ShowSize',
+ 'name' => 'NoticeBiz',
'in' => 'query',
+ 'schema' => ['description' => 'The business code of message notification. The value is fixed as ssl.', 'type' => 'string', 'required' => false, 'example' => 'ssl', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The ID of the request, which is the unique identifier generated by Alibaba Cloud for the request. The ID can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '3F60357E-76D2-52AD-B3EB-D86276755814', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Updates the status of message notification',
+ 'description' => 'After a CA certificate is created, it is in the normal issuance state by default. You can call this operation to change the status of a CA certificate from normal issuance to revoked. In the normal issuance state, the CA certificate can be used to issue certificates. In the revoked state, the CA certificate cannot be used to issue certificates, and the certificates that have been issued by the CA certificate also become invalid accordingly.'."\n"
+ ."\n"
+ .'Before you call this operation, you must have called [CreateRootCACertificate](~~465962~~) to create a root CA certificate and called [CreateSubCACertificate](~~465959~~) to create a sub CA certificate.'."\n"
+ ."\n"
+ .'## QPS limit'."\n"
+ ."\n"
+ .'The QPS limit per user for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation properly.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:BatchUpdateNoticeStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F60357E-76D2-52AD-B3EB-D86276755814\\"\\n}","type":"json"}]',
+ ],
+ 'CancelCertificateForPackageRequest' => [
+ 'summary' => 'Revokes an issued certificate or cancels a pending certificate order and restores the quota.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CurrentPage',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '81667',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The ID of the order.'."\n"
+ ."\n"
+ .'> Call [ListUserCertificateOrder](~~455804~~) to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12345678-1234-1234-1234-123456789ABC',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'ShowSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'CurrentPage' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'InstanceList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cas_dv-cn-123',
- ],
- 'KeyAlgorithm' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'RSA_2048',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'inactive',
- ],
- 'Domain' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test.com',
- ],
- 'Spec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ss.dv.t',
- ],
- 'CertificateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '18541349',
- ],
- 'CertificateName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cert-13216408',
- ],
- 'CertIdentifier' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '21795675-cn-hangzhou',
- ],
- 'Brand' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DigiCert',
- ],
- 'CertificateType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DV',
- ],
- 'CertificateStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'issued',
- ],
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BUY',
- ],
- 'OrderStartTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'CertificateRevokeTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'OrderEndTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'InstanceStartTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'InstanceEndTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'CertificateNotAfter' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'AutoReissue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'enable',
- ],
- 'FullDomainCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'WildcardDomainCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'PendingResult' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'pending',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The unique ID of the request. Alibaba Cloud generates this ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\",\\n \\"TotalCount\\": 12,\\n \\"ShowSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"InstanceList\\": [\\n {\\n \\"InstanceId\\": \\"cas_dv-cn-123\\",\\n \\"KeyAlgorithm\\": \\"RSA_2048\\",\\n \\"Status\\": \\"inactive\\",\\n \\"Domain\\": \\"test.com\\",\\n \\"Spec\\": \\"ss.dv.t\\",\\n \\"CertificateId\\": 18541349,\\n \\"CertificateName\\": \\"cert-13216408\\",\\n \\"CertIdentifier\\": \\"21795675-cn-hangzhou\\",\\n \\"Brand\\": \\"DigiCert\\",\\n \\"CertificateType\\": \\"DV\\",\\n \\"CertificateStatus\\": \\"issued\\",\\n \\"InstanceType\\": \\"BUY\\",\\n \\"OrderStartTime\\": 1801324800000,\\n \\"CertificateRevokeTime\\": 1801324800000,\\n \\"OrderEndTime\\": 1801324800000,\\n \\"InstanceStartTime\\": 1801324800000,\\n \\"InstanceEndTime\\": 1801324800000,\\n \\"CertificateNotAfter\\": 1801324800000,\\n \\"AutoReissue\\": \\"enable\\",\\n \\"FullDomainCount\\": 1,\\n \\"WildcardDomainCount\\": 0,\\n \\"PendingResult\\": \\"pending\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'CancelCertificateForPackageRequest',
+ 'description' => 'This API has a limit of 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled. This can affect your business. Call the API at a reasonable rate.',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-23T08:22:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CancelCertificateForPackageRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","type":"json"}]',
],
- 'UpdateInstance' => [
- 'summary' => '更新实例',
- 'methods' => [
- 'post',
+ 'CancelOrderRequest' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '81668',
+ 'abilityTreeNodes' => ['FEATUREcasP4AIN0'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the certificate order to cancel.'."\n"
+ ."\n"
+ .'> Obtain this ID by calling [ListUserCertificateOrder](~~455804~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123451222', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot and locate problems.', 'type' => 'string', 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
+ 'title' => 'CancelOrderRequest',
+ 'summary' => 'Cancels a certificate application order that is pending domain verification or under review.',
+ 'description' => 'This API is limited to 100 queries per second (QPS) for each user. API calls that exceed this limit are throttled. Because this can impact your business, you should call this API at a reasonable rate.',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-23T08:22:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CancelOrderRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]',
+ ],
+ 'CancelPendingCertificate' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -427,9 +448,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '213377',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'autoTest' => false,
'tenantRelevance' => 'tenant',
],
@@ -437,195 +456,351 @@
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cas_dv-cn-rp643r82d0i1', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789ABC', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cas-cn-68n1mm16****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Revoke a certificate application',
+ 'summary' => 'Revokes a certificate application.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CancelPendingCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\"\\n}","type":"json"}]',
+ ],
+ 'CreateCertificateForPackageRequest' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '81669',
+ 'abilityTreeNodes' => ['FEATUREcasP4AIN0'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ ],
+ 'parameters' => [
[
- 'name' => 'CertificateName',
+ 'name' => 'Csr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'schema' => ['description' => 'The content of the certificate signing request (CSR) file that is manually generated by using OpenSSL or Keytool for the domain name. The key algorithm in the CSR file must be Rivest-Shamir-Adleman (RSA) or elliptic-curve cryptography (ECC), and the key length of the RSA algorithm must be greater than or equal to 2,048 characters. For more information about how to create a CSR file, see [Create a CSR file](~~313297~~). If you do not specify this parameter, Certificate Management Service automatically creates a CSR file.'."\n"
+ ."\n"
+ .'A CSR file contains the information about your server and company. When you apply for a certificate, you must submit the CSR file to the CA. The CA signs the CSR file by using the private key of the root certificate and generates a public key file to issue your certificate.'."\n"
+ ."\n"
+ .'> The \\*\\*CN\\*\\* field in CSR file specifies the domain name that is bound to the certificate. You must include the field in the parameter value.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', 'title' => ''],
],
[
- 'name' => 'Domain',
+ 'name' => 'ProductCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test.com',
- ],
+ 'schema' => ['description' => 'The specifications of the certificate that you want to apply for. Valid values:'."\n"
+ ."\n"
+ .'- **digicert-free-1-free** (default): DigiCert single-domain domain validated (DV) certificate, which is free and valid for 3 months. This value is available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **symantec-free-1-free**: DigiCert single-domain DV certificate, which is free and valid for 1 year. This value is available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **symantec-ov-1-personal**: DigiCert single-domain organization validated (OV) certificate.'."\n"
+ ."\n"
+ .'- **symantec-ov-w-personal**: DigiCert wildcard OV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-ov-1-personal**: GeoTrust single-domain OV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-ov-w-personal**: GeoTrust wildcard OV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-ov-1-personal**: GlobalSign single-domain OV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-ov-w-advanced**: GlobalSign wildcard OV certificate.'."\n"
+ ."\n"
+ .'- **cfca-ov-1-personal**: China Financial Certification Authority (CFCA) single-domain OV certificate, available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **cfca-ev-w-advanced**: CFCA wildcard OV certificate, available only on the China site (aliyun.com).', 'type' => 'string', 'required' => false, 'example' => 'digicert-free-1-free', 'title' => ''],
],
[
- 'name' => 'KeyAlgorithm',
+ 'name' => 'Username',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RSA_2048',
- ],
+ 'schema' => ['description' => 'The name of the applicant.'."\n"
+ ."\n"
+ .'If you do not specify this parameter, the information about the most recent contact that is added to the **Information Management** module is used. For more information about how to add a contact to the **Information Management** module, see [Manage contacts](~~198262~~).', 'type' => 'string', 'required' => false, 'example' => 'Tom', 'title' => ''],
],
[
- 'name' => 'AutoReissue',
+ 'name' => 'Phone',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'enable',
- ],
+ 'schema' => ['description' => 'The contact phone number of the applicant. CA staff can call the phone number to confirm the information in your certificate application.'."\n"
+ ."\n"
+ .'If you do not specify this parameter, the information about the most recent contact that is added to the **Information Management** module is used. For more information about how to add a contact to the **Information Management** module, see [Manage contacts](~~198262~~).', 'type' => 'string', 'required' => false, 'example' => '1390000****', 'title' => ''],
],
[
- 'name' => 'CompanyId',
+ 'name' => 'Email',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '44211',
- ],
+ 'schema' => ['description' => 'The email address of the applicant. After the CA receives your certificate application, the CA sends a verification email to the email address that you specify. You must log on to the mailbox, open the mail, and complete the verification of the domain name ownership based on the steps that are described in the email.'."\n"
+ ."\n"
+ .'If you do not specify this parameter, the information about the most recent contact that is added to the **Information Management** module is used. For more information about how to add a contact to the **Information Management** module, see [Manage contacts](~~198262~~).', 'type' => 'string', 'required' => false, 'example' => 'username@example.com', 'title' => ''],
],
[
- 'name' => 'ContactIdList',
+ 'name' => 'Domain',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The domain name that you want to bind to the certificate. The domain name must meet the following requirements:'."\n"
+ ."\n"
+ .'- The domain name must be a single domain name or a wildcard domain name. Example: `*.aliyundoc.com`.'."\n"
+ ."\n"
+ .'- You can specify multiple domain names. Separate multiple domain names with commas (,). You can specify a maximum of five domain names.'."\n"
+ ."\n"
+ .'- If you specify multiple domain names, the domain names must be only single domain names or only wildcard domain names. You cannot specify both single domain names and wildcard domain names.'."\n"
+ ."\n"
+ .'> If you want to bind multiple domain names to the certificate, you must specify this parameter. You must specify at least one of the Domain parameter and the \\*\\*Csr\\*\\* parameter. If you specify both the Domain parameter and the \\*\\*Csr\\*\\* parameter, the value of the \\*\\*CN\\*\\* field in the \\*\\*Csr\\*\\* parameter is used as the domain name that is bound to the certificate.', 'type' => 'string', 'required' => false, 'example' => 'aliyundoc.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'CompanyName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The company name of the certificate application.'."\n"
+ ."\n"
+ .'> This parameter is available only when you apply for OV certificates. For more information, see [Manage company profiles](~~198289~~). If you want to apply for a DV certificate, you do not need to add a company profile.'."\n"
+ ."\n"
+ .'If you specify a company name, the information about the company that is configured in the **Information Management** module is used. If you do not specify this parameter, the information about the most recent company that is added to the **Information Management** module is used.', 'type' => 'string', 'required' => false, 'example' => '某公司', 'title' => ''],
+ ],
+ [
+ 'name' => 'ValidateType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The verification method of the domain name ownership. Valid values:'."\n"
+ ."\n"
+ .'- **DNS**: DNS verification. If you use this method, you must add a TXT record to the DNS records of the domain name in the management platform of the domain name. You must have operation permissions on domain name resolution to verify the ownership of the domain name.'."\n"
+ ."\n"
+ .'- **FILE**: file verification. If you use this method, you must create a specified file on the DNS server. You must have administrative rights on the DNS server to verify the ownership of the domain name.'."\n"
+ ."\n"
+ .'For more information about the verification methods, see [Verify the ownership of a domain name](~~48016~~).', 'type' => 'string', 'required' => false, 'example' => 'DNS', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tags',
'in' => 'query',
- 'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'A list of tags.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => 'The tags.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'runtime', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
'required' => false,
- 'example' => '123',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'maxItems' => 50,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'GenerateCsrMethod',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'online',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => 'The ID of the certificate application order.'."\n"
+ ."\n"
+ .'> You can use the ID to query the status of the certificate application order. For more information, see [DescribeCertificateState](~~164111~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '2021010', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '5890029B-938A-589E-98B9-3DEC7BA7C400', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'CreateCertificateForPackageRequest',
+ 'summary' => 'Submits a certificate application by using a purchased certificate package quota.',
+ 'description' => '- Before you call this operation, make sure that you have purchased a certificate resource plan of the required specifications. For more information about how to purchase a certificate resource plan, see [Purchase a certificate resource plan](~~28542~~). You can call the [DescribePackageState](~~455800~~) operation to query the usage of a certificate resource plan of specified specifications, including the total number of certificate resource plans that you purchase, the number of certificate applications that you submit, and the number of certificates that are issued.'."\n"
+ ."\n"
+ .'- After you call this operation to submit a certificate application and the certificate is issued, the certificate quota provided by the resource plan that you purchased is consumed. When you call this operation, you can use the **ProductCode** parameter to specify the specifications of the certificate that you want to apply for.'."\n"
+ ."\n"
+ .'- After you call this operation to submit a certificate application, you also need to call the [DescribeCertificateState](~~455800~~) operation to obtain the information that is required for domain name ownership verification and manually complete the verification. Then, your certificate application is reviewed by the certificate authority (CA). If you use the Domain Name System (DNS) verification method, you must complete the verification on your DNS service provider system. If you use the file verification method, you must complete the verification on the DNS server.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-10T09:30:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-23T08:22:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateCertificateForPackageRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 2021010,\\n \\"RequestId\\": \\"5890029B-938A-589E-98B9-3DEC7BA7C400\\"\\n}","type":"json"}]',
+ ],
+ 'CreateCertificateRequest' => [
+ 'summary' => 'Purchases, applies for, and issues a domain validated (DV) certificate by using extended certificate services.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Csr',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProductCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----',
- ],
+ 'schema' => ['description' => 'The specifications of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **digicert-free-1-free** (default): DigiCert single-domain DV certificate, which is free and valid for 3 months.'."\n"
+ ."\n"
+ .'- **symantec-free-1-free**: DigiCert single-domain DV certificate, which is free and valid for 1 year. This value is available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.', 'type' => 'string', 'required' => false, 'example' => 'symantec-dv-1-starter', 'title' => ''],
],
[
- 'name' => 'ValidationMethod',
+ 'name' => 'Username',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DNS',
- ],
+ 'schema' => ['description' => 'The name of the applicant.', 'type' => 'string', 'required' => true, 'example' => 'Tom', 'title' => ''],
],
[
- 'name' => 'City',
+ 'name' => 'Phone',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Beijing',
- ],
+ 'schema' => ['description' => 'The phone number of the applicant.', 'type' => 'string', 'required' => true, 'example' => '1390000****', 'title' => ''],
],
[
- 'name' => 'Province',
+ 'name' => 'Email',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Beijing',
- ],
+ 'schema' => ['description' => 'The contact email address of the applicant.', 'type' => 'string', 'required' => true, 'example' => 'username@example.com', 'title' => ''],
],
[
- 'name' => 'CountryCode',
+ 'name' => 'Domain',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CN',
- ],
+ 'schema' => ['description' => 'The domain name that you want to bind to the certificate. You can specify only one domain name.'."\n"
+ ."\n"
+ .'> The domain name must match the certificate specifications that you specify for the **ProductCode** parameter. If you apply for a single-domain certificate, you must specify a single domain name for this parameter. If you apply for a wildcard certificate, you must specify a wildcard domain name such as `*.aliyundoc.com` for this parameter.', 'type' => 'string', 'required' => true, 'example' => 'www.aliyundoc.com', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'ValidateType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-ae******4wia',
- ],
+ 'schema' => ['description' => 'The method to verify the ownership of a domain name. Valid values:'."\n"
+ ."\n"
+ .'- **DNS**: DNS verification. If you use this method, you must add a TXT record to the DNS records of the domain name in the management platform of the domain name. You must have operation permissions on domain name resolution to verify the ownership of the domain name.'."\n"
+ ."\n"
+ .'- **FILE**: file verification. If you use this method, you must create a specified file on the DNS server. You must have administrative rights on the DNS server to verify the ownership of the domain name.'."\n"
+ ."\n"
+ .'For more information about the verification methods, see [Verify the ownership of a domain name](~~48016~~).', 'type' => 'string', 'required' => true, 'example' => 'DNS', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'A list of tags.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The tags.',
'type' => 'object',
'properties' => [
- 'TagKey' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'TagValue' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'Key' => ['description' => 'The tag key of the resource. You can specify up to 20 tag keys. You cannot specify empty strings as tag keys.'."\n"
+ ."\n"
+ .'The key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The key must start with a letter but cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`.'."\n"
+ ."\n"
+ .'> You must specify at least one of **Tag.N** (**Tag.N.Key** and **Tag.N.Value**).', 'type' => 'string', 'required' => false, 'example' => 'acs:rm:rgId', 'title' => ''],
+ 'Value' => ['description' => 'The tag value. You can specify up to 20 tag values. The tag value can be an empty string.'."\n"
+ ."\n"
+ .'The tag value cannot exceed 128 characters in length, and can contain digits, periods (.), underscores (\\_), and hyphens (-). The key must start with a letter but cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0068247C-A454-5FC9-93BF-C41CBB5CD19E',
- ],
+ 'OrderId' => ['description' => 'The ID of the certificate application order.'."\n"
+ ."\n"
+ .'> You can use the ID to query the status of the certificate application. For more information, see [DescribeCertificateState](~~164111~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '98987582437920968', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -633,343 +808,193 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0068247C-A454-5FC9-93BF-C41CBB5CD19E\\"\\n}","type":"json"}]',
- ],
- 'GetInstanceDetail' => [
- 'summary' => '查询实例详情',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'CreateCertificateRequest',
+ 'description' => '- You can call this operation to apply for only DV certificates. If you want to apply for an organization validated (OV) or extended validation (EV) certificate, we recommend that you call the [CreateCertificateForPackageRequest](~~455296~~) operation. This operation allows you to apply for certificates of all specifications and specify the method to generate a certificate signing request (CSR) file.'."\n"
+ ."\n"
+ .'- Before you call this operation, make sure that you have purchased a certificate resource plan of the required specifications. For more information about how to purchase a certificate resource plan, see [Purchase a certificate resource plan](~~28542~~). You can call the [DescribePackageState](~~455803~~) operation to query the usage of a certificate resource plan of specified specifications, including the total number of certificate resource plans that you purchase, the number of certificate applications that you submit, and the number of certificates that are issued.'."\n"
+ ."\n"
+ .'- When you call this operation, you can use the **ProductCode** parameter to specify the specifications of the certificate.'."\n"
+ ."\n"
+ .'- After you call this operation to submit a certificate application, Certificate Management Service automatically creates a CSR file for your application and consumes the certificate quota in the certificate resource plans of the specified specifications that you purchased. After you call this operation, you also need to call the [DescribeCertificateState](~~455800~~) operation to obtain the information that is required to complete domain name verification, and manually complete the verification. If you use the DNS verification method, you must complete the verification on the management platform of the domain name. If you use the file verification method, you must complete the verification on your DNS server. Then, the certificate authority (CA) will review your certificate application.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-10T09:30:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-23T08:22:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateCertificateRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 98987582437920960,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","type":"json"}]',
+ ],
+ 'CreateCertificateWithCsrRequest' => [
+ 'summary' => 'Purchases, applies for, and issues a domain validated (DV) certificate by using a custom certificate signing request (CSR) file.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213379',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '81671',
+ 'abilityTreeNodes' => ['FEATUREcasP4AIN0'],
'autoTest' => false,
- 'tenantRelevance' => 'tenant',
+ 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'Csr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of the CSR file.<br> The key algorithm in the CSR file must be Rivest-Shamir-Adleman (RSA) or elliptic-curve cryptography (ECC), and the key length of the RSA algorithm must be greater than or equal to 2,048 characters. For more information about how to create a CSR file, see [How do I create a CSR file?](~~42218~~)<br> A CSR file contains the information about your server and company. When you apply for a certificate, you must submit the CSR file to the CA. The CA signs the CSR file by using the private key of the root certificate and generates a public key file to issue your certificate.<br><br>'."\n"
+ ."\n"
+ .'> The **CN** field in the CSR file specifies the domain name that is bound to the certificate.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', 'title' => ''],
+ ],
+ [
+ 'name' => 'ProductCode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The specifications of the certificate that you want to apply for. Valid values:'."\n"
+ ."\n"
+ .'- **digicert-free-1-free** (default): DigiCert single-domain DV certificate in a three-month free trial, available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **symantec-free-1-free**: DigiCert single-domain DV certificate in a one-year free trial, available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.', 'type' => 'string', 'required' => false, 'example' => 'digicert-free-1-free', 'title' => ''],
+ ],
+ [
+ 'name' => 'Username',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the applicant.', 'type' => 'string', 'required' => true, 'example' => 'Tom', 'title' => ''],
+ ],
+ [
+ 'name' => 'Phone',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The phone number of the applicant.', 'type' => 'string', 'required' => true, 'example' => '1390000****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Email',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The contact email address of the applicant.', 'type' => 'string', 'required' => true, 'example' => 'username@example.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'ValidateType',
'in' => 'query',
+ 'schema' => ['description' => 'The method to verify the ownership of a domain name. Valid values:'."\n"
+ ."\n"
+ .'- **DNS**: DNS verification. If you use this method, you must add a TXT record to the DNS records of the domain name in the management platform of the domain name. You must have operation permissions on domain name resolution to verify the ownership of the domain name.'."\n"
+ ."\n"
+ .'- **FILE**: file verification. If you use this method, you must create a specified file on the DNS server. You must have administrative rights on the DNS server to verify the ownership of the domain name.'."\n"
+ ."\n"
+ .'For more information about the verification methods, see [Verify the ownership of a domain name](~~48016~~).', 'type' => 'string', 'required' => true, 'example' => 'DNS', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cas_dv-cn-123',
+ 'description' => 'A list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'database', 'title' => ''],
+ 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cas_dv-cn-123',
- ],
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TEST',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9',
- ],
- 'KeyAlgorithm' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'RSA_2048',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'inactive',
- ],
- 'Domain' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'example.com',
- ],
- 'CertificateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1234567890',
- ],
- 'CertificateName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'CertIdentifier' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '22783111-cn-hangzhou',
- ],
- 'Spec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ss.dv.t',
- ],
- 'CertificateType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DV',
- ],
- 'CertificateStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'issued',
- ],
- 'CertificateNotAfter' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'OrderEndTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'InstanceStartTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'InstanceEndTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'FullDomainCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'WildcardDomainCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'CompanyId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '47305',
- ],
- 'ContactIdList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- ],
- 'ResourceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rg-aek****wia',
- ],
- 'DomainValidationList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Domain' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'example.com',
- ],
- 'RootDomain' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'example.com',
- ],
- 'ValidationType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TXT',
- ],
- 'ValidationValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'ValidationKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '@',
- ],
- 'Cname' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123.com',
- ],
- ],
- ],
- ],
- 'City' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Beijing',
- ],
- 'Province' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Beijing',
- ],
- 'CountryCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CN',
- ],
- 'Csr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----',
- ],
- 'ValidationMethod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DNS',
- ],
- 'AverageWaitingTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '120',
- ],
- 'DingGroupList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'DingGroupInstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'DingGroupName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'DingGroupType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'remote',
- ],
- 'DingGroupUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://123.com',
- ],
- ],
- ],
- ],
- 'Tags' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TagKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'TagValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- ],
- 'GenerateCsrMethod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'online',
- ],
- 'AutoReissue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'enable',
- ],
- 'PendingResult' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'pending',
- ],
- 'CertificateRevokeTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
- 'Brand' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DigiCert',
- ],
- 'OrderStartTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1801324800000',
- ],
+ 'OrderId' => ['description' => 'The ID of the certificate application order.'."\n"
+ ."\n"
+ .'> You can use the ID to query the status of the certificate application. For more information, see [DescribeCertificateState](~~164111~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '98987582437920968', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"cas_dv-cn-123\\",\\n \\"InstanceType\\": \\"TEST\\",\\n \\"RequestId\\": \\"B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9\\",\\n \\"KeyAlgorithm\\": \\"RSA_2048\\",\\n \\"Status\\": \\"inactive\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"CertificateId\\": 1234567890,\\n \\"CertificateName\\": \\"123\\",\\n \\"CertIdentifier\\": \\"22783111-cn-hangzhou\\",\\n \\"Spec\\": \\"ss.dv.t\\",\\n \\"CertificateType\\": \\"DV\\",\\n \\"CertificateStatus\\": \\"issued\\",\\n \\"CertificateNotAfter\\": 1801324800000,\\n \\"OrderEndTime\\": 1801324800000,\\n \\"InstanceStartTime\\": 1801324800000,\\n \\"InstanceEndTime\\": 1801324800000,\\n \\"FullDomainCount\\": 1,\\n \\"WildcardDomainCount\\": 0,\\n \\"CompanyId\\": 47305,\\n \\"ContactIdList\\": [\\n 123\\n ],\\n \\"ResourceGroupId\\": \\"rg-aek****wia\\",\\n \\"DomainValidationList\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"RootDomain\\": \\"example.com\\",\\n \\"ValidationType\\": \\"TXT\\",\\n \\"ValidationValue\\": \\"123\\",\\n \\"ValidationKey\\": \\"@\\",\\n \\"Cname\\": \\"123.com\\"\\n }\\n ],\\n \\"City\\": \\"Beijing\\",\\n \\"Province\\": \\"Beijing\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"Csr\\": \\"-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----\\",\\n \\"ValidationMethod\\": \\"DNS\\",\\n \\"AverageWaitingTime\\": \\"120\\",\\n \\"DingGroupList\\": [\\n {\\n \\"DingGroupInstanceId\\": \\"123\\",\\n \\"DingGroupName\\": \\"123\\",\\n \\"DingGroupType\\": \\"remote\\",\\n \\"DingGroupUrl\\": \\"https://123.com\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"test\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"GenerateCsrMethod\\": \\"online\\",\\n \\"AutoReissue\\": \\"enable\\",\\n \\"PendingResult\\": \\"pending\\",\\n \\"CertificateRevokeTime\\": 1801324800000,\\n \\"Brand\\": \\"DigiCert\\",\\n \\"OrderStartTime\\": 1801324800000\\n}","type":"json"}]',
- ],
- 'DeleteInstance' => [
- 'summary' => '删除实例',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'CreateCertificateWithCsrRequest',
+ 'description' => '- You can use this operation to apply for only a domain validated (DV) certificate. You cannot use this operation to apply for an organization validated (OV) certificate. We recommend that you use the [CreateCertificateForPackageRequest](~~455296~~) operation to apply for a certificate. You can use the CreateCertificateForPackageRequest operation to apply for certificates of all types and specify the CSR generation method.'."\n"
+ ."\n"
+ .'- Before you call this operation, make sure that you have purchased a certificate resource plan of the required specifications. For more information about how to purchase a certificate resource plan, see [Purchase a certificate resource plan](~~28542~~). You can call the [DescribePackageState](~~455803~~) operation to query the usage of a certificate resource plan of specified specifications, including the total number of certificate resource plans that you purchase, the number of certificate applications that you submit, and the number of certificates that are issued.'."\n"
+ ."\n"
+ .'- When you call this operation, you can use the **ProductCode** parameter to specify the specifications of the certificate that you want to apply for.'."\n"
+ ."\n"
+ .'- After you call this operation to submit a certificate application, the certificate quota of the required specifications that you purchased is consumed. After you call this operation, you must call the [DescribeCertificateState](~~455800~~) operation to obtain the information that is required for domain name ownership verification and manually complete the verification. Then, your certificate application is reviewed by the certificate authority (CA). If you use the Domain Name System (DNS) verification method, you must complete the verification on your DNS service provider system. If you use the file verification method, you must complete the verification on the DNS server.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '|HTTP status code|Error code|Description|'."\n"
+ .'|---|---|---|'."\n"
+ .'|404|NotFoundPackage|The error message returned because no certificate resource plans were purchased.|'."\n"
+ .'|404|NotRemainCount|The error message returned because the certificate quota is insufficient.|'."\n"
+ .'|403|CreateCertificateRequestFailed|The error message returned because the request failed to be created.|'."\n"
+ .'|404|NotFoundOrder|The error message returned because the specified certificate order was not found.|'."\n"
+ .'|403|OrderStateError|The error message returned because the status of the certificate order is invalid.|'."\n"
+ .'|403|DeleteFail|The error message returned because the certificate application order failed to be deleted.|'."\n"
+ .'|500|Error|The error message returned because an error occurred.|',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-10T09:30:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-23T08:22:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateCertificateWithCsrRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 98987582437920960,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","type":"json"}]',
+ ],
+ 'CreateCsr' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -978,56 +1003,116 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213377',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'KeySize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The key length that is used by the algorithm.'."\n"
+ ."\n"
+ .'- The key length for RSA algorithms can be 2,048, 3,072, and 4,096 bits.'."\n"
+ ."\n"
+ .'- The key length for ECC and SM2 algorithms can be 256 bits.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2048', 'title' => ''],
+ ],
+ [
+ 'name' => 'Algorithm',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The algorithm. Valid values: RSA, SM2, and ECC. For more information about algorithms, see [Select an SSL certificate](~~197871~~).',
+ 'enumValueTitles' => ['RSA' => 'RSA', 'ECC' => 'ECC', 'SM2' => 'SM2'],
'type' => 'string',
'required' => true,
- 'example' => 'cas-cn-68n1mm16****',
+ 'example' => 'RSA',
+ 'title' => '',
],
],
+ [
+ 'name' => 'CommonName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The primary domain name, which is a common name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'Sans',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The secondary domain names. Separate multiple domain names with commas (,). You can use the CSR to apply for a certificate for both the primary and secondary domain names.', 'type' => 'string', 'required' => false, 'example' => 'www.aliyundoc.com,www.example.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'CountryCode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The code of the country or region in which the organization is located. For example, you can use CN to indicate China and use US to indicate the United States.', 'type' => 'string', 'required' => true, 'example' => 'CN', 'title' => ''],
+ ],
+ [
+ 'name' => 'Province',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The province or location where the company is located.', 'type' => 'string', 'required' => true, 'example' => 'Beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'Locality',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The city where the company is located.', 'type' => 'string', 'required' => true, 'example' => 'Beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'CorpName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the company.', 'type' => 'string', 'required' => false, 'example' => '北京CSR科技有效公司', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the CSR. The name can be up to 50 characters in length and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.).', 'type' => 'string', 'required' => false, 'example' => 'csr-123', 'title' => ''],
+ ],
+ [
+ 'name' => 'Department',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The department that uses the certificate.', 'type' => 'string', 'required' => false, 'example' => 'IT', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4BD0CBD9-FB03-5ECD-A8FD-F90C62D78095',
- ],
+ 'Csr' => ['description' => 'The content of the CSR.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789ABC', 'title' => ''],
+ 'CsrId' => ['description' => 'The unique identifier of the CSR. You can use this value to obtain the content of the CSR. For more information about the operation that you can call to obtain the content of a CSR, see [GetCsrDetail](~~2709720~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '3365', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BD0CBD9-FB03-5ECD-A8FD-F90C62D78095\\"\\n}","type":"json"}]',
- ],
- 'RefundInstance' => [
- 'summary' => '申请证书',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'CreateCsr',
+ 'summary' => 'Creates a certificate signing request (CSR) that contains information about an SSL certificate to apply for, such as the domain names and the certificate holder. You must provide a CSR when you submit a certificate application to a certificate authority (CA).',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Csr\\": \\"-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----\\",\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\",\\n \\"CsrId\\": 3365\\n}","type":"json"}]',
+ ],
+ 'CreateDeploymentJob' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1036,57 +1121,101 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213377',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '214600',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'autoTest' => false,
- 'tenantRelevance' => 'tenant',
+ 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the deployment task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'jobName'],
+ ],
+ [
+ 'name' => 'JobType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The type of the deployment task.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- cloud: multi-cloud deployment task.'."\n"
+ ."\n"
+ .'- user: cloud service deployment task. This type of task does not support cloud servers.',
+ 'enumValueTitles' => ['cloud' => 'cloud', 'user' => 'user'],
'type' => 'string',
'required' => true,
- 'example' => 'cas-ivauto-hqito6',
+ 'title' => '',
+ 'example' => 'user',
],
],
+ [
+ 'name' => 'CertIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the certificate. Separate multiple certificate IDs with commas (,). You can call the [ListUserCertificateOrder](~~455804~~) operation to obtain the IDs of certificates from the **CertificateId** parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '12342649,12304338,12067351,9957285'],
+ ],
+ [
+ 'name' => 'ResourceIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the cloud resource. Separate multiple resource IDs with commas (,). You can call the [ListCloudResources](~~2712230~~) operation to obtain the IDs of cloud resources from the **Id** parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '6591316,6585549,6190248,5811894,5775176,5772504'],
+ ],
+ [
+ 'name' => 'ContactIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the contact. Separate multiple contact IDs with commas (,). You can call the [ListContact](~~2712221~~) operation to obtain the IDs of contacts from the **ContactId** parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1,2'],
+ ],
+ [
+ 'name' => 'ScheduleTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The time when the task starts. The value is a UNIX timestamp. If you do not specify this parameter, the system immediately starts the task after the task is in the pending state.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1706613560008'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'OpenApiDefaultResponse<CreateDeploymentResult>',
+ 'description' => 'OpenApiDefaultResponse.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D3F1FA43-1C26-50A2-8F0F-7A03851DBB46',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
+ 'JobId' => ['description' => 'The ID of the deployment task.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '8888'],
],
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3F1FA43-1C26-50A2-8F0F-7A03851DBB46\\"\\n}","type":"json"}]',
- ],
- 'GetInstanceSummary' => [
- 'summary' => '实例统计',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'CreateDeploymentJob',
+ 'summary' => 'Creates a certificate deployment task to deploy an SSL certificate to one or more Alibaba Cloud services immediately or at a scheduled time.',
+ 'description' => 'After the task creation is completed, the task will be in the editing state. You need to call the UpdateDeploymentJobStatus interface to change the status to the pending state, otherwise the task will not be executed.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateDeploymentJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"JobId\\": 8888\\n}","type":"json"}]',
+ ],
+ 'CreateWHClientCertificate' => [
+ 'summary' => 'Issues a single client certificate from the general user certificate repository.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1095,89 +1224,174 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213379',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '158039',
+ 'abilityTreeNodes' => ['FEATUREcasY9QF1D'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '需要签发pca证书，涉及多产品联动，无法自动化测试',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'InstanceType',
+ 'name' => 'SanType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TEST',
- ],
+ 'schema' => ['description' => 'The type of the subject alternative name (SAN) for the client certificate. Valid values:'."\n"
+ ."\n"
+ .'- **1**: email address.'."\n"
+ ."\n"
+ .'- **2**: domain name.'."\n"
+ ."\n"
+ .'- **6**: Uniform Resource Identifier (URI).'."\n"
+ ."\n"
+ .'- **7**: IP address.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'SanValue',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The value of the SAN extension. To specify multiple values, separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'CommonName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The common name of the client certificate. Supports Chinese, English, and other characters.', 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''],
+ ],
+ [
+ 'name' => 'Algorithm',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The key algorithm for the client certificate. The format is `<encryption_algorithm>_<key_length>`. Valid values:'."\n"
+ ."\n"
+ .'- **RSA\\_1024**: The corresponding signature algorithm is Sha256WithRSA.'."\n"
+ ."\n"
+ .'- **RSA\\_2048**: The corresponding signature algorithm is Sha256WithRSA.'."\n"
+ ."\n"
+ .'- **RSA\\_4096**: The corresponding signature algorithm is Sha256WithRSA.'."\n"
+ ."\n"
+ .'- **ECC\\_256**: The corresponding signature algorithm is Sha256WithECDSA.'."\n"
+ ."\n"
+ .'- **ECC\\_384**: The corresponding signature algorithm is Sha256WithECDSA.'."\n"
+ ."\n"
+ .'- **ECC\\_512**: The corresponding signature algorithm is Sha256WithECDSA.'."\n"
+ ."\n"
+ .'- **SM2\\_256**: The corresponding signature algorithm is SM3WithSM2.'."\n"
+ ."\n"
+ .'The encryption algorithm of the client certificate must match that of the issuing subordinate CA certificate, but the key lengths can differ. For example, if the key algorithm of the subordinate CA certificate is RSA\\_2048, the key algorithm for the client certificate must be one of RSA\\_1024, RSA\\_2048, or RSA\\_4096.', 'type' => 'string', 'required' => false, 'example' => 'RSA_2048', 'title' => ''],
+ ],
+ [
+ 'name' => 'Csr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of the certificate signing request (CSR). You can generate a CSR with tools like OpenSSL or Keytool.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', 'title' => ''],
+ ],
+ [
+ 'name' => 'ParentIdentifier',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique identifier of the issuing subordinate CA certificate.', 'type' => 'string', 'required' => true, 'example' => '273ae6bb538d538c70c01f81jh2****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Days',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The validity period of the client certificate, in days.'."\n"
+ ."\n"
+ .'You cannot leave the `Days`, `BeforeTime`, and `AfterTime` parameters all empty. The `BeforeTime` and `AfterTime` parameters must be specified together or not at all.'."\n"
+ ."\n"
+ .'- If you specify the `Days` parameter, specifying `BeforeTime` and `AfterTime` is optional.'."\n"
+ ."\n"
+ .'- If you do not specify the `Days` parameter, you must specify both `BeforeTime` and `AfterTime`.'."\n"
+ ."\n"
+ .'> If you specify `Days`, `BeforeTime`, and `AfterTime` simultaneously, the `Days` parameter takes precedence in determining the validity period.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '365', 'title' => ''],
+ ],
+ [
+ 'name' => 'BeforeTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The issuance time of the client certificate, as a Unix timestamp in seconds. If omitted, this defaults to the time of the API call.'."\n"
+ ."\n"
+ .'> The `BeforeTime` and `AfterTime` parameters must be specified together or not at all.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1634283958', 'title' => ''],
+ ],
+ [
+ 'name' => 'AfterTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The expiration time of the client certificate, specified as a Unix timestamp in seconds.'."\n"
+ ."\n"
+ .'> The `BeforeTime` and `AfterTime` parameters must be specified together or not at all.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1665819958', 'title' => ''],
+ ],
+ [
+ 'name' => 'Organization',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The organization name associated with the root CA certificate, typically your company or enterprise name. Supports Chinese, English, and other characters.', 'type' => 'string', 'required' => false, 'example' => '阿里巴巴网络技术有限公司', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrganizationUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the department or business unit within the organization.', 'type' => 'string', 'required' => false, 'example' => 'IT', 'title' => ''],
+ ],
+ [
+ 'name' => 'Country',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The country where the organization is located.', 'type' => 'string', 'required' => false, 'example' => 'CN', 'title' => ''],
+ ],
+ [
+ 'name' => 'State',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The province, municipality, or autonomous region where the organization is located. Chinese, English, and other characters are supported.', 'type' => 'string', 'required' => false, 'example' => 'Zhejiang', 'title' => ''],
+ ],
+ [
+ 'name' => 'Locality',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The city where the organization is located. Chinese, English, and other characters are supported.', 'type' => 'string', 'required' => false, 'example' => 'Hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'Years',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The validity period of the certificate, in years.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Months',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The validity period of the certificate, in months.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12', 'title' => ''],
+ ],
+ [
+ 'name' => 'Immediately',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies which certificate content to return in the response.'."\n"
+ ."\n"
+ .'- **0**: Does not return the certificate (default).'."\n"
+ ."\n"
+ .'- **1**: Returns the certificate.'."\n"
+ ."\n"
+ .'- **2**: Returns the certificate and its certificate chain.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '09470F19-CEE8-5C63-BF2C-02B5E3F07A17',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'InactiveCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AutoReissueCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CertificateCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'WillExpireCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Identifier' => ['description' => 'The unique identifier of the client certificate.', 'type' => 'string', 'example' => '190ae6bb538d538c70c01f81dcf2****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. This unique ID is generated by Alibaba Cloud for each request and can be used for troubleshooting.', 'type' => 'string', 'example' => '8C467B38-3910-447D-87BC-AC049166F216', 'title' => ''],
+ 'RootX509Certificate' => ['description' => 'The content of the root CA certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----', 'title' => ''],
+ 'ParentX509Certificate' => ['description' => 'The content of the subordinate CA certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----', 'title' => ''],
+ 'X509Certificate' => ['description' => 'The content of the client certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----', 'title' => ''],
+ 'CertificateChain' => ['description' => 'The certificate chain.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateWHClientCertificate',
+ 'description' => 'This API is limited to 10 QPS per user. Exceeding this limit triggers throttling, which can affect your business. Call this API at a reasonable rate to avoid disruption.',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-07T10:36:49.000Z', 'description' => 'Request parameters changed'],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09470F19-CEE8-5C63-BF2C-02B5E3F07A17\\",\\n \\"TotalCount\\": 10,\\n \\"InactiveCount\\": 1,\\n \\"AutoReissueCount\\": 1,\\n \\"CertificateCount\\": 1,\\n \\"WillExpireCount\\": 1\\n}","type":"json"}]',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Identifier\\": \\"190ae6bb538d538c70c01f81dcf2****\\",\\n \\"RequestId\\": \\"8C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"RootX509Certificate\\": \\"-----BEGIN CERTIFICATE-----\\\\\\\\n......\\\\\\\\n-----END CERTIFICATE-----\\",\\n \\"ParentX509Certificate\\": \\"-----BEGIN CERTIFICATE-----\\\\\\\\n......\\\\\\\\n-----END CERTIFICATE-----\\",\\n \\"X509Certificate\\": \\"-----BEGIN CERTIFICATE-----\\\\\\\\n......\\\\\\\\n-----END CERTIFICATE-----\\",\\n \\"CertificateChain\\": \\"-----BEGIN CERTIFICATE-----\\\\\\\\n......\\\\\\\\n-----END CERTIFICATE-----\\\\\\\\n-----BEGIN CERTIFICATE-----\\\\\\\\n......\\\\\\\\n-----END CERTIFICATE-----\\\\\\\\n\\"\\n}","type":"json"}]',
],
- 'ApplyCertificate' => [
- 'summary' => '申请证书',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateWarehouse' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1186,57 +1400,66 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213377',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '245181',
+ 'abilityTreeNodes' => ['FEATUREcasEAT643'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the certificate warehouse.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'MyCertificateWarehouse'],
+ ],
+ [
+ 'name' => 'Type',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The type of the certificate warehouse. Valid values:',
+ 'enumValueTitles' => ['uploadedAuthorityCertificate' => 'Uploaded CA certificate', 'pcaCertificate' => 'PCA-issued certificate', 'uploadedCertificate' => 'Uploaded SSL certificate', 'personal' => 'Personal test SSL certificate', 'ssl' => 'SSL certificate', 'pcaAuthorityCertificate' => 'CA certificate of a PCA instance'],
'type' => 'string',
- 'required' => true,
- 'example' => 'cas_dv-cn-rp643r82d0i1',
+ 'title' => '',
+ 'required' => false,
+ 'example' => 'pcaCertificate',
],
],
+ [
+ 'name' => 'Biz',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The use case of the certificate warehouse.', 'type' => 'string', 'required' => false, 'example' => 'contract', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F0206B77-14B9-584C-8A3A-09D5827FBC50', 'title' => ''],
+ 'WarehouseInstanceId' => ['description' => 'The instance ID of the certificate warehouse.', 'type' => 'string', 'title' => '', 'example' => 'cas-wh-typ-serial'],
],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
+ 'title' => 'CreateWarehouse',
+ 'summary' => 'Creates a certificate warehouse.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0206B77-14B9-584C-8A3A-09D5827FBC50\\",\\n \\"WarehouseInstanceId\\": \\"cas-wh-typ-serial\\"\\n}","type":"json"}]',
],
- 'GetTaskAttribute' => [
- 'summary' => '查询异步任务状态',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'Decrypt' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1245,79 +1468,109 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213379',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '155856',
+ 'abilityTreeNodes' => ['FEATUREcasW9WPDK'],
],
'parameters' => [
[
- 'name' => 'TaskType',
+ 'name' => 'CertIdentifier',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique identifier of the certificate. Call [ListCert](~~455806~~) to obtain this parameter.'."\n"
+ ."\n"
+ .'- The identifier of an SSL certificate is typically in the format {Certificate ID}-cn-hangzhou.'."\n"
+ ."\n"
+ .'- For a private certificate authority (PCA) certificate, this is the value of the Identifier field of the private certificate.', 'type' => 'string', 'required' => false, 'example' => '1ef1da5f-38ed-69b3-****-037781890265', 'title' => ''],
+ ],
+ [
+ 'name' => 'Algorithm',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The encryption algorithm. Valid values:'."\n"
+ ."\n"
+ .'- **RSAES\\_OAEP\\_SHA\\_1**'."\n"
+ ."\n"
+ .'- **RSAES\\_OAEP\\_SHA\\_256**'."\n"
+ ."\n"
+ .'- **SM2PKE**', 'type' => 'string', 'required' => true, 'example' => 'RSAESOAEPSHA_1', 'title' => ''],
+ ],
+ [
+ 'name' => 'CiphertextBlob',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Base64-encoded data to decrypt.', 'type' => 'string', 'required' => true, 'example' => 'ZOyIygCyaOW6Gj****MlNKiuyjfzw=', 'title' => ''],
+ ],
+ [
+ 'name' => 'MessageType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The message type. Valid values:'."\n"
+ ."\n"
+ .'- RAW: The response returns the plaintext in UTF-8 encoding.'."\n"
+ ."\n"
+ .'- Base64 (default): The response returns the Base64-encoded plaintext.',
+ 'enumValueTitles' => ['Base64' => 'Base64', 'RAW' => 'RAW'],
'type' => 'string',
'required' => false,
- 'example' => 'ApplyCertificate',
+ 'example' => 'Base64',
+ 'title' => '',
],
],
[
- 'name' => 'TaskId',
+ 'name' => 'CustomIdentifier',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'schema' => ['description' => 'A custom identifier that serves as a unique key.', 'type' => 'string', 'required' => false, 'example' => '****6bb538d538c70c01f81jh2****', 'title' => ''],
+ ],
+ [
+ 'name' => 'WarehouseId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the repository.'."\n"
+ ."\n"
+ .'> Call [ListCertWarehouse](~~455805~~) to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D',
- ],
- 'TaskStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'TaskMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'error',
- ],
+ 'Plaintext' => ['description' => 'The decrypted data.', 'type' => 'string', 'example' => 'VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5979d897-d69f-4fc9-87dd-f3bb73c40b80', 'title' => ''],
+ 'CertIdentifier' => ['description' => 'The unique identifier of the certificate.', 'type' => 'string', 'example' => '1ef1da5f-38ed-69b3-****-037781890265', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"TaskStatus\\": \\"success\\",\\n \\"TaskMessage\\": \\"error\\"\\n}","type":"json"}]',
- ],
- 'CancelPendingCertificate' => [
- 'summary' => '撤回证书申请',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'Decrypt',
+ 'summary' => 'Decrypts data that was encrypted by using a certificate in a certificate application repository.',
+ 'description' => 'The queries per second (QPS) limit for this API operation is 10 per user. If you exceed the limit, API calls are throttled, which may affect your business. Call this operation at a reasonable rate.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:Decrypt',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Plaintext\\": \\"VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4\\",\\n \\"RequestId\\": \\"5979d897-d69f-4fc9-87dd-f3bb73c40b80\\",\\n \\"CertIdentifier\\": \\"1ef1da5f-38ed-69b3-****-037781890265\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteCertificateRequest' => [
+ 'summary' => 'Deletes a failed domain validated (DV) certificate application order.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1326,39 +1579,31 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213377',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '81672',
+ 'abilityTreeNodes' => ['FEATUREcasP4AIN0'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cas_dv-cn-rp643r82d0i1',
- ],
+ 'schema' => ['description' => 'The ID of the certificate application order that you want to delete.'."\n"
+ ."\n"
+ .'> After you call the [CreateCertificateForPackageRequest](~~455296~~), [CreateCertificateRequest](~~455292~~), or [CreateCertificateWithCsrRequest](~~455801~~) operation to submit a certificate application, you can obtain the ID of the certificate application order from the **OrderId** response parameter. You can also call the [ListUserCertificateOrder](~~455804~~) operation to obtain the order ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123451222', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12345678-1234-1234-1234-123456789ABC',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -1366,299 +1611,234 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\"\\n}","type":"json"}]',
- ],
- 'ListCertificates' => [
- 'summary' => '获取证书列表',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DeleteCertificateRequest',
+ 'description' => 'You can call this operation to delete a certificate application order only in the following scenarios:'."\n"
+ ."\n"
+ .'- The status of the order is **review failed**. You have called the [DescribeCertificateState](~~455800~~) operation to query the status of the certificate application order and the value of the **Type** parameter is **verify\\_fail**.'."\n"
+ ."\n"
+ .'- The status of the order is **pending application**. You have called the [CancelOrderRequest](~~455299~~) operation to cancel a certificate application order whose status is pending review or being reviewed. The status of the certificate application order that is canceled in this case changes to **pending application**.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '|HTTP status code|Error code|Description|'."\n"
+ .'|---|---|---|'."\n"
+ .'|404|NotFoundPackage|The error message returned because no certificate resource plans were purchased.|'."\n"
+ .'|404|NotRemainCount|The error message returned because the certificate quota is insufficient.|'."\n"
+ .'|403|CreateCertificateRequestFailed|The error message returned because the request failed to be created.|'."\n"
+ .'|404|NotFoundOrder|The error message returned because the specified certificate order was not found.|'."\n"
+ .'|403|OrderStateError|The error message returned because the status of the certificate order is invalid.|'."\n"
+ .'|403|DeleteFail|The error message returned because the certificate application order failed to be deleted.|'."\n"
+ .'|500|Error|The error message returned because an error occurred.|',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-23T08:22:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteCertificateRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]',
+ 'requestParamsDescription' => 'All Alibaba Cloud API operations must include common request parameters.'."\n"
+ ."\n"
+ .'For more information about sample requests, see the **"Examples"** section of this topic.',
+ ],
+ 'DeleteCloudAccess' => [
+ 'summary' => 'Deletes an access key.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214629',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '214632',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
],
'parameters' => [
[
- 'name' => 'Keyword',
+ 'name' => 'AccessId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The ID of the access key.', 'type' => 'string', 'required' => false, 'example' => '132', 'title' => ''],
],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cas-ivauto-hqito6',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76'],
+ ],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteCloudAccess',
+ 'description' => 'This operation is limited to 100 queries per second (QPS) per user. API calls that exceed this limit are throttled, which can impact your business.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteCsr' => [
+ 'summary' => 'Deletes a certificate signing request (CSR).',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CertificateStatus',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'issued',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '213378',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ ],
+ 'parameters' => [
[
- 'name' => 'CertificateSource',
+ 'name' => 'CsrId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the CSR.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3013', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BUY',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D3F1FA43-1C26-50A2-8F0F-7A03851DBB46', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek****wia',
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'DeleteCsr',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3F1FA43-1C26-50A2-8F0F-7A03851DBB46\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteDeploymentJob' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ShowSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '214604',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ ],
+ 'parameters' => [
[
- 'name' => 'CurrentPage',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The ID of the deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '8888'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'OpenApiDefaultResponse<?>',
+ 'description' => 'OpenApiDefaultResponse\\<?>.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'ShowSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'CurrentPage' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CertificateList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => ' cas-cn-v***',
- ],
- 'Algorithm' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'RSA',
- ],
- 'CertificateStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'issued',
- ],
- 'Domain' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test.com',
- ],
- 'CertificateId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '17281539',
- ],
- 'CertificateName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'CertIdentifier' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '21589515-cn-hangzhou',
- ],
- 'CommonName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'aliyun.com',
- ],
- 'SubjectAlternativeNames' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test.com',
- ],
- ],
- 'CertificateSource' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BUY',
- ],
- 'NotBefore' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1760745600000',
- ],
- 'NotAfter' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1749580567000',
- ],
- 'KeySize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2048',
- ],
- 'FingerPrint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'Serial' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'Issuer' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DigiCert',
- ],
- 'ExistPrivateKey' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'UsingProductList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CDN',
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"TotalCount\\": 10,\\n \\"ShowSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"CertificateList\\": [\\n {\\n \\"InstanceId\\": \\" cas-cn-v***\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"CertificateStatus\\": \\"issued\\",\\n \\"Domain\\": \\"test.com\\",\\n \\"CertificateId\\": \\"17281539\\",\\n \\"CertificateName\\": \\"test\\",\\n \\"CertIdentifier\\": \\"21589515-cn-hangzhou\\",\\n \\"CommonName\\": \\"aliyun.com\\",\\n \\"SubjectAlternativeNames\\": [\\n \\"test.com\\"\\n ],\\n \\"CertificateSource\\": \\"BUY\\",\\n \\"NotBefore\\": 1760745600000,\\n \\"NotAfter\\": 1749580567000,\\n \\"KeySize\\": 2048,\\n \\"FingerPrint\\": \\"123\\",\\n \\"Serial\\": \\"123\\",\\n \\"Issuer\\": \\"DigiCert\\",\\n \\"ExistPrivateKey\\": true,\\n \\"UsingProductList\\": [\\n \\"CDN\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'GetCertificateDetail' => [
- 'summary' => '查询证书详情',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DeleteDeploymentJob',
+ 'summary' => 'Deletes a certificate deployment task.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteDeploymentJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteInstance' => [
+ 'summary' => 'Deletes a Certificate Management Service instance.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213379',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => true,
+ 'abilityTreeCode' => '213377',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'CertificateId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '18594156',
- ],
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cas-cn-68n1mm16****', 'title' => ''],
],
],
'responses' => [
@@ -1666,192 +1846,38 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cas_dv-cn-123',
- ],
- 'CommonName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'www.example.com',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5979d897-d69f-4fc9-87dd-f3bb73c40b80',
- ],
- 'Algorithm' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'RSA',
- ],
- 'Domain' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'aliyundoc.com,example.aliyundoc.com',
- ],
- 'CertificateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22559621',
- ],
- 'CertificateName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'CertIdentifier' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '21912069-cn-hangzhou',
- ],
- 'CertificateSource' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BUY',
- ],
- 'CertificateStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'issued',
- ],
- 'NotBefore' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '17321613180000',
- ],
- 'NotAfter' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '17326613180000',
- ],
- 'KeySize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2048',
- ],
- 'SubjectAlternativeNames' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'aliyundoc.com',
- ],
- ],
- 'Serial' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'ExistPrivateKey' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'UsingProductList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CDN',
- ],
- ],
- 'FingerPrint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'CertificateChainList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Issuer' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Digicert',
- ],
- 'Subject' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Digicert',
- ],
- 'RemainDay' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NotBefore' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '17321613180000',
- ],
- 'NotAfter' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '17326613180000',
- ],
- ],
- ],
- ],
- 'Issuer' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Digicert',
- ],
- 'Tags' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TagKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'TagValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4BD0CBD9-FB03-5ECD-A8FD-F90C62D78095', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"cas_dv-cn-123\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"RequestId\\": \\"5979d897-d69f-4fc9-87dd-f3bb73c40b80\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"Domain\\": \\"aliyundoc.com,example.aliyundoc.com\\",\\n \\"CertificateId\\": 22559621,\\n \\"CertificateName\\": \\"123\\",\\n \\"CertIdentifier\\": \\"21912069-cn-hangzhou\\",\\n \\"CertificateSource\\": \\"BUY\\",\\n \\"CertificateStatus\\": \\"issued\\",\\n \\"NotBefore\\": 17321613180000,\\n \\"NotAfter\\": 17326613180000,\\n \\"KeySize\\": 2048,\\n \\"SubjectAlternativeNames\\": [\\n \\"aliyundoc.com\\"\\n ],\\n \\"Serial\\": \\"123\\",\\n \\"ExistPrivateKey\\": true,\\n \\"UsingProductList\\": [\\n \\"CDN\\"\\n ],\\n \\"FingerPrint\\": \\"123\\",\\n \\"CertificateChainList\\": [\\n {\\n \\"Issuer\\": \\"Digicert\\",\\n \\"Subject\\": \\"Digicert\\",\\n \\"RemainDay\\": 10,\\n \\"NotBefore\\": 17321613180000,\\n \\"NotAfter\\": 17326613180000\\n }\\n ],\\n \\"Issuer\\": \\"Digicert\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"test\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'RevokeCertificate' => [
- 'summary' => '吊销证书',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DeleteInstance',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BD0CBD9-FB03-5ECD-A8FD-F90C62D78095\\"\\n}","type":"json"}]',
+ ],
+ 'DeletePCACert' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1860,26 +1886,19 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213377',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
+ 'abilityTreeCode' => '153635',
+ 'abilityTreeNodes' => ['FEATUREcasY9QF1D'],
+ 'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'Identifier',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cas-cn-68n1mm16****',
- ],
+ 'schema' => ['description' => 'The unique identifier of the certificate. You can call the [ListCert](~~452331~~) operation to query the unique identifiers of certificates.', 'type' => 'string', 'required' => true, 'example' => 'ccaf0c629c2be1e2ab', 'title' => ''],
],
],
'responses' => [
@@ -1887,31 +1906,48 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
+ 'title' => 'DeletePCACert',
+ 'summary' => 'Deletes a private certificate from a certificate application repository.',
+ 'description' => 'You can call the DeletePCACert operation to delete a private certificate from a certificate application repository.'."\n"
+ ."\n"
+ .'### Limits'."\n"
+ ."\n"
+ .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeletePCACert',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
],
'DeleteUserCertificate' => [
- 'summary' => 'Deletes an expired or uploaded certificate.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1924,62 +1960,58 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '160957',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'CertId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the certificate.'."\n"
- ."\n"
- .'> You can call the [ListUserCertificateOrder](~~455804~~) operation to obtain the ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '7562353',
- ],
+ 'schema' => ['description' => 'The certificate ID.'."\n"
+ ."\n"
+ .'> To obtain the certificate ID, call the [ListUserCertificateOrder](~~455804~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7562353', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The object.'."\n",
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '3E50D480-9765-5CFD-9650-9BACCECA5135',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E50D480-9765-5CFD-9650-9BACCECA5135', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E50D480-9765-5CFD-9650-9BACCECA5135\\"\\n}","type":"json"}]',
'title' => 'DeleteUserCertificate',
- 'description' => 'You can call this operation up to 100 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'MoveResourceGroup' => [
- 'summary' => 'Changes the resource group to which a certificate or certificate order belongs.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'summary' => 'Deletes an expired, revoked, or manually uploaded certificate from Certificate Management Service.',
+ 'description' => 'This operation is limited to 100 queries per second (QPS) per user. API calls exceeding this limit are throttled, which can impact your business. We recommend calling this operation at a reasonable rate to avoid this.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteUserCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E50D480-9765-5CFD-9650-9BACCECA5135\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteWarehouse' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1988,241 +2020,493 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
+ 'operationType' => 'delete',
+ 'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeCode' => '226097',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '245183',
+ 'abilityTreeNodes' => ['FEATUREcasEAT643'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ResourceId',
+ 'name' => 'WarehouseInstanceId',
'in' => 'query',
+ 'schema' => ['description' => 'The certificate warehouse instance ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cas-wh-Q7ID6V'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The ID of the resource.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cas-cn-4591d3xa****',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5C53F7EC-7C47-5DA5-8B6D-FE6B1F934E82', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The response body.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'DeleteWarehouse',
+ 'summary' => 'Deletes a certificate warehouse.',
+ 'description' => 'This operation deletes a certificate warehouse.'."\n"
+ ."\n"
+ .'### QPS limit'."\n"
+ ."\n"
+ .'This operation has a QPS limit of 10 requests per second per user. Exceeding this limit causes subsequent API calls to be throttled, which can impact your services. To ensure service availability, call this operation at a reasonable rate.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C53F7EC-7C47-5DA5-8B6D-FE6B1F934E82\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteWorkerResource' => [
+ 'summary' => 'Deletes a worker task from a certificate deployment task.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rg-acfmykgxu5d46ey',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '214607',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ ],
+ 'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the resource.\\'."\n"
- .'Default value: **instance**'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* instance: certificate order'."\n"
- .'* Certificate: certificate'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'instance' => 'instance',
- 'Certificate' => 'Certificate',
- ],
- 'example' => 'instance',
- ],
+ 'schema' => ['description' => 'The ID of the deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '8888'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'WorkerId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region of the organization to which the owner of the certificate belongs. Valid values: ap-southeast-1 and cn-hangzhou.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the worker for the deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '13'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'OpenApiDefaultResponse<?>',
+ 'description' => 'OpenApiDefaultResponse\\<?>.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EA69E364-5CBB-50E8-BF09-E8CAA396A4F8', 'title' => ''],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E\\"\\n}","type":"json"}]',
- 'title' => 'MoveResourceGroup',
- ],
- 'CreateDeploymentJob' => [
- 'summary' => 'Creates a certificate deployment task. After an SSL certificate is issued, you can create a certificate deployment task to immediately deploy the certificate to an Alibaba Cloud service or deploy the certificate to the service at a specific point in time. Then, the certificate can implement trusted identity authentication and ensure the security of data transmission for your website hosted on the service.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'DeleteWorkerResource',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteWorkerResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EA69E364-5CBB-50E8-BF09-E8CAA396A4F8\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeCertificateState' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214600',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '81673',
+ 'abilityTreeNodes' => ['FEATUREcasP4AIN0'],
'autoTest' => false,
'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
],
'parameters' => [
[
- 'name' => 'Name',
+ 'name' => 'OrderId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the certificate request order to query.'."\n"
+ ."\n"
+ .'> You can call [ListUserCertificateOrder](~~455804~~) to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123451222', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '部署任务名称',
- 'description' => 'The name of the deployment task.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'jobName',
+ 'description' => 'The object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The status of the certificate request order. Valid values:'."\n"
+ ."\n"
+ .'- **domain\\_verify**: **Pending validation**, which indicates that you have not completed domain validation after submitting the certificate request.'."\n"
+ ."\n"
+ .' > After you submit a certificate request, you must manually complete domain ownership validation before the certificate request can enter the review stage. If you have not completed domain validation, you can refer to the response parameters of this operation to complete domain validation.'."\n"
+ ."\n"
+ .'- **process**: **Under review**, which indicates that the certificate request is being reviewed by the CA center.'."\n"
+ ."\n"
+ .'- **verify\\_fail**: **Review failed**, which indicates that the certificate request failed the review.'."\n"
+ ."\n"
+ .' > The review may fail because the certificate request information you submitted is incorrect. We recommend that you call [DeleteCertificateRequest](~~455294~~) to delete the order that failed the review (deleted orders do not consume certificate resource plan quota) and submit a new certificate request.'."\n"
+ ."\n"
+ .'- **certificate**: **Issued**, which indicates that the certificate has been issued.'."\n"
+ ."\n"
+ .'- **payed**: **Pending request**, which indicates that the certificate is pending request.'."\n"
+ ."\n"
+ .'- **unknow**: **Unknown status**.', 'type' => 'string', 'example' => 'domain_verify', 'title' => ''],
+ 'Domain' => ['description' => 'The domain name to be validated when you use the file validation method for domain validation. You need to connect to the server corresponding to this domain name and create the specified file (i.e., **Uri**) on the server.'."\n"
+ ."\n"
+ .'> This parameter is returned only when **Type** is set to **domain\\_verify** (indicating the domain validation stage) and **ValidateType** is set to **FILE** (indicating the file validation method).', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''],
+ 'RecordType' => ['description' => 'The type of DNS record that you need to add when you use the DNS validation method for domain validation. Valid values:'."\n"
+ ."\n"
+ .'- **TXT**: text record.'."\n"
+ ."\n"
+ .'- **CNAME**: alias record.'."\n"
+ ."\n"
+ .'> This parameter is returned only when **Type** is set to **domain\\_verify** (indicating the domain validation stage) and **ValidateType** is set to **DNS** (indicating the DNS validation method).', 'type' => 'string', 'example' => 'TXT', 'title' => ''],
+ 'CertId' => ['description' => 'The certificate ID.'."\n"
+ ."\n"
+ .'> This parameter is returned when the certificate is issued.', 'type' => 'string', 'example' => '111111', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76', 'title' => ''],
+ 'RecordDomain' => ['description' => 'The host record that you need to operate when you use the DNS validation method for domain validation.'."\n"
+ ."\n"
+ .'> This parameter is returned only when **Type** is set to **domain\\_verify** (indicating the domain validation stage) and **ValidateType** is set to **DNS** (indicating the DNS validation method).', 'type' => 'string', 'example' => '_dnsauth', 'title' => ''],
+ 'PrivateKey' => ['description' => 'The content of the certificate private key (in PEM format). For more information about the PEM format and how to convert the format of a certificate, see [What are the formats of mainstream digital certificates?](~~42214~~).'."\n"
+ ."\n"
+ .'> This parameter is returned only when **Type** is set to **certificate** (indicating that the certificate has been issued).', 'type' => 'string', 'example' => '-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----', 'title' => ''],
+ 'ValidateType' => ['description' => 'The domain validation method selected when submitting the certificate request. Valid values:'."\n"
+ ."\n"
+ .'- **DNS**: DNS validation. This method validates domain ownership by adding the specified DNS record to the domain on the DNS management platform.'."\n"
+ ."\n"
+ .'- **FILE**: file validation. This method validates domain ownership by creating the specified file on the domain server.'."\n"
+ ."\n"
+ .'> This parameter is returned only when **Type** is set to **domain\\_verify** (indicating the domain validation stage).', 'type' => 'string', 'example' => 'FILE', 'title' => ''],
+ 'RecordValue' => ['description' => 'The record value that you need to add when you use the DNS validation method for domain validation.'."\n"
+ ."\n"
+ .'> This parameter is returned only when **Type** is set to **domain\\_verify** (indicating the domain validation stage) and **ValidateType** is set to **DNS** (indicating the DNS validation method).', 'type' => 'string', 'example' => '20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy', 'title' => ''],
+ 'Content' => ['description' => 'The content that you need to write to the newly created file when you use the file validation method for domain validation.'."\n"
+ ."\n"
+ .'> This parameter is returned only when **Type** is set to **domain\\_verify** (indicating the domain validation stage) and **ValidateType** is set to **FILE** (indicating the file validation method).', 'type' => 'string', 'example' => 'http://example.com/.well-known/pki-validation/fileauth.txt', 'title' => ''],
+ 'Uri' => ['description' => 'The file that you need to create on the domain server when you use the file validation method for domain validation. **Uri** includes the file path and name.'."\n"
+ ."\n"
+ .'> This parameter is returned only when **Type** is set to **domain\\_verify** (indicating the domain validation stage) and **ValidateType** is set to **FILE** (indicating the file validation method).', 'type' => 'string', 'example' => '/.well-known/pki-validation/fileauth.txt', 'title' => ''],
+ 'Certificate' => ['description' => 'The certificate content (in PEM format). For more information about the PEM format and how to convert the format of a certificate, see [What are the formats of mainstream digital certificates?](~~42214~~).'."\n"
+ ."\n"
+ .'> This parameter is returned only when **Type** is set to **certificate** (indicating that the certificate has been issued).', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'JobType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务类型：',
- 'description' => 'The type of the deployment task.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cloud: multi-cloud deployment task.'."\n"
- .'* user: cloud service deployment task. This type of task does not support cloud servers.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'cloud' => 'cloud',
- 'user' => 'user',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DescribeCertificateState',
+ 'summary' => 'Queries the status of a certificate application order, such as domain validation progress.',
+ 'description' => 'If you have not completed domain ownership validation after submitting a certificate request, you can call this operation to obtain the information required to complete domain validation. Using the returned domain validation information, you can complete domain validation on the DNS management platform (DNS validation method) or on the domain server (file validation method).'."\n"
+ ."\n"
+ .'Your certificate request will enter the CA center review stage only after you complete domain validation. After the CA center approves your certificate request, a certificate will be issued to you. If the certificate has been issued, you can call this operation to obtain the issued certificate file and private key content.'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ ."\n"
+ .'For the complete process of requesting a certificate using the resource plan API, see [Process of requesting a certificate using API operations](~~204741~~).'."\n"
+ ."\n"
+ .'</props>',
+ 'requestParamsDescription' => 'When you call an API operation, in addition to the request parameters specific to the operation, you must also include Alibaba Cloud common request parameters.'."\n"
+ ."\n"
+ .'For the request format when calling an API operation, see the request examples in the **Examples** section of this topic.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-23T08:22:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribeCertificateState',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'example' => 'user',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Type\\": \\"domain_verify\\",\\n \\"Domain\\": \\"www.example.com\\",\\n \\"RecordType\\": \\"TXT\\",\\n \\"CertId\\": \\"111111\\",\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\",\\n \\"RecordDomain\\": \\"_dnsauth\\",\\n \\"PrivateKey\\": \\"-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----\\",\\n \\"ValidateType\\": \\"FILE\\",\\n \\"RecordValue\\": \\"20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy\\",\\n \\"Content\\": \\"http://example.com/.well-known/pki-validation/fileauth.txt\\",\\n \\"Uri\\": \\"/.well-known/pki-validation/fileauth.txt\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeCloudResourceStatus' => [
+ 'summary' => 'Queries the number of cloud resources on which certificates were deployed by using a multi-cloud deployment task.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CertIds',
- 'in' => 'query',
- 'schema' => [
- 'title' => '证书IDs',
- 'description' => 'The ID of the certificate. Separate multiple certificate IDs with commas (,). You can call the [ListUserCertificateOrder](~~455804~~) operation to obtain the IDs of certificates from the **CertificateId** parameter.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '12342649,12304338,12067351,9957285',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '214598',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'ResourceIds',
+ 'name' => 'SecretId',
'in' => 'query',
+ 'schema' => ['description' => 'The AccessKey secret used to access cloud resources.'."\n"
+ ."\n"
+ .'> You can call the [ListCloudAccess](~~2712219~~) operation to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => 'AKID9AHG6iCZlncN7yPmOsQ1X******', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '资源Ids',
- 'description' => 'The ID of the cloud resource. Separate multiple resource IDs with commas (,). You can call the [ListCloudResources](~~2712230~~) operation to obtain the IDs of cloud resources from the **Id** parameter.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '6591316,6585549,6190248,5811894,5775176,5772504',
+ 'title' => 'OpenApiDefaultResponse<List<CloudResourceCount>>',
+ 'description' => 'OpenApiDefaultResponse\\<List>.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The response parameters.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CloudName' => ['description' => 'The cloud service provider.', 'type' => 'string', 'title' => '', 'example' => 'aliyun'],
+ 'CloudProduct' => ['description' => 'The cloud service.', 'type' => 'string', 'title' => '', 'example' => 'OSS'],
+ 'TotalCount' => ['description' => 'The total number of cloud resources on which certificates are deployed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '09470F19-CEE8-5C63-BF2C-02B5E3F07A17', 'title' => ''],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'ContactIds',
- 'in' => 'query',
- 'schema' => [
- 'title' => '联系人IDs',
- 'description' => 'The ID of the contact. Separate multiple contact IDs with commas (,). You can call the [ListContact](~~2712221~~) operation to obtain the IDs of contacts from the **ContactId** parameter.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '1,2',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'DescribeCloudResourceStatus',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribeCloudResourceStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"CloudName\\": \\"aliyun\\",\\n \\"CloudProduct\\": \\"OSS\\",\\n \\"TotalCount\\": 2\\n }\\n ],\\n \\"RequestId\\": \\"09470F19-CEE8-5C63-BF2C-02B5E3F07A17\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeDeploymentJob' => [
+ 'summary' => 'Retrieves information about a certificate deployment task, including the task status, target resources, and certificates.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '214580',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖短信验证通过的手机号，无法自动化测试',
+ ],
+ 'parameters' => [
[
- 'name' => 'ScheduleTime',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'title' => '任务调度时间',
- 'description' => 'The time when the task starts. The value is a UNIX timestamp. If you do not specify this parameter, the system immediately starts the task after the task is in the pending state.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1706613560008',
- ],
+ 'schema' => ['description' => 'The ID of the deployment job. To get the job ID, call the [CreateDeploymentJob](~~2712234~~) or [ListDeploymentJob](~~2712223~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '8888'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<CreateDeploymentResult>',
- 'description' => 'OpenApiDefaultResponse.'."\n",
+ 'title' => 'OpenApiDefaultResponse<DeploymentJob>',
+ 'description' => 'OpenApiDefaultResponse.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
+ 'Id' => ['description' => 'The ID of the deployment job.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '43222'],
+ 'GmtCreate' => ['description' => 'The time when the deployment job was created. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'string', 'title' => '', 'example' => '1679541809000'],
+ 'GmtModified' => ['description' => 'The time when the deployment job was last modified. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'string', 'title' => '', 'example' => '1679541809000'],
+ 'UserId' => ['description' => 'The ID of the Alibaba Cloud account in which the deployment job is created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '166688437******'],
+ 'InstanceId' => ['description' => 'The instance ID of the deployment task.', 'type' => 'string', 'title' => '', 'example' => '14dcc8afc7578e1f'],
+ 'Name' => ['description' => 'The name of the deployment task.', 'type' => 'string', 'title' => '', 'example' => 'auto-test-AXX'],
+ 'CertType' => [
+ 'description' => 'The type of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **upload**: uploaded certificate'."\n"
+ ."\n"
+ .'- **buy**: purchased certificate'."\n"
+ ."\n"
+ .'- **free**: free certificate available only on the China site (aliyun.com)',
+ 'enumValueTitles' => [],
'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
+ 'title' => '',
+ 'example' => 'buy',
+ ],
+ 'ScheduleTime' => ['description' => 'The time when the deployment job was scheduled. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'string', 'title' => '', 'example' => '1678083209335'],
+ 'StartTime' => ['description' => 'The start time of the deployment job. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'string', 'title' => '', 'example' => '1679541809000'],
+ 'EndTime' => ['description' => 'The end time of the deployment job. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'string', 'title' => '', 'example' => '1679541809000'],
+ 'Status' => [
+ 'description' => 'The status of the deployment job. Valid values:'."\n"
+ ."\n"
+ .'- **pending**'."\n"
+ ."\n"
+ .'- **editing**'."\n"
+ ."\n"
+ .'- **scheduling**'."\n"
+ ."\n"
+ .'- **processing**'."\n"
+ ."\n"
+ .'- **error**'."\n"
+ ."\n"
+ .'- **success**',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'title' => '',
+ 'example' => 'editing',
+ ],
+ 'Del' => [
+ 'description' => 'Indicates whether the deployment job was deleted. Valid values:'."\n"
+ ."\n"
+ .'- **0**: not deleted'."\n"
+ ."\n"
+ .'- **1**: deleted',
+ 'enumValueTitles' => [],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'title' => '',
+ 'example' => '1',
],
- 'JobId' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task.'."\n",
+ 'Rollback' => [
+ 'description' => 'Indicates whether the deployment job includes the rollback worker. For example, if a cloud service in a deployment job has been rolled back, **1** is returned. Valid values:'."\n"
+ ."\n"
+ .'- **0**: The rollback worker is not included.'."\n"
+ ."\n"
+ .'- **1**: The rollback worker is included.',
+ 'enumValueTitles' => [],
'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8888',
+ 'format' => 'int32',
+ 'title' => '',
+ 'example' => '1',
+ ],
+ 'JobType' => [
+ 'description' => 'The type of the deployment job. Valid values:'."\n"
+ ."\n"
+ .'- **cloud**: multi-cloud deployment job.'."\n"
+ ."\n"
+ .'- **trustee**: hosted deployment job available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **user**: cloud service deployment job. The cloud server is not included.',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'title' => '',
+ 'example' => 'user',
+ ],
+ 'CertDomain' => ['description' => 'The domain names bound to the certificate of the deployment task.', 'type' => 'string', 'title' => '', 'example' => 'example.aliyundoc.com,demo.aliyundoc.com'],
+ 'ProductName' => ['description' => 'The cloud services included in the deployment task.', 'type' => 'string', 'title' => '', 'example' => 'CDN'],
+ 'Config' => ['description' => 'The configurations of the deployment task.', 'type' => 'string', 'title' => '', 'example' => '{\\"shareCertIds\\":[],\\"certIds\\":[12342649,12304338,12067351,9957285]}'],
+ 'CasContacts' => [
+ 'description' => 'The information about the contact.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The ID of the contact.', 'type' => 'string', 'example' => '3304', 'title' => ''],
+ 'Name' => ['description' => 'The name of the contact.', 'type' => 'string', 'example' => 'John', 'title' => ''],
+ 'Mobile' => ['description' => 'The phone number of the contact.', 'type' => 'string', 'example' => '139****0000', 'title' => ''],
+ 'Email' => ['description' => 'The email address of the contact.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"JobId\\": 8888\\n}","type":"json"}]',
- 'title' => 'CreateDeploymentJob',
- 'description' => 'After the task creation is completed, the task will be in the editing state. You need to call the UpdateDeploymentJobStatus interface to change the status to the pending state, otherwise the task will not be executed.',
- ],
- 'UpdateDeploymentJobStatus' => [
- 'summary' => 'Updates the status of a deployment task.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Id\\": 43222,\\n \\"GmtCreate\\": \\"1679541809000\\",\\n \\"GmtModified\\": \\"1679541809000\\",\\n \\"UserId\\": 0,\\n \\"InstanceId\\": \\"14dcc8afc7578e1f\\",\\n \\"Name\\": \\"auto-test-AXX\\",\\n \\"CertType\\": \\"buy\\",\\n \\"ScheduleTime\\": \\"1678083209335\\",\\n \\"StartTime\\": \\"1679541809000\\",\\n \\"EndTime\\": \\"1679541809000\\",\\n \\"Status\\": \\"editing\\",\\n \\"Del\\": 1,\\n \\"Rollback\\": 1,\\n \\"JobType\\": \\"user\\",\\n \\"CertDomain\\": \\"example.aliyundoc.com,demo.aliyundoc.com\\",\\n \\"ProductName\\": \\"CDN\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"shareCertIds\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"certIds\\\\\\\\\\\\\\":[12342649,12304338,12067351,9957285]}\\",\\n \\"CasContacts\\": [\\n {\\n \\"Id\\": \\"3304\\",\\n \\"Name\\": \\"John\\",\\n \\"Mobile\\": \\"139****0000\\",\\n \\"Email\\": \\"username@example.com\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeDeploymentJob',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribeDeployment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeDeploymentJobStatus' => [
+ 'summary' => 'Queries the execution status summary of a certificate deployment task, including the number of succeeded and failed workers.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2231,92 +2515,124 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214601',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '214581',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖真实的，短信验证通过的手机，无法自动化测试',
+ 'notSupportAutoTestReason' => '依赖短信验证通过的手机号，无法自动化测试',
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '8888',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'title' => '目标状态：',
- 'description' => 'The desired status.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* pending'."\n"
- .'* scheduling'."\n"
- .'* editing'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'pending' => '',
- 'scheduling' => '',
- 'editing' => '',
- ],
- 'example' => 'editing',
- ],
+ 'schema' => ['description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the **JobId** parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '8888'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<?>',
- 'description' => 'OpenApiDefaultResponse\\<?>.'."\n",
+ 'title' => 'OpenApiDefaultResponse<DeploymentJobStatus>',
+ 'description' => 'OpenApiDefaultResponse',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'The response parameters.'."\n",
- 'type' => 'any',
- 'example' => '[]',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'EA69E364-5CBB-50E8-BF09-E8CAA396A4F8',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
+ 'ResourceCount' => ['description' => 'The total number of resources.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4127'],
+ 'UseCount' => ['description' => 'The total number of used resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''],
+ 'BuyCount' => ['description' => 'The total number of purchased resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
+ 'WorkerCount' => ['description' => 'The total number of resources to which certificate are deployed in the current cloud service. The value indicates the total number of worker tasks.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'MatchWorkerCount' => ['description' => 'The total number of worker tasks that match the certificate.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'SuccessCount' => ['description' => 'The number of successful worker tasks, excluding rollback tasks.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'FailedCount' => ['description' => 'The number of failed worker tasks, excluding rollback tasks.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'RollbackCount' => ['description' => 'The number of worker tasks that are rolled backed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'RollbackSuccessCount' => ['description' => 'The number of worker tasks that are successfully rolled back.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'RollbackFailedCount' => ['description' => 'The number of worker tasks that failed to be rolled back.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'CostCount' => ['description' => 'The number of resources consumed by worker tasks.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'CertCount' => ['description' => 'The number of certificates involved in the deployment task.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'ProductWorkerCount' => [
+ 'title' => '',
+ 'description' => 'The number of cloud resources to which certificates are deployed in the deployment task.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductName' => ['description' => 'The name of the cloud service. Valid values:'."\n"
+ ."\n"
+ .'- **SLB**: Classic Load Balancer (CLB). This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **LIVE**: ApsaraVideo Live. This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **webHosting**: Cloud Web Hosting. This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **VOD**: ApsaraVideo VOD. This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **CR**: Container Registry. This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **DCDN**: Dynamic Content Delivery Network (DCDN).'."\n"
+ ."\n"
+ .'- **DDOS**: Anti-DDoS.'."\n"
+ ."\n"
+ .'- **CDN**: Alibaba Cloud CDN (CDN).'."\n"
+ ."\n"
+ .'- **ALB**: Application Load Balancer (ALB).'."\n"
+ ."\n"
+ .'- **APIGateway**: API Gateway.'."\n"
+ ."\n"
+ .'- **FC**: Function Compute.'."\n"
+ ."\n"
+ .'- **GA**: Global Accelerator (GA).'."\n"
+ ."\n"
+ .'- **MSE**: Microservices Engine (MSE).'."\n"
+ ."\n"
+ .'- **NLB**: Network Load Balancer (NLB).'."\n"
+ ."\n"
+ .'- **OSS**: Object Storage Service (OSS).'."\n"
+ ."\n"
+ .'- **SAE**: Serverless App Engine (SAE).'."\n"
+ ."\n"
+ .'- **TencentCDN**: Tencent Cloud Content Delivery Network (CDN).'."\n"
+ ."\n"
+ .'- **WAF**: Web Application Firewall (WAF).', 'type' => 'string', 'title' => '', 'example' => 'NLB'],
+ 'Count' => ['description' => 'The total number of resources of a cloud service in the deployment task.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"EA69E364-5CBB-50E8-BF09-E8CAA396A4F8\\"\\n}","type":"json"}]',
- 'title' => 'UpdateDeploymentJobStatus',
- ],
- 'ListDeploymentJob' => [
- 'summary' => 'Queries a list of deployment tasks that are created.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DescribeDeploymentJobStatus',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribeDeploymentJobStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"ResourceCount\\": 4127,\\n \\"UseCount\\": 300,\\n \\"BuyCount\\": 500,\\n \\"WorkerCount\\": 20,\\n \\"MatchWorkerCount\\": 20,\\n \\"SuccessCount\\": 20,\\n \\"FailedCount\\": 20,\\n \\"RollbackCount\\": 20,\\n \\"RollbackSuccessCount\\": 20,\\n \\"RollbackFailedCount\\": 20,\\n \\"CostCount\\": 20,\\n \\"CertCount\\": 20,\\n \\"ProductWorkerCount\\": [\\n {\\n \\"ProductName\\": \\"NLB\\",\\n \\"Count\\": 2\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribePackageState' => [
+ 'summary' => 'Queries the quota and usage of domain validated (DV) certificate packages.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2325,381 +2641,421 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214571',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '81674',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'JobType',
+ 'name' => 'ProductCode',
'in' => 'query',
+ 'schema' => ['description' => 'The specifications of the certificate resource plan. Valid values:'."\n"
+ ."\n"
+ .'- **digicert-free-1-free** (default): DigiCert single-domain domain validated (DV) certificate in a three-month free trial, available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **symantec-free-1-free**: DigiCert single-domain DV certificate in a one-year free trial, available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **symantec-ov-1-personal**: DigiCert single-domain organization validated (OV) certificate.'."\n"
+ ."\n"
+ .'- **symantec-ov-w-personal**: DigiCert wildcard OV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-ov-1-personal**: GeoTrust single-domain OV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-ov-w-personal**: GeoTrust wildcard OV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-ov-1-personal**: GlobalSign single-domain OV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-ov-w-advanced**: GlobalSign wildcard OV certificate.'."\n"
+ ."\n"
+ .'- **cfca-ov-1-personal**: China Financial Certification Authority (CFCA) single-domain OV certificate, available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **cfca-ev-w-advanced**: CFCA wildcard OV certificate, available only on the China site (aliyun.com).', 'type' => 'string', 'required' => false, 'example' => 'digicert-free-1-free', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The type of the deployment task.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cloud: multi-cloud deployment task.'."\n"
- .'* user: cloud service deployment task. This type of task does not support Elastic Compute Service (ECS) instances.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cloud' => '',
- 'user' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'IssuedCount' => ['description' => 'The number of issued certificates of the specified specifications.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '10CFA380-1C58-45C7-8075-06215F3DB681', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of purchased certificate resource plans of the specified specifications.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'ProductCode' => ['description' => 'The specifications of the certificate resource plan. Valid values:'."\n"
+ ."\n"
+ .'- **digicert-free-1-free**: DigiCert single-domain DV certificate in a three-month free trial, available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **symantec-free-1-free**: DigiCert single-domain DV certificate in a one-year free trial, available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **symantec-ov-1-personal**: DigiCert single-domain OV certificate.'."\n"
+ ."\n"
+ .'- **symantec-ov-w-personal**: DigiCert wildcard OV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-ov-1-personal**: GeoTrust single-domain OV certificate.'."\n"
+ ."\n"
+ .'- **geotrust-ov-w-personal**: GeoTrust wildcard OV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-ov-1-personal**: GlobalSign single-domain OV certificate.'."\n"
+ ."\n"
+ .'- **globalsign-ov-w-advanced**: GlobalSign wildcard OV certificate.'."\n"
+ ."\n"
+ .'- **cfca-ov-1-personal**: CFCA single-domain OV certificate, available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **cfca-ev-w-advanced**: CFCA wildcard OV certificate, available only on the China site (aliyun.com).', 'type' => 'string', 'example' => 'digicert-free-1-free', 'title' => ''],
+ 'UsedCount' => ['description' => 'The number of certificate applications that you submitted for certificates of the specified specifications.'."\n"
+ ."\n"
+ .'> : A successful call of the [CreateCertificateForPackageRequest](~~204087~~), [CreateCertificateRequest](~~164105~~), or [CreateCertificateWithCsrRequest](~~178732~~) operation is counted as one a certificate application, regardless of whether the certificate is issued.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
],
- 'example' => 'user',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The status of the deployment task.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* success'."\n"
- .'* pending'."\n"
- .'* scheduling'."\n"
- .'* processing'."\n"
- .'* error'."\n"
- .'* editing'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'success' => 'success',
- 'pending' => 'pending',
- 'scheduling' => 'scheduling',
- 'processing' => 'processing',
- 'error' => 'error',
- 'editing' => 'editing',
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'DescribePackageState',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-23T08:22:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribePackageState',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'example' => 'pending',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IssuedCount\\": 1,\\n \\"RequestId\\": \\"10CFA380-1C58-45C7-8075-06215F3DB681\\",\\n \\"TotalCount\\": 20,\\n \\"ProductCode\\": \\"digicert-free-1-free\\",\\n \\"UsedCount\\": 2\\n}","type":"json"}]',
+ ],
+ 'DescribeWarehouseCert' => [
+ 'summary' => 'Retrieves the details of a certificate stored in a certificate warehouse.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '245360',
+ 'abilityTreeNodes' => ['FEATUREcasY9QF1D'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- 'name' => 'ShowSize',
+ 'name' => 'CertIdentifier',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of certificates per page. Default value: **50**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The unique identifier of the certificate.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1ef1da5f-38ed-69b3-****-037781890265'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '12345678-1234-1234-1234-123456789ABC',
- ],
- 'Total' => [
- 'description' => 'The total number of deployment tasks returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '7',
- ],
- 'CurrentPage' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ShowSize' => [
- 'description' => 'The number of deployment tasks per page. Default value: **50**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Data' => [
- 'description' => 'The data returned for the request.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => 'The ID of the deployment task. You can use the ID to query the details and status of the deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '19975',
- ],
- 'GmtCreate' => [
- 'description' => 'The time when the deployment task was created.'."\n",
- 'type' => 'string',
- 'example' => '1624343180000',
- ],
- 'GmtModified' => [
- 'description' => 'The time when the deployment task was last modified.'."\n",
- 'type' => 'string',
- 'example' => '1606482979000',
- ],
- 'UserId' => [
- 'description' => 'The ID of the user.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666884372152785',
- ],
- 'InstanceId' => [
- 'description' => 'The instance ID of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => 'cas-job-user-0gvntn',
- ],
- 'Name' => [
- 'description' => 'The name of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => 'job-test',
- ],
- 'CertType' => [
- 'description' => 'The type of the certificate. Valid values:'."\n"
- ."\n"
- .'* **upload**: uploaded certificate'."\n"
- .'* **buy**: purchased certificate'."\n"
- .'* **free**: free certificate, available only on the China site (aliyun.com)'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'upload',
- ],
- 'ScheduleTime' => [
- 'description' => 'The time when the deployment task was scheduled.'."\n",
- 'type' => 'string',
- 'example' => '1606482979000',
- ],
- 'StartTime' => [
- 'description' => 'The start time of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => '1606482979000',
- ],
- 'EndTime' => [
- 'description' => 'The end time of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => '1606482979000',
- ],
- 'Status' => [
- 'description' => 'The status of the deployment task. Valid values:'."\n"
- ."\n"
- .'* **pending**'."\n"
- .'* **editing**'."\n"
- .'* **scheduling**'."\n"
- .'* **processing**'."\n"
- .'* **error**'."\n"
- .'* **success**'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'scheduling',
- ],
- 'Del' => [
- 'description' => 'Indicates whether the deployment task is deleted. Valid values:'."\n"
- ."\n"
- .'* **0**: not deleted'."\n"
- .'* **1**: deleted'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [],
- 'example' => '1',
- ],
- 'Rollback' => [
- 'description' => 'Indicates whether the rollback worker is included. For example, if a cloud service involved in a deployment task has been rolled back, **1** is returned. Valid values:'."\n"
- ."\n"
- .'* **0**: The rollback worker is not included.'."\n"
- .'* **1**: The rollback worker is included.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [],
- 'example' => '1',
- ],
- 'JobType' => [
- 'description' => 'The type of the deployment task.'."\n"
- ."\n"
- .'* **cloud**: multi-cloud deployment task.'."\n"
- .'* **user**: cloud service deployment task. This type of task does not support ECS instances.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'user',
- ],
- 'CertDomain' => [
- 'description' => 'The domain names bound to the certificate of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => 'aliyundoc1.com,aliyundoc2.com,aliyundoc3.com',
- ],
- 'ProductName' => [
- 'description' => 'The cloud service included in the resources of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => 'NLB',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
+ 'Content' => ['description' => 'The content of the certificate, including the certificate chain.', 'type' => 'string', 'title' => '', 'example' => '---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----'],
+ 'Fingerprint' => ['description' => 'The fingerprint of the certificate content.', 'type' => 'string', 'title' => '', 'example' => 'C1291AF83F48170E48140FDFE5DADC19FE51F261'],
+ 'WarehouseInstanceId' => ['description' => 'The instance ID of the certificate warehouse.', 'type' => 'string', 'title' => '', 'example' => '66'],
+ 'CertIdentifier' => ['description' => 'The unique identifier of the certificate.', 'type' => 'string', 'title' => '', 'example' => '1ef1da5f-38ed-69b3-****-037781890265'],
+ 'CertStatus' => ['description' => 'The status of the certificate.', 'type' => 'string', 'title' => '', 'example' => 'issued'],
+ 'CertType' => ['description' => 'The type of the certificate.', 'type' => 'string', 'title' => '', 'example' => 'OV'],
+ 'CommonName' => ['description' => 'The common name of the certificate subject. This field is empty if the certificate subject does not include a common name (CN).', 'type' => 'string', 'title' => '', 'example' => 'aliyundoc.com'],
+ 'Issuer' => ['description' => 'The common name (or organization name) of the issuer.', 'type' => 'string', 'title' => '', 'example' => 'Digicert'],
+ 'IssuerIdentifier' => ['description' => 'The unique identifier of the issuer certificate.', 'type' => 'string', 'title' => '', 'example' => '1ef1da5f-38ed-69b3-****-037781890265'],
+ 'PrivateCaInstanceId' => ['description' => 'The instance ID of the private CA instance associated with the certificate.', 'type' => 'string', 'title' => '', 'example' => '1ef1da5f-38ed-69b3-****-037781890265'],
+ 'PrivateCaRegionId' => ['description' => 'The region ID of the private CA instance associated with the certificate.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'],
],
+ 'title' => '',
+ 'description' => 'OpenApiDefaultResponse',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\",\\n \\"Total\\": 7,\\n \\"CurrentPage\\": 1,\\n \\"ShowSize\\": 50,\\n \\"Data\\": [\\n {\\n \\"Id\\": 19975,\\n \\"GmtCreate\\": \\"1624343180000\\",\\n \\"GmtModified\\": \\"1606482979000\\",\\n \\"UserId\\": 0,\\n \\"InstanceId\\": \\"cas-job-user-***\\",\\n \\"Name\\": \\"job-test\\",\\n \\"CertType\\": \\"upload\\",\\n \\"ScheduleTime\\": \\"1606482979000\\",\\n \\"StartTime\\": \\"1606482979000\\",\\n \\"EndTime\\": \\"1606482979000\\",\\n \\"Status\\": \\"scheduling\\",\\n \\"Del\\": 1,\\n \\"Rollback\\": 1,\\n \\"JobType\\": \\"user\\",\\n \\"CertDomain\\": \\"aliyundoc1.com,aliyundoc2.com,aliyundoc3.com\\",\\n \\"ProductName\\": \\"NLB\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListDeploymentJob',
+ 'title' => 'DescribeWarehouseCert',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"Content\\": \\"---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----\\",\\n \\"Fingerprint\\": \\"C1291AF83F48170E48140FDFE5DADC19FE51F261\\",\\n \\"WarehouseInstanceId\\": \\"66\\",\\n \\"CertIdentifier\\": \\"1ef1da5f-38ed-69b3-****-037781890265\\",\\n \\"CertStatus\\": \\"issued\\",\\n \\"CertType\\": \\"OV\\",\\n \\"CommonName\\": \\"aliyundoc.com\\",\\n \\"Issuer\\": \\"Digicert\\",\\n \\"IssuerIdentifier\\": \\"1ef1da5f-38ed-69b3-****-037781890265\\",\\n \\"PrivateCaInstanceId\\": \\"1ef1da5f-38ed-69b3-****-037781890265\\",\\n \\"PrivateCaRegionId\\": \\"cn-hangzhou\\"\\n}","type":"json"}]',
],
- 'UpdateDeploymentJob' => [
- 'summary' => 'Updates a deployment task.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'Encrypt' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '214599',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖真实的，短信验证通过的手机，无法自动化测试',
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '155852',
+ 'abilityTreeNodes' => ['FEATUREcasVZUJH0'],
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'Plaintext',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the JobId parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '8888',
- ],
+ 'schema' => ['description' => 'The data to encrypt. The data can be plaintext or Base64-encoded plaintext. For more information, see the MessageType parameter. If you use Base64 encoding, for example, if the hexadecimal content of the data to be encrypted is `[0x31, 0x32, 0x33, 0x34]`, the corresponding Base64-encoded string is MTIzNA==. The maximum size of Plaintext depends on the Algorithm:'."\n"
+ ."\n"
+ .'- **RSAES\\_OAEP\\_SHA\\_1**: 214 bytes.'."\n"
+ ."\n"
+ .'- **RSAES\\_OAEP\\_SHA\\_256**: 190 bytes.'."\n"
+ ."\n"
+ .'- **SM2PKE**: 6047 bytes.', 'type' => 'string', 'required' => true, 'example' => '1234***', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'CertIdentifier',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务名称',
- 'description' => 'The name of the deployment task.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cert-1',
- ],
+ 'schema' => ['description' => 'The unique identifier of the certificate. To obtain this parameter, call the [ListCert](~~455806~~) operation.'."\n"
+ ."\n"
+ .'- The identifier of an SSL certificate is usually in the {Certificate ID}-cn-hangzhou format.'."\n"
+ ."\n"
+ .'- For a private certificate authority (PCA) certificate, this is the value of the Identifier field of the private certificate.', 'type' => 'string', 'required' => false, 'example' => '1ef1da5f-38ed-69b3-****-037781890265', 'title' => ''],
],
[
- 'name' => 'CertIds',
+ 'name' => 'Algorithm',
'in' => 'query',
- 'schema' => [
- 'title' => '证书IDs',
- 'description' => 'The ID of the certificate. Separate multiple certificate IDs with commas (,). You can call the [ListUserCertificateOrder](~~455804~~) operation to obtain the ID of a certificate from the **CertificateId** parameter.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '9957285,12067351,12304338,12342649',
- ],
+ 'schema' => ['description' => 'The encryption algorithm. Valid values:'."\n"
+ ."\n"
+ .'- **RSAES\\_OAEP\\_SHA\\_1**'."\n"
+ ."\n"
+ .'- **RSAES\\_OAEP\\_SHA\\_256**'."\n"
+ ."\n"
+ .'- **SM2PKE**', 'type' => 'string', 'required' => true, 'example' => 'RSAESOAEPSHA_1', 'title' => ''],
],
[
- 'name' => 'ResourceIds',
+ 'name' => 'MessageType',
'in' => 'query',
'schema' => [
- 'title' => '资源Ids',
- 'description' => 'The ID of the cloud resource. Separate multiple resource IDs with commas (,). You can call the [ListCloudResources](~~2712230~~) operation to obtain the ID of a cloud resource from the **Id** parameter.'."\n",
+ 'description' => 'The message type. Valid values:'."\n"
+ ."\n"
+ .'- RAW (default): Directly encrypts the value of Plaintext.'."\n"
+ ."\n"
+ .'- Base64: Decodes the Base64-encoded value of Plaintext and then encrypts the decoded data.',
+ 'enumValueTitles' => ['Base64' => 'Base64', 'RAW' => 'RAW'],
'type' => 'string',
'required' => false,
- 'example' => '9957285,12067351,12304338,12342649',
+ 'example' => 'RAW',
+ 'title' => '',
],
],
[
- 'name' => 'ContactIds',
+ 'name' => 'CustomIdentifier',
'in' => 'query',
- 'schema' => [
- 'title' => '联系人IDs',
- 'description' => 'The ID of the contact. Separate multiple contact IDs with commas (,). You can call the [ListContact](~~2712221~~) operation to obtain the ID of a contact from the **ContactId** parameter.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '9957285,12067351,12304338,12342649',
- ],
+ 'schema' => ['description' => 'The custom identifier, which serves as a unique key.', 'type' => 'string', 'required' => false, 'example' => '****6bb538d538c70c01f81dg3****', 'title' => ''],
],
[
- 'name' => 'ScheduleTime',
+ 'name' => 'WarehouseId',
'in' => 'query',
+ 'schema' => ['description' => 'The repository ID.'."\n"
+ ."\n"
+ .'> To obtain this ID, call the [ListCertWarehouse](~~455805~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '任务调度时间',
- 'description' => 'The time when the task starts. The value is a UNIX timestamp. If you do not specify this parameter, the system immediately starts the task after it is created.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1606482979000',
+ 'description' => 'Object',
+ 'type' => 'object',
+ 'properties' => [
+ 'CertIdentifier' => ['description' => 'The unique identifier of the certificate.', 'type' => 'string', 'example' => '1ef1da5f-38ed-69b3-****-037781890265', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5979d897-d69f-4fc9-87dd-f3bb73c40b80', 'title' => ''],
+ 'CiphertextBlob' => ['description' => 'The encrypted data. The data is Base64-encoded.', 'type' => 'string', 'example' => 'ZOyIygCyaOW6Gj****MlNKiuyjfzw=', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'title' => 'Encrypt',
+ 'summary' => 'Encrypts data by using a certificate in a certificate application repository.',
+ 'description' => 'The queries per second (QPS) limit for a single user is 10. If you exceed this limit, API calls are throttled, which may affect your business. To prevent this, call this operation at a reasonable rate.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:Encrypt',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertIdentifier\\": \\"1ef1da5f-38ed-69b3-****-037781890265\\",\\n \\"RequestId\\": \\"5979d897-d69f-4fc9-87dd-f3bb73c40b80\\",\\n \\"CiphertextBlob\\": \\"ZOyIygCyaOW6Gj****MlNKiuyjfzw=\\"\\n}","type":"json"}]',
+ ],
+ 'GetAssetCount' => [
+ 'summary' => 'Queries the total number of certificate-related assets, such as websites and cloud resources.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '234188',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<UpdateDeploymentResult>',
- 'description' => 'OpenApiDefaultResponse.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76',
- ],
+ 'Point' => ['description' => 'Generated perspective.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'PointTime' => ['description' => 'Health score update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767681210879', 'title' => ''],
+ 'PointRatio' => ['description' => 'Health score ratio.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'BuyCertificateCount' => ['description' => 'Number of paid certificates.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'FreeCertificateCount' => ['description' => 'Number of free certificates.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'UploadCertificateCount' => ['description' => 'Number of uploaded certificates.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'AliyunAssetCount' => ['description' => 'Total number of Alibaba Cloud resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TencentAssetCount' => ['description' => 'Total number of Tencent Cloud resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'HuaweiAssetCount' => ['description' => 'Total number of Huawei Cloud resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'This ID is a unique identifier generated by Alibaba Cloud for the request. Use it to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'EECA10D5-BD0F-4EF1-B3EA-B4578E5C6F8E', 'title' => ''],
+ 'AwsAssetCount' => ['description' => 'Total number of Amazon Cloud resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'DomainAssetCount' => ['description' => 'Total number of Domain Name resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'LastPoint' => ['description' => 'Last health score.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]',
- 'title' => 'UpdateDeploymentJob',
+ 'title' => 'GetAssetCount',
+ 'description' => 'This API call queries the number of CA certificates that you have created, including root CA certificates and sub-CA certificates.'."\n"
+ ."\n"
+ .'## QPS Limit'."\n"
+ ."\n"
+ .'This API call has a single-user limit of 10 queries per second (QPS). If you exceed this limit, API calls are rate-limited. This may affect your business. We recommend that you call this API operation at a reasonable rate.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Point\\": 50,\\n \\"PointTime\\": 1767681210879,\\n \\"PointRatio\\": 1,\\n \\"BuyCertificateCount\\": 10,\\n \\"FreeCertificateCount\\": 10,\\n \\"UploadCertificateCount\\": 10,\\n \\"AliyunAssetCount\\": 10,\\n \\"TencentAssetCount\\": 10,\\n \\"HuaweiAssetCount\\": 10,\\n \\"RequestId\\": \\"EECA10D5-BD0F-4EF1-B3EA-B4578E5C6F8E\\",\\n \\"AwsAssetCount\\": 10,\\n \\"DomainAssetCount\\": 10,\\n \\"LastPoint\\": 60\\n}","type":"json"}]',
],
- 'DescribeDeploymentJob' => [
- 'summary' => 'Queries the details of a deployment task. You can call the CreateDeploymentJob operation to create a deployment task and obtain the ID of the task.',
- 'methods' => [
- 'get',
- 'post',
+ 'GetCertWarehouseQuota' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '159262',
+ 'abilityTreeNodes' => ['FEATUREcasY9QF1D'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalQuota' => ['description' => 'The total quota for the electronic contract signing service. This includes both complimentary and purchased quotas.', 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
+ 'UseCount' => ['description' => 'The used quota for the electronic contract signing service.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'AppTotalQuota' => ['description' => 'The total quota for the certificate application service. This includes both complimentary and purchased quotas.', 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''],
+ 'AppUseCount' => ['description' => 'The used quota for the certificate application service.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'GetCertWarehouseQuota',
+ 'summary' => 'Queries the remaining quota for certificate application repository operations.',
+ 'description' => 'The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed the limit, your API calls are throttled. This may impact your business. Call this operation at a reasonable rate.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetCertWarehouseQuota',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalQuota\\": 5000,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"UseCount\\": 1000,\\n \\"AppTotalQuota\\": 5000,\\n \\"AppUseCount\\": 1000\\n}","type":"json"}]',
+ ],
+ 'GetCertificateDetail' => [
+ 'summary' => 'Retrieves certificate details, excluding the certificate body and private key.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2711,224 +3067,155 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214580',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的手机号，无法自动化测试',
+ 'abilityTreeCode' => '213379',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'CertificateId',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment job. The **ID** of the job is returned after you call the [CreateDeploymentJob](~~2712234~~) operation. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '8888',
- ],
+ 'schema' => ['description' => 'The certificate ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '18594156', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<DeploymentJob>',
- 'description' => 'OpenApiDefaultResponse.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
- 'Id' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment job.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8888',
- ],
- 'GmtCreate' => [
- 'title' => '部署任务创建时间',
- 'description' => 'The time when the deployment job was created. The value is a UNIX timestamp. Unit: seconds.'."\n",
- 'type' => 'string',
- 'example' => '1679541809000',
- ],
- 'GmtModified' => [
- 'title' => '部署任务上次修订时间',
- 'description' => 'The time when the deployment job was last modified. The value is a UNIX timestamp. Unit: seconds.'."\n",
- 'type' => 'string',
- 'example' => '1679541809000',
- ],
- 'UserId' => [
- 'title' => '部署任务Owner',
- 'description' => 'The ID of the Alibaba Cloud account in which the deployment job is created.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '166688437XXXX785',
- ],
- 'InstanceId' => [
- 'title' => '部署任务实例ID',
- 'description' => 'The instance ID of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => '14dcc8afc7578e1f',
- ],
- 'Name' => [
- 'title' => '部署任务名称',
- 'description' => 'The name of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => 'auto-test-AXX',
- ],
- 'CertType' => [
- 'title' => '证书类型：',
- 'description' => 'The type of the certificate. Valid values:'."\n"
- ."\n"
- .'* **upload**: uploaded certificate'."\n"
- .'* **buy**: purchased certificate'."\n"
- .'* **free**: free certificate available only on the China site (aliyun.com)'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'buy',
- ],
- 'ScheduleTime' => [
- 'title' => '部署任务计划调度时间',
- 'description' => 'The time when the deployment job was scheduled. The value is a UNIX timestamp. Unit: seconds.'."\n",
- 'type' => 'string',
- 'example' => '1678083209335',
- ],
- 'StartTime' => [
- 'title' => '部署任务执行开始时间',
- 'description' => 'The start time of the deployment job. The value is a UNIX timestamp. Unit: seconds.'."\n",
- 'type' => 'string',
- 'example' => '1679541809000',
- ],
- 'EndTime' => [
- 'title' => '部署任务执行结束时间',
- 'description' => 'The end time of the deployment job. The value is a UNIX timestamp. Unit: seconds.'."\n",
- 'type' => 'string',
- 'example' => '1679541809000',
- ],
- 'Status' => [
- 'title' => '部署任务状态：',
- 'description' => 'The status of the deployment job. Valid values:'."\n"
- ."\n"
- .'* **pending**'."\n"
- .'* **editing**'."\n"
- .'* **scheduling**'."\n"
- .'* **processing**'."\n"
- .'* **error**'."\n"
- .'* **success**'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'editing',
- ],
- 'Del' => [
- 'title' => '是否已删除',
- 'description' => 'Indicates whether the deployment job was deleted. Valid values:'."\n"
- ."\n"
- .'* **0**: not deleted'."\n"
- .'* **1**: deleted'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [],
- 'example' => '1',
- ],
- 'Rollback' => [
- 'title' => '是否包含回滚worker',
- 'description' => 'Indicates whether the deployment job includes the rollback worker. For example, if a cloud service in a deployment job has been rolled back, **1** is returned. Valid values:'."\n"
- ."\n"
- .'* **0**: The rollback worker is not included.'."\n"
- .'* **1**: The rollback worker is included.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [],
- 'example' => '1',
- ],
- 'JobType' => [
- 'title' => '任务类型：',
- 'description' => 'The type of the deployment job. Valid values:'."\n"
- ."\n"
- .'* **cloud**: multi-cloud deployment job.'."\n"
- .'* **trustee**: hosted deployment job available only on the China site (aliyun.com).'."\n"
- .'* **user**: cloud service deployment job. The cloud server is not included.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'user',
- ],
- 'CertDomain' => [
- 'title' => '部署任务证书包含域名（多个）',
- 'description' => 'The domain names bound to the certificate of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => 'example.aliyundoc.com,demo.aliyundoc.com',
+ 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'cas_dv-cn-123', 'title' => ''],
+ 'CommonName' => ['description' => 'The common name.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5979d897-d69f-4fc9-87dd-f3bb73c40b80', 'title' => ''],
+ 'Algorithm' => ['description' => 'The certificate algorithm. Valid values:'."\n"
+ ."\n"
+ .'- **RSA**: The RSA algorithm.'."\n"
+ ."\n"
+ .'- **ECC**: The ECC algorithm.'."\n"
+ ."\n"
+ .'- **SM2**: The SM2 algorithm.', 'type' => 'string', 'example' => 'RSA', 'title' => ''],
+ 'Domain' => ['description' => 'The domain names that are bound to the certificate. Multiple domain names are separated by commas (,).', 'type' => 'string', 'example' => 'aliyundoc.com,example.aliyundoc.com', 'title' => ''],
+ 'CertificateId' => ['description' => 'The certificate ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '22559621', 'title' => ''],
+ 'CertificateName' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'CertIdentifier' => ['description' => 'The global ID of the certificate, which is used in various Alibaba Cloud services. The format of the ID is `<Certificate ID>-<Region ID>`. The region ID is `cn-hangzhou` for the China site and `ap-southeast-1` for the International site. For example, if a certificate ID is `123`, its `CertIdentifier` is `123-cn-hangzhou` for the China site and `123-ap-southeast-1` for the International site.', 'type' => 'string', 'example' => '21912069-cn-hangzhou', 'title' => ''],
+ 'CertificateSource' => ['description' => 'The source of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **BUY**: a purchased certificate.'."\n"
+ ."\n"
+ .'- **TEST**: a test certificate.'."\n"
+ ."\n"
+ .'- Upload the certificate.', 'type' => 'string', 'example' => 'BUY', 'title' => ''],
+ 'CertificateStatus' => ['description' => 'The status of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **issued**: The certificate is issued.'."\n"
+ ."\n"
+ .'- **revoked**: The certificate is revoked.'."\n"
+ ."\n"
+ .'- **willExpire**: The certificate is about to expire.'."\n"
+ ."\n"
+ .'- **expired**: The certificate has expired.', 'type' => 'string', 'example' => 'issued', 'title' => ''],
+ 'Csr' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----'],
+ 'NotBefore' => ['description' => 'The beginning of the validity period of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '17321613180000', 'title' => ''],
+ 'NotAfter' => ['description' => 'The end of the validity period of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '17326613180000', 'title' => ''],
+ 'CompanyId' => ['description' => 'The ID of the company profile that is associated with the certificate application. This parameter is empty for DV certificates.', 'type' => 'integer', 'format' => 'int64', 'example' => '44211', 'title' => ''],
+ 'ContactId' => ['description' => 'The ID of the contact.', 'type' => 'integer', 'format' => 'int64', 'example' => '304066', 'title' => ''],
+ 'KeySize' => ['description' => 'The key size.'."\n"
+ ."\n"
+ .'- For RSA algorithms, the key size is typically 2,048, 3,072, or 4,096 bits.'."\n"
+ ."\n"
+ .'- For ECC and SM2 algorithms, the key size is typically 256 bits.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''],
+ 'SubjectAlternativeNames' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'An SAN.', 'type' => 'string', 'example' => 'aliyundoc.com', 'title' => ''],
+ 'description' => 'The subject alternative names (SANs) of the certificate.',
+ 'title' => '',
+ 'example' => '',
],
- 'ProductName' => [
- 'title' => '部署任务资源包含云产品（多个）',
- 'description' => 'The cloud services included in the deployment task.'."\n",
- 'type' => 'string',
- 'example' => 'CDN',
+ 'Serial' => ['description' => 'The serial number of the certificate.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'ExistPrivateKey' => ['description' => 'Indicates whether a private key is available. Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'UsingProductList' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The cloud service.', 'type' => 'string', 'example' => 'CDN', 'title' => ''],
+ 'description' => 'The list of cloud services in which the certificate is deployed.',
+ 'title' => '',
+ 'example' => '',
],
- 'Config' => [
- 'title' => '部署任务配置',
- 'description' => 'The configurations of the deployment task.'."\n",
- 'type' => 'string',
- 'example' => '{\\"shareCertIds\\":[],\\"certIds\\":[12342649,12304338,12067351,9957285]}',
+ 'FingerPrint' => ['description' => 'The fingerprint of the public key.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'CertificateChainList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Issuer' => ['description' => 'The issuer of the certificate chain.', 'type' => 'string', 'example' => 'Digicert', 'title' => ''],
+ 'Subject' => ['description' => 'The common name of the certificate chain.', 'type' => 'string', 'example' => 'Digicert', 'title' => ''],
+ 'RemainDay' => ['description' => 'The remaining validity period of the certificate chain.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'NotBefore' => ['description' => 'The beginning of the validity period.', 'type' => 'integer', 'format' => 'int64', 'example' => '17321613180000', 'title' => ''],
+ 'NotAfter' => ['description' => 'The end of the validity period.', 'type' => 'integer', 'format' => 'int64', 'example' => '17326613180000', 'title' => ''],
+ ],
+ 'description' => 'The information about the certificate chain.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The information about the certificate chain.',
+ 'title' => '',
+ 'example' => '',
],
- 'CasContacts' => [
- 'description' => 'The information about the contact.'."\n",
+ 'Issuer' => ['description' => 'The issuer of the certificate.', 'type' => 'string', 'example' => 'Digicert', 'title' => ''],
+ 'Tags' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => 'The ID of the contact.'."\n",
- 'type' => 'string',
- 'example' => '3304',
- ],
- 'Name' => [
- 'description' => 'The name of the contact.'."\n",
- 'type' => 'string',
- 'example' => 'zhangsan',
- ],
- 'Mobile' => [
- 'description' => 'The phone number of the contact.'."\n",
- 'type' => 'string',
- 'example' => '139****0000',
- ],
- 'Email' => [
- 'description' => 'The email address of the contact.'."\n",
- 'type' => 'string',
- 'example' => 'username@example.com',
- ],
+ 'TagKey' => ['description' => 'The tag key of the instance. You can specify 1 to 20 tag keys. The value cannot be an empty string.'."\n"
+ ."\n"
+ .'The value can be up to 64 characters in length, cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
+ 'description' => 'The list of tags.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'The list of tags.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Id\\": 43222,\\n \\"GmtCreate\\": \\"1679541809000\\",\\n \\"GmtModified\\": \\"1679541809000\\",\\n \\"UserId\\": 0,\\n \\"InstanceId\\": \\"14dcc8afc7578e1f\\",\\n \\"Name\\": \\"auto-test-AXX\\",\\n \\"CertType\\": \\"buy\\",\\n \\"ScheduleTime\\": \\"1678083209335\\",\\n \\"StartTime\\": \\"1679541809000\\",\\n \\"EndTime\\": \\"1679541809000\\",\\n \\"Status\\": \\"editing\\",\\n \\"Del\\": 1,\\n \\"Rollback\\": 1,\\n \\"JobType\\": \\"user\\",\\n \\"CertDomain\\": \\"example.aliyundoc.com,demo.aliyundoc.com\\",\\n \\"ProductName\\": \\"CDN\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"shareCertIds\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"certIds\\\\\\\\\\\\\\":[12342649,12304338,12067351,9957285]}\\",\\n \\"CasContacts\\": [\\n {\\n \\"Id\\": \\"3304\\",\\n \\"Name\\": \\"John\\",\\n \\"Mobile\\": \\"139****0000\\",\\n \\"Email\\": \\"username@example.com\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DescribeDeploymentJob',
- ],
- 'ListWorkerResource' => [
- 'summary' => 'Queries the details about the worker tasks of a deployment task. Alibaba Cloud allows you to deploy multiple certificates at a time. Therefore, a deployment task may include multiple worker tasks in multiple cloud services. A worker task refers to a task that deploys a certificate to a cloud resource in a cloud service.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'GetCertificateDetail',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetCertificateDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"cas_dv-cn-123\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"RequestId\\": \\"5979d897-d69f-4fc9-87dd-f3bb73c40b80\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"Domain\\": \\"aliyundoc.com,example.aliyundoc.com\\",\\n \\"CertificateId\\": 22559621,\\n \\"CertificateName\\": \\"123\\",\\n \\"CertIdentifier\\": \\"21912069-cn-hangzhou\\",\\n \\"CertificateSource\\": \\"BUY\\",\\n \\"CertificateStatus\\": \\"issued\\",\\n \\"Csr\\": \\"-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----\\",\\n \\"NotBefore\\": 17321613180000,\\n \\"NotAfter\\": 17326613180000,\\n \\"CompanyId\\": 44211,\\n \\"ContactId\\": 304066,\\n \\"KeySize\\": 2048,\\n \\"SubjectAlternativeNames\\": [\\n \\"aliyundoc.com\\"\\n ],\\n \\"Serial\\": \\"123\\",\\n \\"ExistPrivateKey\\": true,\\n \\"UsingProductList\\": [\\n \\"CDN\\"\\n ],\\n \\"FingerPrint\\": \\"123\\",\\n \\"CertificateChainList\\": [\\n {\\n \\"Issuer\\": \\"Digicert\\",\\n \\"Subject\\": \\"Digicert\\",\\n \\"RemainDay\\": 10,\\n \\"NotBefore\\": 17321613180000,\\n \\"NotAfter\\": 17326613180000\\n }\\n ],\\n \\"Issuer\\": \\"Digicert\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"test\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetCsrDetail' => [
+ 'summary' => 'Queries the content of a certificate signing request (CSR).',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2937,542 +3224,319 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214605',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '213379',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'CsrId',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the **ID** parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '8888',
- ],
+ 'schema' => ['description' => 'The ID of the CSR.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3924', 'title' => ''],
],
- [
- 'name' => 'Status',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '部署任务worker状态：',
- 'description' => 'The status of the worker task.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* rollback'."\n"
- .'* rollback_error'."\n"
- .'* success'."\n"
- .'* rollback_success'."\n"
- .'* pending'."\n"
- .'* scheduling'."\n"
- .'* processing'."\n"
- .'* error'."\n"
- .'* editing'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'rollback' => '',
- 'rollback_error' => '',
- 'success' => '',
- 'rollback_success' => '',
- 'pending' => '',
- 'scheduling' => '',
- 'processing' => '',
- 'error' => '',
- 'editing' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Csr' => ['description' => 'The content of the CSR.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', 'title' => ''],
+ 'PrivateKey' => ['description' => 'The private key. Specify a Base64-encoded string.', 'type' => 'string', 'example' => '-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '08F45EA0-66A7-4504-9B31-3589F5CE308D', 'title' => ''],
],
- 'example' => 'editing',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'CloudProduct',
- 'in' => 'query',
- 'schema' => [
- 'title' => '部署任务worker状态：',
- 'description' => 'The cloud service in the deployment task.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NLB',
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'GetCsrDetail',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-20T09:20:31.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetCsrDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Csr\\": \\"-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----\\",\\n \\"PrivateKey\\": \\"-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----\\",\\n \\"RequestId\\": \\"08F45EA0-66A7-4504-9B31-3589F5CE308D\\"\\n}","type":"json"}]',
+ ],
+ 'GetInstanceDetail' => [
+ 'summary' => 'Queries the details of an instance.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: **1**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '213379',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- 'name' => 'ShowSize',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Default value: 50.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cas_dv-cn-123', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiPaginationResponse<WorkerResource>',
- 'description' => 'OpenApiPaginationResponse'."\n",
'type' => 'object',
'properties' => [
- 'Total' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8',
- ],
- 'CurrentPage' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'cas_dv-cn-123', 'title' => ''],
+ 'InstanceType' => ['description' => 'The instance type. Valid values:'."\n"
+ .'- **BUY**: formal certificate.'."\n"
+ .'- **TEST**: test certificate.', 'type' => 'string', 'example' => 'TEST', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => 'B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9', 'title' => ''],
+ 'KeyAlgorithm' => ['description' => 'The certificate algorithm. Valid values:'."\n"
+ .'- **RSA_2048**'."\n"
+ .'- **RSA_3072**'."\n"
+ .'- **RSA_4096**'."\n"
+ .'- **ECC_256**'."\n"
+ .'- **SM2**.', 'type' => 'string', 'example' => 'RSA_2048', 'title' => ''],
+ 'Status' => ['description' => 'The instance status. Valid values:'."\n"
+ .'- **inactive**: pending use.'."\n"
+ .'- **pending**: under review. The latest certificate is being reviewed.'."\n"
+ .'- **willExpire**: the instance is about to expire.'."\n"
+ .'- **expired**: the instance has expired.'."\n"
+ .'- **refund**: refunded.'."\n"
+ .'- **normal**: normal.'."\n"
+ .'- **closed**: closed and unavailable.', 'type' => 'string', 'example' => 'inactive', 'title' => ''],
+ 'Domain' => ['description' => 'The domain name bound to the certificate.', 'type' => 'string', 'example' => 'example.com', 'title' => ''],
+ 'CertificateId' => ['description' => 'The certificate ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1234567890', 'title' => ''],
+ 'CertificateName' => ['description' => 'The name of the instance. When a certificate is issued, this name is used as the default certificate name.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'CertIdentifier' => ['description' => 'The global certificate ID, in the format of certificate ID + "-" + site region ID. This ID is commonly used across Alibaba Cloud services.'."\n"
+ .' --For the China site, the format is certificate ID + "-cn-hangzhou".'."\n"
+ .'For the China site, the format is certificate ID + "-ap-southeast-1".'."\n"
+ .'For example, if the certificate ID is 123, the CertIdentifier on the China site is "123-cn-hangzhou", and the CertIdentifier on the China site is "123-ap-southeast-1".', 'type' => 'string', 'example' => '22783111-cn-hangzhou', 'title' => ''],
+ 'Spec' => ['description' => 'The purchased instance specification.', 'type' => 'string', 'example' => 'ss.dv.t', 'title' => ''],
+ 'CertificateType' => ['description' => 'The type of the certificate. Valid values: DV, OV, and EV.', 'type' => 'string', 'example' => 'DV', 'title' => ''],
+ 'CertificateStatus' => ['description' => 'The status of the certificate. Valid values:'."\n"
+ .'- **issued**: issued.'."\n"
+ .'- **revoked**: revoked.'."\n"
+ .'- **willExpire**: about to expire.'."\n"
+ .'- **expired**: expired.', 'type' => 'string', 'example' => 'issued', 'title' => ''],
+ 'CertificateNotAfter' => ['description' => 'The end time of the latest certificate. The value is a UNIX timestamp. This field is empty if no certificate has been issued.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'CertificateNotBefore' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'OrderEndTime' => ['description' => 'The end time of the instance purchase. The value is a UNIX timestamp. You can use this value to determine the purchase duration of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'InstanceStartTime' => ['description' => 'The start time of the instance. The value is a UNIX timestamp. If no certificate has been issued, this field is empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'InstanceEndTime' => ['description' => 'The expiration time of the instance. The value is a UNIX timestamp. If no certificate has been issued, this field is empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'FullDomainCount' => ['description' => 'The number of exact-match domain names.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'WildcardDomainCount' => ['description' => 'The number of wildcard domain names.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'CompanyId' => ['description' => 'The company information ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '47305', 'title' => ''],
+ 'ContactIdList' => [
+ 'description' => 'The list of contact IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'ShowSize' => [
- 'description' => 'The number of entries per page. Default value: **50**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
+ 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aek****wia', 'title' => ''],
+ 'DomainValidationList' => [
+ 'description' => 'The list of domain names to be validated.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The domain name to be validated.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Domain' => ['description' => 'The domain name to be validated.', 'type' => 'string', 'example' => 'example.com', 'title' => ''],
+ 'RootDomain' => ['description' => 'The root domain name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''],
+ 'ValidationType' => ['description' => 'The validation type. Valid values: TXT, HTTP, and CNAME.', 'type' => 'string', 'example' => 'TXT', 'title' => ''],
+ 'ValidationValue' => ['description' => 'The host record value for validation.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'ValidationKey' => ['description' => 'The host record.', 'type' => 'string', 'example' => '@', 'title' => ''],
+ 'Cname' => ['description' => 'The CNAME record value for verification-free authorization. This field may be empty.', 'type' => 'string', 'example' => '123.com', 'title' => ''],
+ 'CnameKey' => ['description' => 'The prefix for CNAME validation.', 'type' => 'string', 'example' => 'abc', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'Data' => [
- 'description' => 'The response parameters.'."\n",
+ 'City' => ['description' => 'The city where the company or organization of the certificate purchaser is located. This field is required when generating a certificate signing request. Default value: Beijing.', 'type' => 'string', 'example' => 'Beijing', 'title' => ''],
+ 'Province' => ['description' => 'The province or region where the company is located. This field is required when generating a certificate signing request. Default value: Beijing.', 'type' => 'string', 'example' => 'Beijing', 'title' => ''],
+ 'CountryCode' => ['description' => 'The code of the country or region where the certificate organization is located. For example, CN indicates China, and US indicates the United States. This field is required when generating a certificate signing request. Default value: CN.', 'type' => 'string', 'example' => 'CN', 'title' => ''],
+ 'Csr' => ['description' => 'The certificate signing request in PEM format.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', 'title' => ''],
+ 'ValidationMethod' => ['description' => 'The validation method for the certificate application. Valid values:'."\n"
+ .'- DNS: DNS validation, using TXT or CNAME.'."\n"
+ .'- HTTP: file-based validation.', 'type' => 'string', 'example' => 'DNS', 'title' => ''],
+ 'AverageWaitingTime' => ['description' => 'The average waiting time for issuing a certificate of this specification. Unit: seconds.', 'type' => 'string', 'example' => '120', 'title' => ''],
+ 'DingGroupList' => [
+ 'description' => 'The list of associated expert service DingTalk groups.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The associated expert service DingTalk group.',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '部署任务WorkerId',
- 'description' => 'The ID of the worker task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22487',
- ],
- 'GmtCreate' => [
- 'title' => '部署任务Worker创建时间',
- 'description' => 'The time when the worker task was created. The time is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'example' => '1680228896000',
- ],
- 'GmtModified' => [
- 'title' => '部署任务Worker最后修订时间',
- 'description' => 'The time when the worker task was last modified. The time is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'example' => '1681956830000',
- ],
- 'UserId' => [
- 'title' => '部署任务Worker Owner',
- 'description' => 'The ID of the Alibaba Cloud account to which the worker task belongs.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666884372152785',
- ],
- 'JobId' => [
- 'title' => '部署任务Worker JobId',
- 'description' => 'The ID of the deployment task to which the worker task belongs.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8888',
- ],
- 'OrderId' => [
- 'title' => '部署任务Worker OrderId，与CertOrder值一致',
- 'description' => 'The order ID of the worker task, which is the same as the order ID of the certificate.'."\n"
- ."\n"
- .'> If the CertId parameter is returned, this parameter is not returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9349278',
- ],
- 'CertId' => [
- 'title' => '部署任务Worker CertId，与UserCert值一致',
- 'description' => 'The ID of the certificate in the worker task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12073663',
- ],
- 'CertDomain' => [
- 'title' => '部署任务Worker证书域名，与UserCert/CertOrder值一致',
- 'description' => 'The domain name bound to the certificate in the worker task.'."\n",
- 'type' => 'string',
- 'example' => 'www.example.com',
- ],
- 'CertInstanceId' => [
- 'title' => '部署任务Worker证书实例ID，与UserCert/CertOrder值一致',
- 'description' => 'The instance ID of the certificate in the worker task.'."\n",
- 'type' => 'string',
- 'example' => 'lsn-jzk2h0xz5dmynuphb8@1883',
- ],
- 'CertName' => [
- 'title' => '部署任务Worker证书名称，与UserCert/CertOrder值一致',
- 'description' => 'The name of the certificate in the worker task.'."\n",
- 'type' => 'string',
- 'example' => 'testCertName',
- ],
- 'ResourceId' => [
- 'title' => '部署任务Worker云资源ID，与CloudResource值一致',
- 'description' => 'The ID of the cloud resource in the worker task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1286999',
- ],
- 'CloudProduct' => [
- 'title' => '部署任务Worker云资源所属云产品，与CloudResource值一致',
- 'description' => 'The cloud service to which the cloud resource in the worker task belongs. Valid values:'."\n"
- ."\n"
- .'* **CDN**: Alibaba Cloud CDN (CDN). This value is supported only at the China site (aliyun.com).'."\n"
- .'* **SLB**: Classic Load Balancer (CLB). This value is supported only at the China site (aliyun.com).'."\n"
- .'* **DCDN**: Dynamic Content Delivery Network (DCDN). This value is supported only at the China site (aliyun.com).'."\n"
- .'* **DDOS**: Anti-DDoS. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **LIVE**: ApsaraVideo Live. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **webHosting**: Cloud Web Hosting. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **VOD**: ApsaraVideo VOD. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **CR**: Container Registry. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **ALB**: Application Load Balancer (ALB).'."\n"
- .'* **APIGateway**: API Gateway.'."\n"
- .'* **FC**: Function Compute.'."\n"
- .'* **GA**: Global Accelerator (GA).'."\n"
- .'* **MSE**: Microservices Engine (MSE).'."\n"
- .'* **NLB**: Network Load Balancer (NLB).'."\n"
- .'* **OSS**: Object Storage Service (OSS).'."\n"
- .'* **SAE**: Serverless App Engine (SAE).'."\n"
- .'* **TencentCDN**: Tencent Cloud Content Delivery Network (CDN).'."\n"
- .'* **WAF**: Web Application Firewall (WAF).'."\n",
- 'type' => 'string',
- 'example' => 'SLB',
- ],
- 'ResourceCertId' => [
- 'title' => '部署任务Worker云资源当前绑定证书ID，与CloudResource值一致',
- 'description' => 'The ID of the certificate that was originally bound to the cloud resource in the worker task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'ResourceDomain' => [
- 'title' => '部署任务Worker云资源配置域名，与CloudResource值一致',
- 'description' => 'The domain name that was originally bound to the cloud resource in the worker task.'."\n",
- 'type' => 'string',
- 'example' => 'www.example.com',
- ],
- 'RegionId' => [
- 'title' => '部署任务Worker云资源RegionID，与CloudResource值一致',
- 'description' => 'The region ID of the cloud resource in the worker task.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'CloudRegion' => [
- 'title' => '部署任务Worker云资源原始RegionID（云厂商的RegionID），与CloudResource值一致',
- 'description' => 'The original region ID of the cloud resource in the worker task. The value is the region ID defined by the cloud service provider. This parameter is required only when you deploy certificates to services of multiple clouds.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'InstanceId' => [
- 'title' => '部署任务Worker云资源实例ID，与CloudResource值一致',
- 'description' => 'The ID of the cloud resource in the worker task.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'string',
- 'example' => 'cas-cn-0pp118nuu40b',
- ],
- 'ListenerId' => [
- 'title' => '部署任务Worker云资源监听ID（各云产品称呼不同，这里统一称为监听ID），与CloudResource值一致',
- 'description' => 'The listener ID of the cloud resource in the worker task.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'string',
- 'example' => 'lsn-lhl8y7s1e1ngc3m3zz@81',
- ],
- 'Port' => [
- 'title' => '部署任务Worker云资源监听端口（可选，若存在），与CloudResource值一致',
- 'description' => 'The listening port of the cloud resource in the worker task.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4431',
- ],
- 'DefaultResource' => [
- 'title' => '部署任务Worker云资源是否为“默认资源”，与CloudResource值一致',
- 'description' => 'Indicates whether the cloud resource in the worker task is the default resource. Valid values:'."\n"
- ."\n"
- .'* **true**'."\n"
- .'* **false**'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'boolean',
- 'example' => '0',
- ],
- 'CloudName' => [
- 'title' => '部署任务Worker云资源所属云厂商，与CloudResource值一致',
- 'description' => 'The cloud service provider to which the cloud resource in the worker task belongs.'."\n"
- ."\n"
- .'> This parameter is not returned if you deploy certificates to Alibaba Cloud services.'."\n",
- 'type' => 'string',
- 'example' => 'aliyun',
- ],
- 'NamespaceId' => [
- 'title' => '部署任务Worker执行参数',
- 'description' => 'The ID of the namespace in SAE. This parameter is returned only if you deploy certificates to SAE.'."\n",
- 'type' => 'string',
- 'example' => '32fed52a-4bf7-44f6-955f-e82ada68ef18',
- ],
- 'Status' => [
- 'title' => '部署任务Worker状态：',
- 'description' => 'The status of the worker task. Valid values:'."\n"
- ."\n"
- .'* **editing**'."\n"
- .'* **pending**'."\n"
- .'* **scheduling**'."\n"
- .'* **processing**'."\n"
- .'* **error**'."\n"
- .'* **success**'."\n"
- .'* **rollback**'."\n"
- .'* **rollback_success**'."\n"
- .'* **rollback_error**'."\n",
- 'type' => 'string',
- 'example' => 'editing',
- ],
+ 'DingGroupInstanceId' => ['description' => 'The instance ID of the expert service DingTalk group.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'DingGroupName' => ['description' => 'The name of the expert service DingTalk group.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'DingGroupType' => ['description' => 'The type of the expert service DingTalk group. Valid values:'."\n"
+ .'- expedite: application assistance.'."\n"
+ .'- remote: offline deployment.', 'type' => 'string', 'example' => 'remote', 'title' => ''],
+ 'DingGroupUrl' => ['description' => 'The link to join the expert service DingTalk group.', 'type' => 'string', 'example' => 'https://123.com', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '3E50D480-9765-5CFD-9650-9BACCECA5135',
+ 'Tags' => [
+ 'description' => 'The list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of tags.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'GenerateCsrMethod' => ['description' => 'The CSR generation method. Valid values:'."\n"
+ .'- online: system-generated. The Csr field is ignored.'."\n"
+ .'- upload: user-uploaded. The Csr field is required.', 'type' => 'string', 'example' => 'online', 'title' => ''],
+ 'AutoReissue' => ['description' => 'Specifies whether automatic managed renewal is enabled. Valid values:'."\n"
+ .'- enable: Enabled.'."\n"
+ .'- disable: Disabled.', 'type' => 'string', 'example' => 'enable', 'title' => ''],
+ 'PendingResult' => ['description' => 'The result returned by the certification authority (CA) during the last certificate operation.', 'type' => 'string', 'example' => 'pending', 'title' => ''],
+ 'UpgradeStatus' => ['description' => 'The upgrade status of the instance. Valid values:'."\n"
+ ."\n"
+ .'- none: the instance has not been upgraded.'."\n"
+ ."\n"
+ .'- payed: the instance upgrade has been paid.'."\n"
+ ."\n"
+ .'- issued: the latest certificate has been issued after the instance upgrade.', 'type' => 'string', 'example' => 'none', 'title' => ''],
+ 'CertificateRevokeTime' => ['description' => 'The revocation time of the latest certificate. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'Brand' => ['description' => 'The CA brand. Valid values: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus, and Alibaba.', 'type' => 'string', 'example' => 'DigiCert', 'title' => ''],
+ 'OrderStartTime' => ['description' => 'The start time of the instance purchase. The value is a UNIX timestamp. You can use this value to determine the refund time limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 8,\\n \\"CurrentPage\\": 1,\\n \\"ShowSize\\": 50,\\n \\"Data\\": [\\n {\\n \\"Id\\": 22487,\\n \\"GmtCreate\\": \\"1680228896000\\",\\n \\"GmtModified\\": \\"1681956830000\\",\\n \\"UserId\\": 0,\\n \\"JobId\\": 8888,\\n \\"OrderId\\": 9349278,\\n \\"CertId\\": 12073663,\\n \\"CertDomain\\": \\"www.example.com\\",\\n \\"CertInstanceId\\": \\"lsn-jzk2h0xz5dmynuphb8@1883\\",\\n \\"CertName\\": \\"testCertName\\",\\n \\"ResourceId\\": 1286999,\\n \\"CloudProduct\\": \\"SLB\\",\\n \\"ResourceCertId\\": 123,\\n \\"ResourceDomain\\": \\"www.example.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CloudRegion\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"cas-cn-0pp118nuu40b\\",\\n \\"ListenerId\\": \\"lsn-lhl8y7s1e1ngc3m3zz@81\\",\\n \\"Port\\": 4431,\\n \\"DefaultResource\\": true,\\n \\"CloudName\\": \\"aliyun\\",\\n \\"NamespaceId\\": \\"32fed52a-4bf7-44f6-955f-e82ada68ef18\\",\\n \\"Status\\": \\"editing\\"\\n }\\n ],\\n \\"RequestId\\": \\"3E50D480-9765-5CFD-9650-9BACCECA5135\\"\\n}","type":"json"}]',
- 'title' => 'ListWorkerResource',
- ],
- 'DescribeDeploymentJobStatus' => [
- 'summary' => 'Queries the number of worker tasks in a deployment task.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Get instance details',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetInstanceDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"cas_dv-cn-123\\",\\n \\"InstanceType\\": \\"TEST\\",\\n \\"RequestId\\": \\"B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9\\",\\n \\"KeyAlgorithm\\": \\"RSA_2048\\",\\n \\"Status\\": \\"inactive\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"CertificateId\\": 1234567890,\\n \\"CertificateName\\": \\"123\\",\\n \\"CertIdentifier\\": \\"22783111-cn-hangzhou\\",\\n \\"Spec\\": \\"ss.dv.t\\",\\n \\"CertificateType\\": \\"DV\\",\\n \\"CertificateStatus\\": \\"issued\\",\\n \\"CertificateNotAfter\\": 1801324800000,\\n \\"CertificateNotBefore\\": 0,\\n \\"OrderEndTime\\": 1801324800000,\\n \\"InstanceStartTime\\": 1801324800000,\\n \\"InstanceEndTime\\": 1801324800000,\\n \\"FullDomainCount\\": 1,\\n \\"WildcardDomainCount\\": 0,\\n \\"CompanyId\\": 47305,\\n \\"ContactIdList\\": [\\n 123\\n ],\\n \\"ResourceGroupId\\": \\"rg-aek****wia\\",\\n \\"DomainValidationList\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"RootDomain\\": \\"example.com\\",\\n \\"ValidationType\\": \\"TXT\\",\\n \\"ValidationValue\\": \\"123\\",\\n \\"ValidationKey\\": \\"@\\",\\n \\"Cname\\": \\"123.com\\",\\n \\"CnameKey\\": \\"abc\\"\\n }\\n ],\\n \\"City\\": \\"Beijing\\",\\n \\"Province\\": \\"Beijing\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"Csr\\": \\"-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----\\",\\n \\"ValidationMethod\\": \\"DNS\\",\\n \\"AverageWaitingTime\\": \\"120\\",\\n \\"DingGroupList\\": [\\n {\\n \\"DingGroupInstanceId\\": \\"123\\",\\n \\"DingGroupName\\": \\"123\\",\\n \\"DingGroupType\\": \\"remote\\",\\n \\"DingGroupUrl\\": \\"https://123.com\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"test\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"GenerateCsrMethod\\": \\"online\\",\\n \\"AutoReissue\\": \\"enable\\",\\n \\"PendingResult\\": \\"pending\\",\\n \\"UpgradeStatus\\": \\"none\\",\\n \\"CertificateRevokeTime\\": 1801324800000,\\n \\"Brand\\": \\"DigiCert\\",\\n \\"OrderStartTime\\": 1801324800000\\n}","type":"json"}]',
+ ],
+ 'GetInstanceSummary' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214581',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的手机号，无法自动化测试',
+ 'abilityTreeCode' => '213379',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the **JobId** parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '8888',
- ],
+ 'schema' => ['description' => 'The instance type. Valid values: BUY: a paid certificate. TEST: a test certificate.', 'type' => 'string', 'required' => false, 'example' => 'TEST', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<DeploymentJobStatus>',
- 'description' => 'OpenApiDefaultResponse'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D',
- ],
- 'ResourceCount' => [
- 'title' => '部署任务涉及的资源数量',
- 'description' => 'The total number of resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4127',
- ],
- 'UseCount' => [
- 'description' => 'The total number of used resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '300',
- ],
- 'BuyCount' => [
- 'description' => 'The total number of purchased resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '500',
- ],
- 'WorkerCount' => [
- 'title' => '部署任务（包含回滚任务）总数量',
- 'description' => 'The total number of resources to which certificate are deployed in the current cloud service. The value indicates the total number of worker tasks.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'MatchWorkerCount' => [
- 'title' => '部署任务（包含回滚任务）总数量',
- 'description' => 'The total number of worker tasks that match the certificate.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'SuccessCount' => [
- 'title' => '部署任务（不含回滚任务）成功数量',
- 'description' => 'The number of successful worker tasks, excluding rollback tasks.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'FailedCount' => [
- 'title' => '部署任务（不含回滚任务）失败数量',
- 'description' => 'The number of failed worker tasks, excluding rollback tasks.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'RollbackCount' => [
- 'title' => '部署任务回滚任务数量',
- 'description' => 'The number of worker tasks that are rolled backed.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'RollbackSuccessCount' => [
- 'title' => '部署任务回滚成功数量',
- 'description' => 'The number of worker tasks that are successfully rolled back.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'RollbackFailedCount' => [
- 'title' => '部署任务回滚失败数量',
- 'description' => 'The number of worker tasks that failed to be rolled back.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'CostCount' => [
- 'title' => '部署任务消耗部署配额数量',
- 'description' => 'The number of resources consumed by worker tasks.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'CertCount' => [
- 'title' => '部署任务涉及的证书数量',
- 'description' => 'The number of certificates involved in the deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'ProductWorkerCount' => [
- 'title' => '部署任务云产品维度worker数量统计',
- 'description' => 'The number of cloud resources to which certificates are deployed in the deployment task.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ProductName' => [
- 'title' => '云产品名称',
- 'description' => 'The name of the cloud service. Valid values:'."\n"
- ."\n"
- .'* **SLB**: Classic Load Balancer (CLB). This value is supported only at the China site (aliyun.com).'."\n"
- .'* **LIVE**: ApsaraVideo Live. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **webHosting**: Cloud Web Hosting. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **VOD**: ApsaraVideo VOD. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **CR**: Container Registry. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **DCDN**: Dynamic Content Delivery Network (DCDN).'."\n"
- .'* **DDOS**: Anti-DDoS.'."\n"
- .'* **CDN**: Alibaba Cloud CDN (CDN).'."\n"
- .'* **ALB**: Application Load Balancer (ALB).'."\n"
- .'* **APIGateway**: API Gateway.'."\n"
- .'* **FC**: Function Compute.'."\n"
- .'* **GA**: Global Accelerator (GA).'."\n"
- .'* **MSE**: Microservices Engine (MSE).'."\n"
- .'* **NLB**: Network Load Balancer (NLB).'."\n"
- .'* **OSS**: Object Storage Service (OSS).'."\n"
- .'* **SAE**: Serverless App Engine (SAE).'."\n"
- .'* **TencentCDN**: Tencent Cloud Content Delivery Network (CDN).'."\n"
- .'* **WAF**: Web Application Firewall (WAF).'."\n",
- 'type' => 'string',
- 'example' => 'NLB',
- ],
- 'Count' => [
- 'title' => 'worker数量',
- 'description' => 'The total number of resources of a cloud service in the deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The unique ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '09470F19-CEE8-5C63-BF2C-02B5E3F07A17', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'InactiveCount' => ['description' => 'The total number of inactive instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'AutoReissueCount' => ['description' => 'The remaining quota for automatic reissue.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CertificateCount' => ['description' => 'The remaining certificate quota.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'WillExpireCount' => ['description' => 'The total number of instances that are about to expire.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"ResourceCount\\": 4127,\\n \\"UseCount\\": 300,\\n \\"BuyCount\\": 500,\\n \\"WorkerCount\\": 20,\\n \\"MatchWorkerCount\\": 20,\\n \\"SuccessCount\\": 20,\\n \\"FailedCount\\": 20,\\n \\"RollbackCount\\": 20,\\n \\"RollbackSuccessCount\\": 20,\\n \\"RollbackFailedCount\\": 20,\\n \\"CostCount\\": 20,\\n \\"CertCount\\": 20,\\n \\"ProductWorkerCount\\": [\\n {\\n \\"ProductName\\": \\"NLB\\",\\n \\"Count\\": 2\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DescribeDeploymentJobStatus',
- ],
- 'ListDeploymentJobResource' => [
- 'summary' => 'Queries the cloud resources of cloud services in a deployment task.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'GetInstanceSummary',
+ 'summary' => 'Queries the summary statistics of Certificate Management Service instances, such as certificate counts by status.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetInstanceSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09470F19-CEE8-5C63-BF2C-02B5E3F07A17\\",\\n \\"TotalCount\\": 10,\\n \\"InactiveCount\\": 1,\\n \\"AutoReissueCount\\": 1,\\n \\"CertificateCount\\": 1,\\n \\"WillExpireCount\\": 1\\n}","type":"json"}]',
+ ],
+ 'GetMatchedResources' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3484,253 +3548,149 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214583',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '217072',
+ 'abilityTreeNodes' => ['FEATUREcasNQUDIX'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'CertIds',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '8888',
- ],
+ 'schema' => ['title' => '', 'description' => 'The certificate IDs.', 'type' => 'string', 'required' => true, 'example' => '19736665'],
+ ],
+ [
+ 'name' => 'ResourceScope',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The resource match scope. This parameter can be empty.', 'type' => 'string', 'required' => false, 'example' => '目前支持全部云产品'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Because of the large number of matched resources, the backend uses aggregation and does not support pagination. This parameter is reserved. By default, a maximum of 2,000 entries are returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Because of the large number of matched resources, the backend uses aggregation and does not support pagination. This parameter is reserved.', 'type' => 'string', 'required' => false, 'example' => '666', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<List<CloudResource>>',
- 'description' => 'OpenApiDefaultResponse\\<List>.'."\n",
+ 'title' => '',
+ 'description' => 'OpenApiDefaultResponse\\<?>',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'The response parameters.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '云资源ID',
- 'description' => 'The ID of the cloud resource.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20979',
- ],
- 'GmtCreate' => [
- 'title' => '数据创建时间',
- 'description' => 'The time when the cloud resource was created. The time is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'example' => '1673423339000',
- ],
- 'GmtModified' => [
- 'title' => '数据更新时间',
- 'description' => 'The time when the cloud resource was last modified. The time is in the timestamp format.'."\n",
- 'type' => 'string',
- 'example' => '1681956830000',
- ],
- 'CloudProduct' => [
- 'title' => '云产品',
- 'description' => 'The cloud service. Valid values:'."\n"
- ."\n"
- .'* **CDN**: Alibaba Cloud CDN (CDN). This value is supported only at the China site (aliyun.com).'."\n"
- .'* **SLB**: Classic Load Balancer (CLB). This value is supported only at the China site (aliyun.com).'."\n"
- .'* **DCDN**: Dynamic Content Delivery Network (DCDN). This value is supported only at the China site (aliyun.com).'."\n"
- .'* **DDOS**: Anti-DDoS. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **LIVE**: ApsaraVideo Live. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **webHosting**: Cloud Web Hosting. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **VOD**: ApsaraVideo VOD. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **CR**: Container Registry. This value is supported only at the China site (aliyun.com).'."\n"
- .'* **ALB**: Application Load Balancer (ALB).'."\n"
- .'* **APIGateway**: API Gateway.'."\n"
- .'* **FC**: Function Compute.'."\n"
- .'* **GA**: Global Accelerator (GA).'."\n"
- .'* **MSE**: Microservices Engine (MSE).'."\n"
- .'* **NLB**: Network Load Balancer (NLB).'."\n"
- .'* **OSS**: Object Storage Service (OSS).'."\n"
- .'* **SAE**: Serverless App Engine (SAE).'."\n"
- .'* **TencentCDN**: Tencent Cloud Content Delivery Network (CDN).'."\n"
- .'* **WAF**: Web Application Firewall (WAF).'."\n",
- 'type' => 'string',
- 'example' => 'SLB',
- ],
- 'UserId' => [
- 'title' => '用户ID',
- 'description' => 'The ID of the Alibaba Cloud account.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666884372152785',
- ],
- 'CertId' => [
- 'title' => '云资源绑定证书ID',
- 'description' => 'The ID of the certificate bound to the cloud resource.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '11599949',
- ],
- 'CertName' => [
- 'title' => '云资源绑定证书名称',
- 'description' => 'The name of the certificate bound to the cloud resource.'."\n",
- 'type' => 'string',
- 'example' => 'sc-SSL',
- ],
- 'CertEndTime' => [
- 'title' => '云资源绑定证书结束日期',
- 'description' => 'The end date of the certificate bound to the cloud resource. The value is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'example' => '1681956830000',
- ],
- 'CertStartTime' => [
- 'title' => '云资源绑定证书开始日期',
- 'description' => 'The start date of the certificate bound to the cloud resource. The value is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'example' => '1681956830000',
- ],
- 'Domain' => [
- 'title' => '云资源绑定域名',
- 'description' => 'The domain name bound to the cloud resource.'."\n",
- 'type' => 'string',
- 'example' => 'aliyundoc.com',
- ],
- 'InstanceId' => [
- 'title' => '云资源实例ID',
- 'description' => 'The instance ID of the cloud resource.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'string',
- 'example' => 'cas-cn-m7r1qocw91at',
- ],
- 'ListenerId' => [
- 'title' => '云资源监听ID',
- 'description' => 'The listener ID of the cloud resource.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'string',
- 'example' => 'lsn-vwdff0q20poq5xazb9@443',
- ],
- 'ListenerPort' => [
- 'title' => '云资源监听端口',
- 'description' => 'The listening port of the cloud resource.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'string',
- 'example' => '8047',
- ],
- 'EnableHttps' => [
- 'title' => '云资源开启HTTPS',
- 'description' => 'Indicates whether HTTPS is enabled for the cloud resource. Valid values:'."\n"
- ."\n"
- .'* **1**: yes'."\n"
- .'* **0**: no'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DefaultResource' => [
- 'title' => '云资源是否为默认资源',
- 'description' => 'Indicates whether the cloud resource is the default resource. Valid values:'."\n"
- ."\n"
- .'* **1**: yes'."\n"
- .'* **0**: no'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Remark' => [
- 'title' => '其他',
- 'description' => 'The other metadata related to the cloud resource.'."\n",
- 'type' => 'string',
- 'example' => '{\\"camera_model\\":\\"GIFSHOW [1267087617][OnePlus',
- ],
- 'Status' => [
- 'title' => '云资源状态',
- 'description' => 'The status of the cloud resource.'."\n",
- 'type' => 'string',
- 'example' => 'online',
- ],
- 'UseSsl' => [
- 'title' => '使用SSL',
- 'description' => 'Indicates whether an Alibaba Cloud SSL certificate is used. Valid values:'."\n"
- ."\n"
- .'* **1**: yes'."\n"
- .'* **0**: no'."\n"
- ."\n"
- .'> This parameter is required only when you deploy certificates to services of multiple clouds.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RegionId' => [
- 'title' => '云资源RegionID',
- 'description' => 'The region ID of the cloud resource.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'CloudName' => [
- 'title' => '云资源供应商：',
- 'description' => 'The cloud service provider of the cloud resource. Valid values:'."\n"
- ."\n"
- .'* **aliyun**: Alibaba Cloud'."\n"
- .'* **Tencent**: Tencent Cloud'."\n",
- 'type' => 'string',
- 'example' => 'aliyun',
- ],
- 'CloudRegion' => [
- 'title' => '云资源在云供应商的RegionID',
- 'description' => 'The region ID of the cloud service provider to which the cloud resource belongs.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'CloudAccessId' => [
- 'title' => '云资源访问ID',
- 'description' => 'The AccessKey ID used to access cloud resources.'."\n"
- ."\n"
- .'> This parameter is required only when you deploy certificates to services of multiple clouds.'."\n",
- 'type' => 'string',
- 'example' => '1234',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
+ 'Data' => ['description' => '请求接口返回的数据。', 'type' => 'any', 'example' => '[]', 'title' => ''],
+ 'RequestId' => ['description' => '本次请求的 ID。', 'type' => 'string', 'example' => '26F62CED-1E0E-51AA-B8EB-BCD61C5B0C50', 'title' => ''],
+ 'NextToken' => ['description' => '下一个查询开始 Token，NextToken 为空说明没有下一个。', 'type' => 'string', 'example' => '1d2db86sca4384811e0b5e8707e68181f', 'title' => ''],
+ 'MaxResults' => ['description' => '分页参数：结果集的最大数量，默认值为 20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Id\\": 20979,\\n \\"GmtCreate\\": \\"1673423339000\\",\\n \\"GmtModified\\": \\"1681956830000\\",\\n \\"CloudProduct\\": \\"SLB\\",\\n \\"UserId\\": 0,\\n \\"CertId\\": 11599949,\\n \\"CertName\\": \\"sc-SSL\\",\\n \\"CertEndTime\\": \\"1681956830000\\",\\n \\"CertStartTime\\": \\"1681956830000\\",\\n \\"Domain\\": \\"aliyundoc.com\\",\\n \\"InstanceId\\": \\"cas-cn-m7r1qocw91at\\",\\n \\"ListenerId\\": \\"lsn-vwdff0q20poq5xazb9@443\\",\\n \\"ListenerPort\\": \\"8047\\",\\n \\"EnableHttps\\": 1,\\n \\"DefaultResource\\": 0,\\n \\"Remark\\": \\"{\\\\\\\\\\\\\\"camera_model\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"GIFSHOW [1267087617][OnePlus\\",\\n \\"Status\\": \\"online\\",\\n \\"UseSsl\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CloudName\\": \\"aliyun\\",\\n \\"CloudRegion\\": \\"cn-hangzhou\\",\\n \\"CloudAccessId\\": \\"1234\\"\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
- 'title' => 'ListDeploymentJobResource',
+ 'title' => 'Retrieve matched resources for a certificate',
+ 'summary' => 'Retrieves the resources that match a certificate.',
+ 'description' => '本接口用于通过私有 CA 实例的 ID，查询您通过 SSL 证书服务控制台购买的私有 CA 实例的状态信息，例如，CA 实例的状态、包含的证书数量、已签发的证书数量等。'."\n"
+ ."\n"
+ .'调用本接口前，您必须已经通过[数字证书管理服务控制台](https://yundun.console.aliyun.com/?p=cas#/pca/rootlist)购买了私有 CA。具体操作，请参见[购买私有 CA](~~208553~~)。'."\n"
+ ."\n"
+ .'## QPS 限制'."\n"
+ ."\n"
+ .'本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetMatchedResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"26F62CED-1E0E-51AA-B8EB-BCD61C5B0C50\\",\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68181f\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
- 'ListContact' => [
- 'summary' => 'Queries a list of contacts.',
- 'methods' => [
- 'post',
- 'get',
+ 'GetRiskCount' => [
+ 'summary' => 'Queries the number of assets with certificate-related risks, such as expired or soon-to-expire certificates.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '234188',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
- 'schemes' => [
- 'http',
- 'https',
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'BuyCertificateExpireCount' => ['description' => 'Number of expired paid certificates.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'BuyCertificateWillExpiredCount' => ['description' => 'Number of paid certificates that will expire soon.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'BuyCertificateNotDeploymentCount' => ['description' => 'Number of paid certificates not deployed.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'BuyCheckedFailCount' => ['description' => 'Number of failed paid certificate orders.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'BuyCertificateNotTrusteeCount' => ['description' => 'Number of paid certificates not managed.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'FreeCertificateExpireCount' => ['description' => 'Number of expired free certificates.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'FreeCertificateWillExpiredCount' => ['description' => 'Number of free certificates that will expire soon.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'FreeCertificateNotDeploymentCount' => ['description' => 'Number of free certificates not deployed.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'FreeCheckedFailCount' => ['description' => 'Number of failed free certificate orders.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of this API call. Alibaba Cloud generates this unique identifier for each request. Use it to troubleshoot and locate issues.', 'type' => 'string', 'example' => '5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E', 'title' => ''],
+ 'UploadCertificateExpireCount' => ['description' => 'Number of expired uploaded certificates.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'UploadCertificateWillExpiredCount' => ['description' => 'Number of uploaded certificates that will expire soon.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'UploadCertificateNotDeploymentCount' => ['description' => 'Number of uploaded certificates not deployed.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'UploadCertificateNotNoticeCount' => ['description' => 'Number of uploaded certificates without alerting configured.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'AliyunAssetCertificateExpiredCount' => ['description' => 'Number of expired Alibaba Cloud certificates.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'AliyunAssetCertificateWillExpiredCount' => ['description' => 'Number of Alibaba Cloud certificates that will expire soon.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'MultiCloudAssetCertificateExpiredCount' => ['description' => 'Number of expired multicloud certificates.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'DomainAssetNotMonitorCount' => ['description' => 'Number of domains without monitoring configured.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'MultiCloudAssetCertificateWillExpiredCount' => ['description' => 'Number of multicloud certificates that will expire soon.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'GetRiskCount',
+ 'description' => 'This operation queries the number of created Certificate Authority (CA) certificates, including root and subordinate CA certificates.'."\n"
+ ."\n"
+ .'## QPS limits'."\n"
+ ."\n"
+ .'The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, API calls are rate-limited, which may affect your business. We recommend that you call this operation at a reasonable frequency.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BuyCertificateExpireCount\\": 10,\\n \\"BuyCertificateWillExpiredCount\\": 10,\\n \\"BuyCertificateNotDeploymentCount\\": 10,\\n \\"BuyCheckedFailCount\\": 10,\\n \\"BuyCertificateNotTrusteeCount\\": 10,\\n \\"FreeCertificateExpireCount\\": 10,\\n \\"FreeCertificateWillExpiredCount\\": 10,\\n \\"FreeCertificateNotDeploymentCount\\": 10,\\n \\"FreeCheckedFailCount\\": 10,\\n \\"RequestId\\": \\"5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E\\",\\n \\"UploadCertificateExpireCount\\": 10,\\n \\"UploadCertificateWillExpiredCount\\": 10,\\n \\"UploadCertificateNotDeploymentCount\\": 10,\\n \\"UploadCertificateNotNoticeCount\\": 10,\\n \\"AliyunAssetCertificateExpiredCount\\": 10,\\n \\"AliyunAssetCertificateWillExpiredCount\\": 10,\\n \\"MultiCloudAssetCertificateExpiredCount\\": 10,\\n \\"DomainAssetNotMonitorCount\\": 10,\\n \\"MultiCloudAssetCertificateWillExpiredCount\\": 10\\n}","type":"json"}]',
+ ],
+ 'GetTaskAttribute' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3739,155 +3699,227 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214629',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '213379',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'Keyword',
+ 'name' => 'TaskType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The keyword used in the query. For example, you can specify a keyword in names, email addresses, and mobile phone numbers.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '186',
- ],
+ 'schema' => ['description' => 'The type of the asynchronous task. The default value is ApplyCertificate, which specifies a query for the result of a certificate application.', 'type' => 'string', 'required' => false, 'example' => 'ApplyCertificate', 'title' => ''],
],
[
- 'name' => 'ShowSize',
+ 'name' => 'TaskId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the task.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The number of contacts per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The unique ID of the request. Alibaba Cloud generates this ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
+ 'TaskStatus' => ['description' => 'The result of the task.'."\n"
+ ."\n"
+ .'- success: The submission is successful.'."\n"
+ ."\n"
+ .'- processing: The submission is in progress.'."\n"
+ ."\n"
+ .'- failed: The submission failed.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'TaskMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'GetTaskAttribute',
+ 'summary' => 'Queries the processing result and status of a submitted certificate application.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetTaskAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"TaskStatus\\": \\"success\\",\\n \\"TaskMessage\\": \\"error\\"\\n}","type":"json"}]',
+ ],
+ 'GetUserCertificateDetail' => [
+ 'summary' => 'Retrieves certificate details, including the basic information, certificate body, and private key. You can also use this operation to download the certificate content and private key.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CurrentPage',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '160954',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CertId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The ID of the certificate. To get this ID, call the [ListUserCertificateOrder](~~455804~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6055048', 'title' => ''],
+ ],
+ [
+ 'name' => 'CertFilter',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to filter the certificate content from the response. Valid values: **true**: The Cert, Key, EncryptCert, EncryptPrivateKey, SignCert, and SignPrivateKey parameters are not returned. **false** (default): All parameters are returned.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '31C66C7B-671A-4297-9187-2C4477247A74',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'ShowSize' => [
- 'description' => 'The number of certificates per page. Default value: **20**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'CurrentPage' => [
- 'description' => 'The page number. Default value: **1**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Keyword' => [
- 'description' => 'The keyword used in the fuzzy search.'."\n",
- 'type' => 'string',
- 'example' => '186',
+ 'Cert' => ['description' => 'The content of the certificate that does not use a Chinese cryptographic algorithm. This parameter is returned only when the certFilter request parameter is false.', 'type' => 'string', 'example' => '---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----', 'title' => ''],
+ 'Key' => ['description' => 'The private key of the certificate that does not use a Chinese cryptographic algorithm. This parameter is returned only when the certFilter request parameter is false.', 'type' => 'string', 'example' => '-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----', 'title' => ''],
+ 'EncryptCert' => ['description' => 'The content of the encryption certificate that uses a Chinese cryptographic algorithm. The certificate is in PEM format. This parameter is returned only when the certFilter request parameter is false.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
+ .'MIICDzCCA***'."\n"
+ .'-----END CERTIFICATE-----', 'title' => ''],
+ 'EncryptPrivateKey' => ['description' => 'The private key of the encryption certificate that uses a Chinese cryptographic algorithm. The private key is in PEM format. This parameter is returned only when the certFilter request parameter is false.', 'type' => 'string', 'example' => '-----BEGIN EC PRIVATE KEY-----'."\n"
+ .'MHcCAQEEI****'."\n"
+ .'-----END EC PRIVATE KEY-----', 'title' => ''],
+ 'SignCert' => ['description' => 'The content of the signing certificate that uses a Chinese cryptographic algorithm. The certificate is in PEM format. This parameter is returned only when the certFilter request parameter is false.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
+ .'MIICDzCCAbagAw****'."\n"
+ .'-----END CERTIFICATE-----'."\n", 'title' => ''],
+ 'SignPrivateKey' => ['description' => 'The private key of the signing certificate that uses a Chinese cryptographic algorithm. The private key is in PEM format. This parameter is returned only when the certFilter request parameter is false.', 'type' => 'string', 'example' => '-----BEGIN EC PRIVATE KEY-----'."\n"
+ .'MHcCAQEEILR****'."\n"
+ .'-----END EC PRIVATE KEY-----'."\n", 'title' => ''],
+ 'Id' => ['description' => 'The ID of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '121345', 'title' => ''],
+ 'Name' => ['description' => 'The name of the certificate.', 'type' => 'string', 'example' => 'cert_name', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request. This unique ID is generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
+ 'Common' => ['description' => 'The primary domain name that is bound to the certificate.', 'type' => 'string', 'example' => '*.com', 'title' => ''],
+ 'Fingerprint' => ['description' => 'The fingerprint of the certificate.', 'type' => 'string', 'example' => '1D7801BBE772D5DE55CBF1F88AEB41A42402DA07', 'title' => ''],
+ 'Issuer' => ['description' => 'The certification authority (CA) that issued the certificate.', 'type' => 'string', 'example' => 'Digicert', 'title' => ''],
+ 'OrgName' => ['description' => 'The name of the company or organization of the certificate purchaser.', 'type' => 'string', 'example' => 'Alibaba', 'title' => ''],
+ 'Province' => ['description' => 'The province where the company or organization of the certificate purchaser is located.', 'type' => 'string', 'example' => 'zhejiang', 'title' => ''],
+ 'City' => ['description' => 'The city where the company or organization of the certificate purchaser is located.', 'type' => 'string', 'example' => 'hangzhou', 'title' => ''],
+ 'Country' => ['description' => 'The country where the company or organization of the certificate purchaser is located.', 'type' => 'string', 'example' => 'CN', 'title' => ''],
+ 'StartDate' => ['description' => 'The issuance date of the certificate.', 'type' => 'string', 'example' => '2018-07-13', 'title' => ''],
+ 'EndDate' => ['description' => 'The expiration date of the certificate.', 'type' => 'string', 'example' => '2023-10-25', 'title' => ''],
+ 'Sans' => ['description' => 'All domain names that are bound to the certificate.', 'type' => 'string', 'example' => '*.com', 'title' => ''],
+ 'Expired' => ['description' => 'Indicates whether the certificate has expired. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The certificate has expired.'."\n"
+ ."\n"
+ .'- **false**: The certificate has not expired.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'BuyInAliyun' => ['description' => 'Indicates whether the certificate was purchased from Alibaba Cloud. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Yes'."\n"
+ ."\n"
+ .'- **false**: No', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'OrderId' => ['description' => 'The ID of the certificate application order.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aek****wia', 'title' => ''],
+ 'Algorithm' => ['description' => 'The algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''],
+ 'InstanceId' => ['description' => 'The ID of the resource instance.', 'type' => 'string', 'example' => 'cas-ivauto-hqito6', 'title' => ''],
+ 'Sha2' => ['description' => 'The SHA-2 value of the certificate.', 'type' => 'string', 'example' => '573415B23243066AD345AE5A57BD0FAE94F598BDD06D906278B5FF318F090FC8', 'title' => ''],
+ 'SerialNo' => ['description' => 'The serial number of the certificate.', 'type' => 'string', 'example' => '033cd852608689ef5e368fde89e0961769e8', 'title' => ''],
+ 'CertIdentifier' => ['description' => 'The certificate ID followed by "-cn-hangzhou". For example, if the certificate ID is 123, the value of CertIdentifier is "123-cn-hangzhou".', 'type' => 'string', 'example' => '13781326-cn-hangzhou', 'title' => ''],
+ 'CertChain' => [
+ 'description' => 'The information about the certificate chain.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The certificate chain object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'IssuerCommonName' => ['description' => 'The common name of the issuer.', 'type' => 'string', 'example' => 'Encryption Everywhere DV TLS CA - G2', 'title' => ''],
+ 'CommonName' => ['description' => 'The common name of the certificate in the chain.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'NotAfter' => ['description' => 'The expiration date of the certificate in the chain.', 'type' => 'integer', 'format' => 'int64', 'example' => '17352613180000', 'title' => ''],
+ 'NotBefore' => ['description' => 'The issuance date of the certificate in the chain.', 'type' => 'integer', 'format' => 'int64', 'example' => '17322633180000', 'title' => ''],
+ 'RemainDay' => ['description' => 'The number of days until the certificate in the chain expires.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'ContactList' => [
- 'description' => 'The contacts.'."\n",
+ 'NotAfter' => ['description' => 'The end time of the validity period of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '17326613180000', 'title' => ''],
+ 'NotBefore' => ['description' => 'The start time of the validity period of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '17321613180000', 'title' => ''],
+ 'Tags' => [
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'ContactId' => [
- 'description' => 'The ID of the contact.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '519580',
- ],
- 'Name' => [
- 'description' => 'The name of the contact.'."\n",
- 'type' => 'string',
- 'example' => 'ty-yaoyue.com',
- ],
- 'Mobile' => [
- 'description' => 'The phone number.'."\n",
- 'type' => 'string',
- 'example' => '139****8888',
- ],
- 'MobileStatus' => [
- 'description' => 'Indicates whether the phone number was verified.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Email' => [
- 'description' => 'The email address of the contact.'."\n",
- 'type' => 'string',
- 'example' => 'username@example.com',
- ],
- 'EmailStatus' => [
- 'description' => 'Indicates whether the email address passed the verification.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Webhooks' => [
- 'description' => 'The webhook URL of the chatbot.'."\n",
- 'type' => 'string',
- 'example' => '[\\"https://open.feishu.cn/open-apis/bot/v2/hook/XXX\\",\\"https://oapi.dingtalk.com/robot/send?access_token=XXX\\",\\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX\\"]',
- ],
+ 'TagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'TagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
+ 'description' => 'The resource tag.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'The list of tags.',
+ 'title' => '',
+ 'example' => '',
],
+ 'CertSha2' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
- 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cert\\": \\"---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----\\",\\n \\"Key\\": \\"-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----\\",\\n \\"EncryptCert\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIICDzCCA***\\\\n-----END CERTIFICATE-----\\",\\n \\"EncryptPrivateKey\\": \\"-----BEGIN EC PRIVATE KEY-----\\\\nMHcCAQEEI****\\\\n-----END EC PRIVATE KEY-----\\",\\n \\"SignCert\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIICDzCCAbagAw****\\\\n-----END CERTIFICATE-----\\\\n\\",\\n \\"SignPrivateKey\\": \\"-----BEGIN EC PRIVATE KEY-----\\\\nMHcCAQEEILR****\\\\n-----END EC PRIVATE KEY-----\\\\n\\",\\n \\"Id\\": 121345,\\n \\"Name\\": \\"cert_name\\",\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Common\\": \\"*.com\\",\\n \\"Fingerprint\\": \\"1D7801BBE772D5DE55CBF1F88AEB41A42402DA07\\",\\n \\"Issuer\\": \\"Digicert\\",\\n \\"OrgName\\": \\"Alibaba\\",\\n \\"Province\\": \\"zhejiang\\",\\n \\"City\\": \\"hangzhou\\",\\n \\"Country\\": \\"CN\\",\\n \\"StartDate\\": \\"2018-07-13\\",\\n \\"EndDate\\": \\"2023-10-25\\",\\n \\"Sans\\": \\"*.com\\",\\n \\"Expired\\": true,\\n \\"BuyInAliyun\\": true,\\n \\"OrderId\\": 123456,\\n \\"ResourceGroupId\\": \\"rg-aek****wia\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"InstanceId\\": \\"cas-ivauto-hqito6\\",\\n \\"Sha2\\": \\"573415B23243066AD345AE5A57BD0FAE94F598BDD06D906278B5FF318F090FC8\\",\\n \\"SerialNo\\": \\"033cd852608689ef5e368fde89e0961769e8\\",\\n \\"CertIdentifier\\": \\"13781326-cn-hangzhou\\",\\n \\"CertChain\\": [\\n {\\n \\"IssuerCommonName\\": \\"Encryption Everywhere DV TLS CA - G2\\",\\n \\"CommonName\\": \\"test\\",\\n \\"NotAfter\\": 17352613180000,\\n \\"NotBefore\\": 17322633180000,\\n \\"RemainDay\\": 1000\\n }\\n ],\\n \\"NotAfter\\": 17326613180000,\\n \\"NotBefore\\": 17321613180000,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"test\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"CertSha2\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => 'GetUserCertificateDetail',
+ 'description' => 'The queries per second (QPS) limit for each user is 100. If you exceed this limit, the system throttles your API calls, which may affect your business. We recommend that you call this operation within this limit.',
+ 'changeSet' => [
+ ['createdAt' => '2025-02-18T09:07:25.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-11-22T03:45:36.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-09-23T04:28:14.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-08-06T10:01:58.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-04-20T08:55:28.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-11-30T10:12:53.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-11-30T09:59:46.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetUserCertificateDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"TotalCount\\": 12,\\n \\"ShowSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"Keyword\\": \\"186\\",\\n \\"ContactList\\": [\\n {\\n \\"ContactId\\": 519580,\\n \\"Name\\": \\"John\\",\\n \\"Mobile\\": \\"139****8888\\",\\n \\"MobileStatus\\": 1,\\n \\"Email\\": \\"username@example.com\\",\\n \\"EmailStatus\\": 1,\\n \\"Webhooks\\": \\"[\\\\\\\\\\\\\\"https://open.feishu.cn/open-apis/bot/v2/hook/XXX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"https://oapi.dingtalk.com/robot/send?access_token=XXX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX\\\\\\\\\\\\\\"]\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListContact',
],
- 'ListDeploymentJobCert' => [
- 'summary' => 'Queries the basic information about a deployment task. After you create a deployment task, you can call this operation to obtain the basic information about the deployment task, including the instance ID, type, and name of the certificate.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListAssetCount' => [
+ 'summary' => 'Queries the certificate deployment statistics by cloud service type.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3897,438 +3929,581 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '214582',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '需要真实的，短信验证通过的手机号，无法进行自动化测试',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '153639',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the **JobId** parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '8888',
- ],
+ 'schema' => ['description' => 'The date of certificate issuance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2018-07-13', 'title' => ''],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The expiration date of the certificate.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2020-07-13', 'title' => ''],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShowSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page. Default value: 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<List<DeploymentJobCertInfo>>',
- 'description' => 'OpenApiDefaultResponse\\<List>.'."\n",
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'The response parameters.'."\n",
+ 'ShowSize' => ['description' => 'The number of entries returned on each page. This parameter is not returned if you do not specify \\`ShowSize\\` in the request.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The current page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ 'AssetCountList' => [
'type' => 'array',
'items' => [
- 'description' => 'The information about the certificate.'."\n",
'type' => 'object',
'properties' => [
- 'CertId' => [
- 'title' => '证书ID',
- 'description' => 'The ID of the certificate.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '11174100',
- ],
- 'OrderId' => [
- 'title' => '订单ID',
- 'description' => 'The ID of the certificate order.'."\n"
- ."\n"
- .'> If CertId is returned, this parameter is not returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '6127067',
- ],
- 'CertInstanceId' => [
- 'title' => '证书实例ID',
- 'description' => 'The instance ID of the certificate.'."\n",
- 'type' => 'string',
- 'example' => 'cas-ivauto-2crxzi',
- ],
- 'CertName' => [
- 'title' => '证书名称',
- 'description' => 'The name of the certificate.'."\n",
- 'type' => 'string',
- 'example' => 'edkog.shop',
- ],
- 'CommonName' => [
- 'title' => '证书CommonName',
- 'description' => 'The common name of the certificate.'."\n",
- 'type' => 'string',
- 'example' => 'vaultwebhook.vault-webhook.svc',
- ],
- 'Sans' => [
- 'title' => '证书SANs',
- 'description' => 'The subject alternative name (SAN) extensions of the certificate.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The extended domain name of the certificate.'."\n",
- 'type' => 'string',
- 'example' => 'aliyundoc.com',
- ],
- ],
- 'Algorithm' => [
- 'title' => '证书公钥算法',
- 'description' => 'The algorithm of the certificate public key.'."\n",
- 'type' => 'string',
- 'example' => 'RSA',
- ],
- 'NotBeforeTime' => [
- 'title' => '证书有效期NotBefore',
- 'description' => 'The start time of the validity period of the certificate. The value is a timestamp in seconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1683625266108',
- ],
- 'NotAfterTime' => [
- 'title' => '证书有效期NotAfter',
- 'description' => 'The end time of the validity period of the certificate. The value is a timestamp in seconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1683625266108',
- ],
- 'Month' => [
- 'title' => '证书申请Month',
- 'description' => 'The month in which the certificate is applied for.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'StatusCode' => [
- 'title' => '证书状态Code',
- 'description' => 'The status code of the certificate. Valid values:'."\n"
- ."\n"
- .'* **payed**: paid and pending application'."\n"
- .'* **checking**: being validated'."\n"
- .'* **checkedFail**: validation failed'."\n"
- .'* **revoked**: revoked'."\n"
- .'* **revokeChecking**: revocation request being validated'."\n"
- .'* **issued**: issued (excluding hosted certificates that are issued, certificates that are about to expire, expired certificates, and uploaded certificates)'."\n"
- .'* **trustee**: hosted and issued'."\n"
- .'* **upload**: uploaded (excluding certificates that are about to expire and expired certificates)'."\n"
- .'* **willExpired**: about to expire (including certificates issued by using the Certificate Management Service console and uploaded certificates)'."\n"
- .'* **expired**: expired (including certificates issued by using the Certificate Management Service console and uploaded certificates)'."\n"
- .'* **validity**: valid (including certificates that are not expired or revoked)'."\n"
- .'* **refund**: refunded'."\n"
- .'* **closed**: closed'."\n",
- 'type' => 'string',
- 'example' => 'issued',
- ],
- 'CertType' => [
- 'title' => '证书类型',
- 'description' => 'The type of the certificate.'."\n",
- 'type' => 'string',
- 'example' => 'DV',
- ],
- 'CertOrderType' => [
- 'title' => '证书类型',
- 'description' => 'The type of the certificate order. Valid values:'."\n"
- ."\n"
- .'* **upload**: uploaded certificate.'."\n"
- .'* **buy**: purchased certificate.'."\n"
- .'* **free**: free certificate. This value is available only on the China site (aliyun.com).'."\n",
- 'type' => 'string',
- 'example' => 'buy',
- ],
- 'IsTrustee' => [
- 'title' => 'isTrustee',
- 'description' => 'Indicates whether the certificate is hosted. Valid values:'."\n"
- ."\n"
- .'* **true**'."\n"
- .'* **false**'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'CountDate' => ['description' => 'The date when the statistics were collected.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767680115423', 'title' => ''],
+ 'Points' => ['description' => 'The number of points.', 'type' => 'integer', 'format' => 'int64', 'example' => '99', 'title' => ''],
+ 'MultiCloudAssetCount' => ['description' => 'The total number of resources from other cloud providers.', 'type' => 'integer', 'format' => 'int64', 'example' => '99', 'title' => ''],
+ 'AliyunAssetCount' => ['description' => 'The total number of Alibaba Cloud resources.', 'type' => 'integer', 'format' => 'int64', 'example' => '99', 'title' => ''],
+ 'CertificateCount' => ['description' => 'The total number of certificate resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '99', 'title' => ''],
+ 'DomainAssetCount' => ['description' => 'The total number of domain name resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '99', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'A list of resource statistics.',
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
+ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"CertId\\": 11174100,\\n \\"OrderId\\": 6127067,\\n \\"CertInstanceId\\": \\"cas-ivauto-2crxzi\\",\\n \\"CertName\\": \\"cert-11488855\\",\\n \\"CommonName\\": \\"example.com\\",\\n \\"Sans\\": [\\n \\"aliyundoc.com\\"\\n ],\\n \\"Algorithm\\": \\"RSA\\",\\n \\"NotBeforeTime\\": 1683625266108,\\n \\"NotAfterTime\\": 1683625266108,\\n \\"Month\\": 12,\\n \\"StatusCode\\": \\"issued\\",\\n \\"CertType\\": \\"DV\\",\\n \\"CertOrderType\\": \\"buy\\",\\n \\"IsTrustee\\": true\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
- 'title' => 'ListDeploymentJobCert',
+ 'title' => 'ListAssetCount',
+ 'description' => 'Queries the number of created Certificate Authority (CA) certificates, including root and subordinate CA certificates.'."\n"
+ ."\n"
+ .'## QPS limit'."\n"
+ ."\n"
+ .'Each user can make up to 10 queries per second (QPS). If you exceed this limit, the system applies rate limiting to your API calls. This may affect your business. Make API calls at a reasonable rate.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ShowSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"TotalCount\\": 12,\\n \\"AssetCountList\\": [\\n {\\n \\"CountDate\\": 1767680115423,\\n \\"Points\\": 99,\\n \\"MultiCloudAssetCount\\": 99,\\n \\"AliyunAssetCount\\": 99,\\n \\"CertificateCount\\": 99,\\n \\"DomainAssetCount\\": 99\\n }\\n ],\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","type":"json"}]',
],
- 'UpdateWorkerResourceStatus' => [
- 'summary' => 'Rolls back or executes a worker task in a deployment task.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListCert' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214606',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖真实的，短信验证通过的手机，无法自动化测试',
+ 'abilityTreeCode' => '153639',
+ 'abilityTreeNodes' => ['FEATUREcasEAT643'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'KeyWord',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the **JobId** parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '8888',
- ],
+ 'schema' => ['description' => 'The keyword for a fuzzy search by name, domain name, or subject alternative name.', 'type' => 'string', 'required' => false, 'example' => 'test_name', 'title' => ''],
],
[
- 'name' => 'WorkerId',
+ 'name' => 'WarehouseId',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务workerID',
- 'description' => 'The ID of the worker task. You can call the [ListWorkerResource](~~2712224~~) operation to obtain the ID of a worker task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1234',
- ],
+ 'schema' => ['description' => 'The warehouse ID. You can obtain this ID by calling the [ListCertWarehouse](~~453246~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'title' => '目标状态：',
- 'description' => 'The desired status.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* rollback'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'rollback' => 'rollback',
- ],
- 'example' => 'rollback',
- ],
+ 'schema' => ['description' => 'The certificate status. Valid values:'."\n"
+ ."\n"
+ .'- **ISSUE**: issued'."\n"
+ ."\n"
+ .'- **REVOKE**: revoked', 'type' => 'string', 'required' => false, 'example' => 'ISSUE', 'title' => ''],
+ ],
+ [
+ 'name' => 'SourceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The source of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **upload**: uploaded certificate'."\n"
+ ."\n"
+ .'- **aliyun**: Alibaba Cloud certificate', 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''],
+ ],
+ [
+ 'name' => 'CertType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The certificate type. Valid values:'."\n"
+ ."\n"
+ .'- **CA**: CA certificate'."\n"
+ ."\n"
+ .'- **CERT**: issued certificate', 'type' => 'string', 'required' => false, 'example' => 'CERT', 'title' => ''],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number to return. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShowSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. The default value is 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''],
+ ],
+ [
+ 'name' => 'Identifiers',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A comma-separated list of certificate identifiers.', 'type' => 'string', 'required' => false, 'example' => 'aaa,bbb', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<?>',
- 'description' => 'OpenApiDefaultResponse\\<?>.'."\n",
+ 'description' => 'A container for the response data.',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'The response parameters.'."\n",
- 'type' => 'any',
- 'example' => '[]',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '12345678-1234-1234-1234-123456789ABC',
+ 'ShowSize' => ['description' => 'The page size. Default value: 50.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The current page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'CertList' => [
+ 'description' => 'The list of certificates.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of a certificate.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WhId' => ['description' => 'The warehouse ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'Identifier' => ['description' => 'The unique identifier of the certificate.', 'type' => 'string', 'example' => '14dcc8afc7578e', 'title' => ''],
+ 'WhInstanceId' => ['description' => 'The warehouse instance ID.', 'type' => 'string', 'example' => 'test_whInstanceId', 'title' => ''],
+ 'Status' => ['description' => 'The status of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **ISSUE**: The certificate is issued.'."\n"
+ ."\n"
+ .'- **REVOKE**: The certificate is revoked.', 'type' => 'string', 'example' => 'ISSUE', 'title' => ''],
+ 'SourceType' => ['description' => 'The source of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **upload**: The certificate is uploaded.'."\n"
+ ."\n"
+ .'- **aliyun**: The certificate is from Alibaba Cloud.', 'type' => 'string', 'example' => 'aliyun', 'title' => ''],
+ 'CertType' => ['description' => 'The type of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **CA**: a Certificate Authority (CA) certificate'."\n"
+ ."\n"
+ .'- **CERT**: an issued certificate', 'type' => 'string', 'example' => 'CERT', 'title' => ''],
+ 'CommonName' => ['description' => 'The common name of the certificate. This is typically the primary domain name associated with the certificate.', 'type' => 'string', 'example' => 'aliyun.alibaba.com', 'title' => ''],
+ 'BeforeDate' => ['description' => 'The start date of the certificate\'s validity period. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1665819958000', 'title' => ''],
+ 'Issuer' => ['description' => 'The issuer of the certificate.', 'type' => 'string', 'example' => 'mySSL', 'title' => ''],
+ 'AfterDate' => ['description' => 'The expiration date of the certificate. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634283958000', 'title' => ''],
+ 'ExistPrivateKey' => ['description' => 'Indicates whether a private key is available for the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'Sans' => ['description' => 'The Subject Alternative Names (SANs) associated with the certificate. Multiple domain names are separated by commas (,).', 'type' => 'string', 'example' => '*.alibaba.com,aliyun.alibaba.com', 'title' => ''],
+ 'SerialNo' => ['description' => 'The serial number of the certificate. This parameter is returned only if the `OrderType` request parameter is set to `CERT` or `UPLOAD`.', 'type' => 'string', 'example' => '038abf4c27c33a7c11ad6658124135b52180', 'title' => ''],
+ 'Algorithm' => ['description' => 'The encryption algorithm of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **RSA**: the RSA algorithm'."\n"
+ ."\n"
+ .'- **ECC**: the ECC algorithm'."\n"
+ ."\n"
+ .'- **SM2**: the SM2 algorithm', 'type' => 'string', 'example' => 'RSA', 'title' => ''],
+ 'SignAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256WITHRSA', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\"\\n}","type":"json"}]',
- 'title' => 'UpdateWorkerResourceStatus',
- ],
- 'DeleteWorkerResource' => [
- 'summary' => 'Deletes the worker of a deployment task.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListCert',
+ 'summary' => 'This API queries certificates in the certificate store.',
+ 'description' => 'The single-user QPS limit for this API is 10. Calls exceeding this limit are throttled, which may impact your business. Plan your API calls accordingly.',
+ 'changeSet' => [
+ ['createdAt' => '2023-12-19T07:40:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-11-17T06:36:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCert',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ShowSize\\": 50,\\n \\"CurrentPage\\": 1,\\n \\"TotalCount\\": 10,\\n \\"CertList\\": [\\n {\\n \\"WhId\\": 2,\\n \\"Identifier\\": \\"14dcc8afc7578e\\",\\n \\"WhInstanceId\\": \\"test_whInstanceId\\",\\n \\"Status\\": \\"ISSUE\\",\\n \\"SourceType\\": \\"aliyun\\",\\n \\"CertType\\": \\"CERT\\",\\n \\"CommonName\\": \\"aliyun.alibaba.com\\",\\n \\"BeforeDate\\": 1665819958000,\\n \\"Issuer\\": \\"mySSL\\",\\n \\"AfterDate\\": 1634283958000,\\n \\"ExistPrivateKey\\": false,\\n \\"Sans\\": \\"*.alibaba.com,aliyun.alibaba.com\\",\\n \\"SerialNo\\": \\"038abf4c27c33a7c11ad6658124135b52180\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"SignAlgorithm\\": \\"SHA256WITHRSA\\"\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
+ ],
+ 'ListCertWarehouse' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214607',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ 'abilityTreeCode' => '153636',
+ 'abilityTreeNodes' => ['FEATUREcasEAT643'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '8888',
- ],
+ 'schema' => ['description' => 'The name of the certificate application repository. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''],
],
[
- 'name' => 'WorkerId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务workerID',
- 'description' => 'The ID of the worker for the deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '13',
- ],
+ 'schema' => ['description' => 'The instance ID of the certificate application repository.', 'type' => 'string', 'required' => false, 'example' => '14dcc8afc7578e1f', 'title' => ''],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type of the certificate application repository. Valid values:'."\n"
+ ."\n"
+ .'- **ssl**: certificate application repository of SSL certificates'."\n"
+ ."\n"
+ .'- **uploadPCA**: certificate application repository of uploaded private certificates'."\n"
+ ."\n"
+ .'- **free**: certificate application repository of free certificates, available only on the China site (aliyun.com)'."\n"
+ ."\n"
+ .'- **aliyunPCA**: certificate application repository of private certificates purchased from Alibaba Cloud Private Certificate Authority (PCA), available only on the China site (aliyun.com)'."\n"
+ ."\n"
+ .'- **disable**: disabled certificate application repository', 'type' => 'string', 'required' => false, 'example' => 'aliyunPCA', 'title' => ''],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShowSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page. Default value: 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<?>',
- 'description' => 'OpenApiDefaultResponse\\<?>.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'EA69E364-5CBB-50E8-BF09-E8CAA396A4F8',
+ 'ShowSize' => ['description' => 'The number of entries returned per page. Default value: 50.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The page number of the returned page. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'CertWarehouseList' => [
+ 'description' => 'The certificate application repositories.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the certificate application repository.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WhId' => ['description' => 'The ID of the certificate application repository.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID of the certificate application repository.', 'type' => 'string', 'example' => '14dcc8afc7578e1f', 'title' => ''],
+ 'Name' => ['description' => 'The name of the certificate application repository.', 'type' => 'string', 'example' => 'name', 'title' => ''],
+ 'PcaInstanceId' => ['description' => 'The instance ID of the private CA.', 'type' => 'string', 'example' => '14dcc8afc7578e1f', 'title' => ''],
+ 'Qps' => ['description' => 'The queries per second (QPS).', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'Type' => ['description' => 'The type of the certificate application repository. Valid values:'."\n"
+ ."\n"
+ .'- **ssl**: certificate application repository of SSL certificates'."\n"
+ ."\n"
+ .'- **uploadPCA**: certificate application repository of uploaded private certificates'."\n"
+ ."\n"
+ .'- **free**: certificate application repository of free certificates, available only on the China site (aliyun.com)'."\n"
+ ."\n"
+ .'- **aliyunPCA**: certificate application repository of private certificates purchased from Alibaba Cloud PCA, available only on the China site (aliyun.com)'."\n"
+ ."\n"
+ .'- **disable**: disabled certificate application repository', 'type' => 'string', 'example' => 'aliyunPCA', 'title' => ''],
+ 'EndTime' => ['description' => 'The timestamp when the certificate application repository expires. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1665819958000', 'title' => ''],
+ 'IsExpired' => ['description' => 'Indicates whether the certificate application repository has expired. Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EA69E364-5CBB-50E8-BF09-E8CAA396A4F8\\"\\n}","type":"json"}]',
- 'title' => 'DeleteWorkerResource',
- ],
- 'DeleteDeploymentJob' => [
- 'summary' => 'Deletes a deployment task.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListCertWarehouse',
+ 'summary' => 'Queries the certificate application repositories in your account.',
+ 'description' => 'You can call the ListCertWarehouse operation to query certificate repositories.'."\n"
+ ."\n"
+ .'### Limits'."\n"
+ ."\n"
+ .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCertWarehouse',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ShowSize\\": 50,\\n \\"CurrentPage\\": 1,\\n \\"TotalCount\\": 10,\\n \\"CertWarehouseList\\": [\\n {\\n \\"WhId\\": 1,\\n \\"InstanceId\\": \\"14dcc8afc7578e1f\\",\\n \\"Name\\": \\"name\\",\\n \\"PcaInstanceId\\": \\"14dcc8afc7578e1f\\",\\n \\"Qps\\": 10,\\n \\"Type\\": \\"aliyunPCA\\",\\n \\"EndTime\\": 1665819958000,\\n \\"IsExpired\\": false\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
+ ],
+ 'ListCertificates' => [
+ 'summary' => 'Queries the certificates managed by Certificate Management Service.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '214604',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '214629',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'Keyword',
'in' => 'query',
- 'schema' => [
- 'title' => '部署任务ID',
- 'description' => 'The ID of the deployment task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '8888',
- ],
+ 'schema' => ['description' => 'A keyword for a fuzzy query. The keyword can be a domain name, a certificate name, or a resource ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cas-ivauto-hqito6', 'title' => ''],
+ ],
+ [
+ 'name' => 'CertificateStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The status of the certificate.'."\n"
+ ."\n"
+ .'- **issued**: The certificate is issued.'."\n"
+ ."\n"
+ .'- **revoked**: The certificate is revoked.'."\n"
+ ."\n"
+ .'- **willExpire**: The certificate is about to expire.'."\n"
+ ."\n"
+ .'- **expired**: The certificate has expired.', 'type' => 'string', 'required' => false, 'example' => 'issued', 'title' => ''],
+ ],
+ [
+ 'name' => 'CertificateSource',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The source of the certificate.'."\n"
+ ."\n"
+ .'- BUY: A purchased certificate.'."\n"
+ ."\n"
+ .'- TEST: A test certificate.'."\n"
+ ."\n"
+ .'- UPLOAD: An uploaded certificate.', 'type' => 'string', 'required' => false, 'example' => 'BUY', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek****wia', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShowSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<?>',
- 'description' => 'OpenApiDefaultResponse\\<?>.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
+ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'ShowSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The current page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CertificateList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => 'The ID of the certificate instance.', 'type' => 'string', 'example' => ' cas-cn-v***', 'title' => ''],
+ 'Algorithm' => ['description' => 'The encryption algorithm of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **RSA**'."\n"
+ ."\n"
+ .'- **ECC**'."\n"
+ ."\n"
+ .'- **SM2**', 'type' => 'string', 'example' => 'RSA', 'title' => ''],
+ 'CertificateStatus' => ['description' => 'The status of the certificate.'."\n"
+ ."\n"
+ .'- **issued**: The certificate is issued.'."\n"
+ ."\n"
+ .'- **revoked**: The certificate is revoked.'."\n"
+ ."\n"
+ .'- **willExpire**: The certificate is about to expire.'."\n"
+ ."\n"
+ .'- **expired**: The certificate has expired.', 'type' => 'string', 'example' => 'issued', 'title' => ''],
+ 'Domain' => ['description' => 'The domain names that are bound to the certificate. Multiple domain names are separated by commas.', 'type' => 'string', 'example' => 'test.com', 'title' => ''],
+ 'CertificateId' => ['description' => 'The ID of the certificate.', 'type' => 'string', 'example' => '17281539', 'title' => ''],
+ 'CertificateName' => ['description' => 'The name of the certificate.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'CertIdentifier' => ['description' => 'The global ID of the certificate. This ID is used across Alibaba Cloud services and is in the `Certificate ID-Region ID` format. For example, if a certificate ID is `123`, the `CertIdentifier` is `123-cn-hangzhou` for the Alibaba Cloud China site and `123-ap-southeast-1` for the Alibaba Cloud International site (www\\.alibabacloud.com).'."\n"
+ ."\n"
+ .'- For the Alibaba Cloud China website, the format is certificate ID + "-cn-hangzhou".'."\n"
+ ."\n"
+ .'- For the Alibaba Cloud International website (www\\.alibabacloud.com), the format is certificate ID + "-ap-southeast-1".'."\n"
+ ."\n"
+ .'For example, if the certificate ID is 123, the CertIdentifier is "123-cn-hangzhou" for the China site and "123-ap-southeast-1" for the International site.', 'type' => 'string', 'example' => '21589515-cn-hangzhou', 'title' => ''],
+ 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'aliyun.com', 'title' => ''],
+ 'SubjectAlternativeNames' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'An alternative domain name of the certificate.', 'type' => 'string', 'example' => 'test.com', 'title' => ''],
+ 'description' => 'An array that contains the alternative domain names of the certificate. This parameter corresponds to the `Subject Alternative Name` field of the certificate.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CertificateSource' => ['description' => 'The source of the certificate.'."\n"
+ ."\n"
+ .'- BUY: A purchased certificate.'."\n"
+ ."\n"
+ .'- TEST: A test certificate.'."\n"
+ ."\n"
+ .'- UPLOAD: An uploaded certificate.', 'type' => 'string', 'example' => 'BUY', 'title' => ''],
+ 'NotBefore' => ['description' => 'The beginning of the certificate validity period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1760745600000', 'title' => ''],
+ 'NotAfter' => ['description' => 'The end of the certificate validity period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749580567000', 'title' => ''],
+ 'KeySize' => ['description' => 'The key size, in bits.'."\n"
+ ."\n"
+ .'- For RSA keys, typical sizes are 2048, 3072, or 4096.'."\n"
+ ."\n"
+ .'- For ECC or SM2 keys, the typical size is 256.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''],
+ 'FingerPrint' => ['description' => 'The fingerprint of the public key.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'Serial' => ['description' => 'The serial number of the certificate.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'Issuer' => ['description' => 'The certification authority.', 'type' => 'string', 'example' => 'DigiCert', 'title' => ''],
+ 'ExistPrivateKey' => ['description' => 'Indicates whether a private key is available. Valid values:'."\n"
+ ."\n"
+ .'- **true**: A private key is available.'."\n"
+ ."\n"
+ .'- **false**: A private key is not available.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'UsingProductList' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'An Alibaba Cloud product.', 'type' => 'string', 'example' => 'CDN', 'title' => ''],
+ 'description' => 'The list of Alibaba Cloud products in which the certificate is deployed.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The certificate information.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The list of certificates.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
- 'title' => 'DeleteDeploymentJob',
- ],
- 'DescribeCloudResourceStatus' => [
- 'summary' => 'Queries the number of third-party cloud resources on which you deployed certificates by using a multi-cloud deployment task.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListCertificates',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCertificates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"TotalCount\\": 10,\\n \\"ShowSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"CertificateList\\": [\\n {\\n \\"InstanceId\\": \\" cas-cn-v***\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"CertificateStatus\\": \\"issued\\",\\n \\"Domain\\": \\"test.com\\",\\n \\"CertificateId\\": \\"17281539\\",\\n \\"CertificateName\\": \\"test\\",\\n \\"CertIdentifier\\": \\"21589515-cn-hangzhou\\",\\n \\"CommonName\\": \\"aliyun.com\\",\\n \\"SubjectAlternativeNames\\": [\\n \\"test.com\\"\\n ],\\n \\"CertificateSource\\": \\"BUY\\",\\n \\"NotBefore\\": 1760745600000,\\n \\"NotAfter\\": 1749580567000,\\n \\"KeySize\\": 2048,\\n \\"FingerPrint\\": \\"123\\",\\n \\"Serial\\": \\"123\\",\\n \\"Issuer\\": \\"DigiCert\\",\\n \\"ExistPrivateKey\\": true,\\n \\"UsingProductList\\": [\\n \\"CDN\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListCloudAccess' => [
+ 'summary' => 'Queries the AccessKey pairs that are configured for multi-cloud certificate deployment.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4337,93 +4512,94 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214598',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '214631',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SecretId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The AccessKey secret used to access cloud resources.'."\n"
- ."\n"
- .'> You can call the [ListCloudAccess](~~2712219~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AKID9*******XX',
- ],
+ 'schema' => ['description' => 'The AccessKey ID that is used to access cloud resources.', 'type' => 'string', 'required' => false, 'example' => '276', 'title' => ''],
+ ],
+ [
+ 'name' => 'CloudName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cloud service provider. Set the value to **Tencent**, which indicates Tencent Cloud.', 'type' => 'string', 'required' => false, 'example' => 'Tencent', 'title' => ''],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShowSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. Valid values: **10**, **20**, and **50**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiDefaultResponse<List<CloudResourceCount>>',
- 'description' => 'OpenApiDefaultResponse\\<List>.'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'The response parameters.'."\n",
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D3F1FA43-1C26-50A2-8F0F-7A03851DBB46'],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''],
+ 'ShowSize' => ['description' => 'The number of entries per page. If ShowSize is not specified, this parameter is not returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The default value is the current page. If CurrentPage is not specified, this parameter is not returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CloudAccessList' => [
+ 'description' => 'The query results.',
'type' => 'array',
'items' => [
+ 'description' => 'The cloud service.',
'type' => 'object',
'properties' => [
- 'CloudName' => [
- 'title' => '云服务供应商',
- 'description' => 'The cloud service provider.'."\n",
- 'type' => 'string',
- 'example' => 'aliyun',
- ],
- 'CloudProduct' => [
- 'title' => '云产品',
- 'description' => 'The cloud service.'."\n",
- 'type' => 'string',
- 'example' => 'OSS',
- ],
- 'TotalCount' => [
- 'title' => '用户资源总数',
- 'description' => 'The total number of cloud resources on which certificates are deployed.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'AccessId' => ['description' => 'The ID of the primary key.', 'type' => 'integer', 'format' => 'int64', 'example' => '888', 'title' => ''],
+ 'CloudName' => ['description' => 'The cloud service provider.', 'type' => 'string', 'example' => 'Tencent', 'title' => ''],
+ 'SecretId' => ['description' => 'The AccessKey ID that is used to access cloud resources.', 'type' => 'string', 'example' => 'AAAZCJQ******', 'title' => ''],
+ 'ServiceStatus' => ['description' => 'The service status. The value normal indicates that the service runs as expected.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '09470F19-CEE8-5C63-BF2C-02B5E3F07A17',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"CloudName\\": \\"aliyun\\",\\n \\"CloudProduct\\": \\"OSS\\",\\n \\"TotalCount\\": 2\\n }\\n ],\\n \\"RequestId\\": \\"09470F19-CEE8-5C63-BF2C-02B5E3F07A17\\"\\n}","type":"json"}]',
- 'title' => 'DescribeCloudResourceStatus',
+ 'title' => 'ListCloudAccess',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCloudAccess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3F1FA43-1C26-50A2-8F0F-7A03851DBB46\\",\\n \\"TotalCount\\": 23,\\n \\"ShowSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"CloudAccessList\\": [\\n {\\n \\"AccessId\\": 888,\\n \\"CloudName\\": \\"Tencent\\",\\n \\"SecretId\\": \\"AAAZCJQ******\\",\\n \\"ServiceStatus\\": \\"normal\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListCloudResources' => [
- 'summary' => 'Queries the certificate resources of a cloud service provider and cloud services.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4436,9 +4612,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '214597',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
@@ -4446,135 +4620,125 @@
'name' => 'CloudName',
'in' => 'query',
'schema' => [
- 'title' => '云厂商:',
'description' => 'The cloud service provider.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
- .'* Tencent'."\n"
- .'* Huawei'."\n"
- .'* Aws'."\n"
- .'* aliyun'."\n",
+ .'- Tencent'."\n"
+ ."\n"
+ .'- Huawei'."\n"
+ ."\n"
+ .'- Aws'."\n"
+ ."\n"
+ .'- aliyun',
+ 'enumValueTitles' => ['Tencent' => '', 'Huawei' => '', 'Aws' => '', 'aliyun' => ''],
'type' => 'string',
+ 'title' => '',
'required' => false,
- 'enumValueTitles' => [
- 'Tencent' => '',
- 'Huawei' => '',
- 'Aws' => '',
- 'aliyun' => '',
- ],
- 'example' => 'Tencent',
+ 'example' => 'aliyun',
],
],
[
'name' => 'CloudProduct',
'in' => 'query',
'schema' => [
- 'title' => '云产品：',
- 'description' => 'The cloud service.'."\n"
+ 'description' => 'The cloud service name. Used to filter resources by cloud service.'."\n"
."\n"
.'Valid values when CloudName is set to aliyun:'."\n"
."\n"
- .'* SLB: Classic Load Balancer (CLB). This value is available only on the China site (aliyun.com).'."\n"
- .'* LIVE: ApsaraVideo Live. This value is available only on the China site (aliyun.com).'."\n"
- .'* webHosting: Cloud Web Hosting. This value is available only on the China site (aliyun.com).'."\n"
- .'* VOD: ApsaraVideo VOD. This value is available only on the China site (aliyun.com).'."\n"
- .'* CR: Container Registry. This value is available only on the China site (aliyun.com).'."\n"
- .'* DCDN: Dynamic Content Delivery Network (DCDN).'."\n"
- .'* DDOS: Anti-DDoS.'."\n"
- .'* CDN: Alibaba Cloud CDN (CDN).'."\n"
- .'* ALB: Application Load Balancer (ALB).'."\n"
- .'* APIGateway: API Gateway.'."\n"
- .'* FC: Function Compute.'."\n"
- .'* GA: Global Accelerator (GA).'."\n"
- .'* MSE: Microservices Engine (MSE).'."\n"
- .'* NLB: Network Load Balancer (NLB).'."\n"
- .'* OSS: Object Storage Service (OSS).'."\n"
- .'* SAE: Serverless App Engine (SAE).'."\n"
- .'* WAF: Web Application Firewall (WAF).'."\n"
+ .'- SLB: Classic Load Balancer (CLB). This value is available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- LIVE: ApsaraVideo Live. This value is available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- webHosting: Cloud Web Hosting. This value is available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- VOD: ApsaraVideo VOD. This value is available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- CR: Container Registry. This value is available only on the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- DCDN: Dynamic Content Delivery Network (DCDN).'."\n"
+ ."\n"
+ .'- DDOS: Anti-DDoS.'."\n"
+ ."\n"
+ .'- CDN: Alibaba Cloud CDN (CDN).'."\n"
+ ."\n"
+ .'- ALB: Application Load Balancer (ALB).'."\n"
+ ."\n"
+ .'- APIGateway: API Gateway.'."\n"
+ ."\n"
+ .'- FC: Function Compute.'."\n"
+ ."\n"
+ .'- GA: Global Accelerator (GA).'."\n"
+ ."\n"
+ .'- MSE: Microservices Engine (MSE).'."\n"
+ ."\n"
+ .'- NLB: Network Load Balancer (NLB).'."\n"
+ ."\n"
+ .'- OSS: Object Storage Service (OSS).'."\n"
+ ."\n"
+ .'- SAE: Serverless App Engine (SAE).'."\n"
+ ."\n"
+ .'- WAF: Web Application Firewall (WAF).'."\n"
."\n"
.'Valid values when CloudName is set to Tencent:'."\n"
."\n"
- .'* TencentCDN: Content Delivery Network (CDN).'."\n"
- .'* TencentCLB: CLB.'."\n"
- .'* TencentWAF: WAF.'."\n"
+ .'- TencentCDN: Content Delivery Network (CDN).'."\n"
+ ."\n"
+ .'- TencentCLB: CLB.'."\n"
+ ."\n"
+ .'- TencentWAF: WAF.'."\n"
."\n"
.'Valid value when CloudName is set to Huawei:'."\n"
."\n"
- .'* HuaweiCDN: CDN.'."\n"
+ .'- HuaweiCDN: CDN.'."\n"
."\n"
.'Valid values when CloudName is set to Aws:'."\n"
."\n"
- .'* AwsCloudFront: Amazon CloudFront.'."\n"
- .'* AwsCLB: CLB.'."\n"
- .'* AwsALB: ALB.'."\n"
- .'* AwsNLB: NLB.'."\n",
+ .'- AwsCloudFront: Amazon CloudFront.'."\n"
+ ."\n"
+ .'- AwsCLB: CLB.'."\n"
+ ."\n"
+ .'- AwsALB: ALB.'."\n"
+ ."\n"
+ .'- AwsNLB: NLB.',
+ 'enumValueTitles' => [],
'type' => 'string',
+ 'title' => '',
'required' => false,
- 'enumValueTitles' => [],
'example' => 'SLB',
],
],
[
'name' => 'SecretId',
'in' => 'query',
- 'schema' => [
- 'title' => '云资源访问ID',
- 'description' => 'The AccessKey ID that is used to access cloud resources.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '21',
- ],
+ 'schema' => ['description' => 'The AccessKey ID that is used to access cloud resources.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'AK96*******6M'],
],
[
'name' => 'Keyword',
'in' => 'query',
- 'schema' => [
- 'title' => '云资源绑定域名',
- 'description' => 'The keyword of the domain name or instance ID bound to the cloud resource.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cert-instanceId',
- ],
+ 'schema' => ['description' => 'The keyword of the domain name or instance ID bound to the cloud resource.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cert-instanceId'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: **1**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ShowSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Default value: **20**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Default value: **20**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'CertIds',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '根据证书ID过滤',
- 'description' => 'The certificate IDs.'."\n",
+ 'title' => '',
+ 'description' => 'The certificate IDs. Separate multiple IDs with commas (,).',
'type' => 'array',
- 'items' => [
- 'description' => 'The certificate ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '14440149',
- ],
+ 'items' => ['description' => 'The certificate ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14440149', 'title' => ''],
'required' => false,
+ 'example' => '',
],
],
],
@@ -4582,235 +4746,128 @@
200 => [
'schema' => [
'title' => 'OpenApiPaginationResponse<CloudResource>',
- 'description' => 'OpenApiPaginationResponse.'."\n",
+ 'description' => 'OpenApiPaginationResponse.',
'type' => 'object',
'properties' => [
- 'Total' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '440',
- ],
- 'CurrentPage' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ShowSize' => [
- 'description' => 'The number of entries per page. Default value: **20**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '440', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ShowSize' => ['description' => 'The number of entries per page. Default value: **20**.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'Data' => [
- 'description' => 'The data returned for the request.'."\n",
+ 'description' => 'The data returned for the request.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '云资源ID',
- 'description' => 'The ID of the cloud resource.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2356',
- ],
- 'GmtCreate' => [
- 'title' => '数据创建时间',
- 'description' => 'The time when the cloud resource was created. The time is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'example' => '1673423339000',
- ],
- 'GmtModified' => [
- 'title' => '数据更新时间',
- 'description' => 'The time when the cloud resource was last modified. The time is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'example' => '1696911946000',
- ],
- 'CloudProduct' => [
- 'title' => '云产品',
- 'description' => 'The cloud service.'."\n",
- 'type' => 'string',
- 'example' => 'ALB',
- ],
- 'UserId' => [
- 'title' => '用户ID',
- 'description' => 'The ID of the Alibaba Cloud account.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666884372152785',
- ],
- 'CertId' => [
- 'title' => '云资源绑定证书ID',
- 'description' => 'The ID of the certificate bound to the cloud resource.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12433121',
- ],
- 'CertName' => [
- 'title' => '云资源绑定证书名称',
- 'description' => 'The name of the certificate bound to the cloud resource.'."\n",
- 'type' => 'string',
- 'example' => 'shop.amsaudio.cn',
- ],
- 'CertEndTime' => [
- 'title' => '云资源绑定证书结束日期',
- 'description' => 'The end date of the certificate bound to the cloud resource. The value is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'example' => '1737795520000',
- ],
- 'CertStartTime' => [
- 'title' => '云资源绑定证书开始日期',
- 'description' => 'The start date of the certificate bound to the cloud resource. The value is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'example' => '1706259520000',
- ],
- 'Domain' => [
- 'title' => '云资源绑定域名',
- 'description' => 'The domain name bound to the cloud resource.'."\n",
- 'type' => 'string',
- 'example' => 'www.tkgeo.ru',
- ],
- 'InstanceId' => [
- 'title' => '云资源实例ID',
- 'description' => 'The instance ID of the cloud resource.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'string',
- 'example' => 'nlb-rv05agjc97ovm14il5',
- ],
- 'ListenerId' => [
- 'title' => '云资源监听ID',
- 'description' => 'The listener ID of the cloud resource.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'string',
- 'example' => 'lsn-jiugof6t23et66lsnc@443',
- ],
- 'ListenerPort' => [
- 'title' => '云资源监听端口',
- 'description' => 'The listening port of the cloud resource.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'string',
- 'example' => '8047',
- ],
+ 'Id' => ['description' => 'The ID of the cloud resource.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2356'],
+ 'GmtCreate' => ['description' => 'The time when the cloud resource was created. The time is a timestamp in seconds.', 'type' => 'string', 'title' => '', 'example' => '1673423339000'],
+ 'GmtModified' => ['description' => 'The time when the cloud resource was last modified. The time is a timestamp in seconds.', 'type' => 'string', 'title' => '', 'example' => '1696911946000'],
+ 'CloudProduct' => ['description' => 'The cloud service.', 'type' => 'string', 'title' => '', 'example' => 'ALB'],
+ 'UserId' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1666884372******'],
+ 'CertId' => ['description' => 'The ID of the certificate bound to the cloud resource.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12433121'],
+ 'CertName' => ['description' => 'The name of the certificate bound to the cloud resource.', 'type' => 'string', 'title' => '', 'example' => 'example'],
+ 'CertEndTime' => ['description' => 'The end date of the certificate bound to the cloud resource. The value is a timestamp in seconds.', 'type' => 'string', 'title' => '', 'example' => '1737795520000'],
+ 'CertStartTime' => ['description' => 'The start date of the certificate bound to the cloud resource. The value is a timestamp in seconds.', 'type' => 'string', 'title' => '', 'example' => '1706259520000'],
+ 'Domain' => ['description' => 'The domain name bound to the cloud resource.', 'type' => 'string', 'title' => '', 'example' => 'example.com'],
+ 'InstanceId' => ['description' => 'The instance ID of the cloud resource.'."\n"
+ ."\n"
+ .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.', 'type' => 'string', 'title' => '', 'example' => 'nlb-rv05a********14il5'],
+ 'ListenerId' => ['description' => 'The listener ID of the cloud resource.'."\n"
+ ."\n"
+ .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.', 'type' => 'string', 'title' => '', 'example' => 'lsn-jiug********66lsnc@443'],
+ 'ListenerPort' => ['description' => 'The listening port of the cloud resource.'."\n"
+ ."\n"
+ .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.', 'type' => 'string', 'title' => '', 'example' => '443'],
'EnableHttps' => [
- 'title' => '云资源开启HTTPS',
'description' => 'Indicates whether HTTPS is enabled for the cloud resource. Valid values:'."\n"
."\n"
- .'* **1**: yes.'."\n"
- .'* **0**: no.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '',
- '',
- ],
- 'example' => '1',
- ],
- 'DefaultResource' => [
- 'title' => '云资源是否为默认资源',
- 'description' => 'Indicates whether the cloud resource is the default resource. Valid values:'."\n"
- ."\n"
- .'* **1**: yes'."\n"
- .'* **0**: no'."\n"
+ .'- **1**: yes.'."\n"
."\n"
- .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Status' => [
- 'title' => '云资源状态',
- 'description' => 'The status of the cloud resource.'."\n",
- 'type' => 'string',
- 'example' => 'BUY',
- ],
- 'UseSsl' => [
- 'title' => '使用SSL',
- 'description' => 'Indicates whether an Alibaba Cloud SSL certificate is used. Valid values:'."\n"
- ."\n"
- .'* **1**: yes'."\n"
- .'* **0**: no'."\n"
- ."\n"
- .'> This parameter is required only when you deploy certificates to services of multiple clouds.'."\n",
+ .'- **0**: no.',
+ 'enumValueTitles' => ['', ''],
'type' => 'integer',
'format' => 'int32',
+ 'title' => '',
'example' => '1',
],
- 'RegionId' => [
- 'title' => '云资源RegionID',
- 'description' => 'The region ID of the cloud resource.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
+ 'DefaultResource' => ['description' => 'Indicates whether the cloud resource is the default resource. Valid values:'."\n"
+ ."\n"
+ .'- **1**: yes'."\n"
+ ."\n"
+ .'- **0**: no'."\n"
+ ."\n"
+ .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'Status' => ['description' => 'The status of the cloud resource.', 'type' => 'string', 'title' => '', 'example' => 'BUY'],
+ 'UseSsl' => ['description' => 'Indicates whether an Alibaba Cloud SSL certificate is used. Valid values:'."\n"
+ ."\n"
+ .'- **1**: yes'."\n"
+ ."\n"
+ .'- **0**: no'."\n"
+ ."\n"
+ .'> This parameter is required only when you deploy certificates to services of multiple clouds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'RegionId' => ['description' => 'The region ID of the cloud resource.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'],
'CloudName' => [
- 'title' => '云资源供应商：',
'description' => 'The cloud service provider.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
- .'* Tencent'."\n"
- .'* Huawei'."\n"
- .'* Aws'."\n"
- .'* aliyun'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Tencent' => '',
- 'Huawei' => '',
- 'Aws' => '',
- 'aliyun' => '',
- ],
- 'example' => 'aliyun',
- ],
- 'CloudRegion' => [
- 'title' => '云资源在云供应商的RegionID',
- 'description' => 'The region ID of the cloud service provider to which the cloud resource belongs.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou'."\n",
- ],
- 'CloudAccessId' => [
- 'title' => '云资源访问ID',
- 'description' => 'The AccessKey ID that is used to access cloud resources.'."\n"
+ .'- Tencent'."\n"
+ ."\n"
+ .'- Huawei'."\n"
+ ."\n"
+ .'- Aws'."\n"
."\n"
- .'> This parameter is returned only when you deploy certificates to cloud services of third-party clouds.'."\n",
+ .'- aliyun',
+ 'enumValueTitles' => ['Tencent' => '', 'Huawei' => '', 'Aws' => '', 'aliyun' => ''],
'type' => 'string',
- 'example' => '1234',
+ 'title' => '',
+ 'example' => 'aliyun',
],
+ 'CloudRegion' => ['description' => 'The region ID of the cloud service provider to which the cloud resource belongs.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'."\n"],
+ 'CloudAccessId' => ['description' => 'The AccessKey ID that is used to access cloud resources.'."\n"
+ ."\n"
+ .'> This parameter is returned only when you deploy certificates to cloud services of third-party clouds.', 'type' => 'string', 'title' => '', 'example' => 'AK96*******6M'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '12345678-1234-1234-1234-123456789ABC',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789ABC', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 440,\\n \\"CurrentPage\\": 1,\\n \\"ShowSize\\": 20,\\n \\"Data\\": [\\n {\\n \\"Id\\": 2356,\\n \\"GmtCreate\\": \\"1673423339000\\",\\n \\"GmtModified\\": \\"1696911946000\\",\\n \\"CloudProduct\\": \\"ALB\\",\\n \\"UserId\\": 0,\\n \\"CertId\\": 12433121,\\n \\"CertName\\": \\"example\\",\\n \\"CertEndTime\\": \\"1737795520000\\",\\n \\"CertStartTime\\": \\"1706259520000\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"InstanceId\\": \\"nlb-rv05a********14il5\\",\\n \\"ListenerId\\": \\"lsn-jiug********66lsnc@443\\",\\n \\"ListenerPort\\": \\"443\\",\\n \\"EnableHttps\\": 1,\\n \\"DefaultResource\\": 0,\\n \\"Status\\": \\"BUY\\",\\n \\"UseSsl\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CloudName\\": \\"aliyun\\",\\n \\"CloudRegion\\": \\"cn-hangzhou\\\\n\\",\\n \\"CloudAccessId\\": \\"AK96*******6M\\"\\n }\\n ],\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\"\\n}","type":"json"}]',
'title' => 'ListCloudResources',
- ],
- 'ListCloudAccess' => [
- 'summary' => 'Queries a list of AccessKey pairs for multi-cloud deployment.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'summary' => 'Queries the cloud resources on which certificates are deployed, such as Server Load Balancer (SLB) instances and CDN domains.',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-13T08:47:18.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCloudResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 440,\\n \\"CurrentPage\\": 1,\\n \\"ShowSize\\": 20,\\n \\"Data\\": [\\n {\\n \\"Id\\": 2356,\\n \\"GmtCreate\\": \\"1673423339000\\",\\n \\"GmtModified\\": \\"1696911946000\\",\\n \\"CloudProduct\\": \\"ALB\\",\\n \\"UserId\\": 0,\\n \\"CertId\\": 12433121,\\n \\"CertName\\": \\"example\\",\\n \\"CertEndTime\\": \\"1737795520000\\",\\n \\"CertStartTime\\": \\"1706259520000\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"InstanceId\\": \\"nlb-rv05a********14il5\\",\\n \\"ListenerId\\": \\"lsn-jiug********66lsnc@443\\",\\n \\"ListenerPort\\": \\"443\\",\\n \\"EnableHttps\\": 1,\\n \\"DefaultResource\\": 0,\\n \\"Status\\": \\"BUY\\",\\n \\"UseSsl\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CloudName\\": \\"aliyun\\",\\n \\"CloudRegion\\": \\"cn-hangzhou\\\\n\\",\\n \\"CloudAccessId\\": \\"AK96*******6M\\"\\n }\\n ],\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\"\\n}","type":"json"}]',
+ ],
+ 'ListContact' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4822,142 +4879,92 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '214631',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '214629',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'SecretId',
+ 'name' => 'Keyword',
'in' => 'query',
- 'schema' => [
- 'description' => 'The AccessKey ID that is used to access cloud resources.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '276',
- ],
+ 'schema' => ['description' => 'The search keyword, such as a keyword in the name, email address, or phone number.', 'type' => 'string', 'required' => false, 'example' => '186', 'title' => ''],
],
[
- 'name' => 'CloudName',
+ 'name' => 'ShowSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cloud service provider. Set the value to **Tencent**, which indicates Tencent Cloud.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Tencent',
- ],
+ 'schema' => ['description' => 'The number of contacts to display per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'ShowSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Valid values: **10**, **20**, and **50**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The current page number for paged queries. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'D3F1FA43-1C26-50A2-8F0F-7A03851DBB46',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- 'ShowSize' => [
- 'description' => 'The number of entries per page. If ShowSize is not specified, this parameter is not returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'CurrentPage' => [
- 'description' => 'The default value is the current page. If CurrentPage is not specified, this parameter is not returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CloudAccessList' => [
- 'description' => 'The query results.'."\n",
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '31C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of search results.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ 'ShowSize' => ['description' => 'The number of certificates displayed per page in a paged query. Default value: **20**.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The current page number in a paged query. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Keyword' => ['description' => 'The fuzzy match keyword.', 'type' => 'string', 'example' => '186', 'title' => ''],
+ 'ContactList' => [
+ 'description' => 'The contact list.',
'type' => 'array',
'items' => [
- 'description' => 'The cloud service.'."\n",
+ 'description' => 'The contact object.',
'type' => 'object',
'properties' => [
- 'AccessId' => [
- 'description' => 'The ID of the primary key.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '888',
- ],
- 'CloudName' => [
- 'description' => 'The cloud service provider.'."\n",
- 'type' => 'string',
- 'example' => 'Tencent',
- ],
- 'SecretId' => [
- 'description' => 'The AccessKey ID that is used to access cloud resources.'."\n",
- 'type' => 'string',
- 'example' => 'AAAqdwPBA****',
- ],
- 'ServiceStatus' => [
- 'description' => 'The service status. The value normal indicates that the service runs as expected.'."\n",
- 'type' => 'string',
- 'example' => 'normal',
- ],
+ 'ContactId' => ['description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '519580', 'title' => ''],
+ 'Name' => ['description' => 'The contact name.', 'type' => 'string', 'example' => 'John', 'title' => ''],
+ 'Mobile' => ['description' => 'The mobile phone number.', 'type' => 'string', 'example' => '139****8888', 'title' => ''],
+ 'MobileStatus' => ['description' => 'Indicates whether the mobile phone number is verified.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Email' => ['description' => 'The email address of the contact.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''],
+ 'EmailStatus' => ['description' => 'Indicates whether the email address is verified.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Webhooks' => ['description' => 'The webhook URL.', 'type' => 'string', 'example' => '[\\"https://open.feishu.cn/open-apis/bot/v2/hook/XXX\\",\\"https://oapi.dingtalk.com/robot/send?access_token=XXX\\",\\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX\\"]', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3F1FA43-1C26-50A2-8F0F-7A03851DBB46\\",\\n \\"TotalCount\\": 23,\\n \\"ShowSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"CloudAccessList\\": [\\n {\\n \\"AccessId\\": 888,\\n \\"CloudName\\": \\"Tencent\\",\\n \\"SecretId\\": \\"AAAZCJQ******\\",\\n \\"ServiceStatus\\": \\"normal\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListCloudAccess',
- ],
- 'DescribeCertificateState' => [
- 'summary' => 'Queries the status of a specified certificate application order.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Retrieve contact list',
+ 'summary' => 'Retrieves a list of contacts.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListContact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"TotalCount\\": 12,\\n \\"ShowSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"Keyword\\": \\"186\\",\\n \\"ContactList\\": [\\n {\\n \\"ContactId\\": 519580,\\n \\"Name\\": \\"John\\",\\n \\"Mobile\\": \\"139****8888\\",\\n \\"MobileStatus\\": 1,\\n \\"Email\\": \\"username@example.com\\",\\n \\"EmailStatus\\": 1,\\n \\"Webhooks\\": \\"[\\\\\\\\\\\\\\"https://open.feishu.cn/open-apis/bot/v2/hook/XXX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"https://oapi.dingtalk.com/robot/send?access_token=XXX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX\\\\\\\\\\\\\\"]\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListCsr' => [
+ 'summary' => 'Queries the certificate signing requests (CSRs) in your account.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4966,784 +4973,797 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '81673',
- 'abilityTreeNodes' => [
- 'FEATUREcasP4AIN0',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ 'abilityTreeCode' => '213371',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'OrderId',
+ 'name' => 'KeyWord',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The keyword for fuzzy search. For example, you can specify a domain name.', 'type' => 'string', 'required' => false, 'example' => 'test_name', 'title' => ''],
+ ],
+ [
+ 'name' => 'Algorithm',
'in' => 'query',
'schema' => [
- 'description' => 'The ID of the certificate application order that you want to query.'."\n"
- ."\n"
- .'> You can call the [ListUserCertificateOrder](~~455804~~) operation to obtain the ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123451222',
+ 'description' => 'The algorithm. Valid values: RSA, ECC, and SM2.',
+ 'enumValueTitles' => ['RSA' => 'RSA', 'ECC' => 'ECC', 'SM2' => 'SM2'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'RSA',
+ 'title' => '',
],
],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShowSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. Default value: 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'description' => 'The object.',
'type' => 'object',
'properties' => [
- 'Type' => [
- 'description' => 'The status of the certificate application order. Valid values:'."\n"
- ."\n"
- .'* **domain_verify**: **pending review**, which indicates that you have not completed the verification of the domain name ownership after you submit the certificate application.'."\n"
- .' >After you submit a certificate application, you must manually complete the verification of the domain name ownership. The CA reviews the certificate application only after the verification is complete. If you have not completed the verification of the domain name ownership, you can complete the verification based on the data returned by this operation.'."\n"
- ."\n"
- .'* **process**: **being reviewed**, which indicates that the certificate application is being reviewed by the CA.'."\n"
- ."\n"
- .'* **verify_fail**: **review failed**, which indicates that the certificate application failed to be reviewed.'."\n"
- .' > If a certificate application fails to be reviewed, the information that you specified in the certificate application may be incorrect. We recommend that you call the [DeleteCertificateRequest](~~164109~~) operation to delete the certificate application order and resubmit a certificate application. After the order is deleted, the quota that is consumed for the order is released.'."\n"
- ."\n"
- .'* **certificate**: **issued**, which indicates that the certificate is issued.'."\n"
- ."\n"
- .'* **payed**: **pending application**, which indicates that you have not submitted a certificate application.'."\n"
- ."\n"
- .'* **unknow**: The status is **unknown**.',
- 'type' => 'string',
- 'example' => 'domain_verify',
- ],
- 'Domain' => [
- 'description' => 'The domain name to be verified when you use the file verification method. You must connect to the DNS server of the domain name and create a file on the server. The file is specified by the **Uri** parameter.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of the **Type** parameter is **domain_verify** and the value of the **ValidateType** parameter is **FILE**. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value FILE indicates that the file verification method is used.'."\n",
- 'type' => 'string',
- 'example' => 'www.example.com',
- ],
- 'RecordType' => [
- 'description' => 'The type of the DNS record that you need to add when you use the DNS verification method. Valid values:'."\n"
- ."\n"
- .'* **TXT**'."\n"
- .'* **CNAME**'."\n"
- ."\n"
- .'> This parameter is returned only when the value of the **Type** parameter is **domain_verify** and the value of the **ValidateType** parameter is **DNS**. The value domain_verify indicates that the verification of the domain name ownership is not complete.'."\n",
- 'type' => 'string',
- 'example' => 'TXT',
- ],
- 'CertId' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76',
- ],
- 'RecordDomain' => [
- 'description' => 'The DNS record that you need to manage when you use the DNS verification method.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of the **Type** parameter is **domain_verify** and the value of the **ValidateType** parameter is **DNS**. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value DNS indicates that the DNS verification method is used.'."\n",
- 'type' => 'string',
- 'example' => '_dnsauth',
- ],
- 'PrivateKey' => [
- 'description' => 'The private key of the certificate in the PEM format. For more information about the PEM format and how to convert certificate formats, see [What formats are used for mainstream digital certificates?](~~42214~~)'."\n"
- ."\n"
- .'> This parameter is returned only when the value of the **Type** parameter is **certificate**. The value certificate indicates that the certificate is issued.'."\n",
- 'type' => 'string',
- 'example' => '——BEGIN RSA PRIVATE KEY—— …… ——END RSA PRIVATE KEY——',
- ],
- 'ValidateType' => [
- 'description' => 'The verification method of the domain name ownership. Valid values:'."\n"
- ."\n"
- .'* **DNS**: DNS verification. If you use this method, you must add a TXT record to the DNS records of the domain name in the management platform of the domain name.'."\n"
- .'* **FILE**: file verification. If you use this method, you must create a specified file on the DNS server.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of the **Type** parameter is **domain_verify**. The value domain_verify indicates that the verification of the domain name ownership is not complete.'."\n",
- 'type' => 'string',
- 'example' => 'FILE',
- ],
- 'RecordValue' => [
- 'description' => 'You need to add a TXT record to the DNS records only when you use the DNS verification method.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of the **Type** parameter is **domain_verify** and the value of the **ValidateType** parameter is **DNS**. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value DNS indicates that the DNS verification method is used.'."\n",
- 'type' => 'string',
- 'example' => '20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy',
- ],
- 'Content' => [
- 'description' => 'The content that you need to write to the newly created file when you use the file verification method.'."\n"
- ."\n"
- .'> This parameter is returned only when the value of the **Type** parameter is **domain_verify** and the value of the **ValidateType** parameter is **FILE**. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value FILE indicates that the file verification method is used.'."\n",
- 'type' => 'string',
- 'example' => 'http://example.com/.well-known/pki-validation/fileauth.txt',
- ],
- 'Uri' => [
- 'description' => 'The file that you need to create on the DNS server when you use the file verification method. **The value of this parameter contains the file path and file name.**'."\n"
- ."\n"
- .'> This parameter is returned only when the value of the **Type** parameter is **domain_verify** and the value of the **ValidateType** parameter is **FILE**. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value FILE indicates that the file verification method is used.'."\n",
- 'type' => 'string',
- 'example' => '/.well-known/pki-validation/fileauth.txt',
- ],
- 'Certificate' => [
- 'description' => 'The content of the certificate in the PEM format. For more information about the PEM format and how to convert certificate formats, see [What formats are used for mainstream digital certificates?](~~42214~~)'."\n"
- ."\n"
- .'> This parameter is returned only when the value of the **Type** parameter is **certificate**. The value certificate indicates that the certificate is issued.'."\n",
- 'type' => 'string',
- 'example' => '——BEGIN CERTIFICATE—— …… ——END CERTIFICATE——',
+ 'ShowSize' => ['description' => 'The number of entries per page. Default value: 50.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'CsrList' => [
+ 'description' => 'The CSRs.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'CsrId' => ['description' => 'The ID of the CSR.', 'type' => 'integer', 'format' => 'int64', 'example' => '3454', 'title' => ''],
+ 'Algorithm' => ['description' => 'The algorithm. Valid values: RSA, SM2, and ECC.', 'type' => 'string', 'example' => 'RSA', 'title' => ''],
+ 'KeySize' => ['description' => 'The key length that is used by the algorithm. The key length for RSA algorithms can be 2,048, 3,072, and 4,096 bits. The key length for ECC and SM2 algorithms can be 256 bits.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''],
+ 'KeySha2' => ['description' => 'The public key that is calculated by using the SHA256 algorithm.', 'type' => 'string', 'example' => '1234', 'title' => ''],
+ 'CommonName' => ['description' => 'The primary domain name, which is a common name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''],
+ 'Sans' => ['description' => 'The secondary domain names. Separate multiple domain names with commas (,).', 'type' => 'string', 'example' => 'www.aliyundoc.com,www.example.com', 'title' => ''],
+ 'CountryCode' => ['description' => 'The code of the country or region in which the organization is located. For example, you can use CN to indicate China and use US to indicate the United States. The default value is the code of the country or region in which the organization is located. The organization is associated with the intermediate CA certificate from which the certificate is issued. For more information about country codes, see the "Country codes" section of the [Manage company profiles](~~198289~~) topic.', 'type' => 'string', 'example' => 'CN', 'title' => ''],
+ 'Province' => ['description' => 'The province or location.', 'type' => 'string', 'example' => 'Beijing', 'title' => ''],
+ 'Locality' => ['description' => 'The city where the company is located.', 'type' => 'string', 'example' => 'Beijing', 'title' => ''],
+ 'CorpName' => ['description' => 'The name of the company.', 'type' => 'string', 'example' => '北京CSR科技有限公司', 'title' => ''],
+ 'Department' => ['description' => 'The department that uses the certificate.', 'type' => 'string', 'example' => 'IT', 'title' => ''],
+ 'HasPrivateKey' => ['description' => 'Indicates whether the certificate contains a private key.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Name' => ['description' => 'The name of the CSR.', 'type' => 'string', 'example' => 'test_name', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E865F6AD-0294-4A24-A58B-DAC6BE2BDD20', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"domain_verify\\",\\n \\"Domain\\": \\"www.example.com\\",\\n \\"RecordType\\": \\"TXT\\",\\n \\"CertId\\": \\"111111\\",\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\",\\n \\"RecordDomain\\": \\"_dnsauth\\",\\n \\"PrivateKey\\": \\"-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----\\",\\n \\"ValidateType\\": \\"FILE\\",\\n \\"RecordValue\\": \\"20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy\\",\\n \\"Content\\": \\"http://example.com/.well-known/pki-validation/fileauth.txt\\",\\n \\"Uri\\": \\"/.well-known/pki-validation/fileauth.txt\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCertificateStateResponse>\\n <RequestId>082FAB35-6AB9-4FD5-8750-D36673548E76</RequestId>\\n <Type>domain_verify</Type>\\n <ValidateType>FILE</ValidateType>\\n <Domain>www.example.com</Domain>\\n <Uri>/.well-known/pki-validation/fileauth.txt</Uri>\\n <Content>http://example.com/.well-known/pki-validation/fileauth.txt</Content>\\n</DescribeCertificateStateResponse>","errorExample":""}]',
- 'title' => 'DescribeCertificateState',
- 'description' => 'If you do not complete the verification of the domain name ownership after you submit a certificate application, you can call this operation to obtain the information that is required to complete the verification. You can complete the verification of the domain name ownership based on the data returned. If you use the DNS verification method, you must complete the verification on the management platform of the domain name. If you use the file verification method, you must complete the verification on the DNS server.'."\n"
- ."\n"
- .'The certificate authority (CA) reviews your certificate application only after you complete the verification of the domain name ownership. After the CA approves your certificate application, the CA issues the certificate. If a certificate is issued, you can call this operation to obtain the CA certificate and private key of the certificate.',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateCertificateWithCsrRequest' => [
- 'summary' => 'Purchases, applies for, and issues a domain validated (DV) certificate by using a custom certificate signing request (CSR) file. You can use extended certificate services to purchase and apply for a DV certificate with a few clicks.',
- 'methods' => [
- 'post',
- 'get',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListCsr',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ShowSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalCount\\": 10,\\n \\"CsrList\\": [\\n {\\n \\"CsrId\\": 3454,\\n \\"Algorithm\\": \\"RSA\\",\\n \\"KeySize\\": 2048,\\n \\"KeySha2\\": \\"1234\\",\\n \\"CommonName\\": \\"example.com\\",\\n \\"Sans\\": \\"www.aliyundoc.com,www.example.com\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"Province\\": \\"Beijing\\",\\n \\"Locality\\": \\"Beijing\\",\\n \\"CorpName\\": \\"北京CSR科技有限公司\\",\\n \\"Department\\": \\"IT\\",\\n \\"HasPrivateKey\\": true,\\n \\"Name\\": \\"test_name\\"\\n }\\n ],\\n \\"RequestId\\": \\"E865F6AD-0294-4A24-A58B-DAC6BE2BDD20\\"\\n}","type":"json"}]',
+ ],
+ 'ListDeploymentJob' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '81671',
- 'abilityTreeNodes' => [
- 'FEATUREcasP4AIN0',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ 'abilityTreeCode' => '214571',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Csr',
+ 'name' => 'JobType',
'in' => 'query',
'schema' => [
- 'description' => 'The content of the CSR file.\\'."\n"
- .'The key algorithm in the CSR file must be Rivest-Shamir-Adleman (RSA) or elliptic-curve cryptography (ECC), and the key length of the RSA algorithm must be greater than or equal to 2,048 characters. For more information about how to create a CSR file, see [How do I create a CSR file?](~~42218~~)\\'."\n"
- .'A CSR file contains the information about your server and company. When you apply for a certificate, you must submit the CSR file to the CA. The CA signs the CSR file by using the private key of the root certificate and generates a public key file to issue your certificate.'."\n"
+ 'description' => 'The type of the deployment task.'."\n"
."\n"
- .'> The **CN** field in the CSR file specifies the domain name that is bound to the certificate.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----',
- ],
- ],
- [
- 'name' => 'ProductCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The specifications of the certificate that you want to apply for. Valid values:'."\n"
+ .'Valid values:'."\n"
."\n"
- .'* **digicert-free-1-free** (default): DigiCert single-domain DV certificate in a three-month free trial, available only on the China site (aliyun.com).'."\n"
- .'* **symantec-free-1-free**: DigiCert single-domain DV certificate in a one-year free trial, available only on the China site (aliyun.com).'."\n"
- .'* **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
- .'* **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
- .'* **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
- .'* **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
- .'* **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.'."\n",
+ .'- cloud: multi-cloud deployment task.'."\n"
+ ."\n"
+ .'- user: cloud service deployment task. This type of task does not support Elastic Compute Service (ECS) instances.',
+ 'enumValueTitles' => ['cloud' => '', 'user' => ''],
'type' => 'string',
'required' => false,
- 'example' => 'symantec-free-1-free',
- ],
- ],
- [
- 'name' => 'Username',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the applicant.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Tom',
- ],
- ],
- [
- 'name' => 'Phone',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The phone number of the applicant.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '1390000****',
+ 'example' => 'user',
+ 'title' => '',
],
],
[
- 'name' => 'Email',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => 'The contact email address of the applicant.'."\n",
+ 'description' => 'The status of the deployment task.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- success'."\n"
+ ."\n"
+ .'- pending'."\n"
+ ."\n"
+ .'- scheduling'."\n"
+ ."\n"
+ .'- processing'."\n"
+ ."\n"
+ .'- error'."\n"
+ ."\n"
+ .'- editing',
+ 'enumValueTitles' => ['success' => 'success', 'pending' => 'pending', 'scheduling' => 'scheduling', 'processing' => 'processing', 'error' => 'error', 'editing' => 'editing'],
'type' => 'string',
- 'required' => true,
- 'example' => 'username@example.com',
+ 'required' => false,
+ 'example' => 'pending',
+ 'title' => '',
],
],
[
- 'name' => 'ValidateType',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => 'The method to verify the ownership of a domain name. Valid values:'."\n"
- ."\n"
- .'* **DNS**: DNS verification. If you use this method, you must add a TXT record to the DNS records of the domain name in the management platform of the domain name. You must have operation permissions on domain name resolution to verify the ownership of the domain name.'."\n"
- .'* **FILE**: file verification. If you use this method, you must create a specified file on the DNS server. You must have administrative rights on the DNS server to verify the ownership of the domain name.'."\n"
- ."\n"
- .'For more information about the verification methods, see [Verify the ownership of a domain name](~~48016~~).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DNS',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Tags',
+ 'name' => 'ShowSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The tag list.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'database',
- ],
- 'Value' => [
- 'description' => 'The value of the tag.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page. Default value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => 'The ID of the certificate application order.'."\n"
- ."\n"
- .'> You can use the ID to query the status of the certificate application. For more information, see [DescribeCertificateState](~~164111~~).'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '98987582437920968',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n",
- 'type' => 'string',
- 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789ABC'],
+ 'Total' => ['description' => 'The total number of deployment tasks returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ShowSize' => ['description' => 'The number of deployment tasks per page. Default value: **50**.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The data returned for the request.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The ID of the deployment task. You can use the ID to query the details and status of the deployment task.', 'type' => 'integer', 'format' => 'int64', 'example' => '19975', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The time when the deployment task was created.', 'type' => 'string', 'example' => '1624343180000', 'title' => ''],
+ 'GmtModified' => ['description' => 'The time when the deployment task was last modified.', 'type' => 'string', 'example' => '1606482979000', 'title' => ''],
+ 'UserId' => ['description' => 'The ID of the user.', 'type' => 'integer', 'format' => 'int64', 'example' => '166688437*****', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID of the deployment task.', 'type' => 'string', 'example' => 'cas-job-user-***', 'title' => ''],
+ 'Name' => ['description' => 'The name of the deployment task.', 'type' => 'string', 'example' => 'job-test', 'title' => ''],
+ 'CertType' => [
+ 'description' => 'The type of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **upload**: uploaded certificate'."\n"
+ ."\n"
+ .'- **buy**: purchased certificate'."\n"
+ ."\n"
+ .'- **free**: free certificate, available only on the China site (aliyun.com)',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'example' => 'upload',
+ 'title' => '',
+ ],
+ 'ScheduleTime' => ['description' => 'The time when the deployment task was scheduled.', 'type' => 'string', 'example' => '1606482979000', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time of the deployment task.', 'type' => 'string', 'example' => '1606482979000', 'title' => ''],
+ 'EndTime' => ['description' => 'The end time of the deployment task.', 'type' => 'string', 'example' => '1606482979000', 'title' => ''],
+ 'Status' => [
+ 'description' => 'The status of the deployment task. Valid values:'."\n"
+ ."\n"
+ .'- **pending**'."\n"
+ ."\n"
+ .'- **editing**'."\n"
+ ."\n"
+ .'- **scheduling**'."\n"
+ ."\n"
+ .'- **processing**'."\n"
+ ."\n"
+ .'- **error**'."\n"
+ ."\n"
+ .'- **success**',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'example' => 'scheduling',
+ 'title' => '',
+ ],
+ 'Del' => [
+ 'description' => 'Indicates whether the deployment task is deleted. Valid values:'."\n"
+ ."\n"
+ .'- **0**: not deleted'."\n"
+ ."\n"
+ .'- **1**: deleted',
+ 'enumValueTitles' => [],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'title' => '',
+ ],
+ 'Rollback' => [
+ 'description' => 'Indicates whether the rollback worker is included. For example, if a cloud service involved in a deployment task has been rolled back, **1** is returned. Valid values:'."\n"
+ ."\n"
+ .'- **0**: The rollback worker is not included.'."\n"
+ ."\n"
+ .'- **1**: The rollback worker is included.',
+ 'enumValueTitles' => [],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'title' => '',
+ ],
+ 'JobType' => [
+ 'description' => 'The type of the deployment task.'."\n"
+ ."\n"
+ .'- **cloud**: multi-cloud deployment task.'."\n"
+ ."\n"
+ .'- **user**: cloud service deployment task. This type of task does not support ECS instances.',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'example' => 'user',
+ 'title' => '',
+ ],
+ 'CertDomain' => ['description' => 'The domain names bound to the certificate of the deployment task.', 'type' => 'string', 'example' => 'aliyundoc1.com,aliyundoc2.com,aliyundoc3.com', 'title' => ''],
+ 'ProductName' => ['description' => 'The cloud service included in the resources of the deployment task.', 'type' => 'string', 'example' => 'NLB', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 98987582437920960,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","type":"json"}]',
- 'title' => 'CreateCertificateWithCsrRequest',
- 'description' => '* You can use this operation to apply for only a domain validated (DV) certificate. You cannot use this operation to apply for an organization validated (OV) certificate. We recommend that you use the [CreateCertificateForPackageRequest](~~455296~~) operation to apply for a certificate. You can use the CreateCertificateForPackageRequest operation to apply for certificates of all types and specify the CSR generation method.'."\n"
- .'* Before you call this operation, make sure that you have purchased a certificate resource plan of the required specifications. For more information about how to purchase a certificate resource plan, see [Purchase a certificate resource plan](~~28542~~). You can call the [DescribePackageState](~~455803~~) operation to query the usage of a certificate resource plan of specified specifications, including the total number of certificate resource plans that you purchase, the number of certificate applications that you submit, and the number of certificates that are issued.'."\n"
- .'* When you call this operation, you can use the **ProductCode** parameter to specify the specifications of the certificate that you want to apply for.'."\n"
- .'* After you call this operation to submit a certificate application, the certificate quota of the required specifications that you purchased is consumed. After you call this operation, you must call the [DescribeCertificateState](~~455800~~) operation to obtain the information that is required for domain name ownership verification and manually complete the verification. Then, your certificate application is reviewed by the certificate authority (CA). If you use the Domain Name System (DNS) verification method, you must complete the verification on your DNS service provider system. If you use the file verification method, you must complete the verification on the DNS server.'."\n",
- 'responseParamsDescription' => ' ',
- 'extraInfo' => '|HTTP status code|Error code|Description|'."\n"
- .'|---|---|---|'."\n"
- .'|404|NotFoundPackage|The error message returned because no certificate resource plans were purchased.|'."\n"
- .'|404|NotRemainCount|The error message returned because the certificate quota is insufficient.|'."\n"
- .'|403|CreateCertificateRequestFailed|The error message returned because the request failed to be created.|'."\n"
- .'|404|NotFoundOrder|The error message returned because the specified certificate order was not found.|'."\n"
- .'|403|OrderStateError|The error message returned because the status of the certificate order is invalid.|'."\n"
- .'|403|DeleteFail|The error message returned because the certificate application order failed to be deleted.|'."\n"
- .'|500|Error|The error message returned because an error occurred.|',
- ],
- 'CreateCertificateRequest' => [
- 'summary' => 'Purchases, applies for, and issues a domain validated (DV) certificate by using extended certificate services.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListDeploymentJob',
+ 'summary' => 'Queries the certificate deployment tasks that are created in your account.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListDeploymentJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\",\\n \\"Total\\": 7,\\n \\"CurrentPage\\": 1,\\n \\"ShowSize\\": 50,\\n \\"Data\\": [\\n {\\n \\"Id\\": 19975,\\n \\"GmtCreate\\": \\"1624343180000\\",\\n \\"GmtModified\\": \\"1606482979000\\",\\n \\"UserId\\": 0,\\n \\"InstanceId\\": \\"cas-job-user-***\\",\\n \\"Name\\": \\"job-test\\",\\n \\"CertType\\": \\"upload\\",\\n \\"ScheduleTime\\": \\"1606482979000\\",\\n \\"StartTime\\": \\"1606482979000\\",\\n \\"EndTime\\": \\"1606482979000\\",\\n \\"Status\\": \\"scheduling\\",\\n \\"Del\\": 1,\\n \\"Rollback\\": 1,\\n \\"JobType\\": \\"user\\",\\n \\"CertDomain\\": \\"aliyundoc1.com,aliyundoc2.com,aliyundoc3.com\\",\\n \\"ProductName\\": \\"NLB\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListDeploymentJobCert' => [
+ 'summary' => 'Queries the certificates associated with a deployment task, such as the certificate instance ID, type, and name.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '214582',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ 'notSupportAutoTestReason' => '需要真实的，短信验证通过的手机号，无法进行自动化测试',
],
'parameters' => [
[
- 'name' => 'ProductCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The specifications of the certificate. Valid values:'."\n"
- ."\n"
- .'* **digicert-free-1-free** (default): DigiCert single-domain DV certificate, which is free and valid for 3 months.'."\n"
- .'* **symantec-free-1-free**: DigiCert single-domain DV certificate, which is free and valid for 1 year. This value is available only on the China site (aliyun.com).'."\n"
- .'* **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
- .'* **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
- .'* **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
- .'* **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
- .'* **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'symantec-free-1-free',
- ],
- ],
- [
- 'name' => 'Username',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the applicant.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Tom',
- ],
- ],
- [
- 'name' => 'Phone',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The phone number of the applicant.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '1390000****',
- ],
- ],
- [
- 'name' => 'Email',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The contact email address of the applicant.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'username@example.com',
- ],
- ],
- [
- 'name' => 'Domain',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The domain name that you want to bind to the certificate. You can specify only one domain name.'."\n"
- ."\n"
- .'> The domain name must match the certificate specifications that you specify for the **ProductCode** parameter. If you apply for a single-domain certificate, you must specify a single domain name for this parameter. If you apply for a wildcard certificate, you must specify a wildcard domain name such as `*.aliyundoc.com` for this parameter.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'www.aliyundoc.com',
- ],
- ],
- [
- 'name' => 'ValidateType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The method to verify the ownership of a domain name. Valid values:'."\n"
- ."\n"
- .'* **DNS**: DNS verification. If you use this method, you must add a TXT record to the DNS records of the domain name in the management platform of the domain name. You must have operation permissions on domain name resolution to verify the ownership of the domain name.'."\n"
- .'* **FILE**: file verification. If you use this method, you must create a specified file on the DNS server. You must have administrative rights on the DNS server to verify the ownership of the domain name.'."\n"
- ."\n"
- .'For more information about the verification methods, see [Verify the ownership of a domain name](~~48016~~).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DNS',
- ],
- ],
- [
- 'name' => 'Tags',
+ 'name' => 'JobId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key of the resource. You can specify up to 20 tag keys. You cannot specify empty strings as tag keys.'."\n"
- ."\n"
- .'The key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The key must start with a letter but cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`.'."\n"
- ."\n"
- .'> You must specify at least one of **Tag.N** (**Tag.N.Key** and **Tag.N.Value**).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acs:rm:rgId',
- ],
- 'Value' => [
- 'description' => 'The tag value. You can specify up to 20 tag values. The tag value can be an empty string.'."\n"
- ."\n"
- .'The tag value cannot exceed 128 characters in length, and can contain digits, periods (.), underscores (\\_), and hyphens (-). The key must start with a letter but cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the **JobId** parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '8888'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => 'OpenApiDefaultResponse<List<DeploymentJobCertInfo>>',
+ 'description' => 'OpenApiDefaultResponse\\<List>.',
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => 'The ID of the certificate application order.'."\n"
- ."\n"
- .'> You can use the ID to query the status of the certificate application. For more information, see [DescribeCertificateState](~~164111~~).'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '98987582437920968',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n",
- 'type' => 'string',
- 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D',
+ 'Data' => [
+ 'description' => 'The response parameters.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the certificate.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CertId' => ['description' => 'The ID of the certificate.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '11174100'],
+ 'OrderId' => ['description' => 'The ID of the certificate order.'."\n"
+ ."\n"
+ .'> If CertId is returned, this parameter is not returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '6127067'],
+ 'CertInstanceId' => ['description' => 'The instance ID of the certificate.', 'type' => 'string', 'title' => '', 'example' => 'cas-ivauto-2crxzi'],
+ 'CertName' => ['description' => 'The name of the certificate.', 'type' => 'string', 'title' => '', 'example' => 'cert-11488855'],
+ 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'title' => '', 'example' => 'example.com'],
+ 'Sans' => [
+ 'title' => '',
+ 'description' => 'The subject alternative name (SAN) extensions of the certificate.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The extended domain name of the certificate.', 'type' => 'string', 'example' => 'aliyundoc.com', 'title' => ''],
+ 'example' => '',
+ ],
+ 'Algorithm' => ['description' => 'The algorithm of the certificate public key.', 'type' => 'string', 'title' => '', 'example' => 'RSA'],
+ 'NotBeforeTime' => ['description' => 'The start time of the validity period of the certificate. The value is a timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1683625266108'],
+ 'NotAfterTime' => ['description' => 'The end time of the validity period of the certificate. The value is a timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1683625266108'],
+ 'Month' => ['description' => 'The month in which the certificate is applied for.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '12'],
+ 'StatusCode' => ['description' => 'The status code of the certificate. Valid values:'."\n"
+ ."\n"
+ .'- **payed**: paid and pending application'."\n"
+ ."\n"
+ .'- **checking**: being validated'."\n"
+ ."\n"
+ .'- **checkedFail**: validation failed'."\n"
+ ."\n"
+ .'- **revoked**: revoked'."\n"
+ ."\n"
+ .'- **revokeChecking**: revocation request being validated'."\n"
+ ."\n"
+ .'- **issued**: issued (excluding hosted certificates that are issued, certificates that are about to expire, expired certificates, and uploaded certificates)'."\n"
+ ."\n"
+ .'- **trustee**: hosted and issued'."\n"
+ ."\n"
+ .'- **upload**: uploaded (excluding certificates that are about to expire and expired certificates)'."\n"
+ ."\n"
+ .'- **willExpired**: about to expire (including certificates issued by using the Certificate Management Service (CAS) console and uploaded certificates)'."\n"
+ ."\n"
+ .'- **expired**: expired (including certificates issued by using the CAS console and uploaded certificates)'."\n"
+ ."\n"
+ .'- **validity**: valid (including certificates that are not expired or revoked)'."\n"
+ ."\n"
+ .'- **refund**: refunded'."\n"
+ ."\n"
+ .'- **closed**: closed', 'type' => 'string', 'title' => '', 'example' => 'issued'],
+ 'CertType' => ['description' => 'The type of the certificate.', 'type' => 'string', 'title' => '', 'example' => 'DV'],
+ 'CertOrderType' => ['description' => 'The type of the certificate order. Valid values:'."\n"
+ ."\n"
+ .'- **upload**: uploaded certificate.'."\n"
+ ."\n"
+ .'- **buy**: purchased certificate.'."\n"
+ ."\n"
+ .'- **free**: free certificate. This value is available only on the China site (aliyun.com).', 'type' => 'string', 'title' => '', 'example' => 'buy'],
+ 'IsTrustee' => ['title' => 'isTrustee', 'description' => 'Indicates whether the certificate is hosted. Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
],
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 98987582437920960,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","type":"json"}]',
- 'title' => 'CreateCertificateRequest',
- 'description' => '* You can call this operation to apply for only DV certificates. If you want to apply for an organization validated (OV) or extended validation (EV) certificate, we recommend that you call the [CreateCertificateForPackageRequest](~~455296~~) operation. This operation allows you to apply for certificates of all specifications and specify the method to generate a certificate signing request (CSR) file.'."\n"
- .'* Before you call this operation, make sure that you have purchased a certificate resource plan of the required specifications. For more information about how to purchase a certificate resource plan, see [Purchase a certificate resource plan](~~28542~~). You can call the [DescribePackageState](~~455803~~) operation to query the usage of a certificate resource plan of specified specifications, including the total number of certificate resource plans that you purchase, the number of certificate applications that you submit, and the number of certificates that are issued.'."\n"
- .'* When you call this operation, you can use the **ProductCode** parameter to specify the specifications of the certificate.'."\n"
- .'* After you call this operation to submit a certificate application, Certificate Management Service automatically creates a CSR file for your application and consumes the certificate quota in the certificate resource plans of the specified specifications that you purchased. After you call this operation, you also need to call the [DescribeCertificateState](~~455800~~) operation to obtain the information that is required to complete domain name verification, and manually complete the verification. If you use the DNS verification method, you must complete the verification on the management platform of the domain name. If you use the file verification method, you must complete the verification on your DNS server. Then, the certificate authority (CA) will review your certificate application.'."\n",
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteCertificateRequest' => [
- 'summary' => 'Deletes an order in which the application for a domain validated (DV) certificate failed.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListDeploymentJobCert',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListDeploymentJobCert',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"CertId\\": 11174100,\\n \\"OrderId\\": 6127067,\\n \\"CertInstanceId\\": \\"cas-ivauto-2crxzi\\",\\n \\"CertName\\": \\"cert-11488855\\",\\n \\"CommonName\\": \\"example.com\\",\\n \\"Sans\\": [\\n \\"aliyundoc.com\\"\\n ],\\n \\"Algorithm\\": \\"RSA\\",\\n \\"NotBeforeTime\\": 1683625266108,\\n \\"NotAfterTime\\": 1683625266108,\\n \\"Month\\": 12,\\n \\"StatusCode\\": \\"issued\\",\\n \\"CertType\\": \\"DV\\",\\n \\"CertOrderType\\": \\"buy\\",\\n \\"IsTrustee\\": true\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
+ ],
+ 'ListDeploymentJobResource' => [
+ 'summary' => 'Queries the cloud resources associated with a deployment task. An empty list indicates that the resources are invalid and must be re-associated.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '81672',
- 'abilityTreeNodes' => [
- 'FEATUREcasP4AIN0',
- ],
+ 'abilityTreeCode' => '214583',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'OrderId',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the certificate application order that you want to delete.'."\n"
- ."\n"
- .'> After you call the [CreateCertificateForPackageRequest](~~455296~~), [CreateCertificateRequest](~~455292~~), or [CreateCertificateWithCsrRequest](~~455801~~) operation to submit a certificate application, you can obtain the ID of the certificate application order from the **OrderId** response parameter. You can also call the [ListUserCertificateOrder](~~455804~~) operation to obtain the order ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123451222',
- ],
+ 'schema' => ['description' => 'The ID of the deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '8888'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'title' => 'OpenApiDefaultResponse<List<CloudResource>>',
+ 'description' => 'OpenApiDefaultResponse\\<List\\<CloudResource>>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76',
+ 'Data' => [
+ 'description' => 'The data returned.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The resource object of the deployment task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The ID of the cloud product resource.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20979'],
+ 'GmtCreate' => ['description' => 'The time when the synchronized resource was created. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'string', 'title' => '', 'example' => '1673423339000'],
+ 'GmtModified' => ['description' => 'The time when the synchronized resource was last modified. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'string', 'title' => '', 'example' => '1681956830000'],
+ 'CloudProduct' => ['description' => 'The cloud service.'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ ."\n"
+ .'- **SLB**: Classic Load Balancer (CLB) (China site only)'."\n"
+ ."\n"
+ .'- **LIVE**: ApsaraVideo Live (China site only)'."\n"
+ ."\n"
+ .'- **webHosting**: Cloud Web Hosting (China site only)'."\n"
+ ."\n"
+ .'- **VOD**: ApsaraVideo VOD (China site only)'."\n"
+ ."\n"
+ .'- **CR**: Container Registry (China site only)'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'- **DCDN**: DCDN'."\n"
+ ."\n"
+ .'- **DDOS**: Anti-DDoS'."\n"
+ ."\n"
+ .'- **CDN**: Alibaba Cloud CDN'."\n"
+ ."\n"
+ .'- **ALB**: Application Load Balancer'."\n"
+ ."\n"
+ .'- **APIGateway**: API Gateway'."\n"
+ ."\n"
+ .'- **FC**: Function Compute'."\n"
+ ."\n"
+ .'- **GA**: Global Accelerator'."\n"
+ ."\n"
+ .'- **MSE**: MSE'."\n"
+ ."\n"
+ .'- **NLB**: Network Load Balancer'."\n"
+ ."\n"
+ .'- **OSS**: OSS'."\n"
+ ."\n"
+ .'- **SAE**: SAE'."\n"
+ ."\n"
+ .'- **TencentCDN**: Tencent CDN'."\n"
+ ."\n"
+ .'- **WAF**: WAF', 'type' => 'string', 'title' => '', 'example' => 'SLB'],
+ 'UserId' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1666884372******'],
+ 'CertId' => ['description' => 'The ID of the certificate that is attached to the cloud product resource.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '11599949'],
+ 'CertName' => ['description' => 'The name of the certificate that is attached to the cloud product resource.', 'type' => 'string', 'title' => '', 'example' => 'sc-SSL'],
+ 'CertEndTime' => ['description' => 'The expiration date of the certificate that is attached to the cloud product resource. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'string', 'title' => '', 'example' => '1681956830000'],
+ 'CertStartTime' => ['description' => 'The start date of the certificate that is attached to the cloud product resource. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'string', 'title' => '', 'example' => '1681956830000'],
+ 'Domain' => ['description' => 'The domain name that is attached to the cloud product resource.', 'type' => 'string', 'title' => '', 'example' => 'aliyundoc.com'],
+ 'InstanceId' => ['description' => 'The instance ID of the cloud product resource.'."\n"
+ ."\n"
+ .'> This parameter is returned only for deployments of SLB, NLB, ALB, and GA.', 'type' => 'string', 'title' => '', 'example' => 'cas-cn-m7r1qocw91at'],
+ 'ListenerId' => ['description' => 'The listener ID of the cloud product resource.'."\n"
+ ."\n"
+ .'> This parameter is returned only for deployments of SLB, NLB, ALB, and GA.', 'type' => 'string', 'title' => '', 'example' => 'lsn-vwdff0q20poq5xazb9@443'],
+ 'ListenerPort' => ['description' => 'The listener port of the cloud product resource.'."\n"
+ ."\n"
+ .'> This parameter is returned only for deployments of SLB, NLB, ALB, and GA.', 'type' => 'string', 'title' => '', 'example' => '8047'],
+ 'EnableHttps' => ['description' => 'Indicates whether HTTPS is enabled for the cloud product resource.'."\n"
+ ."\n"
+ .'- **1**: Enabled'."\n"
+ ."\n"
+ .'- **0**: Disabled', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'DefaultResource' => ['description' => 'Indicates whether the cloud product resource is a default resource.'."\n"
+ ."\n"
+ .'- **1**: Default resource'."\n"
+ ."\n"
+ .'- **0**: Not a default resource'."\n"
+ ."\n"
+ .'> This parameter is returned only for deployments of SLB, NLB, ALB, and GA.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'Remark' => ['description' => 'Other metadata about the cloud product resource.', 'type' => 'string', 'title' => '', 'example' => '{\\"camera_model\\":\\"GIFSHOW [1267087617][OnePlus'],
+ 'Status' => ['description' => 'The status of the synchronized cloud product resource.', 'type' => 'string', 'title' => '', 'example' => 'online'],
+ 'UseSsl' => ['description' => 'Indicates whether an Alibaba Cloud SSL certificate is used.'."\n"
+ ."\n"
+ .'- **1**: Yes'."\n"
+ ."\n"
+ .'- **0**: No'."\n"
+ ."\n"
+ .'> This parameter is returned only for multicloud deployments.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'RegionId' => ['description' => 'The region ID of the synchronized cloud product resource.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'],
+ 'CloudName' => ['description' => 'The provider of the cloud product resource.'."\n"
+ ."\n"
+ .'- **aliyun**: Alibaba Cloud'."\n"
+ ."\n"
+ .'- **Tencent**: Tencent Cloud', 'type' => 'string', 'title' => '', 'example' => 'aliyun'],
+ 'CloudRegion' => ['description' => 'The region ID of the cloud product resource from the cloud provider.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'],
+ 'CloudAccessId' => ['description' => 'The key ID used to access the cloud resource set.'."\n"
+ ."\n"
+ .'> This parameter is returned only for multicloud deployments.', 'type' => 'string', 'title' => '', 'example' => '1234'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The unique ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
],
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteCertificateRequestResponse>\\r\\n <RequestId>082FAB35-6AB9-4FD5-8750-D36673548E76</RequestId>\\r\\n</DeleteCertificateRequestResponse>","errorExample":""}]',
- 'title' => 'DeleteCertificateRequest',
- 'description' => 'You can call this operation to delete a certificate application order only in the following scenarios:'."\n"
- ."\n"
- .'* The status of the order is **review failed**. You have called the [DescribeCertificateState](~~455800~~) operation to query the status of the certificate application order and the value of the **Type** parameter is **verify_fail**.'."\n"
- .'* The status of the order is **pending application**. You have called the [CancelOrderRequest](~~455299~~) operation to cancel a certificate application order whose status is pending review or being reviewed. The status of the certificate application order that is canceled in this case changes to **pending application**.'."\n",
- 'requestParamsDescription' => 'All Alibaba Cloud API operations must include common request parameters.'."\n"
- ."\n"
- .'For more information about sample requests, see the **"Examples"** section of this topic.',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => '|HTTP status code|Error code|Description|'."\n"
- .'|---|---|---|'."\n"
- .'|404|NotFoundPackage|The error message returned because no certificate resource plans were purchased.|'."\n"
- .'|404|NotRemainCount|The error message returned because the certificate quota is insufficient.|'."\n"
- .'|403|CreateCertificateRequestFailed|The error message returned because the request failed to be created.|'."\n"
- .'|404|NotFoundOrder|The error message returned because the specified certificate order was not found.|'."\n"
- .'|403|OrderStateError|The error message returned because the status of the certificate order is invalid.|'."\n"
- .'|403|DeleteFail|The error message returned because the certificate application order failed to be deleted.|'."\n"
- .'|500|Error|The error message returned because an error occurred.|',
- ],
- 'UploadUserCertificate' => [
- 'summary' => 'Uploads a certificate.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListDeploymentJobResource',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListDeploymentJobResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Id\\": 20979,\\n \\"GmtCreate\\": \\"1673423339000\\",\\n \\"GmtModified\\": \\"1681956830000\\",\\n \\"CloudProduct\\": \\"SLB\\",\\n \\"UserId\\": 0,\\n \\"CertId\\": 11599949,\\n \\"CertName\\": \\"sc-SSL\\",\\n \\"CertEndTime\\": \\"1681956830000\\",\\n \\"CertStartTime\\": \\"1681956830000\\",\\n \\"Domain\\": \\"aliyundoc.com\\",\\n \\"InstanceId\\": \\"cas-cn-m7r1qocw91at\\",\\n \\"ListenerId\\": \\"lsn-vwdff0q20poq5xazb9@443\\",\\n \\"ListenerPort\\": \\"8047\\",\\n \\"EnableHttps\\": 1,\\n \\"DefaultResource\\": 0,\\n \\"Remark\\": \\"{\\\\\\\\\\\\\\"camera_model\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"GIFSHOW [1267087617][OnePlus\\",\\n \\"Status\\": \\"online\\",\\n \\"UseSsl\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CloudName\\": \\"aliyun\\",\\n \\"CloudRegion\\": \\"cn-hangzhou\\",\\n \\"CloudAccessId\\": \\"1234\\"\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
+ ],
+ 'ListInstances' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '214629',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Name',
+ 'name' => 'Keyword',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the certificate. The name can be up to 64 characters in length, and can contain all types of characters, such as letters, digits, and underscores (\\_).'."\n"
- ."\n"
- .'> The name must be unique within an Alibaba Cloud account.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cert-1',
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'The keyword for fuzzy match. Matches domain names, instance names, or corresponding resource IDs.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'Cert',
+ 'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => 'The content of the certificate in the PEM format.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----',
- ],
+ 'schema' => ['description' => 'The instance status. Valid values:'."\n"
+ .'- **inactive**: pending use.'."\n"
+ .'- **pending**: under review. The latest certificate is being reviewed.'."\n"
+ .'- **willExpire**: about to expire.'."\n"
+ .'- **expired**: expired.'."\n"
+ .'- **refund**: refunded.'."\n"
+ .'- **normal**: normal.'."\n"
+ .'- **closed**: closed and unavailable.', 'type' => 'string', 'required' => false, 'example' => 'inactive', 'title' => ''],
],
[
- 'name' => 'Key',
+ 'name' => 'Brand',
'in' => 'query',
- 'schema' => [
- 'description' => 'The private key of the certificate in the PEM format.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN CERTIFICATE-----'."\n"
- .'MIICDzCCAbagAw****'."\n"
- .'-----END CERTIFICATE-----',
- ],
+ 'schema' => ['description' => 'The certification authority (CA) brand. Valid values: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus, and Alibaba.', 'type' => 'string', 'required' => false, 'example' => 'Digicert', 'title' => ''],
],
[
- 'name' => 'EncryptCert',
+ 'name' => 'CertificateType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The content of the encryption certificate in PEM format.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN CERTIFICATE-----'."\n"
- .'MIICDzCCA***'."\n"
- .'-----END CERTIFICATE-----',
- ],
+ 'schema' => ['description' => 'The type of the certificate. Valid values: DV, OV, and EV.', 'type' => 'string', 'required' => false, 'example' => 'DV', 'title' => ''],
],
[
- 'name' => 'EncryptPrivateKey',
+ 'name' => 'CertificateStatus',
'in' => 'query',
- 'schema' => [
- 'description' => 'The private key of the encryption certificate in the PEM format.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN EC PRIVATE KEY-----'."\n"
- .'MHcCAQEEI****'."\n"
- .'-----END EC PRIVATE KEY-----',
- ],
+ 'schema' => ['description' => 'The status of the certificate. Valid values:'."\n"
+ .'- **issued**: issued.'."\n"
+ .'- **revoked**: revoked.'."\n"
+ .'- **willExpire**: about to expire.'."\n"
+ .'- **expired**: expired.', 'type' => 'string', 'required' => false, 'example' => 'issued', 'title' => ''],
],
[
- 'name' => 'SignCert',
+ 'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The content of the signing certificate in the PEM format.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN CERTIFICATE-----'."\n"
- .'MIICDzCCAbagAw****'."\n"
- .'-----END CERTIFICATE-----'."\n",
- ],
+ 'schema' => ['description' => 'The instance type. Valid values: BUY (official certificate) and TEST (test certificate).', 'type' => 'string', 'required' => false, 'example' => 'BUY', 'title' => ''],
],
[
- 'name' => 'SignPrivateKey',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The private key of the signing certificate in the PEM format.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN EC PRIVATE KEY-----'."\n"
- .'MHcCAQEEILR****'."\n"
- .'-----END EC PRIVATE KEY-----'."\n",
- ],
+ 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******4wia', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'ShowSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'the resource group id.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-ae****vty',
- ],
+ 'schema' => ['description' => 'The number of instances to display per page in a paged query. Default value: **10**. Maximum value: **100**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'Tags',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tag.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testKey',
- ],
- 'Value' => [
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The page number of the current page in a paged query. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'CertId' => [
- 'description' => 'The ID of the certificate.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12345',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => 'BDB81BA2-E1F5-4D08-A2DD-4BE2BF44C90E',
- ],
- 'ResourceId' => [
- 'type' => 'string',
- 'description' => 'The ID of the resource.',
- 'example' => 'cas-upload-j2ofdb',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789ABC', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ 'ShowSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The current page number in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'InstanceList' => [
+ 'description' => 'The list of instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'cas_dv-cn-123', 'title' => ''],
+ 'KeyAlgorithm' => ['description' => 'The certificate algorithm. Default value: RSA_2048. Valid values:'."\n"
+ .'- **RSA_2048**'."\n"
+ .'- **RSA_3072**'."\n"
+ .'- **RSA_4096**'."\n"
+ .'- **ECC_256**'."\n"
+ .'- **SM2**.', 'type' => 'string', 'example' => 'RSA_2048', 'title' => ''],
+ 'Status' => ['description' => 'The instance status. Valid values:'."\n"
+ .'- **inactive**: pending use.'."\n"
+ .'- **pending**: under review. The latest certificate is being reviewed.'."\n"
+ .'- **willExpire**: about to expire.'."\n"
+ .'- **expired**: expired.'."\n"
+ .'- **refund**: refunded.'."\n"
+ .'- **normal**: normal.'."\n"
+ .'- **closed**: closed and unavailable.', 'type' => 'string', 'example' => 'inactive', 'title' => ''],
+ 'Domain' => ['description' => 'The domain name bound to the certificate.', 'type' => 'string', 'example' => 'test.com', 'title' => ''],
+ 'CertificateDomain' => ['title' => '', 'description' => 'The domain name of the latest issued certificate.', 'type' => 'string', 'example' => 'abc.com,www.abc.com'],
+ 'Spec' => ['description' => 'The purchased instance specification.', 'type' => 'string', 'example' => 'ss.dv.t', 'title' => ''],
+ 'CertificateId' => ['description' => 'The certificate ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '18541349', 'title' => ''],
+ 'CertificateName' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'cert-13216408', 'title' => ''],
+ 'UsingProductList' => [
+ 'title' => '',
+ 'description' => 'The list of cloud services to which the latest certificate is deployed.',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => 'The cloud service to which the certificate is deployed.', 'type' => 'string', 'example' => '[\'DCDN\', \'VOD\', \'CDN\', \'OSS\']'],
+ 'example' => '',
+ ],
+ 'CertIdentifier' => ['description' => 'The global certificate ID in the format of certificate ID + "-" + site region ID. This ID is commonly used across Alibaba Cloud services.'."\n"
+ .'- For the China site: certificate ID + "-cn-hangzhou"'."\n"
+ .'- For the China site: certificate ID + "-ap-southeast-1"'."\n"
+ ."\n"
+ .'For example, if the certificate ID is 123, the CertIdentifier on the China site is "123-cn-hangzhou", and the CertIdentifier on the China site is "123-ap-southeast-1".', 'type' => 'string', 'example' => '21795675-cn-hangzhou', 'title' => ''],
+ 'Brand' => ['description' => 'The CA brand. Valid values: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus, and Alibaba.', 'type' => 'string', 'example' => 'DigiCert', 'title' => ''],
+ 'CertificateType' => ['description' => 'The type of the certificate. Valid values: DV, OV, and EV.', 'type' => 'string', 'example' => 'DV', 'title' => ''],
+ 'CertificateStatus' => ['description' => 'The status of the certificate. Valid values:'."\n"
+ .'- **issued**: issued.'."\n"
+ .'- **revoked**: revoked.'."\n"
+ .'- **willExpire**: about to expire.'."\n"
+ .'- **expired**: expired.', 'type' => 'string', 'example' => 'issued', 'title' => ''],
+ 'InstanceType' => ['description' => 'The instance type. Valid values: BUY (official certificate) and TEST (test certificate).', 'type' => 'string', 'example' => 'BUY', 'title' => ''],
+ 'OrderStartTime' => ['description' => 'The start time of the instance purchase, in UNIX timestamp format. This value is used to determine the refund time limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'CertificateRevokeTime' => ['description' => 'The revocation time of the latest certificate, in UNIX timestamp format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'OrderEndTime' => ['description' => 'The end time of the instance purchase, in UNIX timestamp format. This value is used to determine the purchase duration of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'InstanceStartTime' => ['description' => 'The start time of the instance, in UNIX timestamp format. If no certificate has been issued, this value is empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'InstanceEndTime' => ['description' => 'The expiration time of the instance, in UNIX timestamp format. If no certificate has been issued, this value is empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'CertificateNotAfter' => ['description' => 'The end time of the latest certificate, in UNIX timestamp format. If no certificate has been issued, this value is empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1801324800000', 'title' => ''],
+ 'CertificateNotBefore' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'AutoReissue' => ['description' => 'Indicates whether automatic managed renewal is enabled. Valid values:'."\n"
+ .'- enable: enabled.'."\n"
+ .'- disable: disabled.', 'type' => 'string', 'example' => 'enable', 'title' => ''],
+ 'FullDomainCount' => ['description' => 'The number of exact-match domain names.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'WildcardDomainCount' => ['description' => 'The number of wildcard domain names.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'PendingResult' => ['description' => 'The result returned by the CA during the last certificate operation.', 'type' => 'string', 'example' => 'pending', 'title' => ''],
+ 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => '123'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertId\\": 12345,\\n \\"RequestId\\": \\"BDB81BA2-E1F5-4D08-A2DD-4BE2BF44C90E\\",\\n \\"ResourceId\\": \\"cas-upload-xki1d0\\"\\n}","type":"json"}]',
- 'title' => 'UploadUserCertificate',
- 'description' => 'You can call this operation up to 100 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'GetUserCertificateDetail' => [
- 'summary' => 'Queries certificate details, including the basic information and public and private key content. You can call this operation to download the certificate and private key.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'List instances',
+ 'summary' => 'Retrieves a list of instances.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\",\\n \\"TotalCount\\": 12,\\n \\"ShowSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"InstanceList\\": [\\n {\\n \\"InstanceId\\": \\"cas_dv-cn-123\\",\\n \\"KeyAlgorithm\\": \\"RSA_2048\\",\\n \\"Status\\": \\"inactive\\",\\n \\"Domain\\": \\"test.com\\",\\n \\"CertificateDomain\\": \\"abc.com,www.abc.com\\",\\n \\"Spec\\": \\"ss.dv.t\\",\\n \\"CertificateId\\": 18541349,\\n \\"CertificateName\\": \\"cert-13216408\\",\\n \\"UsingProductList\\": [\\n \\"[\'DCDN\', \'VOD\', \'CDN\', \'OSS\']\\"\\n ],\\n \\"CertIdentifier\\": \\"21795675-cn-hangzhou\\",\\n \\"Brand\\": \\"DigiCert\\",\\n \\"CertificateType\\": \\"DV\\",\\n \\"CertificateStatus\\": \\"issued\\",\\n \\"InstanceType\\": \\"BUY\\",\\n \\"OrderStartTime\\": 1801324800000,\\n \\"CertificateRevokeTime\\": 1801324800000,\\n \\"OrderEndTime\\": 1801324800000,\\n \\"InstanceStartTime\\": 1801324800000,\\n \\"InstanceEndTime\\": 1801324800000,\\n \\"CertificateNotAfter\\": 1801324800000,\\n \\"CertificateNotBefore\\": 0,\\n \\"AutoReissue\\": \\"enable\\",\\n \\"FullDomainCount\\": 1,\\n \\"WildcardDomainCount\\": 0,\\n \\"PendingResult\\": \\"pending\\",\\n \\"ResourceGroupId\\": \\"123\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListUserCertificateOrder' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5752,408 +5772,213 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '160954',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '123899',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'CertId',
+ 'name' => 'Keyword',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the certificate.'."\n"
- ."\n"
- .'> You can call the [ListUserCertificateOrder](~~455804~~) operation to query the ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '6055048',
- ],
+ 'schema' => ['description' => 'Performs a fuzzy query. The keyword can be a domain name or a resource ID.', 'type' => 'string', 'required' => false, 'example' => 'cert-instanceId', 'title' => ''],
],
[
- 'name' => 'CertFilter',
+ 'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to filter return results. Valid values: true and false. Default value: false. **true** specifies that the Cert, Key, EncryptCert, EncryptPrivateKey, SignCert, and SignPrivateKey parameters are not returned. **false** specifies that the parameters are returned.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The status of the order. Valid values:'."\n"
+ ."\n"
+ .'- **PAYED**: The certificate is pending application. This value is valid only when OrderType is set to CPACK or BUY.'."\n"
+ ."\n"
+ .'- **CHECKING**: The certificate is under review. This value is valid only when OrderType is set to CPACK or BUY.'."\n"
+ ."\n"
+ .'- **CHECKED\\_FAIL**: The review failed. This value is valid only when OrderType is set to CPACK or BUY.'."\n"
+ ."\n"
+ .'- **ISSUED**: The certificate is issued.'."\n"
+ ."\n"
+ .'- **WILLEXPIRED**: The certificate is about to expire.'."\n"
+ ."\n"
+ .'- **EXPIRED**: The certificate has expired.'."\n"
+ ."\n"
+ .'- **NOTACTIVATED**: The certificate is not activated. This value is valid only when OrderType is set to CPACK or BUY.'."\n"
+ ."\n"
+ .'- **REVOKED**: The certificate is revoked. This value is valid only when OrderType is set to CPACK or BUY.'."\n"
+ ."\n"
+ .'If OrderType is CERT or UPLOAD and you leave this parameter empty, active certificates are returned by default. Active certificates are those in the ISSUED or WILLEXPIRED state. If OrderType is CPACK or BUY and you leave this parameter empty, all orders are returned by default.', 'type' => 'string', 'required' => false, 'example' => 'ISSUED', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrderType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The resource type. Default value: **CPACK**. Valid values:'."\n"
+ ."\n"
+ .'- **CPACK**: An order for a resource plan. Only orders created from a resource plan are returned.'."\n"
+ ."\n"
+ .'- **BUY**: A direct purchase. Only orders created from direct purchases are returned. You can ignore this type in most cases.'."\n"
+ ."\n"
+ .'- **UPLOAD**: An uploaded certificate. Only uploaded certificates are returned.'."\n"
+ ."\n"
+ .'- **CERT**: A certificate. Both issued and uploaded certificates are returned.', 'type' => 'string', 'required' => false, 'example' => 'CPACK', 'title' => ''],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShowSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page. Default value: 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource group. For more information, see [ListResources](~~2716559~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******4wia', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The list of certificates and orders.',
'type' => 'object',
'properties' => [
- 'Cert' => [
- 'description' => 'The content of the certificate if the certificate does not use an SM algorithm. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.'."\n",
- 'type' => 'string',
- 'example' => '---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----',
- ],
- 'Key' => [
- 'description' => 'The private key of the certificate if the certificate does not use an SM algorithm. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.'."\n",
- 'type' => 'string',
- 'example' => '-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----',
- ],
- 'EncryptCert' => [
- 'description' => 'The content of the encryption certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.'."\n",
- 'type' => 'string',
- 'example' => '-----BEGIN CERTIFICATE-----'."\n"
- .'MIICDzCCA***'."\n"
- .'-----END CERTIFICATE-----',
- ],
- 'EncryptPrivateKey' => [
- 'description' => 'The private key of the encryption certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.'."\n",
- 'type' => 'string',
- 'example' => '-----BEGIN EC PRIVATE KEY-----'."\n"
- .'MHcCAQEEI****'."\n"
- .'-----END EC PRIVATE KEY-----',
- ],
- 'SignCert' => [
- 'description' => 'The content of the signing certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.'."\n",
- 'type' => 'string',
- 'example' => '-----BEGIN CERTIFICATE-----'."\n"
- .'MIICDzCCAbagAw****'."\n"
- .'-----END CERTIFICATE-----'."\n",
- ],
- 'SignPrivateKey' => [
- 'description' => 'The private key of the signing certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.'."\n",
- 'type' => 'string',
- 'example' => '-----BEGIN EC PRIVATE KEY-----'."\n"
- .'MHcCAQEEILR****'."\n"
- .'-----END EC PRIVATE KEY-----'."\n",
- ],
- 'Id' => [
- 'description' => 'The ID of the certificate.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '121345',
- ],
- 'Name' => [
- 'description' => 'The name of the certificate.'."\n",
- 'type' => 'string',
- 'example' => 'cert_name',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n",
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
- 'Common' => [
- 'description' => 'The primary domain name that is bound to the certificate.'."\n",
- 'type' => 'string',
- 'example' => '*.com',
- ],
- 'Fingerprint' => [
- 'description' => 'The fingerprint of the certificate.'."\n",
- 'type' => 'string',
- 'example' => '1D7801BBE772D5DE55CBF1F88AEB41A42402DA07',
- ],
- 'Issuer' => [
- 'description' => 'The certificate authority (CA) that issued the certificate.'."\n",
- 'type' => 'string',
- 'example' => 'Digicert',
- ],
- 'OrgName' => [
- 'description' => 'The name of the company or organization to which the certificate purchaser belongs.'."\n",
- 'type' => 'string',
- 'example' => 'Alibaba',
- ],
- 'Province' => [
- 'description' => 'The province of the company or organization to which the certificate purchaser belongs.'."\n",
- 'type' => 'string',
- 'example' => 'zhejiang',
- ],
- 'City' => [
- 'description' => 'The city of the company or organization to which the certificate purchaser belongs.'."\n",
- 'type' => 'string',
- 'example' => 'hangzhou',
- ],
- 'Country' => [
- 'description' => 'The country or region of the company or organization to which the certificate purchaser belongs.'."\n",
- 'type' => 'string',
- 'example' => 'CN',
- ],
- 'StartDate' => [
- 'description' => 'The issuance date of the certificate.'."\n",
- 'type' => 'string',
- 'example' => '2018-07-13',
- ],
- 'EndDate' => [
- 'description' => 'The expiration date of the certificate.'."\n",
- 'type' => 'string',
- 'example' => '2023-10-25',
- ],
- 'Sans' => [
- 'description' => 'All domain names that are bound to the certificate.'."\n",
- 'type' => 'string',
- 'example' => '*.com',
- ],
- 'Expired' => [
- 'description' => 'Indicates whether the certificate has expired. Valid values:'."\n"
- ."\n"
- .'* **true**: yes'."\n"
- .'* **false**: no'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'BuyInAliyun' => [
- 'description' => 'Indicates whether the certificate was purchased from Alibaba Cloud. Valid values:'."\n"
- ."\n"
- .'* **true**: yes'."\n"
- .'* **false**: no'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'OrderId' => [
- 'description' => 'The order ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'ResourceGroupId' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'example' => 'rg-aek****wia',
- ],
- 'Algorithm' => [
- 'description' => 'The algorithm.'."\n",
- 'type' => 'string',
- 'example' => 'RSA',
- ],
- 'InstanceId' => [
- 'description' => 'The instance ID of the resource.'."\n",
- 'type' => 'string',
- 'example' => 'cas-upload-50yf1q',
- ],
- 'Sha2' => [
- 'description' => 'The SHA-2 value of the certificate.'."\n",
- 'type' => 'string',
- 'example' => '840707695D5EE41323102DDC2CB4924AA561012FBDC4E1A6324147119ED3C339',
- ],
- 'SerialNo' => [
- 'description' => 'The serial number of the certificate.'."\n",
- 'type' => 'string',
- 'example' => '06ea4879591ddf84e6c8b6ba43607ccf',
- ],
- 'CertIdentifier' => [
- 'description' => 'The certificate identifier. The value is in the "Certificate ID-cn-hangzhou" format. For example, if the ID of the certificate is 123, the value of CertIdentifier is 123-cn-hangzhou.'."\n",
- 'type' => 'string',
- 'example' => '10741304-cn-hangzhou',
- ],
- 'CertChain' => [
- 'description' => 'The certificate chain.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'The certificate chain object.',
- 'type' => 'object',
- 'properties' => [
- 'IssuerCommonName' => [
- 'description' => 'The common name of the issuer.',
- 'type' => 'string',
- 'example' => 'Encryption Everywhere DV TLS CA - G2',
- ],
- 'CommonName' => [
- 'description' => 'The common name of the certificate.',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'NotAfter' => [
- 'description' => 'The end of the validity period of the certificate.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '17322613180000',
- ],
- 'NotBefore' => [
- 'description' => 'The beginning of the validity period of the certificate.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '17302633180000',
- ],
- 'RemainDay' => [
- 'description' => 'The remaining days of the certificate validity period.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- ],
- ],
- ],
- 'NotAfter' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'description' => 'The end of the validity period of the certificate.'."\n",
- 'example' => '17322613180000',
- ],
- 'NotBefore' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'description' => 'The beginning of the validity period of the certificate.'."\n",
- 'example' => '17312613180000',
- ],
- 'Tags' => [
+ 'ShowSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'CertificateOrderList' => [
+ 'description' => 'The list of certificates and orders.',
'type' => 'array',
'items' => [
+ 'description' => 'The details of the certificate or order.',
'type' => 'object',
'properties' => [
- 'TagKey' => [
- 'type' => 'string',
- ],
- 'TagValue' => [
- 'type' => 'string',
- ],
+ 'Algorithm' => ['description' => 'The algorithm. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'string', 'example' => 'RSA', 'title' => ''],
+ 'AliyunOrderId' => ['description' => 'The ID of the Alibaba Cloud order. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'integer', 'format' => 'int64', 'example' => '234567', 'title' => ''],
+ 'BuyDate' => ['description' => 'The purchase time. The value is a UNIX timestamp. Unit: milliseconds. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634283958000', 'title' => ''],
+ 'CertEndTime' => ['description' => 'The expiration time of the certificate. The value is a UNIX timestamp. Unit: milliseconds. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'integer', 'format' => 'int64', 'example' => '1665819958000', 'title' => ''],
+ 'CertStartTime' => ['description' => 'The start time of the certificate. The value is a UNIX timestamp. Unit: milliseconds. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'integer', 'format' => 'int64', 'example' => '1665819958000', 'title' => ''],
+ 'CertType' => ['description' => 'The certificate type. This parameter is returned when OrderType is set to CPACK or BUY. Valid values:'."\n"
+ ."\n"
+ .'- **DV**: A DV certificate.'."\n"
+ ."\n"
+ .'- **EV**: An EV certificate.'."\n"
+ ."\n"
+ .'- **OV**: An OV certificate.'."\n"
+ ."\n"
+ .'- **FREE**: A free certificate for personal trial. This value is supported only on the Alibaba Cloud China website (www\\.aliyun.com).', 'type' => 'string', 'example' => 'FREE', 'title' => ''],
+ 'Domain' => ['description' => 'The domain name. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'string', 'example' => 'aliyundoc.com', 'title' => ''],
+ 'DomainCount' => ['description' => 'The number of domain names that you purchased. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'DomainType' => ['description' => 'The domain name type. This parameter is returned when OrderType is set to CPACK or BUY. Valid values:'."\n"
+ ."\n"
+ .'- **ONE**: A single domain name.'."\n"
+ ."\n"
+ .'- **MULTIPLE**: Multiple domain names.'."\n"
+ ."\n"
+ .'- **WILDCARD**: A single wildcard domain name.'."\n"
+ ."\n"
+ .'- **M\\_WILDCARD**: Multiple wildcard domain names.'."\n"
+ ."\n"
+ .'- **MIX**: A hybrid domain name.', 'type' => 'string', 'example' => 'ONE', 'title' => ''],
+ 'InstanceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'cas-instanceId', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'integer', 'format' => 'int64', 'example' => '2345687', 'title' => ''],
+ 'PartnerOrderId' => ['description' => 'The ID of the third-party certificate authority (CA) order. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'string', 'example' => 'ca-123456', 'title' => ''],
+ 'ProductCode' => ['description' => 'The code for the product specifications. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'string', 'example' => 'bykj123456', 'title' => ''],
+ 'ProductName' => ['description' => 'The name of the product specifications. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'string', 'example' => 'CFCA', 'title' => ''],
+ 'RootBrand' => ['description' => 'The brand, such as WoSign, CFCA, DigiCert, and vTrus. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'string', 'example' => 'CFCA', 'title' => ''],
+ 'SourceType' => ['description' => 'The order type. This parameter is returned when OrderType is set to CPACK or BUY.'."\n"
+ ."\n"
+ .'- **cpack**: An order for a resource plan.'."\n"
+ ."\n"
+ .'- **buy**: A direct purchase.', 'type' => 'string', 'example' => 'buy', 'title' => ''],
+ 'Status' => ['description' => 'The status of the order or certificate. This parameter is returned when OrderType is set to CPACK or BUY.'."\n"
+ ."\n"
+ .'- **PAYED**: The certificate is pending application.'."\n"
+ ."\n"
+ .'- **CHECKING**: The certificate is under review.'."\n"
+ ."\n"
+ .'- **CHECKED\\_FAIL**: The review failed.'."\n"
+ ."\n"
+ .'- **ISSUED**: The certificate is issued.'."\n"
+ ."\n"
+ .'- **WILLEXPIRED**: The certificate is about to expire.'."\n"
+ ."\n"
+ .'- **EXPIRED**: The certificate has expired.'."\n"
+ ."\n"
+ .'- **NOTACTIVATED**: The certificate is not activated.'."\n"
+ ."\n"
+ .'- **REVOKED**: The certificate is revoked.', 'type' => 'string', 'example' => 'PAYED', 'title' => ''],
+ 'TrusteeStatus' => ['description' => 'The hosting status. This parameter is returned when OrderType is set to CPACK or BUY.'."\n"
+ ."\n"
+ .'- **unTrustee**: Not hosted.'."\n"
+ ."\n"
+ .'- **trustee**: Hosted.', 'type' => 'string', 'example' => 'unTrustee', 'title' => ''],
+ 'WildDomainCount' => ['description' => 'The number of wildcard domain names that you purchased. This parameter is returned when OrderType is set to CPACK or BUY.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'CertificateId' => ['description' => 'The certificate ID. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'integer', 'format' => 'int64', 'example' => '896521', 'title' => ''],
+ 'Name' => ['description' => 'The certificate name. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => 'cert-name', 'title' => ''],
+ 'CommonName' => ['description' => 'The primary domain name of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => 'aliyun.com', 'title' => ''],
+ 'Fingerprint' => ['description' => 'The certificate fingerprint. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => 'CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03', 'title' => ''],
+ 'Sha2' => ['description' => 'The SHA-2 value of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => '56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11', 'title' => ''],
+ 'SerialNo' => ['description' => 'The certificate serial number. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => '040a6e493cffdda6d744acf99b6576cf', 'title' => ''],
+ 'Issuer' => ['description' => 'The issuer of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => 'MyIssuer', 'title' => ''],
+ 'OrgName' => ['description' => 'The name of the organization that is associated with the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
+ 'Province' => ['description' => 'The province or autonomous region. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => '浙江省', 'title' => ''],
+ 'City' => ['description' => 'The city. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => '杭州市', 'title' => ''],
+ 'Country' => ['description' => 'The country code. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => 'CN', 'title' => ''],
+ 'Sans' => ['description' => 'The domain names that are bound to the certificate. Multiple domain names are separated by commas (,). This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => 'aliyun.com', 'title' => ''],
+ 'Expired' => ['description' => 'Indicates whether the certificate has expired. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Upload' => ['description' => 'Indicates whether the certificate is an uploaded certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'StartDate' => ['description' => 'The start date of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => '2021-11-16', 'title' => ''],
+ 'EndDate' => ['description' => 'The end date of the certificate. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => '2022-11-17', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group. This parameter is returned when OrderType is set to CERT or UPLOAD.', 'type' => 'string', 'example' => 'rg-ae******4wia', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '{"CertificateOrderList": [{"Status": "PAYED","ProductName": "专业版通配符 OV SSL","InstanceId": "cert-instanceId","ProductCode": "globalsign-xxxx","SourceType": "buy","WildDomainCount": 1,"CertType": "OV","PartnerOrderId": "","OrderId": 3451111,"Algorithm": "RSA","RootBrand": "GlobalSign","AliyunOrderId": 21xxxxxx40655,"DomainType": "WILDCARD","TrusteeStatus": "trustee","Domain": "","BuyDate": 1632649385000,"DomainCount": 1}]}',
+ 'title' => '',
],
+ 'RequestId' => ['description' => 'The request ID. This ID is unique to each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cert\\": \\"---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----\\",\\n \\"Key\\": \\"-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----\\",\\n \\"EncryptCert\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIICDzCCA***\\\\n-----END CERTIFICATE-----\\",\\n \\"EncryptPrivateKey\\": \\"-----BEGIN EC PRIVATE KEY-----\\\\nMHcCAQEEI****\\\\n-----END EC PRIVATE KEY-----\\",\\n \\"SignCert\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIICDzCCAbagAw****\\\\n-----END CERTIFICATE-----\\\\n\\",\\n \\"SignPrivateKey\\": \\"-----BEGIN EC PRIVATE KEY-----\\\\nMHcCAQEEILR****\\\\n-----END EC PRIVATE KEY-----\\\\n\\",\\n \\"Id\\": 121345,\\n \\"Name\\": \\"cert_name\\",\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Common\\": \\"*.com\\",\\n \\"Fingerprint\\": \\"1D7801BBE772D5DE55CBF1F88AEB41A42402DA07\\",\\n \\"Issuer\\": \\"Digicert\\",\\n \\"OrgName\\": \\"Alibaba\\",\\n \\"Province\\": \\"zhejiang\\",\\n \\"City\\": \\"hangzhou\\",\\n \\"Country\\": \\"CN\\",\\n \\"StartDate\\": \\"2018-07-13\\",\\n \\"EndDate\\": \\"2023-10-25\\",\\n \\"Sans\\": \\"*.com\\",\\n \\"Expired\\": true,\\n \\"BuyInAliyun\\": true,\\n \\"OrderId\\": 123456,\\n \\"ResourceGroupId\\": \\"rg-aek****wia\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"InstanceId\\": \\"cas-ivauto-hqito6\\",\\n \\"Sha2\\": \\"573415B23243066AD345AE5A57BD0FAE94F598BDD06D906278B5FF318F090FC8\\",\\n \\"SerialNo\\": \\"033cd852608689ef5e368fde89e0961769e8\\",\\n \\"CertIdentifier\\": \\"13781326-cn-hangzhou\\",\\n \\"CertChain\\": [\\n {\\n \\"IssuerCommonName\\": \\"Encryption Everywhere DV TLS CA - G2\\",\\n \\"CommonName\\": \\"test\\",\\n \\"NotAfter\\": 17352613180000,\\n \\"NotBefore\\": 17322633180000,\\n \\"RemainDay\\": 1000\\n }\\n ],\\n \\"NotAfter\\": 17326613180000,\\n \\"NotBefore\\": 17321613180000,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"test\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'GetUserCertificateDetail',
- 'description' => 'You can call this operation up to 100 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'DescribePackageState' => [
- 'summary' => 'Queries the quota for domain validated (DV) certificates that you purchase and the quota usage.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '81674',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'ProductCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The specifications of the certificate resource plan. Valid values:'."\n"
- ."\n"
- .'* **digicert-free-1-free** (default): DigiCert single-domain domain validated (DV) certificate in a three-month free trial, available only on the China site (aliyun.com).'."\n"
- .'* **symantec-free-1-free**: DigiCert single-domain DV certificate in a one-year free trial, available only on the China site (aliyun.com).'."\n"
- .'* **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
- .'* **symantec-ov-1-personal**: DigiCert single-domain organization validated (OV) certificate.'."\n"
- .'* **symantec-ov-w-personal**: DigiCert wildcard OV certificate.'."\n"
- .'* **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
- .'* **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
- .'* **geotrust-ov-1-personal**: GeoTrust single-domain OV certificate.'."\n"
- .'* **geotrust-ov-w-personal**: GeoTrust wildcard OV certificate.'."\n"
- .'* **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
- .'* **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.'."\n"
- .'* **globalsign-ov-1-personal**: GlobalSign single-domain OV certificate.'."\n"
- .'* **globalsign-ov-w-advanced**: GlobalSign wildcard OV certificate.'."\n"
- .'* **cfca-ov-1-personal**: China Financial Certification Authority (CFCA) single-domain OV certificate, available only on the China site (aliyun.com).'."\n"
- .'* **cfca-ev-w-advanced**: CFCA wildcard OV certificate, available only on the China site (aliyun.com).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'symantec-free-1-free',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => 'The response parameters.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'IssuedCount' => [
- 'description' => 'The number of issued certificates of the specified specifications.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n",
- 'type' => 'string',
- 'example' => '10CFA380-1C58-45C7-8075-06215F3DB681',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of purchased certificate resource plans of the specified specifications.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'ProductCode' => [
- 'description' => 'The specifications of the certificate resource plan. Valid values:'."\n"
- ."\n"
- .'* **digicert-free-1-free**: DigiCert single-domain DV certificate in a three-month free trial, available only on the China site (aliyun.com).'."\n"
- .'* **symantec-free-1-free**: DigiCert single-domain DV certificate in a one-year free trial, available only on the China site (aliyun.com).'."\n"
- .'* **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
- .'* **symantec-ov-1-personal**: DigiCert single-domain OV certificate.'."\n"
- .'* **symantec-ov-w-personal**: DigiCert wildcard OV certificate.'."\n"
- .'* **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
- .'* **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
- .'* **geotrust-ov-1-personal**: GeoTrust single-domain OV certificate.'."\n"
- .'* **geotrust-ov-w-personal**: GeoTrust wildcard OV certificate.'."\n"
- .'* **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
- .'* **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.'."\n"
- .'* **globalsign-ov-1-personal**: GlobalSign single-domain OV certificate.'."\n"
- .'* **globalsign-ov-w-advanced**: GlobalSign wildcard OV certificate.'."\n"
- .'* **cfca-ov-1-personal**: CFCA single-domain OV certificate, available only on the China site (aliyun.com).'."\n"
- .'* **cfca-ev-w-advanced**: CFCA wildcard OV certificate, available only on the China site (aliyun.com).'."\n",
- 'type' => 'string',
- 'example' => 'symantec-free-1-free',
- ],
- 'UsedCount' => [
- 'description' => 'The number of certificate applications that you submitted for certificates of the specified specifications.'."\n"
- ."\n"
- .'> : A successful call of the [CreateCertificateForPackageRequest](~~204087~~), [CreateCertificateRequest](~~164105~~), or [CreateCertificateWithCsrRequest](~~178732~~) operation is counted as one a certificate application, regardless of whether the certificate is issued.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListUserCertificateOrder',
+ 'summary' => 'Queries the SSL certificates and certificate orders in your account.',
+ 'description' => 'This operation queries a list of your certificates or orders. Set OrderType to CERT or UPLOAD to query certificates. Set OrderType to CPACK or BUY to query orders.'."\n"
+ ."\n"
+ .'## QPS limit'."\n"
+ ."\n"
+ .'The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, API calls are throttled, which may affect your business. Plan your calls accordingly.',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-30T09:59:46.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-11-17T06:36:40.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-02-23T11:49:45.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-02-23T11:49:45.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListUserCertificateOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"IssuedCount\\": 1,\\n \\"RequestId\\": \\"10CFA380-1C58-45C7-8075-06215F3DB681\\",\\n \\"TotalCount\\": 20,\\n \\"ProductCode\\": \\"digicert-free-1-free\\",\\n \\"UsedCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribePackageStateResponse>\\n\\t<TotalCount>20</TotalCount>\\n\\t<RequestId>10CFA380-1C58-45C7-8075-06215F3DB681</RequestId>\\n\\t<ProductCode>symantec-free-1-free</ProductCode>\\n\\t<UsedCount>2</UsedCount>\\n\\t<IssuedCount>1</IssuedCount>\\n</DescribePackageStateResponse>","errorExample":""}]',
- 'title' => 'DescribePackageState',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ShowSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalCount\\": 1,\\n \\"CertificateOrderList\\": [\\n {\\n \\"Algorithm\\": \\"RSA\\",\\n \\"AliyunOrderId\\": 234567,\\n \\"BuyDate\\": 1634283958000,\\n \\"CertEndTime\\": 1665819958000,\\n \\"CertStartTime\\": 1665819958000,\\n \\"CertType\\": \\"FREE\\",\\n \\"Domain\\": \\"aliyundoc.com\\",\\n \\"DomainCount\\": 1,\\n \\"DomainType\\": \\"ONE\\",\\n \\"InstanceId\\": \\"cas-instanceId\\",\\n \\"OrderId\\": 2345687,\\n \\"PartnerOrderId\\": \\"ca-123456\\",\\n \\"ProductCode\\": \\"bykj123456\\",\\n \\"ProductName\\": \\"CFCA\\",\\n \\"RootBrand\\": \\"CFCA\\",\\n \\"SourceType\\": \\"buy\\",\\n \\"Status\\": \\"PAYED\\",\\n \\"TrusteeStatus\\": \\"unTrustee\\",\\n \\"WildDomainCount\\": 0,\\n \\"CertificateId\\": 896521,\\n \\"Name\\": \\"cert-name\\",\\n \\"CommonName\\": \\"aliyun.com\\",\\n \\"Fingerprint\\": \\"CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03\\",\\n \\"Sha2\\": \\"56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11\\",\\n \\"SerialNo\\": \\"040a6e493cffdda6d744acf99b6576cf\\",\\n \\"Issuer\\": \\"MyIssuer\\",\\n \\"OrgName\\": \\"阿里云\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Country\\": \\"CN\\",\\n \\"Sans\\": \\"aliyun.com\\",\\n \\"Expired\\": true,\\n \\"Upload\\": false,\\n \\"StartDate\\": \\"2021-11-16\\",\\n \\"EndDate\\": \\"2022-11-17\\",\\n \\"ResourceGroupId\\": \\"rg-ae******4wia\\"\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
],
- 'ListUserCertificateOrder' => [
- 'summary' => 'Queries the certificates or certificate orders of users.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListWarehouse' => [
+ 'summary' => 'Lists warehouses.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6165,587 +5990,319 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '123899',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '246170',
+ 'abilityTreeNodes' => ['FEATUREcasY9QF1D'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Keyword',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The domain name that is bound or the ID of the resource. Fuzzy match is supported.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cert-instanceId',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The certificate status of the order. Valid values:'."\n"
- ."\n"
- .'* **PAYED**: pending application. You can set Status to PAYED only if you set OrderType to CPACK or BUY.'."\n"
- .'* **CHECKING**: validating. You can set Status to CHECKING only if you set OrderType to CPACK or BUY.'."\n"
- .'* **CHECKED_FAIL**: validation failed. You can set Status to CHECKED_FAIL only if you set OrderType to CPACK or BUY.'."\n"
- .'* **ISSUED**: issued.'."\n"
- .'* **WILLEXPIRED**: about to expire.'."\n"
- .'* **EXPIRED**: expired.'."\n"
- .'* **NOTACTIVATED**: not activated. You can set Status to NOTACTIVATED only if you set OrderType to CPACK or BUY.'."\n"
- .'* **REVOKED**: revoked. You can set Status to REVOKED only if you set OrderType to CPACK or BUY.'."\n"
- ."\n"
- .'If you set OrderType to CERT or UPLOAD and Status is left empty, valid certificates are returned by default, including issued certificates and certificates that are about to expire. If you set OrderType to CPACK or BUY and Status is left empty, all orders are returned by default.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ISSUED',
- ],
- ],
- [
- 'name' => 'OrderType',
+ 'name' => 'WarehouseInstanceIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The type of the order. Default value: **CPACK**. Valid values:'."\n"
- ."\n"
- .'* **CPACK**: virtual resource order. If you set OrderType to CPACK, only the information about orders that are generated to consume the certificate quota is returned.'."\n"
- .'* **BUY**: purchase order. If you set OrderType to BUY, only the information about purchase orders is returned. In most cases, this type of order can be ignored.'."\n"
- .'* **UPLOAD**: uploaded certificate. If you set OrderType to UPLOAD, only uploaded certificates are returned.'."\n"
- .'* **CERT**: certificate. If you set OrderType to CERT, both issued certificates and uploaded certificates are returned.'."\n",
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['description' => 'The warehouse instance ID.', 'type' => 'string', 'required' => false, 'example' => 'cas-wh-uc-gl2bsq', 'title' => ''],
+ 'title' => '',
+ 'description' => 'A list of warehouse instance IDs.',
'required' => false,
- 'example' => 'CPACK',
+ 'example' => 'cas-wh-uc-gl2bsq',
],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'WarehouseTypes',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The number of the page to return.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
+ 'type' => 'array',
+ 'items' => ['description' => 'The warehouse type.', 'type' => 'string', 'required' => false, 'example' => 'pcaCaCert', 'title' => ''],
+ 'title' => '',
+ 'description' => 'A list of warehouse types.',
'required' => false,
- 'example' => '1',
+ 'example' => 'pcaCaCert',
],
],
[
- 'name' => 'ShowSize',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries to return on each page. Default value: 50.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The pagination token from a previous response. Use this token to retrieve the next page of results. Omit this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => '1d2db86sca4384811e0b5e8707e68181f', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the resource group. You can call the [ListResources](~~2716559~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-ae******4wia',
- ],
+ 'schema' => ['description' => 'The maximum number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The data returned.'."\n",
'type' => 'object',
'properties' => [
- 'ShowSize' => [
- 'description' => 'The number of entries returned per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'CurrentPage' => [
- 'description' => 'The page number of the returned page.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CertificateOrderList' => [
- 'description' => 'The certificates and orders.'."\n",
+ 'TotalCount' => ['description' => 'The total number of entries in the result set.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
+ 'NextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is not returned, all results have been retrieved.', 'type' => 'string', 'title' => '', 'example' => '1d2db86sca4384811e0b5e8707e68181f'],
+ 'MaxResults' => ['description' => 'The maximum number of entries returned on each page. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'Data' => [
'type' => 'array',
'items' => [
- 'description' => 'The information about the certificate and order.'."\n",
'type' => 'object',
'properties' => [
- 'Algorithm' => [
- 'description' => 'The algorithm. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'string',
- 'example' => 'RSA',
- ],
- 'AliyunOrderId' => [
- 'description' => 'The ID of the Alibaba Cloud order. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '234567',
- ],
- 'BuyDate' => [
- 'description' => 'The time at which the order was placed. Unit: milliseconds. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1634283958000',
- ],
- 'CertEndTime' => [
- 'description' => 'The time at which the certificate expires. Unit: milliseconds. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1665819958000',
- ],
- 'CertStartTime' => [
- 'description' => 'The time at which the certificate starts to take effect. Unit: milliseconds. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1665819958000',
- ],
- 'CertType' => [
- 'description' => 'The type of the certificate. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values:'."\n"
- ."\n"
- .'* **DV**: domain validated (DV) certificate'."\n"
- .'* **EV**: extended validation (EV) certificate'."\n"
- .'* **OV**: organization validated (OV) certificate **FREE**: free certificate, available only on the China site (aliyun.com)'."\n",
- 'type' => 'string',
- 'example' => 'FREE',
- ],
- 'Domain' => [
- 'description' => 'The domain name. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'string',
- 'example' => 'aliyundoc.com',
- ],
- 'DomainCount' => [
- 'description' => 'The total number of domain names that can be bound to the certificate. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'DomainType' => [
- 'description' => 'The type of the domain name. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values:'."\n"
- ."\n"
- .'* **ONE**: single domain name'."\n"
- .'* **MULTIPLE**: multiple domain names'."\n"
- .'* **WILDCARD**: single wildcard domain name'."\n"
- .'* **M_WILDCARD**: multiple wildcard domain names'."\n"
- .'* **MIX**: hybrid domain name'."\n",
- 'type' => 'string',
- 'example' => 'ONE',
- ],
- 'InstanceId' => [
- 'description' => 'The ID of the resource.'."\n",
- 'type' => 'string',
- 'example' => 'cas-instanceId',
- ],
- 'OrderId' => [
- 'description' => 'The order ID. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2345687',
- ],
- 'PartnerOrderId' => [
- 'description' => 'The ID of the third-party certificate authority (CA) order. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'string',
- 'example' => 'ca-123456',
- ],
- 'ProductCode' => [
- 'description' => 'The specification ID of the order. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'string',
- 'example' => 'bykj123456',
- ],
- 'ProductName' => [
- 'description' => 'The specification name of the order. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'string',
- 'example' => 'CFCA',
- ],
- 'RootBrand' => [
- 'description' => 'The brand of the certificate. Valid values: WoSign, CFCA, DigiCert, and vTrus. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'string',
- 'example' => 'CFCA',
- ],
- 'SourceType' => [
- 'description' => 'The type of the order. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values:'."\n"
- ."\n"
- .'* **cpack**: virtual resource order'."\n"
- .'* **buy**: purchase order'."\n",
- 'type' => 'string',
- 'example' => 'buy',
- ],
- 'Status' => [
- 'description' => 'The certificate status of the order. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values:'."\n"
- ."\n"
- .'* **PAYED**: pending application'."\n"
- .'* **CHECKING**: reviewing'."\n"
- .'* **CHECKED_FAIL**: review failed'."\n"
- .'* **ISSUED**: issued'."\n"
- .'* **WILLEXPIRED**: about to expire'."\n"
- .'* **EXPIRED**: expired'."\n"
- .'* **NOTACTIVATED**: not activated'."\n"
- .'* **REVOKED**: revoked'."\n",
- 'type' => 'string',
- 'example' => 'PAYED',
- ],
- 'TrusteeStatus' => [
- 'description' => 'The hosting status of the certificate. This parameter is returned only if OrderType is set to CPACK or BUY. Valid values:'."\n"
- ."\n"
- .'* **unTrustee**: not hosted'."\n"
- .'* **trustee**: hosted'."\n",
- 'type' => 'string',
- 'example' => 'unTrustee',
- ],
- 'WildDomainCount' => [
- 'description' => 'The number of wildcard domain names that can be bound to the certificate. This parameter is returned only if OrderType is set to CPACK or BUY.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'CertificateId' => [
- 'description' => 'The ID of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '896521',
- ],
- 'Name' => [
- 'description' => 'The name of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'cert-name',
- ],
- 'CommonName' => [
- 'description' => 'The parent domain name of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'aliyun.com',
- ],
- 'Fingerprint' => [
- 'description' => 'The fingerprint of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03',
- ],
- 'Sha2' => [
- 'description' => 'The SHA-2 value of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => '56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11',
- ],
- 'SerialNo' => [
- 'description' => 'The serial number of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => '040a6e493cffdda6d744acf99b6576cf',
- ],
- 'Issuer' => [
- 'description' => 'The issuer of the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'MyIssuer',
- ],
- 'OrgName' => [
- 'description' => 'The name of the organization that is associated with the certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'Alibaba Cloud'."\n",
- ],
- 'Province' => [
- 'description' => 'The province or autonomous region in which the organization is located. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'Zhejiang'."\n",
- ],
- 'City' => [
- 'description' => 'The city in which the organization is located. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'Hangzhou'."\n",
- ],
- 'Country' => [
- 'description' => 'The code of the country in which the organization is located. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'CN',
- ],
- 'Sans' => [
- 'description' => 'All domain names that are bound to the certificate. Multiple domain names are separated by commas (,). This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'aliyun.com',
- ],
- 'Expired' => [
- 'description' => 'Indicates whether the certificate expires. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Upload' => [
- 'description' => 'Indicates whether the certificate is an uploaded certificate. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'StartDate' => [
- 'description' => 'The time at which the certificate starts to take effect. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => '2021-11-16',
- ],
- 'EndDate' => [
- 'description' => 'The time at which the certificate expires. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => '2022-11-17',
- ],
- 'ResourceGroupId' => [
- 'description' => 'The ID of the resource group. This parameter is returned only if OrderType is set to CERT or UPLOAD.'."\n",
- 'type' => 'string',
- 'example' => 'rg-ae******4wia',
- ],
+ 'WarehouseInstanceId' => ['description' => 'The warehouse instance ID.', 'type' => 'string', 'title' => '', 'example' => 'cas-wh-Q7ID6V'],
+ 'WarehouseName' => ['description' => 'The warehouse name.', 'type' => 'string', 'title' => '', 'example' => 'default_warehouse'],
+ 'WarehouseType' => ['description' => 'The warehouse type.', 'type' => 'string', 'title' => '', 'example' => 'pcaCaCert'],
],
+ 'description' => 'The details of a warehouse object.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'A list of warehouse objects.',
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n",
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5979d897-d69f-4fc9-87dd-f3bb73c40b80', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response body.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"ShowSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalCount\\": 1,\\n \\"CertificateOrderList\\": [\\n {\\n \\"Algorithm\\": \\"RSA\\",\\n \\"AliyunOrderId\\": 234567,\\n \\"BuyDate\\": 1634283958000,\\n \\"CertEndTime\\": 1665819958000,\\n \\"CertStartTime\\": 1665819958000,\\n \\"CertType\\": \\"FREE\\",\\n \\"Domain\\": \\"aliyundoc.com\\",\\n \\"DomainCount\\": 1,\\n \\"DomainType\\": \\"ONE\\",\\n \\"InstanceId\\": \\"cas-instanceId\\",\\n \\"OrderId\\": 2345687,\\n \\"PartnerOrderId\\": \\"ca-123456\\",\\n \\"ProductCode\\": \\"bykj123456\\",\\n \\"ProductName\\": \\"CFCA\\",\\n \\"RootBrand\\": \\"CFCA\\",\\n \\"SourceType\\": \\"buy\\",\\n \\"Status\\": \\"PAYED\\",\\n \\"TrusteeStatus\\": \\"unTrustee\\",\\n \\"WildDomainCount\\": 0,\\n \\"CertificateId\\": 896521,\\n \\"Name\\": \\"cert-name\\",\\n \\"CommonName\\": \\"aliyun.com\\",\\n \\"Fingerprint\\": \\"CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03\\",\\n \\"Sha2\\": \\"56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11\\",\\n \\"SerialNo\\": \\"040a6e493cffdda6d744acf99b6576cf\\",\\n \\"Issuer\\": \\"MyIssuer\\",\\n \\"OrgName\\": \\"阿里云\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Country\\": \\"CN\\",\\n \\"Sans\\": \\"aliyun.com\\",\\n \\"Expired\\": true,\\n \\"Upload\\": false,\\n \\"StartDate\\": \\"2021-11-16\\",\\n \\"EndDate\\": \\"2022-11-17\\",\\n \\"ResourceGroupId\\": \\"rg-ae******4wia\\"\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<ListUserCertificateOrderResponse>\\n <ShowSize>10</ShowSize>\\n <CurrentPage>1</CurrentPage>\\n <TotalCount>1</TotalCount>\\n <CertificateOrderList>\\n <Algorithm>RSA</Algorithm>\\n <AliyunOrderId>234567</AliyunOrderId>\\n <BuyDate>1634283958000</BuyDate>\\n <CertEndTime>1665819958000</CertEndTime>\\n <CertStartTime>1665819958000</CertStartTime>\\n <CertType>FREE</CertType>\\n <Domain>aliyundoc.com</Domain>\\n <DomainCount>1</DomainCount>\\n <DomainType>ONE</DomainType>\\n <InstanceId>cas-instanceId</InstanceId>\\n <OrderId>2345687</OrderId>\\n <PartnerOrderId>ca-123456</PartnerOrderId>\\n <ProductCode>bykj123456</ProductCode>\\n <ProductName>CFCA</ProductName>\\n <RootBrand>CFCA</RootBrand>\\n <SourceType>buy</SourceType>\\n <Status>PAYED</Status>\\n <TrusteeStatus>unTrustee</TrusteeStatus>\\n <WildDomainCount>0</WildDomainCount>\\n <CertificateId>896521</CertificateId>\\n <Name>name</Name>\\n <CommonName>aliyun.com</CommonName>\\n <Fingerprint>sdfdsfds4xkjghaknhhssa</Fingerprint>\\n <Sha2>sdfdsdfxkjghaknhhssa</Sha2>\\n <SerialNo>12354xkjghaknhhssa</SerialNo>\\n <Issuer>MyIssuer</Issuer>\\n <OrgName>阿里云</OrgName>\\n <Province>浙江省</Province>\\n <City>杭州市</City>\\n <Country>CN</Country>\\n <Sans>aliyun.com</Sans>\\n <Expired>true</Expired>\\n <Upload>false</Upload>\\n <StartDate>2022-11-16</StartDate>\\n <EndDate>2022-11-17</EndDate>\\n </CertificateOrderList>\\n <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\n</ListUserCertificateOrderResponse>","errorExample":""}]',
- 'title' => 'ListUserCertificateOrder',
- 'description' => 'You can call the ListUserCertificateOrder operation to query the certificates or certificate orders of users. If you set OrderType to CERT or UPLOAD, certificates are returned. If you set OrderType to CPACK or BUY, certificate orders are returned.'."\n"
+ 'title' => 'ListWarehouse',
+ 'description' => 'This operation lists your warehouses.'."\n"
."\n"
- .'## Limits'."\n"
+ .'### QPS limit'."\n"
."\n"
- .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
+ .'This operation has a per-user QPS limit of 10 requests per second. Calls exceeding this limit are throttled, which can affect your business.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68181f\\",\\n \\"MaxResults\\": 20,\\n \\"Data\\": [\\n {\\n \\"WarehouseInstanceId\\": \\"cas-wh-Q7ID6V\\",\\n \\"WarehouseName\\": \\"default_warehouse\\",\\n \\"WarehouseType\\": \\"pcaCaCert\\"\\n }\\n ],\\n \\"RequestId\\": \\"5979d897-d69f-4fc9-87dd-f3bb73c40b80\\"\\n}","type":"json"}]',
],
- 'CreateCertificateForPackageRequest' => [
- 'summary' => 'Submits a certificate application.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListWorkerResource' => [
+ 'summary' => 'Queries the worker tasks of a deployment task. Each worker task deploys a certificate to a specific cloud resource in a cloud service.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '81669',
- 'abilityTreeNodes' => [
- 'FEATUREcasP4AIN0',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ 'abilityTreeCode' => '214605',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Csr',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The content of the certificate signing request (CSR) file that is manually generated by using OpenSSL or Keytool for the domain name. The key algorithm in the CSR file must be Rivest-Shamir-Adleman (RSA) or elliptic-curve cryptography (ECC), and the key length of the RSA algorithm must be greater than or equal to 2,048 characters. For more information about how to create a CSR file, see [Create a CSR file](~~313297~~). If you do not specify this parameter, Certificate Management Service automatically creates a CSR file.'."\n"
- ."\n"
- .'A CSR file contains the information about your server and company. When you apply for a certificate, you must submit the CSR file to the CA. The CA signs the CSR file by using the private key of the root certificate and generates a public key file to issue your certificate.'."\n"
- ."\n"
- .'> The \\*\\*CN\\*\\* field in CSR file specifies the domain name that is bound to the certificate. You must include the field in the parameter value.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----',
- ],
+ 'schema' => ['description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the **ID** parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '8888'],
],
[
- 'name' => 'ProductCode',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => 'The specifications of the certificate that you want to apply for. Valid values:'."\n"
+ 'description' => 'The status of the worker task.'."\n"
."\n"
- .'* **digicert-free-1-free** (default): DigiCert single-domain domain validated (DV) certificate, which is free and valid for 3 months. This value is available only on the China site (aliyun.com).'."\n"
- .'* **symantec-free-1-free**: DigiCert single-domain DV certificate, which is free and valid for 1 year. This value is available only on the China site (aliyun.com).'."\n"
- .'* **symantec-dv-1-starter**: DigiCert wildcard DV certificate.'."\n"
- .'* **symantec-ov-1-personal**: DigiCert single-domain organization validated (OV) certificate.'."\n"
- .'* **symantec-ov-w-personal**: DigiCert wildcard OV certificate.'."\n"
- .'* **geotrust-dv-1-starter**: GeoTrust single-domain DV certificate.'."\n"
- .'* **geotrust-dv-w-starter**: GeoTrust wildcard DV certificate.'."\n"
- .'* **geotrust-ov-1-personal**: GeoTrust single-domain OV certificate.'."\n"
- .'* **geotrust-ov-w-personal**: GeoTrust wildcard OV certificate.'."\n"
- .'* **globalsign-dv-1-personal**: GlobalSign single-domain DV certificate.'."\n"
- .'* **globalsign-dv-w-advanced**: GlobalSign wildcard DV certificate.'."\n"
- .'* **globalsign-ov-1-personal**: GlobalSign single-domain OV certificate.'."\n"
- .'* **globalsign-ov-w-advanced**: GlobalSign wildcard OV certificate.'."\n"
- .'* **cfca-ov-1-personal**: China Financial Certification Authority (CFCA) single-domain OV certificate, available only on the China site (aliyun.com).'."\n"
- .'* **cfca-ev-w-advanced**: CFCA wildcard OV certificate, available only on the China site (aliyun.com).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'symantec-free-1-free',
- ],
- ],
- [
- 'name' => 'Username',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the applicant.'."\n"
+ .'Valid values:'."\n"
."\n"
- .'If you do not specify this parameter, the information about the most recent contact that is added to the **Information Management** module is used. For more information about how to add a contact to the **Information Management** module, see [Manage contacts](~~198262~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Tom',
- ],
- ],
- [
- 'name' => 'Phone',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The contact phone number of the applicant. CA staff can call the phone number to confirm the information in your certificate application.'."\n"
+ .'- rollback'."\n"
."\n"
- .'If you do not specify this parameter, the information about the most recent contact that is added to the **Information Management** module is used. For more information about how to add a contact to the **Information Management** module, see [Manage contacts](~~198262~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1390000****',
- ],
- ],
- [
- 'name' => 'Email',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The email address of the applicant. After the CA receives your certificate application, the CA sends a verification email to the email address that you specify. You must log on to the mailbox, open the mail, and complete the verification of the domain name ownership based on the steps that are described in the email.'."\n"
+ .'- rollback\\_error'."\n"
."\n"
- .'If you do not specify this parameter, the information about the most recent contact that is added to the **Information Management** module is used. For more information about how to add a contact to the **Information Management** module, see [Manage contacts](~~198262~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'username@example.com',
- ],
- ],
- [
- 'name' => 'Domain',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The domain name that you want to bind to the certificate. The domain name must meet the following requirements:'."\n"
+ .'- success'."\n"
+ ."\n"
+ .'- rollback\\_success'."\n"
+ ."\n"
+ .'- pending'."\n"
."\n"
- .'* The domain name must be a single domain name or a wildcard domain name. Example: `*.aliyundoc.com`.'."\n"
- .'* You can specify multiple domain names. Separate multiple domain names with commas (,). You can specify a maximum of five domain names.'."\n"
- .'* If you specify multiple domain names, the domain names must be only single domain names or only wildcard domain names. You cannot specify both single domain names and wildcard domain names.'."\n"
+ .'- scheduling'."\n"
."\n"
- .'> If you want to bind multiple domain names to the certificate, you must specify this parameter. You must specify at least one of the Domain parameter and the \\*\\*Csr\\*\\* parameter. If you specify both the Domain parameter and the \\*\\*Csr\\*\\* parameter, the value of the \\*\\*CN\\*\\* field in the \\*\\*Csr\\*\\* parameter is used as the domain name that is bound to the certificate.'."\n",
+ .'- processing'."\n"
+ ."\n"
+ .'- error'."\n"
+ ."\n"
+ .'- editing',
+ 'enumValueTitles' => ['rollback' => '', 'rollback_error' => '', 'success' => '', 'rollback_success' => '', 'pending' => '', 'scheduling' => '', 'processing' => '', 'error' => '', 'editing' => ''],
'type' => 'string',
+ 'title' => '',
'required' => false,
- 'example' => 'aliyundoc.com',
+ 'example' => 'editing',
],
],
[
- 'name' => 'CompanyName',
+ 'name' => 'CloudProduct',
'in' => 'query',
- 'schema' => [
- 'description' => 'The company name of the certificate application.'."\n"
- ."\n"
- .'> This parameter is available only when you apply for OV certificates. For more information, see [Manage company profiles](~~198289~~). If you want to apply for a DV certificate, you do not need to add a company profile.'."\n"
- ."\n"
- .'If you specify a company name, the information about the company that is configured in the **Information Management** module is used. If you do not specify this parameter, the information about the most recent company that is added to the **Information Management** module is used.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'A company'."\n",
- ],
+ 'schema' => ['description' => 'The cloud service in the deployment task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'NLB'],
],
[
- 'name' => 'ValidateType',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => 'The verification method of the domain name ownership. Valid values:'."\n"
- ."\n"
- .'* **DNS**: DNS verification. If you use this method, you must add a TXT record to the DNS records of the domain name in the management platform of the domain name. You must have operation permissions on domain name resolution to verify the ownership of the domain name.'."\n"
- .'* **FILE**: file verification. If you use this method, you must create a specified file on the DNS server. You must have administrative rights on the DNS server to verify the ownership of the domain name.'."\n"
- ."\n"
- .'For more information about the verification methods, see [Verify the ownership of a domain name](~~48016~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DNS',
- ],
+ 'schema' => ['description' => 'The page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Tags',
+ 'name' => 'ShowSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The list of tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'runtime',
- ],
- 'Value' => [
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The number of entries per page. Default value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => 'OpenApiPaginationResponse<WorkerResource>',
+ 'description' => 'OpenApiPaginationResponse',
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => 'The ID of the certificate application order.'."\n"
- ."\n"
- .'> You can use the ID to query the status of the certificate application order. For more information, see [DescribeCertificateState](~~164111~~).'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2021010',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n",
- 'type' => 'string',
- 'example' => '5890029B-938A-589E-98B9-3DEC7BA7C400',
+ 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ShowSize' => ['description' => 'The number of entries per page. Default value: **50**.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response parameters.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The ID of the worker task.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '22487'],
+ 'GmtCreate' => ['description' => 'The time when the worker task was created. The time is a timestamp in seconds.', 'type' => 'string', 'title' => '', 'example' => '1680228896000'],
+ 'GmtModified' => ['description' => 'The time when the worker task was last modified. The time is a timestamp in seconds.', 'type' => 'string', 'title' => '', 'example' => '1681956830000'],
+ 'UserId' => ['description' => 'The ID of the Alibaba Cloud account to which the worker task belongs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '166688437******'],
+ 'JobId' => ['description' => 'The ID of the deployment task to which the worker task belongs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '8888'],
+ 'OrderId' => ['description' => 'The order ID of the worker task, which is the same as the order ID of the certificate.'."\n"
+ ."\n"
+ .'> If the CertId parameter is returned, this parameter is not returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '9349278'],
+ 'CertId' => ['description' => 'The ID of the certificate in the worker task.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12073663'],
+ 'CertDomain' => ['description' => 'The domain name bound to the certificate in the worker task.', 'type' => 'string', 'title' => '', 'example' => 'www.example.com'],
+ 'CertInstanceId' => ['description' => 'The instance ID of the certificate in the worker task.', 'type' => 'string', 'title' => '', 'example' => 'lsn-jzk2h0xz5dmynuphb8@1883'],
+ 'CertName' => ['description' => 'The name of the certificate in the worker task.', 'type' => 'string', 'title' => '', 'example' => 'testCertName'],
+ 'ResourceId' => ['description' => 'The ID of the cloud resource in the worker task.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1286999'],
+ 'CloudProduct' => ['description' => 'The cloud service to which the cloud resource in the worker task belongs. Valid values:'."\n"
+ ."\n"
+ .'- **CDN**: Alibaba Cloud CDN (CDN). This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **SLB**: Classic Load Balancer (CLB). This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **DCDN**: Dynamic Content Delivery Network (DCDN). This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **DDOS**: Anti-DDoS. This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **LIVE**: ApsaraVideo Live. This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **webHosting**: Cloud Web Hosting. This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **VOD**: ApsaraVideo VOD. This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **CR**: Container Registry. This value is supported only at the China site (aliyun.com).'."\n"
+ ."\n"
+ .'- **ALB**: Application Load Balancer (ALB).'."\n"
+ ."\n"
+ .'- **APIGateway**: API Gateway.'."\n"
+ ."\n"
+ .'- **FC**: Function Compute.'."\n"
+ ."\n"
+ .'- **GA**: Global Accelerator (GA).'."\n"
+ ."\n"
+ .'- **MSE**: Microservices Engine (MSE).'."\n"
+ ."\n"
+ .'- **NLB**: Network Load Balancer (NLB).'."\n"
+ ."\n"
+ .'- **OSS**: Object Storage Service (OSS).'."\n"
+ ."\n"
+ .'- **SAE**: Serverless App Engine (SAE).'."\n"
+ ."\n"
+ .'- **TencentCDN**: Tencent Cloud Content Delivery Network (CDN).'."\n"
+ ."\n"
+ .'- **WAF**: Web Application Firewall (WAF).', 'type' => 'string', 'title' => '', 'example' => 'SLB'],
+ 'ResourceCertId' => ['description' => 'The ID of the certificate that was originally bound to the cloud resource in the worker task.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'],
+ 'ResourceDomain' => ['description' => 'The domain name that was originally bound to the cloud resource in the worker task.', 'type' => 'string', 'title' => '', 'example' => 'www.example.com'],
+ 'RegionId' => ['description' => 'The region ID of the cloud resource in the worker task.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'],
+ 'CloudRegion' => ['description' => 'The original region ID of the cloud resource in the worker task. The value is the region ID defined by the cloud service provider. This parameter is required only when you deploy certificates to services of multiple clouds.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'],
+ 'InstanceId' => ['description' => 'The ID of the cloud resource in the worker task.'."\n"
+ ."\n"
+ .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.', 'type' => 'string', 'title' => '', 'example' => 'cas-cn-0pp118nuu40b'],
+ 'ListenerId' => ['description' => 'The listener ID of the cloud resource in the worker task.'."\n"
+ ."\n"
+ .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.', 'type' => 'string', 'title' => '', 'example' => 'lsn-lhl8y7s1e1ngc3m3zz@81'],
+ 'Port' => ['description' => 'The listening port of the cloud resource in the worker task.'."\n"
+ ."\n"
+ .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4431'],
+ 'DefaultResource' => ['description' => 'Indicates whether the cloud resource in the worker task is the default resource. Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**'."\n"
+ ."\n"
+ .'> This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'CloudName' => ['description' => 'The cloud service provider to which the cloud resource in the worker task belongs.'."\n"
+ ."\n"
+ .'> This parameter is not returned if you deploy certificates to Alibaba Cloud services.', 'type' => 'string', 'title' => '', 'example' => 'aliyun'],
+ 'NamespaceId' => ['description' => 'The ID of the namespace in SAE. This parameter is returned only if you deploy certificates to SAE.', 'type' => 'string', 'title' => '', 'example' => '32fed52a-4bf7-44f6-955f-e82ada68ef18'],
+ 'Status' => ['description' => 'The status of the worker task. Valid values:'."\n"
+ ."\n"
+ .'- **editing**'."\n"
+ ."\n"
+ .'- **pending**'."\n"
+ ."\n"
+ .'- **scheduling**'."\n"
+ ."\n"
+ .'- **processing**'."\n"
+ ."\n"
+ .'- **error**'."\n"
+ ."\n"
+ .'- **success**'."\n"
+ ."\n"
+ .'- **rollback**'."\n"
+ ."\n"
+ .'- **rollback\\_success**'."\n"
+ ."\n"
+ .'- **rollback\\_error**', 'type' => 'string', 'title' => '', 'example' => 'editing'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E50D480-9765-5CFD-9650-9BACCECA5135', 'title' => ''],
],
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": 2021010,\\n \\"RequestId\\": \\"5890029B-938A-589E-98B9-3DEC7BA7C400\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCertificateForPackageRequestResponse>\\n <OrderId>2021010</OrderId>\\n <RequestId>5890029B-938A-589E-98B9-3DEC7BA7C400</RequestId>\\n</CreateCertificateForPackageRequestResponse>","errorExample":""}]',
- 'title' => 'CreateCertificateForPackageRequest',
- 'description' => '* Before you call this operation, make sure that you have purchased a certificate resource plan of the required specifications. For more information about how to purchase a certificate resource plan, see [Purchase a certificate resource plan](~~28542~~). You can call the [DescribePackageState](~~455800~~) operation to query the usage of a certificate resource plan of specified specifications, including the total number of certificate resource plans that you purchase, the number of certificate applications that you submit, and the number of certificates that are issued.'."\n"
- .'* After you call this operation to submit a certificate application and the certificate is issued, the certificate quota provided by the resource plan that you purchased is consumed. When you call this operation, you can use the **ProductCode** parameter to specify the specifications of the certificate that you want to apply for.'."\n"
- .'* After you call this operation to submit a certificate application, you also need to call the [DescribeCertificateState](~~455800~~) operation to obtain the information that is required for domain name ownership verification and manually complete the verification. Then, your certificate application is reviewed by the certificate authority (CA). If you use the Domain Name System (DNS) verification method, you must complete the verification on your DNS service provider system. If you use the file verification method, you must complete the verification on the DNS server.'."\n",
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CancelCertificateForPackageRequest' => [
- 'summary' => 'Revokes an issued certificate and cancels the application order of the certificate.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListWorkerResource',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListWorkerResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 8,\\n \\"CurrentPage\\": 1,\\n \\"ShowSize\\": 50,\\n \\"Data\\": [\\n {\\n \\"Id\\": 22487,\\n \\"GmtCreate\\": \\"1680228896000\\",\\n \\"GmtModified\\": \\"1681956830000\\",\\n \\"UserId\\": 0,\\n \\"JobId\\": 8888,\\n \\"OrderId\\": 9349278,\\n \\"CertId\\": 12073663,\\n \\"CertDomain\\": \\"www.example.com\\",\\n \\"CertInstanceId\\": \\"lsn-jzk2h0xz5dmynuphb8@1883\\",\\n \\"CertName\\": \\"testCertName\\",\\n \\"ResourceId\\": 1286999,\\n \\"CloudProduct\\": \\"SLB\\",\\n \\"ResourceCertId\\": 123,\\n \\"ResourceDomain\\": \\"www.example.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CloudRegion\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"cas-cn-0pp118nuu40b\\",\\n \\"ListenerId\\": \\"lsn-lhl8y7s1e1ngc3m3zz@81\\",\\n \\"Port\\": 4431,\\n \\"DefaultResource\\": true,\\n \\"CloudName\\": \\"aliyun\\",\\n \\"NamespaceId\\": \\"32fed52a-4bf7-44f6-955f-e82ada68ef18\\",\\n \\"Status\\": \\"editing\\"\\n }\\n ],\\n \\"RequestId\\": \\"3E50D480-9765-5CFD-9650-9BACCECA5135\\"\\n}","type":"json"}]',
+ ],
+ 'MoveResourceGroup' => [
+ 'summary' => 'Changes the resource group to which a certificate or certificate order belongs.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6757,61 +6314,84 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '81667',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ 'abilityTreeCode' => '226097',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
],
'parameters' => [
[
- 'name' => 'OrderId',
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => true, 'example' => 'cas-cn-4591d3xa****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-acfmykgxu5d46ey', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceType',
'in' => 'query',
'schema' => [
- 'description' => 'The order ID.'."\n"
+ 'description' => 'The type of the resource.<br>'."\n"
+ .'Default value: **instance**'."\n"
+ ."\n"
+ .'Valid values:'."\n"
."\n"
- .'> You can call the [ListUserCertificateOrder](~~455804~~) operation to obtain the ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
+ .'- instance: certificate order'."\n"
+ ."\n"
+ .'- Certificate: certificate',
+ 'enumValueTitles' => ['instance' => 'instance', 'Certificate' => 'Certificate'],
+ 'type' => 'string',
'required' => true,
- 'example' => '123451222',
+ 'example' => 'instance',
+ 'title' => '',
],
],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region of the organization to which the owner of the certificate belongs. Valid values: ap-southeast-1 and cn-hangzhou.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","type":"json"}]',
- 'title' => 'CancelCertificateForPackageRequest',
- 'description' => 'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'CancelOrderRequest' => [
- 'summary' => 'Cancels a certificate application order that is in the pending validation or being reviewed state.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'MoveResourceGroup',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:MoveResourceGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E\\"\\n}","type":"json"}]',
+ ],
+ 'RefundInstance' => [
+ 'summary' => 'Refunds an instance within 7 days.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6823,40 +6403,28 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '81668',
- 'abilityTreeNodes' => [
- 'FEATUREcasP4AIN0',
- ],
+ 'abilityTreeCode' => '213377',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'autoTest' => false,
- 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'OrderId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The order ID.'."\n"
- ."\n"
- .'> You can call the [ListUserCertificateOrder](~~455804~~) operation to obtain the ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123451222',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cas-ivauto-hqito6', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76',
- ],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique ID for each API request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'D3F1FA43-1C26-50A2-8F0F-7A03851DBB46', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -6864,20 +6432,26 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]',
- 'title' => 'CancelOrderRequest',
- 'description' => 'You can call this operation up to 100 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
+ 'title' => 'Refund an instance',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:RefundInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3F1FA43-1C26-50A2-8F0F-7A03851DBB46\\"\\n}","type":"json"}]',
],
'RenewCertificateOrderForPackageRequest' => [
- 'summary' => 'Submits a renewal application for an issued certificate.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6890,9 +6464,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '81675',
- 'abilityTreeNodes' => [
- 'FEATUREcasP4AIN0',
- ],
+ 'abilityTreeNodes' => ['FEATUREcasP4AIN0'],
'autoTest' => false,
'notSupportAutoTestReason' => '需要签发超过30天的证书，无法自动化测试',
'tenantRelevance' => 'tenant',
@@ -6901,64 +6473,47 @@
[
'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the certificate application order that you want to renew.'."\n"
- ."\n"
- .'> After you call the [CreateCertificateForPackageRequest](~~455296~~), [CreateCertificateRequest](~~455292~~), or [CreateCertificateWithCsrRequest](~~455801~~) operation to submit a certificate application, you can obtain the ID of the certificate application order from the **OrderId** response parameter. You can also call the [ListUserCertificateOrder](~~455804~~) operation to obtain the order ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123451222',
- ],
+ 'schema' => ['description' => 'The ID of the certificate application order that you want to renew.'."\n"
+ ."\n"
+ .'> After you call the [CreateCertificateForPackageRequest](~~455296~~), [CreateCertificateRequest](~~455292~~), or [CreateCertificateWithCsrRequest](~~455801~~) operation to submit a certificate application, you can obtain the ID of the certificate application order from the **OrderId** response parameter. You can also call the [ListUserCertificateOrder](~~455804~~) operation to obtain the order ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123451222', 'title' => ''],
],
[
'name' => 'Csr',
'in' => 'query',
- 'schema' => [
- 'description' => 'The content of the certificate signing request (CSR) file that is manually generated for the domain name by using OpenSSL or Keytool. The key algorithm in the CSR file must be Rivest-Shamir-Adleman (RSA) or elliptic-curve cryptography (ECC), and the key length of the RSA algorithm must be greater than or equal to 2,048 characters. For more information about how to create a CSR file, see [How do I create a CSR file?](~~42218~~)'."\n"
- ."\n"
- .'If you do not specify this parameter, Certificate Management Service automatically generates a CSR file for the domain name in the certificate application order that you want to renew.'."\n"
- ."\n"
- .'A CSR file contains the information about your server and company. When you apply for a certificate, you must submit the CSR file to the CA. The CA signs the CSR file by using the private key of the root certificate and generates a public key file to issue your certificate.'."\n"
- ."\n"
- .'> The **CN** field in the CSR file specifies the domain name that is bound to the certificate.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN CERTIFICATE REQUEST----- MIIC1TCCAb0CAQAwgY8xCzAJBgNVBAYTAkNOMRIwEAYDVQQIDAlHdWFuZ3pob3Ux ETAPBgNVBAcMCFNoZW56aGVuMQ8wDQYDVQQKDAZDaGFjdW8xEDAOBgNVBAsMB0lU IERlcHQxFzAVBgNVBAMMDnd3dy5jaGFjdW8ubmV0MR0wGwYJKoZIhvcNAQkBFg44 MjkyNjY5QHFxLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALo7 atRvQf9tKo1NJ/MQqzHvIjHNhU+0MMerDq+tRlJ+a7Ro1r6IWNF5MB0Z****** -----END CERTIFICATE REQUEST-----',
- ],
+ 'schema' => ['description' => 'The content of the certificate signing request (CSR) file that is manually generated for the domain name by using OpenSSL or Keytool. The key algorithm in the CSR file must be Rivest-Shamir-Adleman (RSA) or elliptic-curve cryptography (ECC), and the key length of the RSA algorithm must be greater than or equal to 2,048 characters. For more information about how to create a CSR file, see [How do I create a CSR file?](~~42218~~)'."\n"
+ ."\n"
+ .'If you do not specify this parameter, Certificate Management Service automatically generates a CSR file for the domain name in the certificate application order that you want to renew.'."\n"
+ ."\n"
+ .'A CSR file contains the information about your server and company. When you apply for a certificate, you must submit the CSR file to the CA. The CA signs the CSR file by using the private key of the root certificate and generates a public key file to issue your certificate.'."\n"
+ ."\n"
+ .'> The **CN** field in the CSR file specifies the domain name that is bound to the certificate.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE REQUEST----- MIIC1TCCAb0CAQAwgY8xCzAJBgNVBAYTAkNOMRIwEAYDVQQIDAlHdWFuZ3pob3Ux ETAPBgNVBAcMCFNoZW56aGVuMQ8wDQYDVQQKDAZDaGFjdW8xEDAOBgNVBAsMB0lU IERlcHQxFzAVBgNVBAMMDnd3dy5jaGFjdW8ubmV0MR0wGwYJKoZIhvcNAQkBFg44 MjkyNjY5QHFxLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALo7 atRvQf9tKo1NJ/MQqzHvIjHNhU+0MMerDq+tRlJ+a7Ro1r6IWNF5MB0Z****** -----END CERTIFICATE REQUEST-----', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The tags.',
+ 'description' => 'A list of tags.',
'type' => 'array',
'items' => [
- 'description' => 'The tags.'."\n",
+ 'description' => 'The tags.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.'."\n"
- ."\n"
- .'A tag key can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'account',
- ],
- 'Value' => [
- 'description' => 'The value of the resource tag. A maximum of 20 tag values can be entered. If this value needs to be passed in, an empty string can be entered.'."\n"
- ."\n"
- .'A maximum of 128 characters are supported, it cannot start with \'aliyun\' or \'acs:\', and it cannot contain \'http://\' or \'https://\'.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'Key' => ['description' => 'The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.'."\n"
+ ."\n"
+ .'A tag key can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http\\:// or https\\://.', 'type' => 'string', 'required' => false, 'example' => 'account', 'title' => ''],
+ 'Value' => ['description' => 'The value of the resource tag. A maximum of 20 tag values can be entered. If this value needs to be passed in, an empty string can be entered.'."\n"
+ ."\n"
+ .'A maximum of 128 characters are supported, it cannot start with \'aliyun\' or \'acs:\', and it cannot contain \'http\\://\' or \'https\\://\'.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -6968,194 +6523,77 @@
'description' => '',
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => 'The ID of the certificate application order that is renewed.'."\n"
- ."\n"
- .'> You can use the ID to query the status of the certificate application order. For more information, see [DescribeCertificateState](~~164111~~).'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '323451222',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76',
- ],
+ 'OrderId' => ['description' => 'The ID of the certificate application order that is renewed.'."\n"
+ ."\n"
+ .'> You can use the ID to query the status of the certificate application order. For more information, see [DescribeCertificateState](~~164111~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '323451222', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": 323451222,\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<RenewCertificateOrderForPackageRequestResponse>\\r\\n\\t<RequestId>082FAB35-6AB9-4FD5-8750-D36673548E76</RequestId>\\r\\n\\t<OrderId>323451222</OrderId>\\r\\n</RenewCertificateOrderForPackageRequestResponse>","errorExample":""}]',
'title' => 'RenewCertificateOrderForPackageRequest',
+ 'summary' => 'Submits a renewal application for an issued SSL certificate.',
'description' => 'You can call the RenewCertificateOrderForPackageRequest operation to submit a renewal application for a certificate only when the order of the certificate is in the expiring state. After the renewal is complete, a new certificate order whose status is pending application is generated. You must submit a certificate application for the new certificate order and install the new certificate after the new certificate is issued.'."\n"
."\n"
- .'> You can call the [DescribeCertificateState](~~164111~~) operation to query the status of a certificate application order. If the value of the **Type** response parameter is **certificate**, the certificate is issued.'."\n",
+ .'> You can call the [DescribeCertificateState](~~164111~~) operation to query the status of a certificate application order. If the value of the **Type** response parameter is **certificate**, the certificate is issued.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetCertWarehouseQuota' => [
- 'summary' => 'Queries the API call quota for certificate application repositories. When you call API operations for signature generation, signature verification, data encryption, and data decryption, your API call quota for certificate application repositories is consumed. If your API call quota is exhausted, you can no longer call specific certificate application repository-related operations. You can call this operation to query the API call quota for certificate application repositories.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '159262',
- 'abilityTreeNodes' => [
- 'FEATUREcasY9QF1D',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => 'The object.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'TotalQuota' => [
- 'description' => 'The total quota for certificate repositories, including the free quota and purchased quota.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5000',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n",
- 'type' => 'string',
- 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D',
- ],
- 'UseCount' => [
- 'description' => 'The used quota.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'AppTotalQuota' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'AppUseCount' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'changeSet' => [
+ ['createdAt' => '2024-12-10T09:30:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-23T08:22:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:RenewCertificateOrderForPackageRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalQuota\\": 5000,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"UseCount\\": 1000,\\n \\"AppTotalQuota\\": 5000,\\n \\"AppUseCount\\": 1000\\n}","errorExample":""},{"type":"xml","example":"<GetCertWarehouseQuotaResponse>\\n <TotalQuota>5000</TotalQuota>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n <UseCount>1000</UseCount>\\n</GetCertWarehouseQuotaResponse>","errorExample":""}]',
- 'title' => 'GetCertWarehouseQuota',
- 'description' => 'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 323451222,\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]',
],
- 'ListCertWarehouse' => [
- 'summary' => 'Queries certificate repositories.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RevokeCertificate' => [
+ 'summary' => 'Revokes a certificate.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '153636',
- 'abilityTreeNodes' => [
- 'FEATUREcasEAT643',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '213377',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the certificate application repository. Fuzzy match is supported.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'name',
- ],
- ],
- [
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The instance ID of the certificate application repository.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '14dcc8afc7578e1f',
- ],
- ],
- [
- 'name' => 'Type',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the certificate application repository. Valid values:'."\n"
- ."\n"
- .'* **ssl**: certificate application repository of SSL certificates'."\n"
- .'* **uploadPCA**: certificate application repository of uploaded private certificates'."\n"
- .'* **free**: certificate application repository of free certificates, available only on the China site (aliyun.com)'."\n"
- .'* **aliyunPCA**: certificate application repository of private certificates purchased from Alibaba Cloud Private Certificate Authority (PCA), available only on the China site (aliyun.com)'."\n"
- .'* **disable**: disabled certificate application repository'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aliyunPCA',
- ],
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cas-cn-68n1mm16****', 'title' => ''],
],
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of the page to return. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'ShowSize',
+ 'name' => 'CertificateId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries to return on each page. Default value: 50.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '50',
- ],
+ 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''],
],
],
'responses' => [
@@ -7163,93 +6601,11 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'ShowSize' => [
- 'description' => 'The number of entries returned per page. Default value: 50.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'CurrentPage' => [
- 'description' => 'The page number of the returned page. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'CertWarehouseList' => [
- 'description' => 'The certificate application repositories.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the certificate application repository.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'WhId' => [
- 'description' => 'The ID of the certificate application repository.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'InstanceId' => [
- 'description' => 'The instance ID of the certificate application repository.'."\n",
- 'type' => 'string',
- 'example' => '14dcc8afc7578e1f',
- ],
- 'Name' => [
- 'description' => 'The name of the certificate application repository.'."\n",
- 'type' => 'string',
- 'example' => 'name',
- ],
- 'PcaInstanceId' => [
- 'description' => 'The instance ID of the private CA.'."\n",
- 'type' => 'string',
- 'example' => '14dcc8afc7578e1f',
- ],
- 'Qps' => [
- 'description' => 'The queries per second (QPS).'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'Type' => [
- 'description' => 'The type of the certificate application repository. Valid values:'."\n"
- ."\n"
- .'* **ssl**: certificate application repository of SSL certificates'."\n"
- .'* **uploadPCA**: certificate application repository of uploaded private certificates'."\n"
- .'* **free**: certificate application repository of free certificates, available only on the China site (aliyun.com)'."\n"
- .'* **aliyunPCA**: certificate application repository of private certificates purchased from Alibaba Cloud Private Certificate Authority (PCA), available only on the China site (aliyun.com)'."\n"
- .'* **disable**: disabled certificate application repository'."\n",
- 'type' => 'string',
- 'example' => 'aliyunPCA',
- ],
- 'EndTime' => [
- 'description' => 'The timestamp when the certificate application repository expires. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1665819958000',
- ],
- 'IsExpired' => [
- 'description' => 'Indicates whether the certificate application repository has expired. Valid values:'."\n"
- ."\n"
- .'* **true**'."\n"
- .'* **false**'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -7257,24 +6613,26 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"ShowSize\\": 50,\\n \\"CurrentPage\\": 1,\\n \\"TotalCount\\": 10,\\n \\"CertWarehouseList\\": [\\n {\\n \\"WhId\\": 1,\\n \\"InstanceId\\": \\"14dcc8afc7578e1f\\",\\n \\"Name\\": \\"name\\",\\n \\"PcaInstanceId\\": \\"14dcc8afc7578e1f\\",\\n \\"Qps\\": 10,\\n \\"Type\\": \\"aliyunPCA\\",\\n \\"EndTime\\": 1665819958000,\\n \\"IsExpired\\": false\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<ListCertWarehouseResponse>\\n <ShowSize>50</ShowSize>\\n <CurrentPage>1</CurrentPage>\\n <TotalCount>10</TotalCount>\\n <CertWarehouseList>\\n <WhId>1</WhId>\\n <InstanceId>14dcc8afc7578e1f</InstanceId>\\n <Name>name</Name>\\n <PcaInstanceId>14dcc8afc7578e1f</PcaInstanceId>\\n <Qps>10</Qps>\\n <Type>aliyunPCA</Type>\\n <EndTime>1665819958000</EndTime>\\n <IsExpired>false</IsExpired>\\n </CertWarehouseList>\\n <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\n</ListCertWarehouseResponse>","errorExample":""}]',
- 'title' => 'ListCertWarehouse',
- 'description' => 'You can call the ListCertWarehouse operation to query certificate repositories.'."\n"
- ."\n"
- .'### Limits'."\n"
- ."\n"
- .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'ListCert' => [
- 'summary' => 'Queries the certificates in a certificate repository.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Revoke a certificate',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:RevokeCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
+ ],
+ 'RevokeWHClientCertificate' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7283,214 +6641,31 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '153639',
- 'abilityTreeNodes' => [
- 'FEATUREcasEAT643',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '158040',
+ 'abilityTreeNodes' => ['FEATUREcasY9QF1D'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '涉及多产品联动，无法自动化测试',
],
'parameters' => [
[
- 'name' => 'KeyWord',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The keyword for the query. You can enter a name, domain name, or Subject Alternative Name (SAN) extension. Fuzzy match is supported.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_name',
- ],
- ],
- [
- 'name' => 'WarehouseId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the certificate repository. You can call the ListCertWarehouse API operation to query the IDs of certificate repositories.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The status of the certificate. Valid values:'."\n"
- ."\n"
- .'* **ISSUE**: issued'."\n"
- .'* **REVOKE**: revoked'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ISSUE',
- ],
- ],
- [
- 'name' => 'SourceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The source of the certificate. Valid values:'."\n"
- ."\n"
- .'* **upload**: uploaded certificate'."\n"
- .'* **aliyun**: Alibaba Cloud certificate'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aliyun',
- ],
- ],
- [
- 'name' => 'CertType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '证书的类型 。取值：'."\n"
- ."\n"
- .'- **CA**：表示CA证书。'."\n"
- .'- **CERT**：表示签发的证书。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CERT',
- ],
- ],
- [
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of the page to return. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'ShowSize',
+ 'name' => 'Identifier',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries to return on each page. Default value: 50.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '50',
- ],
+ 'schema' => ['description' => 'The unique identifier of the client or server certificate to revoke.', 'type' => 'string', 'required' => true, 'example' => '160ae6bb538d538c70c01f81dcf2****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The object.'."\n",
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'ShowSize' => [
- 'description' => 'The number of entries returned per page. Default value: 50.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'CurrentPage' => [
- 'description' => 'The page number of the returned page. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'CertList' => [
- 'description' => 'An array that consists of the certificates.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the certificate.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'WhId' => [
- 'description' => 'The ID of the certificate repository.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'Identifier' => [
- 'description' => 'The unique identifier of the certificate.'."\n",
- 'type' => 'string',
- 'example' => '14dcc8afc7578e',
- ],
- 'WhInstanceId' => [
- 'description' => 'The instance ID of the certificate repository.'."\n",
- 'type' => 'string',
- 'example' => 'test_whInstanceId',
- ],
- 'Status' => [
- 'description' => 'The status of the certificate. Valid values:'."\n"
- ."\n"
- .'* **ISSUE**: issued'."\n"
- .'* **REVOKE**: revoked'."\n",
- 'type' => 'string',
- 'example' => 'ISSUE',
- ],
- 'SourceType' => [
- 'description' => 'The source of the certificate. Valid values:'."\n"
- ."\n"
- .'* **upload**: uploaded certificate'."\n"
- .'* **aliyun**: Alibaba Cloud certificate'."\n",
- 'type' => 'string',
- 'example' => 'aliyun',
- ],
- 'CertType' => [
- 'description' => '证书的类型 。取值：'."\n"
- ."\n"
- .'- **CA**：表示CA证书。'."\n"
- .'- **CERT**：表示签发的证书。',
- 'type' => 'string',
- 'example' => 'CERT',
- ],
- 'CommonName' => [
- 'description' => 'The domain name.'."\n",
- 'type' => 'string',
- 'example' => 'aliyun.alibaba.com',
- ],
- 'BeforeDate' => [
- 'description' => 'The issuance time of the certificate. The value is a UNIX timestamp. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1665819958000',
- ],
- 'Issuer' => [
- 'description' => 'The issuer of the certificate.'."\n",
- 'type' => 'string',
- 'example' => 'mySSL',
- ],
- 'AfterDate' => [
- 'description' => 'The expiration time of the certificate. The value is a UNIX timestamp. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1634283958000',
- ],
- 'ExistPrivateKey' => [
- 'description' => 'Indicates whether the certificate contains a private key. Valid values:'."\n"
- ."\n"
- .'* **true**'."\n"
- .'* **false**'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Sans' => [
- 'description' => 'The domain names that are bound to the certificate. Multiple domain names are separated by commas.'."\n",
- 'type' => 'string',
- 'example' => '*.alibaba.com,aliyun.alibaba.com',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
+ 'RequestId' => ['description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -7498,20 +6673,17 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"ShowSize\\": 50,\\n \\"CurrentPage\\": 1,\\n \\"TotalCount\\": 10,\\n \\"CertList\\": [\\n {\\n \\"WhId\\": 2,\\n \\"Identifier\\": \\"14dcc8afc7578e\\",\\n \\"WhInstanceId\\": \\"test_whInstanceId\\",\\n \\"Status\\": \\"ISSUE\\",\\n \\"SourceType\\": \\"aliyun\\",\\n \\"CertType\\": \\"CERT\\",\\n \\"CommonName\\": \\"aliyun.alibaba.com\\",\\n \\"BeforeDate\\": 1665819958000,\\n \\"Issuer\\": \\"mySSL\\",\\n \\"AfterDate\\": 1634283958000,\\n \\"ExistPrivateKey\\": false,\\n \\"Sans\\": \\"*.alibaba.com,aliyun.alibaba.com\\"\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<ListCertResponse>\\n <ShowSize>50</ShowSize>\\n <CurrentPage>1</CurrentPage>\\n <TotalCount>10</TotalCount>\\n <CertList>\\n <WhId>2</WhId>\\n <Identifier>14dcc8afc7578e</Identifier>\\n <WhInstanceId>test_whInstanceId</WhInstanceId>\\n <Status>ISSUE</Status>\\n <SourceType>aliyun</SourceType>\\n <CommonName>aliyun.alibaba.com</CommonName>\\n <BeforeDate>1665819958000</BeforeDate>\\n <Issuer>mySSL</Issuer>\\n <AfterDate>1634283958000</AfterDate>\\n <ExistPrivateKey>false</ExistPrivateKey>\\n <Sans>*.alibaba.com,aliyun.alibaba.com</Sans>\\n </CertList>\\n <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\n</ListCertResponse>","errorExample":""}]',
- 'title' => 'ListCert',
- 'description' => 'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
+ 'title' => 'RevokeWHClientCertificate',
+ 'summary' => 'Revokes a client certificate from the certificate repository.',
+ 'description' => 'The rate limit for this API is 10 queries per second (QPS) per user. If you exceed this limit, subsequent API calls will be throttled, which can disrupt your services. We recommend that you call this API at a reasonable rate.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]',
],
'Sign' => [
- 'summary' => 'Signs a private certificate in a certificate application repository.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'This operation creates a digital signature with a PCA certificate from a certificate repository.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7524,80 +6696,62 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '153626',
- 'abilityTreeNodes' => [
- 'FEATUREcasVZUJH0',
- ],
+ 'abilityTreeNodes' => ['FEATUREcasVZUJH0'],
],
'parameters' => [
[
'name' => 'Message',
'in' => 'query',
- 'schema' => [
- 'description' => 'The data to sign. The value must be encoded in Base64.\\'."\n"
- .'For example, if the hexadecimal data that you want to sign is \\[0x31, 0x32, 0x33, 0x34], set the parameter to the Base64-encoded value MTIzNA==. If you set MessageType to RAW, the size of the data must be less than 4 KB. If the size of the data is greater than 4 KB, you can set MessageType to DIGEST and set Message to the digest of the data. The digest is a hash value. You can compute the digest of the data on an on-premises machine. The certificate application repository uses the digest that you compute in your own certificate application system. The message digest algorithm that you use must match the specified signature algorithm. The following items describe the details:'."\n"
- ."\n"
- .'* If the signature algorithm is SHA256withRSA, SHA256withRSA/PSS, or SHA256withECDSA, the message digest algorithm must be SHA-256.'."\n"
- .'* If the signature algorithm is SM3withSM2, the message digest algorithm must be SM3.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'message',
- ],
+ 'schema' => ['description' => 'The data to sign. The MessageType parameter determines the format of this data. If MessageType is set to RAW, Message is the raw data. If MessageType is set to BASE64, Message is the Base64-encoded raw data. If MessageType is set to DIGEST, Message is the message digest (hash value). If MessageType is set to BLIND, Message is the Base64-encoded blinded message.', 'type' => 'string', 'required' => true, 'example' => 'MTIzNA==', 'title' => ''],
],
[
'name' => 'CertIdentifier',
'in' => 'query',
- 'schema' => [
- 'description' => 'The unique identifier of the certificate. You can call the [ListCert](~~455806~~) operation to obtain the identifier.'."\n"
- ."\n"
- .'* If the certificate is an SSL certificate, the value of this parameter must be in the {Certificate ID}-cn-hangzhou format.'."\n"
- .'* If the certificate is a private certificate, the value of this parameter must be the value of the Identifier field for the private certificate.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ccaf0c629c2be1e2abb63bb76b',
- ],
+ 'schema' => ['description' => 'The unique identifier of the certificate. You can get this value by calling the [ListCert](~~455806~~) operation.'."\n"
+ ."\n"
+ .'- The identifier of an SSL certificate is typically in the format \'{Certificate ID}-cn-hangzhou\'.'."\n"
+ ."\n"
+ .'- For a PCA certificate, this is the Identifier from the corresponding private certificate.', 'type' => 'string', 'required' => false, 'example' => '1ef1da5f-38ed-69b3-****-037781890265', 'title' => ''],
],
[
'name' => 'SigningAlgorithm',
'in' => 'query',
- 'schema' => [
- 'description' => 'The signature algorithm. Valid values:'."\n"
- ."\n"
- .'* SHA256withRSA'."\n"
- .'* SHA256withRSA/PSS'."\n"
- .'* SHA256withECDSA'."\n"
- .'* SM3withSM2'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SHA256withRSA',
- ],
+ 'schema' => ['description' => 'The signature algorithm. Valid values:'."\n"
+ ."\n"
+ .'- `SHA256withRSA`'."\n"
+ ."\n"
+ .'- `SHA256withRSA/PSS`'."\n"
+ ."\n"
+ .'- `SHA256withECDSA`'."\n"
+ ."\n"
+ .'- `SM3withSM2`'."\n"
+ ."\n"
+ .'- `SHA256withRSA/P7`', 'type' => 'string', 'required' => true, 'example' => 'SHA256withRSA', 'title' => ''],
],
[
'name' => 'MessageType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The value type of the Message parameter. Valid values:'."\n"
- ."\n"
- .'* RAW: the raw data. This is the default value.'."\n"
- .'* DIGEST: the message digest (hash value) of the raw data.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RAW',
- ],
+ 'schema' => ['description' => 'The message type. Valid values:'."\n"
+ ."\n"
+ .'- `RAW` (default): The raw data.'."\n"
+ ."\n"
+ .'- `DIGEST`: The message digest (hash value) of the raw data.'."\n"
+ ."\n"
+ .'- `BASE64`: The Base64-encoded raw data.'."\n"
+ ."\n"
+ .'- `BLIND`: Enables blind signing. This is supported only for certificates that use an RSA algorithm.', 'type' => 'string', 'required' => true, 'example' => 'RAW', 'title' => ''],
],
[
'name' => 'CustomIdentifier',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'A unique, user-defined identifier.', 'type' => 'string', 'required' => false, 'example' => '***e6bb538d538c70c01f81fg3****', 'title' => ''],
],
[
'name' => 'WarehouseId',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'schema' => ['description' => 'The repository ID.'."\n"
+ ."\n"
+ .'> You can get this ID by calling the [ListCertWarehouse](~~455805~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
@@ -7605,17 +6759,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Signature' => [
- 'description' => 'The signature.'."\n",
- 'type' => 'string',
- 'example' => 'eyaC0w3ROK5b3QcHmUtAhMY/sQjKu2t3uBfnf6J/gn7JfZtyxwcCUjzXbw5jmqJQRbj1te670Bshg9kUdanKhtHFhJjU5jX+ZMMBr6pH0gqQDJxR0K0yHXRc0Q5OQoUZ6BfpbI4Wt4jJvJSdCstz1vSg12CfEHS8Kd5qfhItK7Y=',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '1ed33293-2e48-6b14-861e-538e28e408eb',
- ],
+ 'Signature' => ['description' => 'The Base64-encoded signature.', 'type' => 'string', 'example' => 'eyaC0w3ROK5b3QcHmUtAhMY/sQjKu2t3uBfnf6J/gn7JfZtyxwcCUjzXbw5jmqJQRbj1te670Bshg9kUdanKhtHFhJjU5jX+ZMMBr6pH0gqQDJxR0K0yHXRc0Q5OQoUZ6BfpbI4Wt4jJvJSdCstz1vSg12CfEHS8Kd5qfhItK7Y=', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1ed33293-2e48-6b14-861e-538e28e408eb', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -7623,24 +6772,35 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Signature\\": \\"eyaC0w3ROK5b3QcHmUtAhMY/sQjKu2t3uBfnf6J/gn7JfZtyxwcCUjzXbw5jmqJQRbj1te670Bshg9kUdanKhtHFhJjU5jX+ZMMBr6pH0gqQDJxR0K0yHXRc0Q5OQoUZ6BfpbI4Wt4jJvJSdCstz1vSg12CfEHS8Kd5qfhItK7Y=\\",\\n \\"RequestId\\": \\"1ed33293-2e48-6b14-861e-538e28e408eb\\"\\n}","errorExample":""},{"type":"xml","example":"<SignResponse>\\n <Signature>eyaC0w3ROK5b3QcHmUtAhMY/sQjKu2t3uBfnf6J/gn7JfZtyxwcCUjzXbw5jmqJQRbj1te670Bshg9kUdanKhtHFhJjU5jX+ZMMBr6pH0gqQDJxR0K0yHXRc0Q5OQoUZ6BfpbI4Wt4jJvJSdCstz1vSg12CfEHS8Kd5qfhItK7Y=</Signature>\\n <RequestId>1ed33293-2e48-6b14-861e-538e28e408eb</RequestId>\\n</SignResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Signature\\": \\"eyaC0w3ROK5b3QcHmUtAhMY/sQjKu2t3uBfnf6J/gn7JfZtyxwcCUjzXbw5jmqJQRbj1te670Bshg9kUdanKhtHFhJjU5jX+ZMMBr6pH0gqQDJxR0K0yHXRc0Q5OQoUZ6BfpbI4Wt4jJvJSdCstz1vSg12CfEHS8Kd5qfhItK7Y=\\",\\n \\"RequestId\\": \\"1ed33293-2e48-6b14-861e-538e28e408eb\\"\\n}","type":"json"}]',
'title' => 'Sign',
- 'description' => 'You can call the Sign operation to sign a private certificate in a certificate application repository.'."\n"
+ 'description' => 'This operation creates a digital signature with a PCA certificate from a certificate repository.'."\n"
."\n"
- .'### Limits'."\n"
+ .'### QPS limit'."\n"
."\n"
- .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'Verify' => [
- 'summary' => 'Verifies the signature of a private certificate in a certificate application repository.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'This operation supports up to 1,000 queries per second (QPS) for a single user. If you exceed this limit, the system throttles your API calls, which can impact your business. Plan your API calls accordingly.',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:Sign',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateCsr' => [
+ 'summary' => 'Updates the private key associated with a certificate signing request (CSR).',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7649,114 +6809,34 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '153630',
- 'abilityTreeNodes' => [
- 'FEATUREcasW9WPDK',
- ],
+ 'abilityTreeCode' => '213377',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
],
'parameters' => [
[
- 'name' => 'Message',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The data for which you want to verify the signature. The value must be encoded in Base64.\\'."\n"
- .'For example, if the hexadecimal data that you want to verify is \\[0x31, 0x32, 0x33, 0x34], set the parameter to the Base64-encoded value MTIzNA==. If you set MessageType to RAW, the size of the data must be less than 4 KB. If the size of the data is greater than 4 KB, you can set MessageType to DIGEST and set Message to the digest of the data. The digest is also called hash value. You can compute the digest of the data on an on-premises machine. The certificate repository uses your certificate application system to compute the message digest. The message digest algorithm that is used must meet the requirements of the specified signature algorithm. The following signature algorithms require different message digest algorithms:'."\n"
- ."\n"
- .'* If the signature algorithm is SHA256withRSA, SHA256withRSA/PSS, or SHA256withECDSA, the message digest algorithm must be SHA-256.'."\n"
- .'* If the signature algorithm is SM3withSM2, the message digest algorithm must be SM3.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MTIzNA==',
- ],
- ],
- [
- 'name' => 'CertIdentifier',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The unique identifier of the certificate. You can call the [ListCert](~~455806~~) operation to obtain the unique identifier of a certificate.'."\n"
- ."\n"
- .'* If the certificate is an SSL certificate, the value of this parameter must be in the {Certificate ID}-cn-hangzhou format.'."\n"
- .'* If the certificate is a private certificate, the value of this parameter must be the value of the Identifier field for the private certificate.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '5870821-cn-hangzhou',
- ],
- ],
- [
- 'name' => 'SigningAlgorithm',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The signature algorithm. Valid values:'."\n"
- ."\n"
- .'* **SHA256withRSA**'."\n"
- .'* **SHA256withRSA/PSS**'."\n"
- .'* **SHA256withECDSA**'."\n"
- .'* **SM3withSM2**'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SHA256withRSA',
- ],
- ],
- [
- 'name' => 'MessageType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The value type of the Message parameter. Valid values:'."\n"
- ."\n"
- .'* **RAW**: the raw data. This is the default value.'."\n"
- .'* **DIGEST**: the message digest of the raw data.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RAW',
- ],
- ],
- [
- 'name' => 'SignatureValue',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The signature value. The value must be encoded in Base64.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eyaC0w3ROK5b3QcHmUtAhMY/sQjKu2t3uBfnf6J/gn7JfZtyxwcCUjzXbw5jmqJQRbj1te670Bshg9kUdanKhtHFhJjU5jX+ZMMBr6pH0gqQDJxR0K0yHXRc0Q5OQoUZ6BfpbI4Wt4jJvJSdCstz1vSg12CfEHS8Kd5qfhItK7Y=',
- ],
- ],
- [
- 'name' => 'CustomIdentifier',
+ 'name' => 'CsrId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The unique ID of the CSR. This ID is generated when you upload a CSR. To obtain the ID, call the [ListCsr](~~2709717~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5209', 'title' => ''],
],
[
- 'name' => 'WarehouseId',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The content of the certificate private key in PEM format.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '1ed33293-2e48-6b14-861e-538e28e408eb',
- ],
- 'SignatureValid' => [
- 'description' => 'Indicates whether the signature is valid. Valid values:'."\n"
- ."\n"
- .'* **true**'."\n"
- .'* **false**'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => 'The unique ID of the request. Alibaba Cloud generates this ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -7764,284 +6844,197 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1ed33293-2e48-6b14-861e-538e28e408eb\\",\\n \\"SignatureValid\\": true\\n}","errorExample":""},{"type":"xml","example":"<VerifyResponse>\\n <RequestId>1ed33293-2e48-6b14-861e-538e28e408eb</RequestId>\\n <SignatureValid>true</SignatureValid>\\n</VerifyResponse>","errorExample":""}]',
- 'title' => 'Verify',
- 'description' => 'You can call the Verify operation to verify the signature of a private certificate in a certificate application repository.'."\n"
- ."\n"
- .'### Limits'."\n"
- ."\n"
- .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'Encrypt' => [
- 'summary' => 'Encrypts a certificate in a certificate repository.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'UpdateCsr',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateDeploymentJob' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '155852',
- 'abilityTreeNodes' => [
- 'FEATUREcasVZUJH0',
- ],
+ 'abilityTreeCode' => '214599',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖真实的，短信验证通过的手机，无法自动化测试',
],
'parameters' => [
[
- 'name' => 'Plaintext',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The data that you want to encrypt. The value of this parameter can be raw data or Base64-encoded data. For more information, see the description of the MessageType parameter. For example, if the hexadecimal data that you want to encrypt is `[0x31, 0x32, 0x33, 0x34]`, the Base64-encoded data is MTIzNA==. The size of data that can be encrypted varies based on the encryption algorithm that you use. The following list describes the relationship between the encryption algorithms and data sizes:'."\n"
- ."\n"
- .'* **RSAES_OAEP_SHA\\_1**: 214 bytes'."\n"
- .'* **RSAES_OAEP_SHA\\_256**: 190 bytes'."\n"
- .'* **SM2PKE**: 6,047 bytes'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '1234***',
- ],
+ 'schema' => ['description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the JobId parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '8888'],
],
[
- 'name' => 'CertIdentifier',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'The unique identifier of the certificate. You can call the [ListCert](~~455806~~) operation to obtain the identifier.'."\n"
- ."\n"
- .'* If the certificate is an SSL certificate, the value of this parameter must be in the {Certificate ID}-cn-hangzhou format.'."\n"
- .'* If the certificate is a private certificate, the value of this parameter must be the value of the Identifier field for the private certificate.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345678-1234-1234-1234-12345678****',
- ],
+ 'schema' => ['description' => 'The name of the deployment task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cert-1'],
],
[
- 'name' => 'Algorithm',
+ 'name' => 'CertIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The encryption algorithm. Valid values:'."\n"
- ."\n"
- .'* **RSAES_OAEP_SHA\\_1**'."\n"
- .'* **RSAES_OAEP_SHA\\_256**'."\n"
- .'* **SM2PKE**'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RSAESOAEPSHA_1',
- ],
+ 'schema' => ['description' => 'The ID of the certificate. Separate multiple certificate IDs with commas (,). You can call the [ListUserCertificateOrder](~~455804~~) operation to obtain the ID of a certificate from the **CertificateId** parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '9957285,12067351,12304338,12342649'],
],
[
- 'name' => 'MessageType',
+ 'name' => 'ResourceIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The value type of the Message parameter. Valid values:'."\n"
- ."\n"
- .'* RAW: The value of the Plaintext parameter is directly encrypted. This is the default value.'."\n"
- .'* Base64: The value of the Plaintext parameter is Base64-encoded data. The data is decoded and then encrypted.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Base64' => 'Base64',
- 'RAW' => 'RAW',
- ],
- 'example' => 'RAW',
- ],
+ 'schema' => ['description' => 'The ID of the cloud resource. Separate multiple resource IDs with commas (,). You can call the [ListCloudResources](~~2712230~~) operation to obtain the ID of a cloud resource from the **Id** parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '9957285,12067351,12304338,12342649'],
],
[
- 'name' => 'CustomIdentifier',
+ 'name' => 'ContactIds',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the contact. Separate multiple contact IDs with commas (,). You can call the [ListContact](~~2712221~~) operation to obtain the ID of a contact from the **ContactId** parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '9957285,12067351,12304338,12342649'],
],
[
- 'name' => 'WarehouseId',
+ 'name' => 'ScheduleTime',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'schema' => ['description' => 'The time when the task starts. The value is a UNIX timestamp. If you do not specify this parameter, the system immediately starts the task after it is created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1606482979000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'title' => 'OpenApiDefaultResponse<UpdateDeploymentResult>',
+ 'description' => 'OpenApiDefaultResponse.',
'type' => 'object',
'properties' => [
- 'CertIdentifier' => [
- 'description' => 'The unique identifier of the certificate.'."\n",
- 'type' => 'string',
- 'example' => '12345678-1234-1234-1234-12345678****',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '5979d897-d69f-4fc9-87dd-f3bb73c40b80',
- ],
- 'CiphertextBlob' => [
- 'description' => 'The data after encryption. The value is encoded in Base64.'."\n",
- 'type' => 'string',
- 'example' => 'ZOyIygCyaOW6Gj****MlNKiuyjfzw=',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"CertIdentifier\\": \\"1ef1da5f-38ed-69b3-****-037781890265\\",\\n \\"RequestId\\": \\"5979d897-d69f-4fc9-87dd-f3bb73c40b80\\",\\n \\"CiphertextBlob\\": \\"ZOyIygCyaOW6Gj****MlNKiuyjfzw=\\"\\n}","errorExample":""},{"type":"xml","example":"<EncryptResponse>\\n <CertIdentifier>12345678-1234-1234-1234-12345678****</CertIdentifier>\\n <RequestId>5979d897-d69f-4fc9-87dd-f3bb73c40b80</RequestId>\\n <CiphertextBlob>ZOyIygCyaOW6Gj****MlNKiuyjfzw=</CiphertextBlob>\\n</EncryptResponse>","errorExample":""}]',
- 'title' => 'Encrypt',
- 'description' => 'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'Decrypt' => [
- 'summary' => 'Decrypts a certificate in a certificate repository.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'UpdateDeploymentJob',
+ 'summary' => 'Updates the configuration of a certificate deployment task, such as the certificates or target resources.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateDeploymentJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateDeploymentJobStatus' => [
+ 'summary' => 'Updates the status of a certificate deployment task, such as changing from editing to pending execution.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '155856',
- 'abilityTreeNodes' => [
- 'FEATUREcasW9WPDK',
- ],
+ 'abilityTreeCode' => '214601',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖真实的，短信验证通过的手机，无法自动化测试',
],
'parameters' => [
[
- 'name' => 'CertIdentifier',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The unique identifier of the certificate. You can call the [ListCert](~~455806~~) operation to query the identifier.'."\n"
- ."\n"
- .'* If the certificate is an SSL certificate, the value of this parameter must be in the {Certificate ID}-cn-hangzhou format.'."\n"
- .'* If the certificate is a private certificate, the value of this parameter must be the value of the Identifier field for the private certificate.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345678-1234-1234-1234-12345678****',
- ],
+ 'schema' => ['description' => 'The ID of the deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '8888'],
],
[
- 'name' => 'Algorithm',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => 'The encryption algorithm. Valid values:'."\n"
+ 'description' => 'The desired status of the deployment task.'."\n"
."\n"
- .'* **RSAES_OAEP_SHA\\_1**'."\n"
- .'* **RSAES_OAEP_SHA\\_256**'."\n"
- .'* **SM2PKE**'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RSAESOAEPSHA_1',
- ],
- ],
- [
- 'name' => 'CiphertextBlob',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The data that you want to decrypt. The value is encoded in Base64.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ZOyIygCyaOW6Gj****MlNKiuyjfzw=',
- ],
- ],
- [
- 'name' => 'MessageType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The value type of the Message parameter. Valid values:'."\n"
+ .'Valid values:'."\n"
."\n"
- .'* RAW: The returned result is raw data encoded in UTF-8.'."\n"
- .'* Base64: The returned result is Base64-encoded data. This is the default value.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Base64' => 'Base64',
- 'RAW' => 'RAW',
- ],
- 'example' => 'Base64',
- ],
- ],
- [
- 'name' => 'CustomIdentifier',
- 'in' => 'query',
- 'schema' => [
+ .'- pending'."\n"
+ ."\n"
+ .'- scheduling'."\n"
+ ."\n"
+ .'- editing',
+ 'enumValueTitles' => ['pending' => '', 'scheduling' => '', 'editing' => ''],
'type' => 'string',
- ],
- ],
- [
- 'name' => 'WarehouseId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'required' => true,
+ 'title' => '',
+ 'example' => 'editing',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'title' => 'OpenApiDefaultResponse<?>',
+ 'description' => 'OpenApiDefaultResponse\\<?>.',
'type' => 'object',
'properties' => [
- 'Plaintext' => [
- 'description' => 'The data after decryption.'."\n",
- 'type' => 'string',
- 'example' => 'VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '5979d897-d69f-4fc9-87dd-f3bb73c40b80',
- ],
- 'CertIdentifier' => [
- 'description' => 'The unique identifier of the certificate.'."\n",
- 'type' => 'string',
- 'example' => '12345678-1234-1234-1234-12345678****',
- ],
+ 'Data' => ['description' => 'The response parameters.', 'type' => 'any', 'example' => '[]', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EA69E364-5CBB-50E8-BF09-E8CAA396A4F8', 'title' => ''],
],
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Plaintext\\": \\"VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4\\",\\n \\"RequestId\\": \\"5979d897-d69f-4fc9-87dd-f3bb73c40b80\\",\\n \\"CertIdentifier\\": \\"1ef1da5f-38ed-69b3-****-037781890265\\"\\n}","errorExample":""},{"type":"xml","example":"<DecryptResponse>\\n <Plaintext>VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4</Plaintext>\\n <RequestId>5979d897-d69f-4fc9-87dd-f3bb73c40b80</RequestId>\\n <CertIdentifier>12345678-1234-1234-1234-12345678****</CertIdentifier>\\n</DecryptResponse>","errorExample":""}]',
- 'title' => 'Decrypt',
- 'description' => 'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'DeletePCACert' => [
- 'summary' => 'Deletes a private certificate from a certificate application repository.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'UpdateDeploymentJobStatus',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateDeploymentJobStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"EA69E364-5CBB-50E8-BF09-E8CAA396A4F8\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateInstance' => [
+ 'summary' => 'Updates the configuration of a Certificate Management Service instance.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8050,240 +7043,166 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '153635',
- 'abilityTreeNodes' => [
- 'FEATUREcasY9QF1D',
- ],
- 'autoTest' => true,
+ 'abilityTreeCode' => '213377',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'Identifier',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The unique identifier of the certificate. You can call the [ListCert](~~452331~~) operation to query the unique identifiers of certificates.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccaf0c629c2be1e2ab',
- ],
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cas-cn-68n1mm16****', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '15C66C7B-671A-4297-9187-2C4477247A74',
- ],
- ],
- ],
+ [
+ 'name' => 'CertificateName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the instance. When issuing a certificate, this value serves as the default certificate name.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePCACertResponse>\\n <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\n</DeletePCACertResponse>","errorExample":""}]',
- 'title' => 'DeletePCACert',
- 'description' => 'You can call the DeletePCACert operation to delete a private certificate from a certificate application repository.'."\n"
- ."\n"
- .'### Limits'."\n"
- ."\n"
- .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n",
- ],
- 'ListCsr' => [
- 'summary' => 'Queries the details of Certificate Signing Requests (CSRs).',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'Domain',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The domain name to bind to the certificate. Requirements are as follows:'."\n"
+ ."\n"
+ .'- Supports single domain names or wildcard domain names (for example, `*.aliyundoc.com`).'."\n"
+ ."\n"
+ .'- Supports multiple domain names. Separate multiple domain names with commas (,). The first domain determines whether a free domain is included.'."\n"
+ ."\n"
+ .'><notice>'."\n"
+ ."\n"
+ .'If you bind multiple domain names to the certificate, this parameter is required. This parameter and the **Csr** parameter cannot both be empty. If you set both parameters, the system uses the **CN** field value from the **Csr** as the domain name for the certificate.'."\n"
+ ."\n"
+ .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'test.com', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '213371',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
+ [
+ 'name' => 'KeyAlgorithm',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The certificate algorithm. Default value: RSA\\_2048.'."\n"
+ ."\n"
+ .'- **RSA\\_2048**'."\n"
+ ."\n"
+ .'- **RSA\\_3072**'."\n"
+ ."\n"
+ .'- **RSA\\_4096**'."\n"
+ ."\n"
+ .'- **ECC\\_256**'."\n"
+ ."\n"
+ .'- **SM2**', 'type' => 'string', 'required' => false, 'example' => 'RSA_2048', 'title' => ''],
],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'KeyWord',
+ 'name' => 'AutoReissue',
'in' => 'query',
- 'schema' => [
- 'description' => 'The keyword.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_name',
- ],
+ 'schema' => ['description' => 'Whether to enable automatic management.'."\n"
+ ."\n"
+ .'- enable: enabled'."\n"
+ ."\n"
+ .'- disable: disabled', 'type' => 'string', 'required' => false, 'example' => 'enable', 'title' => ''],
],
[
- 'name' => 'Algorithm',
+ 'name' => 'CompanyId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The algorithm. Valid values: RSA, ECC, and SM2.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'RSA' => 'RSA',
- 'ECC' => 'ECC',
- 'SM2' => 'SM2',
- ],
- 'example' => 'RSA',
- ],
+ 'schema' => ['description' => 'The company information ID. Required for OV and EV certificates. Otherwise, you cannot call ApplyCertificate to request a certificate.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '44211', 'title' => ''],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'ContactIdList',
'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
+ 'type' => 'array',
+ 'items' => ['description' => 'The contact information ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 50,
+ 'description' => 'The list of contact IDs. You must specify at least one contact. Otherwise, you cannot call ApplyCertificate to request a certificate.',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ShowSize',
+ 'name' => 'GenerateCsrMethod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The CSR generation method. Default value: online.'."\n"
+ ."\n"
+ .'- online: The system generates the CSR. The Csr field is ignored.'."\n"
+ ."\n"
+ .'- upload: You upload the CSR. The Csr field is required.', 'type' => 'string', 'required' => false, 'example' => 'online', 'title' => ''],
+ ],
+ [
+ 'name' => 'Csr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The CSR content. You can generate a CSR using OpenSSL or Keytool. For more information, see [How to create a CSR file](~~42218~~).', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', 'title' => ''],
+ ],
+ [
+ 'name' => 'ValidationMethod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The certificate validation method.'."\n"
+ ."\n"
+ .'- DNS: DNS validation using TXT or CNAME records.'."\n"
+ ."\n"
+ .'- HTTP: File-based validation.', 'type' => 'string', 'required' => false, 'example' => 'DNS', 'title' => ''],
+ ],
+ [
+ 'name' => 'City',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The city where the company or organization of the certificate requester is located. Required when generating a CSR for a DV certificate. Default value: Beijing.', 'type' => 'string', 'required' => false, 'example' => 'Beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'Province',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The province or region where the company is located. Required when generating a CSR for a DV certificate. Default value: Beijing.', 'type' => 'string', 'required' => false, 'example' => 'Beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'CountryCode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The country or region code of the certificate organization. For example, CN represents China, and US represents the United States. Required when generating a CSR for a DV certificate. Default value: CN.', 'type' => 'string', 'required' => false, 'example' => 'CN', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******4wia', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tags',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The number of entries per page. Default value: 50.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => ['description' => 'The tag key of the instance. Valid values for N: **1** to **20**. If you specify this value, it cannot be an empty string.'."\n"
+ ."\n"
+ .'It can contain up to 64 characters. It cannot start with `aliyun` or `acs:`, and it cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'TagValue' => ['description' => 'The tag value of the instance. Valid values for N: **1** to **20**. If you specify this value, it can be an empty string.'."\n"
+ ."\n"
+ .'It can contain up to 128 characters. It cannot start with `aliyun` or `acs:`, and it cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ 'description' => 'The list of tags.',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'maxItems' => 100,
+ 'description' => 'A list of tags.',
'required' => false,
- 'example' => '10',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The object.'."\n",
'type' => 'object',
'properties' => [
- 'ShowSize' => [
- 'description' => 'The number of entries per page. Default value: 50.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'CurrentPage' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'CsrList' => [
- 'description' => 'The CSRs.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CsrId' => [
- 'description' => 'The ID of the CSR.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3454',
- ],
- 'Algorithm' => [
- 'description' => 'The algorithm. Valid values: RSA, SM2, and ECC.'."\n",
- 'type' => 'string',
- 'example' => 'RSA',
- ],
- 'KeySize' => [
- 'description' => 'The key length that is used by the algorithm. The key length for RSA algorithms can be 2,048, 3,072, and 4,096 bits. The key length for ECC and SM2 algorithms can be 256 bits.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2048',
- ],
- 'KeySha2' => [
- 'description' => 'The public key that is calculated by using the SHA256 algorithm.'."\n",
- 'type' => 'string',
- 'example' => '1234',
- ],
- 'CommonName' => [
- 'description' => 'The primary domain name, which is a common name.'."\n",
- 'type' => 'string',
- 'example' => 'example.com',
- ],
- 'Sans' => [
- 'description' => 'The secondary domain names. Separate multiple domain names with commas (,).'."\n",
- 'type' => 'string',
- 'example' => 'www.example.com,www.aliyundoc.com',
- ],
- 'CountryCode' => [
- 'description' => 'The code of the country or region in which the organization is located. For example, you can use CN to indicate China and use US to indicate the United States. The default value is the code of the country or region in which the organization is located. The organization is associated with the intermediate CA certificate from which the certificate is issued. For more information about country codes, see the "Country codes" section of the [Manage company profiles](~~198289~~) topic.'."\n",
- 'type' => 'string',
- 'example' => 'CN',
- ],
- 'Province' => [
- 'description' => 'The province or location.'."\n",
- 'type' => 'string',
- 'example' => 'Beijing',
- ],
- 'Locality' => [
- 'description' => 'The city where the company is located.'."\n",
- 'type' => 'string',
- 'example' => 'Beijing',
- ],
- 'CorpName' => [
- 'description' => 'The name of the company.'."\n",
- 'type' => 'string',
- 'example' => 'corp_name',
- ],
- 'Department' => [
- 'description' => 'The department that uses the certificate.'."\n",
- 'type' => 'string',
- 'example' => 'IT',
- ],
- 'HasPrivateKey' => [
- 'description' => 'Indicates whether the certificate contains a private key.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Name' => [
- 'description' => 'The name of the CSR.'."\n",
- 'type' => 'string',
- 'example' => 'name',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'E865F6AD-0294-4A24-A58B-DAC6BE2BDD20',
- ],
+ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique identifier for each request to help troubleshoot and locate issues.', 'type' => 'string', 'example' => '0068247C-A454-5FC9-93BF-C41CBB5CD19E', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -8291,19 +7210,27 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ShowSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalCount\\": 10,\\n \\"CsrList\\": [\\n {\\n \\"CsrId\\": 3454,\\n \\"Algorithm\\": \\"RSA\\",\\n \\"KeySize\\": 2048,\\n \\"KeySha2\\": \\"1234\\",\\n \\"CommonName\\": \\"example.com\\",\\n \\"Sans\\": \\"www.aliyundoc.com,www.example.com\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"Province\\": \\"Beijing\\",\\n \\"Locality\\": \\"Beijing\\",\\n \\"CorpName\\": \\"北京CSR科技有限公司\\",\\n \\"Department\\": \\"IT\\",\\n \\"HasPrivateKey\\": true,\\n \\"Name\\": \\"test_name\\"\\n }\\n ],\\n \\"RequestId\\": \\"E865F6AD-0294-4A24-A58B-DAC6BE2BDD20\\"\\n}","type":"json"}]',
- 'title' => 'ListCsr',
- ],
- 'CreateCsr' => [
- 'summary' => 'Creates a certificate signing request (CSR). A CSR file contains the information about an SSL certificate that you want to apply for. The information includes the domain names that you want to bind to the certificate and the name and the geographical location of the certificate holder. When you submit a certificate application to a certificate authority (CA), you must provide a CSR. After the CA approves your certificate application, the CA uses the private key of the root CA to sign your CSR and generates a public key file. The public key file is the SSL certificate that the CA issues to you. The private key of the SSL certificate is generated when you create the CSR.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'UpdateInstance',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0068247C-A454-5FC9-93BF-C41CBB5CD19E\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateWorkerResourceStatus' => [
+ 'summary' => 'Rolls back or re-executes a worker task in a certificate deployment task.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8312,171 +7239,82 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '214606',
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '依赖真实的，短信验证通过的手机，无法自动化测试',
],
'parameters' => [
[
- 'name' => 'KeySize',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The key length that is used by the algorithm.'."\n"
- ."\n"
- .'* The key length for RSA algorithms can be 2,048, 3,072, and 4,096 bits.'."\n"
- .'* The key length for ECC and SM2 algorithms can be 256 bits.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2048',
- ],
- ],
- [
- 'name' => 'Algorithm',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The algorithm. Valid values: RSA, SM2, and ECC. For more information about algorithms, see [Select an SSL certificate](~~197871~~).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'RSA' => 'RSA',
- 'ECC' => 'ECC',
- 'SM2' => 'SM2',
- ],
- 'example' => 'RSA',
- ],
- ],
- [
- 'name' => 'CommonName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The primary domain name, which is a common name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '123.com',
- ],
- ],
- [
- 'name' => 'Sans',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The secondary domain names. Separate multiple domain names with commas (,). You can use the CSR to apply for a certificate for both the primary and secondary domain names.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'www.example.com,www.aliyundoc.com',
- ],
- ],
- [
- 'name' => 'CountryCode',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The code of the country or region in which the organization is located. For example, you can use CN to indicate China and use US to indicate the United States.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CN',
- ],
+ 'schema' => ['description' => 'The ID of the deployment task. You can call the [CreateDeploymentJob](~~2712234~~) operation to obtain the ID of a deployment task from the **JobId** parameter. You can also call the [ListDeploymentJob](~~2712223~~) operation to obtain the ID of a deployment task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '8888'],
],
[
- 'name' => 'Province',
+ 'name' => 'WorkerId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The province or location where the company is located.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Beijing',
- ],
+ 'schema' => ['description' => 'The ID of the worker task. You can call the [ListWorkerResource](~~2712224~~) operation to obtain the ID of a worker task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1234'],
],
[
- 'name' => 'Locality',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => 'The city where the company is located.'."\n",
+ 'description' => 'The desired status of the worker resource.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- rollback',
+ 'enumValueTitles' => ['rollback' => 'rollback'],
'type' => 'string',
'required' => true,
- 'example' => 'Beijing',
- ],
- ],
- [
- 'name' => 'CorpName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the company.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aly',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the CSR. The name can be up to 50 characters in length and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'csr-123',
- ],
- ],
- [
- 'name' => 'Department',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The department that uses the certificate.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'IT',
+ 'title' => '',
+ 'example' => 'rollback',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'title' => 'OpenApiDefaultResponse<?>',
+ 'description' => 'OpenApiDefaultResponse\\<?>.',
'type' => 'object',
'properties' => [
- 'Csr' => [
- 'description' => 'The content of the CSR.'."\n",
- 'type' => 'string',
- 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '12345678-1234-1234-1234-123456789ABC',
- ],
- 'CsrId' => [
- 'description' => 'The unique identifier of the CSR. You can use this value to obtain the content of the CSR. For more information about the operation that you can call to obtain the content of a CSR, see [GetCsrDetail](~~2709720~~).'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3365',
- ],
+ 'Data' => ['description' => 'The response parameters.', 'type' => 'any', 'example' => '[]', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789ABC', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Csr\\": \\"-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----\\",\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\",\\n \\"CsrId\\": 3365\\n}","type":"json"}]',
- 'title' => 'CreateCsr',
+ 'title' => 'UpdateWorkerResourceStatus',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateWorkerResourceStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\"\\n}","type":"json"}]',
],
'UploadCsr' => [
- 'summary' => 'Uploads an existing Certificate Signing Request (CSR). You can use the CSR when you upload a certificate. You can also manage the uploaded CSRs in a centralized manner.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Uploads an existing certificate signing request (CSR) to Certificate Management Service. After the upload, you can use the CSR to apply for certificates.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8488,61 +7326,37 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the CSR.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'name',
- ],
+ 'schema' => ['description' => 'The name of the CSR. The name can be up to 50 characters long and can contain uppercase letters (A–Z), lowercase letters (a–z), digits (0–9), underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''],
],
[
'name' => 'Csr',
'in' => 'query',
- 'schema' => [
- 'description' => 'The content of the CSR.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----',
- ],
+ 'schema' => ['description' => 'The content of the CSR.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', 'title' => ''],
],
[
'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => 'The private key content of the certificate in the PEM format.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----',
- ],
+ 'schema' => ['description' => 'The content of the certificate\'s private key in PEM format.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The returned object.',
'type' => 'object',
'properties' => [
- 'CsrId' => [
- 'description' => 'The ID of the CSR.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2271',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D',
- ],
+ 'CsrId' => ['description' => 'The unique ID of the CSR. You can use this ID to obtain the content of the CSR. For more information, see [GetCsrDetail](~~2709720~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '2271', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -8550,161 +7364,240 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CsrId\\": 2271,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","type":"json"}]',
'title' => 'UploadCsr',
- ],
- 'GetCsrDetail' => [
- 'summary' => 'Obtains the content of a certificate signing request (CSR) file.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UploadCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CsrId\\": 2271,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","type":"json"}]',
+ ],
+ 'UploadPCACert' => [
+ 'summary' => 'Uploads a PCA certificate to a certificate warehouse.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213379',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '153632',
+ 'abilityTreeNodes' => ['FEATUREcasY9QF1D'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'CsrId',
+ 'name' => 'WarehouseId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the CSR.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '3924',
- ],
+ 'schema' => ['description' => 'The ID of the certificate warehouse.'."\n"
+ ."\n"
+ .'> Call [ListCertWarehouse](~~455805~~) to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Cert',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of the certificate and its chain, in PEM format.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN CERTIFICATE----- MIIEJDCCAwygAwIBAgIQITRHItTLTQizTyd3K7AMRTANBgkqhkiG9w0BAQsFADBe **************** 5/akmr2GK/Y= -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIDuzCCAqOgAwIBAgIQSEIWDPfWTDKZcWNyL2O+fjANBgkqhkiG9w0BAQsFADBf **************** URUHyMW5Qd5Q9g6Y4sDOIm6It9TF7EjpwMs42R30agcRYzuUsN72ZFBYFJwnBX8= -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIDizCCAnOgAwIBAgIRAMfjPkDKfELTo07l3A3cUSYwDQYJKoZIhvcNAQELBQAw ********* CjWTnYPhCcO2uIcnqMt7zCVs5LXBK/XSwlAXKMvKT0uuzw9VxeMfEabflKu0By8= -----END CERTIFICATE-----', 'title' => ''],
+ ],
+ [
+ 'name' => 'PrivateKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The private key of the certificate, in PEM format.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEA5SIfpNCBoiDrZhX1H39CHwQMVD0kBNeBTWfP9xkeesvfzbOz ******* POVNFfDf9h7pJtQ5fRZNTYTDs/d+cH62Z3+nS74mNnEfff0nkvne -----END RSA PRIVATE KEY-----', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A custom name for the certificate.', 'type' => 'string', 'required' => false, 'example' => 'cert_name', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'Csr' => [
- 'description' => 'The content of the CSR.'."\n",
- 'type' => 'string',
- 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----',
- ],
- 'PrivateKey' => [
- 'description' => 'The private key. Specify a Base64-encoded string.',
- 'type' => 'string',
- 'example' => '-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '08F45EA0-66A7-4504-9B31-3589F5CE308D',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''],
+ 'Identifier' => ['description' => 'The unique identifier for the certificate.', 'type' => 'string', 'example' => '1ed65580-7e33-6a50-8630-dd13fdc009ee', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Csr\\": \\"-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----\\",\\n \\"PrivateKey\\": \\"-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----\\",\\n \\"RequestId\\": \\"08F45EA0-66A7-4504-9B31-3589F5CE308D\\"\\n}","type":"json"}]',
- 'title' => 'GetCsrDetail',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UploadPCACert',
+ 'description' => 'Use this operation to upload a PCA certificate to a certificate warehouse.'."\n"
+ ."\n"
+ .'## QPS limit'."\n"
+ ."\n"
+ .'The QPS limit for this operation is 10 requests per second per user. Exceeding this limit triggers throttling, which can affect your business.',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-17T06:36:40.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Identifier\\": \\"1ed65580-7e33-6a50-8630-dd13fdc009ee\\"\\n}","type":"json"}]',
],
- 'UpdateCsr' => [
- 'summary' => 'Uploads or updates the private key for a Certificate Signing Request (CSR). If you did not upload the required priviate when you uploaded a CSR, you can call this operation to upload or update the private key.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UploadUserCertificate' => [
+ 'summary' => 'Uploads a certificate and its private key to Certificate Management Service. Both SM and non-SM certificates are supported.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213377',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeNodes' => ['FEATUREcasDX3LGS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'CsrId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the CSR.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '5209',
- ],
+ 'schema' => ['description' => 'The custom name of the certificate. The name can be up to 63 characters long and can contain letters, digits, and underscores (\\_).'."\n"
+ ."\n"
+ .'> Certificate names must be unique for each user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cert-1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Cert',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of a non-SM certificate in PEM format.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----', 'title' => ''],
],
[
'name' => 'Key',
'in' => 'query',
+ 'schema' => ['description' => 'The private key of a non-SM certificate in PEM format.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----'."\n"
+ .'MIICDzCCAbagAw****'."\n"
+ .'-----END CERTIFICATE-----', 'title' => ''],
+ ],
+ [
+ 'name' => 'EncryptCert',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of the SM encryption certificate in PEM format. This parameter is invalid if Cert and Key are not empty.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----'."\n"
+ .'MIICDzCCA***'."\n"
+ .'-----END CERTIFICATE-----', 'title' => ''],
+ ],
+ [
+ 'name' => 'EncryptPrivateKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of the private key of the SM encryption certificate in PEM format. This parameter is invalid if Cert and Key are not empty.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN EC PRIVATE KEY-----'."\n"
+ .'MHcCAQEEI****'."\n"
+ .'-----END EC PRIVATE KEY-----', 'title' => ''],
+ ],
+ [
+ 'name' => 'SignCert',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of the SM signing certificate in PEM format. This parameter is invalid if Cert and Key are not empty.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----'."\n"
+ .'MIICDzCCAbagAw****'."\n"
+ .'-----END CERTIFICATE-----'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'SignPrivateKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of the private key of the SM signing certificate in PEM format. This parameter is invalid if Cert and Key are not empty.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN EC PRIVATE KEY-----'."\n"
+ .'MHcCAQEEILR****'."\n"
+ .'-----END EC PRIVATE KEY-----'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-ae****vty', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The private key content of the certificate in the PEM format.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----',
+ 'description' => 'A list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'testKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The returned object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76',
- ],
+ 'CertId' => ['description' => 'The ID of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BDB81BA2-E1F5-4D08-A2DD-4BE2BF44C90E', 'title' => ''],
+ 'ResourceId' => ['description' => 'The ID of the certificate instance.', 'type' => 'string', 'example' => 'cas-upload-xki1d0', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]',
- 'title' => 'UpdateCsr',
- ],
- 'DeleteCsr' => [
- 'summary' => 'Deletes a Certificate Signing Request (CSR) that is no longer required.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'UploadUserCertificate',
+ 'description' => 'The queries per second (QPS) limit for this operation is 100 for each user. If you exceed this limit, API calls are throttled. This may affect your business. Plan your calls accordingly.',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-20T03:28:36.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-12-10T09:30:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-08-30T07:17:51.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-11-30T09:59:46.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UploadUserCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertId\\": 12345,\\n \\"RequestId\\": \\"BDB81BA2-E1F5-4D08-A2DD-4BE2BF44C90E\\",\\n \\"ResourceId\\": \\"cas-upload-xki1d0\\"\\n}","type":"json"}]',
+ ],
+ 'Verify' => [
+ 'summary' => 'Verifies a data signature by using a private certificate in a certificate application repository.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8713,39 +7606,84 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '213378',
- 'abilityTreeNodes' => [
- 'FEATUREcasDX3LGS',
- ],
+ 'abilityTreeCode' => '153630',
+ 'abilityTreeNodes' => ['FEATUREcasW9WPDK'],
],
'parameters' => [
[
- 'name' => 'CsrId',
+ 'name' => 'Message',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the CSR.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '3013',
- ],
+ 'schema' => ['description' => 'The data to verify. The data must be Base64-encoded. For example, if the hexadecimal content of the data to sign is \\`\\[0x31, 0x32, 0x33, 0x34]\\`, the Base64-encoded value is \\`MTIzNA==\\`. If you set \\`MessageType\\` to \\`RAW\\`, the data size must be less than 4 KB. If the data to sign is larger than 4 KB, set \\`MessageType\\` to \\`DIGEST\\`. Then, set \\`Message\\` to the message digest, or hash, that you calculate locally. The hashing algorithm for the digest must be compatible with the signature algorithm:<br>'."\n"
+ ."\n"
+ .'- The hashing algorithm for \\`SHA256withRSA\\`, \\`SHA256withRSA/PSS\\`, and \\`SHA256withECDSA\\` is SHA-256.'."\n"
+ ."\n"
+ .'- The hashing algorithm for \\`SM3withSM2\\` is SM3.', 'type' => 'string', 'required' => true, 'example' => 'MTIzNA==', 'title' => ''],
+ ],
+ [
+ 'name' => 'CertIdentifier',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique identifier of the certificate. To get this parameter, call the [ListCert](~~455806~~) operation.'."\n"
+ ."\n"
+ .'- The identifier for an SSL certificate is typically in the format \\`{Certificate ID}-cn-hangzhou\\`.'."\n"
+ ."\n"
+ .'- For a PCA certificate, this is the value of the \\`Identifier\\` field.', 'type' => 'string', 'required' => false, 'example' => '1ef1da5f-38ed-69b3-****-037781890265', 'title' => ''],
+ ],
+ [
+ 'name' => 'SigningAlgorithm',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The signature algorithm. Valid values:'."\n"
+ ."\n"
+ .'- **SHA256withRSA**'."\n"
+ ."\n"
+ .'- **SHA256withRSA/PSS**'."\n"
+ ."\n"
+ .'- **SHA256withECDSA**'."\n"
+ ."\n"
+ .'- **SM3withSM2**', 'type' => 'string', 'required' => true, 'example' => 'SHA256withRSA', 'title' => ''],
+ ],
+ [
+ 'name' => 'MessageType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The message type. Valid values:'."\n"
+ ."\n"
+ .'- **RAW** (default): The raw data.'."\n"
+ ."\n"
+ .'- **DIGEST**: The message digest of the raw data.', 'type' => 'string', 'required' => true, 'example' => 'RAW', 'title' => ''],
+ ],
+ [
+ 'name' => 'SignatureValue',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The signature value. The value must be Base64-encoded.', 'type' => 'string', 'required' => true, 'example' => 'eyaC0w3ROK5b3QcHmUtAhMY/sQjKu2t3uBfnf6J/gn7JfZtyxwcCUjzXbw5jmqJQRbj1te670Bshg9kUdanKhtHFhJjU5jX+ZMMBr6pH0gqQDJxR0K0yHXRc0Q5OQoUZ6BfpbI4Wt4jJvJSdCstz1vSg12CfEHS8Kd5qfhItK7Y=', 'title' => ''],
+ ],
+ [
+ 'name' => 'CustomIdentifier',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The custom identifier. This key must be unique.', 'type' => 'string', 'required' => false, 'example' => '****6bb538d538c70c01f81jh2****', 'title' => ''],
+ ],
+ [
+ 'name' => 'WarehouseId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the repository. To get this parameter, call the [ListCertWarehouse](~~453246~~) operation.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'D3F1FA43-1C26-50A2-8F0F-7A03851DBB46',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1ed33293-2e48-6b14-861e-538e28e408eb', 'title' => ''],
+ 'SignatureValid' => ['description' => 'The result of the signature verification. Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -8753,50 +7691,1212 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3F1FA43-1C26-50A2-8F0F-7A03851DBB46\\"\\n}","type":"json"}]',
- 'title' => 'DeleteCsr',
+ 'title' => 'Verify',
+ 'description' => 'This API verifies the signatures of PCA certificates and SSL certificates in the certificate repository.'."\n"
+ ."\n"
+ .'### QPS limits'."\n"
+ ."\n"
+ .'The queries per second (QPS) limit for this API is 1,000 for a single user. For your specific QPS limit, refer to the certificate repository. If you exceed this limit, API calls are throttled, which may affect your business. Plan your API calls accordingly.',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-23T02:44:09.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-09-15T07:45:20.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:Verify',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1ed33293-2e48-6b14-861e-538e28e408eb\\",\\n \\"SignatureValid\\": true\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cas.ap-southeast-2.aliyuncs.com', 'endpoint' => 'cas.ap-southeast-2.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cas.cn-hongkong.aliyuncs.com', 'endpoint' => 'cas.cn-hongkong.aliyuncs.com', 'vpc' => 'cas.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cas.ap-northeast-1.aliyuncs.com', 'endpoint' => 'cas.ap-northeast-1.aliyuncs.com', 'vpc' => 'cas.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cas.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cas.ap-southeast-1.aliyuncs.com', 'vpc' => 'cas.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cas.ap-southeast-3.aliyuncs.com', 'endpoint' => 'cas.ap-southeast-3.aliyuncs.com', 'vpc' => 'cas.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cas.ap-southeast-5.aliyuncs.com', 'endpoint' => 'cas.ap-southeast-5.aliyuncs.com', 'vpc' => 'cas.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cas.aliyuncs.com', 'endpoint' => 'cas.aliyuncs.com', 'vpc' => 'cas.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cas.eu-central-1.aliyuncs.com', 'endpoint' => 'cas.eu-central-1.aliyuncs.com', 'vpc' => 'cas.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cas.me-east-1.aliyuncs.com', 'endpoint' => 'cas.me-east-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cas.ap-south-1.aliyuncs.com', 'endpoint' => 'cas.ap-south-1.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AccessDenied.NoAuth', 'message' => '访问拒绝，没有权限。', 'http_code' => 400, 'description' => 'The access is rejected because you do not have the required permissions.'],
+ ['code' => 'AlreadyExists.%s', 'message' => 'A %s with the same value already exists.', 'http_code' => 400, 'description' => '%s already exists.'],
+ ['code' => 'AlreadyExistsTry', 'message' => 'You have already created a trial instance and cannot create it again.', 'http_code' => 400, 'description' => 'Failed to create an order instance for trial use because one has already been created.'],
+ ['code' => 'CertificateChainNotMatch', 'message' => 'The certificate chain does not match.', 'http_code' => 400, 'description' => 'The certificate chain does not match.'],
+ ['code' => 'CertificateExpired', 'message' => '证书已经过期。', 'http_code' => 400, 'description' => 'The certificate has expired.'],
+ ['code' => 'CertificateFormatException', 'message' => '证书格式异常，请检查输入内容。', 'http_code' => 400, 'description' => 'The CA certificate format is invalid. Check the input.'],
+ ['code' => 'CertificatePrivateKey.Existed', 'message' => '证书私钥已经存在。', 'http_code' => 400, 'description' => 'The private key of the certificate already exists.'],
+ ['code' => 'CouldNotRefund.InsufficientQuota', 'message' => '该订单额度不足，无法退款。', 'http_code' => 400, 'description' => 'The refund failed because the quota in the order is insufficient.'],
+ ['code' => 'CouldNotRefund.NotSupport', 'message' => '不支持退款。', 'http_code' => 400, 'description' => 'Refund is not supported.'],
+ ['code' => 'CouldNotRefund.OverTime', 'message' => '超过退款期限，无法退款。', 'http_code' => 400, 'description' => 'The refund failed because the eligible refund period has expired.'],
+ ['code' => 'CreateCsrFailed', 'message' => '创建CSR失败。', 'http_code' => 400, 'description' => 'Failed to create the CSR.'],
+ ['code' => 'CreateOrderFailed', 'message' => '创建订单失败。', 'http_code' => 400, 'description' => 'Failed to create the order.'],
+ ['code' => 'DataTooLongException', 'message' => '存在超长输入值。', 'http_code' => 400, 'description' => 'An excessively long input value exists.'],
+ ['code' => 'DecryptError', 'message' => '解密错误。', 'http_code' => 400, 'description' => 'A decryption error occurred.'],
+ ['code' => 'DeductQuotaFailed', 'message' => '扣除额度失败，请稍后重试。', 'http_code' => 400, 'description' => 'Failed to deduct from the quota. Try again later.'],
+ ['code' => 'DeployFailed', 'message' => 'Deployment failed.', 'http_code' => 400, 'description' => 'Deployment failed.'],
+ ['code' => 'DeployFailed.CertBackupFailed', 'message' => '部署失败，备份证书失败。', 'http_code' => 400, 'description' => 'Deployment failed because the certificate backup failed.'],
+ ['code' => 'DeployFailed.InvalidCertChainPath', 'message' => '部署失败，无效的证书链路径。', 'http_code' => 400, 'description' => 'Deployment failed because the certificate chain path is invalid.'],
+ ['code' => 'DeployFailed.InvalidCertPath', 'message' => '部署失败，无效的证书路径。', 'http_code' => 400, 'description' => 'Deployment failed because the CA certificate path is invalid.'],
+ ['code' => 'DeployFailed.InvalidPrivatePath', 'message' => '部署失败，无效的私钥路径。', 'http_code' => 400, 'description' => 'Deployment failed because the private key path is invalid.'],
+ ['code' => 'DigestError', 'message' => '摘要错误。', 'http_code' => 400, 'description' => 'A digest error occurred.'],
+ ['code' => 'DomainAlreadyExist', 'message' => 'Domain name already exists.', 'http_code' => 400, 'description' => 'Domain name already exists.'],
+ ['code' => 'DomainAlreadyUsed', 'message' => '域名已经被使用。', 'http_code' => 400, 'description' => 'The domain name has been used.'],
+ ['code' => 'DomainAndProductNotMatch', 'message' => '域名和规格不匹配。', 'http_code' => 400, 'description' => 'The domain name and the specifications do not match.'],
+ ['code' => 'DomainFormatError', 'message' => '域名格式错误，请检查输入内容。', 'http_code' => 400, 'description' => 'The domain name format is invalid. Check the input.'],
+ ['code' => 'DomainParseError', 'message' => 'Failed to parse the domain name. Check the input.', 'http_code' => 400, 'description' => 'Failed to resolve the domain name. Check whether the input is correct.'],
+ ['code' => 'DomainQuotaExceeded', 'message' => '域名超出额度。', 'http_code' => 400, 'description' => 'The domain name quota is exceeded.'],
+ ['code' => 'DomainRepeat', 'message' => '域名重复。', 'http_code' => 400, 'description' => 'The domain name already exists.'],
+ ['code' => 'EncryptError', 'message' => '加密错误。', 'http_code' => 400, 'description' => 'An encryption error occurred.'],
+ ['code' => 'FileValueNotMatch', 'message' => '文件校验值不匹配。', 'http_code' => 400, 'description' => 'No match is found for the file verification value.'],
+ ['code' => 'FileValueNotMatch.EndWrapCharacter', 'message' => '文件校验值不匹配，结尾不能有换行符。', 'http_code' => 400, 'description' => 'No match is found for the file verification value. Line feeds are not allowed at the end.'],
+ ['code' => 'FlowControlError', 'message' => '超过限流QPS，请稍后重试。', 'http_code' => 400, 'description' => 'The QPS for throttling is exceeded. Try again later.'],
+ ['code' => 'Forbidden.NoPermission', 'message' => 'No permissions.', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation. Contact the administrator to obtain the required permissions.'],
+ ['code' => 'GetDNSFailed', 'message' => '获取DNS失败。', 'http_code' => 400, 'description' => 'Failed to obtain the DNS record.'],
+ ['code' => 'GetFileValueFailed', 'message' => '获取文件校验值失败。', 'http_code' => 400, 'description' => 'Failed to obtain the file verification value.'],
+ ['code' => 'IncorrectFormat.%s', 'message' => 'The %s parameter format is incorrect.', 'http_code' => 400, 'description' => 'The value of the %s parameter is in an invalid format.'],
+ ['code' => 'InsufficientQuota', 'message' => '额度不足。', 'http_code' => 400, 'description' => 'The quota is insufficient.'],
+ ['code' => 'InternalError', 'message' => 'An internal error occurred. Try again later.', 'http_code' => 400, 'description' => 'An internal error occurred. Try again later.'],
+ ['code' => 'InvaildParameterSource', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => 'The parameter is invalid.'],
+ ['code' => 'InvalidParameter', 'message' => '无效参数，请检查参数输入。', 'http_code' => 400, 'description' => 'Invalid parameters exist. Check the input parameters.'],
+ ['code' => 'InvalidParameter.%s', 'message' => 'Invalid parameter: %s .', 'http_code' => 400, 'description' => 'The value of the %s parameter is invalid. Modify the value.'],
+ ['code' => 'InvalidParameter.MobileIllegal', 'message' => '手机号非法，请输入正确手机号', 'http_code' => 400, 'description' => 'The mobile phone number is invalid. Enter the correct mobile phone number.'],
+ ['code' => 'InvalidSource.Content.Malformed', 'message' => 'Incorrect format.', 'http_code' => 400, 'description' => 'Incorrect format.'],
+ ['code' => 'InvalidStatus.DeleteProtection', 'message' => '当前状态不允许删除，请稍后重试。', 'http_code' => 400, 'description' => 'The delete operation is not allowed in the current state. Try again later.'],
+ ['code' => 'InvalidStatus.UpdateProtection', 'message' => '当前状态不允许更新，请稍后重试。', 'http_code' => 400, 'description' => 'The update operation is not allowed in the current state. Try again later.'],
+ ['code' => 'LimitExceeded.%s', 'message' => 'The maximum number of %s is exceeded.', 'http_code' => 400, 'description' => 'The number of %s exceeds the limit.'],
+ ['code' => 'MissingDocument', 'message' => '必填文档缺失，请检查输入。', 'http_code' => 400, 'description' => 'The required document is not found. Check the input.'],
+ ['code' => 'MissingParameter', 'message' => '缺失必填参数，请检查参数输入。', 'http_code' => 400, 'description' => 'Required parameters are missing. Check the input parameters.'],
+ ['code' => 'MissingParameter.%s', 'message' => '%s is required for this operation.', 'http_code' => 400, 'description' => 'The current operation requires the %s parameter. Configure the parameter.'],
+ ['code' => 'NameRepeat', 'message' => '名称重复，请重新输入。', 'http_code' => 400, 'description' => 'The name already exists. Enter a different name.'],
+ ['code' => 'NameTooLongException', 'message' => '名称太长，请重新输入。', 'http_code' => 400, 'description' => 'The name length exceeds the upper limit. Enter a different name.'],
+ ['code' => 'NotExpired.DeleteProtection', 'message' => '未过期证书不允许删除，请稍后重试。', 'http_code' => 400, 'description' => 'Unexpired certificates cannot be deleted. Try again later.'],
+ ['code' => 'NotFound', 'message' => 'The resource not found. Check the input parameters.', 'http_code' => 400, 'description' => 'The necessary content was not found, please check whether the parameter input is correct.'],
+ ['code' => 'NotFound.%s', 'message' => 'Resource not found: %s .', 'http_code' => 404, 'description' => 'The resource %s is not found.'],
+ ['code' => 'NotMatch.CertificateAndPrivateKey', 'message' => '证书和私钥不匹配，请检查输入内容。', 'http_code' => 400, 'description' => 'The CA certificate and the private key do not match. Check the input.'],
+ ['code' => 'NotMatch.CertificateChain', 'message' => '证书链不匹配，请检查证书链内容。', 'http_code' => 400, 'description' => 'Mismatch is found in the certificate chain. Check the certificate chain content.'],
+ ['code' => 'NotMatch.CsrAndPrivateKey', 'message' => 'CSR和私钥不匹配，请检查输入内容。', 'http_code' => 400, 'description' => 'The CSR and the private key do not match. Check the input.'],
+ ['code' => 'NotSupport.MissingPrivateKey', 'message' => '缺失私钥，不支持当前操作。', 'http_code' => 400, 'description' => 'The operation is not supported because the private key is not found.'],
+ ['code' => 'NotSupport.ProductAlgorithm', 'message' => '当前规格不支持指定算法。', 'http_code' => 400, 'description' => 'The specified algorithm is not supported for current specifications.'],
+ ['code' => 'NotSupportAlgorithm', 'message' => '当前操作不支持指定算法。', 'http_code' => 400, 'description' => 'The operation does not support the specified algorithm.'],
+ ['code' => 'OperationDenied.AlreadyReissuing', 'message' => '已经存在重签发订单，请稍后重试。', 'http_code' => 400, 'description' => 'A reissuance order already exists. Try again later.'],
+ ['code' => 'OperationDenied.CSRExisted', 'message' => 'CSR已经存在，不支持当前操作。', 'http_code' => 400, 'description' => 'The operation is not supported because the CSR already exists.'],
+ ['code' => 'OperationDenied.CSRPrivateKeyExisted', 'message' => 'CSR私钥已经存在，不支持当前操作。', 'http_code' => 400, 'description' => 'The operation is not supported because the private key of the CSR already exists.'],
+ ['code' => 'OperationDenied.ExistedTrusteeOrder', 'message' => '存在托管订单，不支持当前操作。', 'http_code' => 400, 'description' => 'The operation is not supported because a hosting order exists.'],
+ ['code' => 'OperationDenied.IPFormatError', 'message' => 'IP格式错误，不支持操作。', 'http_code' => 400, 'description' => 'The operation is not supported because the IP address format is invalid.'],
+ ['code' => 'OperationDenied.IPNotSupport', 'message' => 'IP不支持当前操作。', 'http_code' => 400, 'description' => 'The operation is not supported for the current IP address.'],
+ ['code' => 'OperationDenied.IssuedTimeNotSupport', 'message' => '当前签发时间内不支持当前操作。', 'http_code' => 400, 'description' => 'The operation is not supported because the issuance time does not meet the requirements.'],
+ ['code' => 'OperationDenied.NameContainsIllegalCharacters', 'message' => '名称包含非法字符，请检查输入内容。', 'http_code' => 400, 'description' => 'The name contains invalid characters. Check the input.'],
+ ['code' => 'OperationDenied.NotSameCompanyEntity', 'message' => 'not allowed to operate.', 'http_code' => 400, 'description' => 'is not a corporate entity and is not allowed to operate.'],
+ ['code' => 'OperationDenied.NotSupport', 'message' => 'The resource does not support this operation.', 'http_code' => 400, 'description' => 'The operation is not supported for the current resource.'],
+ ['code' => 'OperationDenied.NotSupportAddWildDomain', 'message' => '当前操作不支持泛域名。', 'http_code' => 400, 'description' => 'The operation does not support wildcard domain names.'],
+ ['code' => 'OperationDenied.NotSupportSM2', 'message' => '当前操作不支持国密算法。', 'http_code' => 400, 'description' => 'The operation does not support SM algorithms.'],
+ ['code' => 'OperationDenied.ProductNotSupport', 'message' => '规格不支持。', 'http_code' => 400, 'description' => 'The domain name type is not supported for the current specifications.'],
+ ['code' => 'OperationDenied.RepeatedOperation', 'message' => '重复操作，请刷新页面稍后重试。', 'http_code' => 400, 'description' => 'Repeated operations. Refresh the page and try again later.'],
+ ['code' => 'OperationDenied.StatusNotSupport', 'message' => '当前状态不支持当前操作。', 'http_code' => 400, 'description' => 'The operation is not supported in the current state.'],
+ ['code' => 'OperationDenied.SystemUpgrading', 'message' => 'The operation failed because the system is under maintenance.', 'http_code' => 400, 'description' => 'The operation is not supported because the system is under maintenance. Try again later.'],
+ ['code' => 'OperationDenied.TypeNotSupport', 'message' => '该类型不支持当前操作。', 'http_code' => 400, 'description' => 'The operation is not supported for the current type.'],
+ ['code' => 'OrderExpired', 'message' => 'Order is Expired.', 'http_code' => 400, 'description' => 'Order is expired'],
+ ['code' => 'ParamRepeat', 'message' => 'A specified parameter value already exists.', 'http_code' => 400, 'description' => 'The input data duplicates existing data in the backend. Duplicate data cannot be saved.'],
+ ['code' => 'ParamRepeat', 'message' => 'The input parameter and the backend have duplicate data, and duplicate data storage is not allowed.', 'http_code' => 400, 'description' => 'The input parameter and the backend have duplicate data, and duplicate data storage is not allowed.'],
+ ['code' => 'ParseCertificateFailed', 'message' => '解析证书失败，请检查证书内容。', 'http_code' => 400, 'description' => 'Failed to parse the CA certificate. Check the CA certificate content.'],
+ ['code' => 'ParsePrivateKeyFailed', 'message' => '解析私钥失败，请检查私钥内容。', 'http_code' => 400, 'description' => 'Failed to parse the private key. Check the private key content.'],
+ ['code' => 'PermissionDenied', 'message' => '没有权限。', 'http_code' => 400, 'description' => 'No permissions.'],
+ ['code' => 'PrivateKeyFormatException', 'message' => '私钥格式异常，请检查输入内容。', 'http_code' => 400, 'description' => 'The private key format is invalid. Check the input.'],
+ ['code' => 'QuotaExceeded', 'message' => 'The resource exceeds the quota limit.', 'http_code' => 400, 'description' => 'The resource quota is exhausted.'],
+ ['code' => 'QuotaExceeded.SlbCertificate', 'message' => 'SLB证书管理证书数量达到上限。', 'http_code' => 400, 'description' => 'The number of SLB certificates reaches the upper limit.'],
+ ['code' => 'RequestsTooMany', 'message' => '请求次数太频繁，请稍后重试。', 'http_code' => 400, 'description' => 'The requests are initiated too frequently. Try again later.'],
+ ['code' => 'ResourceAlreadyAssociated', 'message' => 'The specified resource is already associated.', 'http_code' => 400, 'description' => 'The certificate is already associated with the listener.'],
+ ['code' => 'RevokeLimit', 'message' => '超过吊销次数限制，无法吊销。', 'http_code' => 400, 'description' => 'The revoke failed because the number of allowed revoke operations is exceeded.'],
+ ['code' => 'SignError', 'message' => '签名错误。', 'http_code' => 400, 'description' => 'A signature error occurred.'],
+ ['code' => 'SignVerifyError', 'message' => '签名验证错误。', 'http_code' => 400, 'description' => 'A signature verification error occurred.'],
+ ['code' => 'UpdateConflict', 'message' => 'The data you are trying to update has been modified by another user. Please refresh and try again.', 'http_code' => 409, 'description' => 'The data that you want to update is modified by another user. Refresh and try again.'],
+ ['code' => 'ValidateCsrFailed', 'message' => '校验CSR失败，请检查输入内容。', 'http_code' => 400, 'description' => 'Failed to verify the CSR. Check the input.'],
+ ['code' => 'WarehouseUnavailable', 'message' => '仓库不可用。', 'http_code' => 400, 'description' => 'The repository is unavailable.'],
+ ['code' => 'WebHookFailed', 'message' => 'Failed to send WebHook.', 'http_code' => 400, 'description' => 'Failed to send WebHook.'],
+ ['code' => 'CertificateExpired', 'message' => 'The certificate has expired, please purchase a new certificate.', 'http_code' => 400, 'description' => 'The certificate has expired. Please purchase a new certificate.'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetUserCertificateDetail'],
+ ],
+ 'createdAt' => '2024-11-22T03:45:47.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetUserCertificateDetail'],
+ ],
+ 'createdAt' => '2024-09-23T04:28:37.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'UploadUserCertificate'],
+ ],
+ 'createdAt' => '2024-08-30T07:18:02.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetCsrDetail'],
+ ],
+ 'createdAt' => '2024-08-20T09:20:39.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListCloudResources'],
+ ],
+ 'createdAt' => '2024-08-13T08:47:28.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetUserCertificateDetail'],
+ ],
+ 'createdAt' => '2024-08-06T10:02:08.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListCert'],
+ ],
+ 'createdAt' => '2023-12-19T07:40:37.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'cas.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetUserCertificateDetail'],
+ ],
+ 'createdAt' => '2023-04-20T08:55:34.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'cas.cn-hongkong.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetUserCertificateDetail'],
+ ],
+ 'createdAt' => '2022-11-30T10:13:04.000Z',
+ 'description' => '。',
],
[
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'cas.ap-northeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetUserCertificateDetail'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListUserCertificateOrder'],
+ ['description' => 'Request parameters changed', 'api' => 'UploadUserCertificate'],
+ ],
+ 'createdAt' => '2022-11-30T10:00:50.000Z',
+ 'description' => '。',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'cas.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListCert'],
+ ['description' => 'Response parameters changed', 'api' => 'ListUserCertificateOrder'],
+ ['description' => 'Response parameters changed', 'api' => 'UploadPCACert'],
+ ],
+ 'createdAt' => '2022-11-17T06:37:52.000Z',
+ 'description' => '0',
],
[
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'cas.ap-southeast-2.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateWHCertificateWithExtension'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateWHClientCertificate'],
+ ],
+ 'createdAt' => '2022-11-07T10:38:05.000Z',
+ 'description' => '.',
],
[
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'cas.ap-southeast-3.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CancelCertificateForPackageRequest'],
+ ['description' => 'Error codes changed', 'api' => 'CancelOrderRequest'],
+ ['description' => 'Error codes changed', 'api' => 'CreateCertificateForPackageRequest'],
+ ['description' => 'Error codes changed', 'api' => 'CreateCertificateRequest'],
+ ['description' => 'Error codes changed', 'api' => 'CreateCertificateWithCsrRequest'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteCertificateRequest'],
+ ['description' => 'Error codes changed', 'api' => 'DescribeCertificateState'],
+ ['description' => 'Error codes changed', 'api' => 'DescribePackageState'],
+ ['description' => 'Error codes changed', 'api' => 'RenewCertificateOrderForPackageRequest'],
+ ],
+ 'createdAt' => '2022-09-23T08:23:01.000Z',
+ 'description' => '.',
],
[
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'cas.ap-southeast-5.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'Verify'],
+ ],
+ 'createdAt' => '2022-09-23T02:44:19.000Z',
+ 'description' => '。',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'cas.eu-central-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DeletePCACert'],
+ ['description' => 'OpenAPI offline', 'api' => 'DeletePCACert'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListCert'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListCert'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListCertWarehouse'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListCertWarehouse'],
+ ['description' => 'OpenAPI offline', 'api' => 'Sign'],
+ ['description' => 'OpenAPI offline', 'api' => 'Sign'],
+ ['description' => 'OpenAPI offline', 'api' => 'UploadPCACert'],
+ ['description' => 'OpenAPI offline', 'api' => 'UploadPCACert'],
+ ],
+ 'createdAt' => '2022-09-15T09:30:53.000Z',
+ 'description' => '证书仓库',
],
[
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'cas.ap-south-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListUserCertificateOrder'],
+ ],
+ 'createdAt' => '2022-03-17T07:57:55.000Z',
+ 'description' => '修复接口bug',
],
[
- 'regionId' => 'me-east-1',
- 'endpoint' => 'cas.me-east-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListUserCertificateOrder'],
+ ],
+ 'createdAt' => '2022-02-23T11:50:37.000Z',
+ 'description' => '新增订单列表接口',
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'SSLCertificatesService',
+ 'productName' => 'Certificate Management Service (Original SSL Certificate)',
+ 'ramCodes' => ['yundun-cert'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [
+ [
+ 'name' => 'acs:ResourceGroupId',
+ 'schema' => ['type' => 'String', 'description' => 'the resourceGroupId condition'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetAssetCount',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetAssetCount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCertificateRequest',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteCertificateRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeWarehouseCert',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribeWarehouseCert',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCert',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCert',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Encrypt',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:Encrypt',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeletePCACert',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeletePCACert',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteUserCertificate',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteUserCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCsr',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'MoveResourceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:MoveResourceGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWarehouse',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListWarehouse',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Decrypt',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:Decrypt',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RenewCertificateOrderForPackageRequest',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:RenewCertificateOrderForPackageRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDeploymentJob',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateDeploymentJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCloudResourceStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribeCloudResourceStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Sign',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:Sign',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCsr',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Verify',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:Verify',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWarehouse',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteWarehouse',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteInstance',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDeploymentJob',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteDeploymentJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelPendingCertificate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CancelPendingCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCloudAccess',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteCloudAccess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribePackageState',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribePackageState',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetInstanceDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetInstanceDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDeploymentJob',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribeDeployment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTaskAttribute',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetTaskAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDeploymentJobResource',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListDeploymentJobResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWorkerResource',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteWorkerResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListUserCertificateOrder',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListUserCertificateOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAssetCount',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListAssetCount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDeploymentJob',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateDeploymentJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCertWarehouseQuota',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetCertWarehouseQuota',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDeploymentJob',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListDeploymentJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDeploymentJobCert',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListDeploymentJobCert',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetUserCertificateDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetUserCertificateDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCloudResources',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCloudResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWarehouse',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateWarehouse',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCertificateRequest',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateCertificateRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateCsr',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddCloudAccess',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:AddCloudAccess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadPCACert',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UploadPCACert',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RevokeWHClientCertificate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:RevokeWHClientCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCertificateForPackageRequest',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateCertificateForPackageRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListContact',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListContact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelOrderRequest',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CancelOrderRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCsrDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetCsrDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDeploymentJobStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribeDeploymentJobStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetMatchedResources',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetMatchedResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWorkerResource',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListWorkerResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BatchUpdateNoticeStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:BatchUpdateNoticeStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInstances',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCertificateDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetCertificateDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RefundInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:RefundInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCloudAccess',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCloudAccess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadUserCertificate',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UploadUserCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCertWarehouse',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCertWarehouse',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ApplyCertificate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ApplyCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCertificateWithCsrRequest',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateCertificateWithCsrRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetInstanceSummary',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetInstanceSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadCsr',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UploadCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWorkerResourceStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateWorkerResourceStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWHClientCertificate',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CreateWHClientCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDeploymentJobStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:UpdateDeploymentJobStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCsr',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DeleteCsr',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCertificates',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:ListCertificates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelCertificateForPackageRequest',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:CancelCertificateForPackageRequest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RevokeCertificate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:RevokeCertificate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCertificateState',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:DescribeCertificateState',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRiskCount',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-cert:GetRiskCount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SSLCertificatesService', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Certificate', 'arn' => 'acs:sslcertificatesservice::{#accountId}:certificate/{#CertId}'],
+ ['validationType' => 'always', 'resourceType' => 'Certificate', 'arn' => 'acs:yundun-cert:*:{#accountId}:*'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 18:43:44 +0000