diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/cas | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/cas')
| -rw-r--r-- | data/en_us/cas/2020-04-07/api-docs.php | 8802 | ||||
| -rw-r--r-- | data/en_us/cas/2020-06-30/api-docs.php | 10604 |
2 files changed, 19406 insertions, 0 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 new file mode 100644 index 0000000..a4e6938 --- /dev/null +++ b/data/en_us/cas/2020-04-07/api-docs.php @@ -0,0 +1,8802 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'cas', + 'version' => '2020-04-07', + ], + 'directories' => [ + [ + 'id' => 390690, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListInstances', + 'UpdateInstance', + 'GetInstanceDetail', + 'DeleteInstance', + 'RefundInstance', + 'GetInstanceSummary', + 'ApplyCertificate', + 'GetTaskAttribute', + 'CancelPendingCertificate', + 'ListCertificates', + 'GetCertificateDetail', + 'RevokeCertificate', + 'DeleteUserCertificate', + ], + ], + [ + 'id' => 390704, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'MoveResourceGroup', + ], + ], + [ + 'id' => 390706, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDeploymentJob', + 'UpdateDeploymentJobStatus', + 'ListDeploymentJob', + 'UpdateDeploymentJob', + 'DescribeDeploymentJob', + 'ListWorkerResource', + 'DescribeDeploymentJobStatus', + 'ListDeploymentJobResource', + 'ListContact', + 'ListDeploymentJobCert', + 'UpdateWorkerResourceStatus', + 'DeleteWorkerResource', + 'DeleteDeploymentJob', + 'DescribeCloudResourceStatus', + 'ListCloudResources', + 'ListCloudAccess', + ], + ], + [ + 'id' => 390723, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeCertificateState', + 'CreateCertificateWithCsrRequest', + 'CreateCertificateRequest', + 'DeleteCertificateRequest', + 'UploadUserCertificate', + 'GetUserCertificateDetail', + ], + ], + [ + 'id' => 390730, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribePackageState', + 'ListUserCertificateOrder', + 'CreateCertificateForPackageRequest', + 'CancelCertificateForPackageRequest', + 'CancelOrderRequest', + 'RenewCertificateOrderForPackageRequest', + ], + ], + [ + 'id' => 390737, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetCertWarehouseQuota', + 'ListCertWarehouse', + 'ListCert', + 'Sign', + 'Verify', + 'Encrypt', + 'Decrypt', + 'DeletePCACert', + ], + ], + [ + 'id' => 390749, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListCsr', + 'CreateCsr', + 'UploadCsr', + 'GetCsrDetail', + 'UpdateCsr', + 'DeleteCsr', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ListInstances' => [ + 'summary' => '获取实例列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214629', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'inactive', + ], + ], + [ + 'name' => 'Brand', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Digicert', + ], + ], + [ + 'name' => 'CertificateType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DV', + ], + ], + [ + 'name' => 'CertificateStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'issued', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae******4wia', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'UpdateInstance' => [ + 'summary' => '更新实例', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cas-cn-68n1mm16****', + ], + ], + [ + 'name' => 'CertificateName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test.com', + ], + ], + [ + 'name' => 'KeyAlgorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'RSA_2048', + ], + ], + [ + 'name' => 'AutoReissue', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'enable', + ], + ], + [ + 'name' => 'CompanyId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '44211', + ], + ], + [ + 'name' => 'ContactIdList', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'GenerateCsrMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'online', + ], + ], + [ + 'name' => 'Csr', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', + ], + ], + [ + 'name' => 'ValidationMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DNS', + ], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Beijing', + ], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Beijing', + ], + ], + [ + 'name' => 'CountryCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae******4wia', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'TagValue' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0068247C-A454-5FC9-93BF-C41CBB5CD19E', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0068247C-A454-5FC9-93BF-C41CBB5CD19E\\"\\n}","type":"json"}]', + ], + 'GetInstanceDetail' => [ + 'summary' => '查询实例详情', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213379', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cas_dv-cn-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213377', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cas-cn-68n1mm16****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4BD0CBD9-FB03-5ECD-A8FD-F90C62D78095', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BD0CBD9-FB03-5ECD-A8FD-F90C62D78095\\"\\n}","type":"json"}]', + ], + 'RefundInstance' => [ + 'summary' => '申请证书', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cas-ivauto-hqito6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D3F1FA43-1C26-50A2-8F0F-7A03851DBB46', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3F1FA43-1C26-50A2-8F0F-7A03851DBB46\\"\\n}","type":"json"}]', + ], + 'GetInstanceSummary' => [ + 'summary' => '实例统计', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213379', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TEST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + ], + 'ApplyCertificate' => [ + 'summary' => '申请证书', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cas_dv-cn-rp643r82d0i1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'GetTaskAttribute' => [ + 'summary' => '查询异步任务状态', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213379', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ApplyCertificate', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cas_dv-cn-rp643r82d0i1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12345678-1234-1234-1234-123456789ABC', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\"\\n}","type":"json"}]', + ], + 'ListCertificates' => [ + 'summary' => '获取证书列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214629', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cas-ivauto-hqito6', + ], + ], + [ + 'name' => 'CertificateStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'issued', + ], + ], + [ + 'name' => 'CertificateSource', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek****wia', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213379', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CertificateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '18594156', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cas-cn-68n1mm16****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '160957', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The object.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3E50D480-9765-5CFD-9650-9BACCECA5135', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226097', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cas-cn-4591d3xa****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-acfmykgxu5d46ey', + ], + ], + [ + 'name' => 'ResourceType', + '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', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214600', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '部署任务名称', + 'description' => 'The name of the deployment task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'jobName', + ], + ], + [ + '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', + ], + 'example' => 'user', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ResourceIds', + '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 IDs of cloud resources from the **Id** parameter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '6591316,6585549,6190248,5811894,5775176,5772504', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ScheduleTime', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiDefaultResponse<CreateDeploymentResult>', + 'description' => 'OpenApiDefaultResponse.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'JobId' => [ + 'title' => '部署任务ID', + 'description' => 'The ID of the deployment task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8888', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214601', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiDefaultResponse<?>', + 'description' => 'OpenApiDefaultResponse\\<?>.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214571', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobType', + 'in' => 'query', + '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' => '', + ], + 'example' => 'user', + ], + ], + [ + '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', + ], + 'example' => 'pending', + ], + ], + [ + '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 certificates per page. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'UpdateDeploymentJob' => [ + 'summary' => 'Updates a deployment task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '214599', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '依赖真实的，短信验证通过的手机，无法自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + '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', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '部署任务名称', + 'description' => 'The name of the deployment task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cert-1', + ], + ], + [ + '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 ID of a certificate from the **CertificateId** parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9957285,12067351,12304338,12342649', + ], + ], + [ + 'name' => 'ResourceIds', + '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", + 'type' => 'string', + 'required' => false, + 'example' => '9957285,12067351,12304338,12342649', + ], + ], + [ + '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 ID of a contact from the **ContactId** parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9957285,12067351,12304338,12342649', + ], + ], + [ + 'name' => 'ScheduleTime', + '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 it is created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1606482979000', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"082FAB35-6AB9-4FD5-8750-D36673548E76\\"\\n}","type":"json"}]', + 'title' => 'UpdateDeploymentJob', + ], + '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', + ], + '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' => 'JobId', + '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', + ], + ], + ], + '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', + ], + 'ProductName' => [ + 'title' => '部署任务资源包含云产品（多个）', + 'description' => 'The cloud services included in the deployment task.'."\n", + 'type' => 'string', + 'example' => 'CDN', + ], + 'Config' => [ + 'title' => '部署任务配置', + 'description' => 'The configurations of the deployment task.'."\n", + 'type' => 'string', + 'example' => '{\\"shareCertIds\\":[],\\"certIds\\":[12342649,12304338,12067351,9957285]}', + ], + 'CasContacts' => [ + 'description' => 'The information about the contact.'."\n", + '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' => '[email protected]', + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"[email protected]\\"\\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214605', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + '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', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + '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' => '', + ], + 'example' => 'editing', + ], + ], + [ + 'name' => 'CloudProduct', + 'in' => 'query', + 'schema' => [ + 'title' => '部署任务worker状态：', + 'description' => 'The cloud service in the deployment task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NLB', + ], + ], + [ + '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. Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + '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', + ], + 'ShowSize' => [ + 'description' => 'The number of entries per page. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3E50D480-9765-5CFD-9650-9BACCECA5135', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214581', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '依赖短信验证通过的手机号，无法自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214583', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '部署任务ID', + 'description' => 'The ID of the deployment task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8888', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiDefaultResponse<List<CloudResource>>', + 'description' => 'OpenApiDefaultResponse\\<List>.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'ListContact' => [ + 'summary' => 'Queries a list of contacts.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214629', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Keyword', + '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', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of contacts per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'ContactList' => [ + 'description' => 'The contacts.'."\n", + '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' => '[email protected]', + ], + '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\\"]', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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\\": \\"[email protected]\\",\\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '214582', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '需要真实的，短信验证通过的手机号，无法进行自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiDefaultResponse<List<DeploymentJobCertInfo>>', + 'description' => 'OpenApiDefaultResponse\\<List>.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + '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', + ], + 'UpdateWorkerResourceStatus' => [ + 'summary' => 'Rolls back or executes a worker task in a deployment task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214606', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '依赖真实的，短信验证通过的手机，无法自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + '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', + ], + ], + [ + 'name' => 'WorkerId', + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiDefaultResponse<?>', + 'description' => 'OpenApiDefaultResponse\\<?>.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214607', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + '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' => 'WorkerId', + 'in' => 'query', + 'schema' => [ + 'title' => '部署任务workerID', + 'description' => 'The ID of the worker for the deployment task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '13', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '214604', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214598', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiDefaultResponse<List<CloudResourceCount>>', + 'description' => 'OpenApiDefaultResponse\\<List>.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '09470F19-CEE8-5C63-BF2C-02B5E3F07A17', + ], + ], + ], + ], + ], + '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', + ], + 'ListCloudResources' => [ + 'summary' => 'Queries the certificate resources of a cloud service provider and cloud services.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214597', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + '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", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Tencent' => '', + 'Huawei' => '', + 'Aws' => '', + 'aliyun' => '', + ], + 'example' => 'Tencent', + ], + ], + [ + 'name' => 'CloudProduct', + 'in' => 'query', + 'schema' => [ + 'title' => '云产品：', + 'description' => 'The 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" + ."\n" + .'Valid values when CloudName is set to Tencent:'."\n" + ."\n" + .'* TencentCDN: Content Delivery Network (CDN).'."\n" + .'* TencentCLB: CLB.'."\n" + .'* TencentWAF: WAF.'."\n" + ."\n" + .'Valid value when CloudName is set to Huawei:'."\n" + ."\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", + 'type' => 'string', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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. Default value: **20**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CertIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '根据证书ID过滤', + 'description' => 'The certificate IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The certificate ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14440149', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiPaginationResponse<CloudResource>', + 'description' => 'OpenApiPaginationResponse.'."\n", + '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', + ], + 'Data' => [ + 'description' => 'The data returned for the request.'."\n", + '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', + ], + '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" + ."\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", + '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.'."\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" + ."\n" + .'> This parameter is returned only when you deploy certificates to cloud services of third-party clouds.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + ], + 'description' => '', + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '12345678-1234-1234-1234-123456789ABC', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214631', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SecretId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The AccessKey ID that is used to access cloud resources.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '276', + ], + ], + [ + 'name' => 'CloudName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cloud service provider. Set the value to **Tencent**, which indicates Tencent Cloud.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Tencent', + ], + ], + [ + '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', + ], + ], + ], + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The cloud service.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81673', + 'abilityTreeNodes' => [ + 'FEATUREcasP4AIN0', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'OrderId', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '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——', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81671', + 'abilityTreeNodes' => [ + 'FEATUREcasP4AIN0', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '依赖短信验证通过的真实手机号，无法自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'Csr', + '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" + ."\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" + ."\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", + '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' => '[email protected]', + ], + ], + [ + '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', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => false, + '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' => '[email protected]', + ], + ], + [ + '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', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81672', + 'abilityTreeNodes' => [ + 'FEATUREcasP4AIN0', + ], + ], + 'parameters' => [ + [ + 'name' => 'OrderId', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '082FAB35-6AB9-4FD5-8750-D36673548E76', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + '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, + ], + ], + [ + 'name' => 'Cert', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the certificate in the PEM format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----', + ], + ], + [ + 'name' => 'Key', + '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-----', + ], + ], + [ + 'name' => 'EncryptCert', + '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-----', + ], + ], + [ + 'name' => 'EncryptPrivateKey', + '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-----', + ], + ], + [ + 'name' => 'SignCert', + '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", + ], + ], + [ + 'name' => 'SignPrivateKey', + '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", + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'the resource group id.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae****vty', + ], + ], + [ + 'name' => 'Tags', + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + '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 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', + ], + ], + [ + 'name' => 'CertFilter', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'type' => 'string', + ], + 'TagValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => ' ', + ], + 'ListUserCertificateOrder' => [ + 'summary' => 'Queries the certificates or certificate orders of users.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '123899', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + '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', + 'in' => 'query', + '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', + 'required' => false, + 'example' => 'CPACK', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ShowSize', + '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', + ], + ], + [ + 'name' => 'ResourceGroupId', + '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', + ], + ], + ], + '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", + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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" + ."\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", + ], + 'CreateCertificateForPackageRequest' => [ + 'summary' => 'Submits a certificate application.', + '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' => 'Csr', + '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-----', + ], + ], + [ + '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 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" + ."\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" + ."\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" + ."\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' => '[email protected]', + ], + ], + [ + '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" + .'* 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" + ."\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", + 'type' => 'string', + 'required' => false, + 'example' => 'aliyundoc.com', + ], + ], + [ + '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' => 'A company'."\n", + ], + ], + [ + '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" + .'* **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', + ], + ], + [ + 'name' => 'Tags', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + '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' => '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + '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 order ID.'."\n" + ."\n" + .'> You can call the [ListUserCertificateOrder](~~455804~~) operation to obtain the ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123451222', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'eventInfo' => [ + '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", + ], + 'RenewCertificateOrderForPackageRequest' => [ + 'summary' => 'Submits a renewal application for an issued certificate.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81675', + 'abilityTreeNodes' => [ + 'FEATUREcasP4AIN0', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '需要签发超过30天的证书，无法自动化测试', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + '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', + ], + ], + [ + '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-----', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + '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', + '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", + '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', + ], + ], + ], + ], + ], + '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", + ], + 'ListCertWarehouse' => [ + 'summary' => 'Queries certificate repositories.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '153636', + 'abilityTreeNodes' => [ + 'FEATUREcasEAT643', + ], + 'tenantRelevance' => 'publicInformation', + ], + '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', + ], + ], + [ + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '153639', + 'abilityTreeNodes' => [ + 'FEATUREcasEAT643', + ], + 'tenantRelevance' => 'publicInformation', + ], + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The object.'."\n", + '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', + ], + ], + ], + ], + ], + 'eventInfo' => [ + '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", + ], + 'Sign' => [ + 'summary' => 'Signs a private certificate in a certificate application repository.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '153626', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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 (hash value) of the raw data.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'RAW', + ], + ], + [ + 'name' => 'CustomIdentifier', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'WarehouseId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'eventInfo' => [ + '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":""}]', + 'title' => 'Sign', + 'description' => 'You can call the Sign operation to sign 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", + ], + 'Verify' => [ + 'summary' => 'Verifies the signature of a private certificate in a certificate application repository.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '153630', + 'abilityTreeNodes' => [ + 'FEATUREcasW9WPDK', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'WarehouseId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + 'eventInfo' => [ + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155852', + 'abilityTreeNodes' => [ + 'FEATUREcasVZUJH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'Plaintext', + '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***', + ], + ], + [ + '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' => '12345678-1234-1234-1234-12345678****', + ], + ], + [ + 'name' => 'Algorithm', + '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', + ], + ], + [ + 'name' => 'MessageType', + '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', + ], + ], + [ + 'name' => 'CustomIdentifier', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'WarehouseId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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=', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155856', + 'abilityTreeNodes' => [ + 'FEATUREcasW9WPDK', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertIdentifier', + '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****', + ], + ], + [ + 'name' => 'Algorithm', + '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', + ], + ], + [ + '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" + ."\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' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'WarehouseId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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****', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '153635', + 'abilityTreeNodes' => [ + 'FEATUREcasY9QF1D', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Identifier', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213371', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + [ + 'name' => 'Algorithm', + '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', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'eventInfo' => [ + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'tenantRelevance' => 'publicInformation', + ], + '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', + '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', + ], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => [ + 'description' => 'The province or location where the company is located.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Beijing', + ], + ], + [ + 'name' => 'Locality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The city where the company is located.'."\n", + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the CSR.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'Csr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the CSR.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', + ], + ], + [ + '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-----', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + 'eventInfo' => [ + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213379', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + ], + 'parameters' => [ + [ + 'name' => 'CsrId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the CSR.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3924', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213377', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + ], + 'parameters' => [ + [ + 'name' => 'CsrId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the CSR.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5209', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + '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-----', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213378', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + ], + 'parameters' => [ + [ + 'name' => 'CsrId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the CSR.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3013', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3F1FA43-1C26-50A2-8F0F-7A03851DBB46\\"\\n}","type":"json"}]', + 'title' => 'DeleteCsr', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cas.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cas.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'cas.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cas.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'cas.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'cas.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cas.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'cas.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'cas.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'cas.me-east-1.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/cas/2020-06-30/api-docs.php b/data/en_us/cas/2020-06-30/api-docs.php new file mode 100644 index 0000000..bf59c32 --- /dev/null +++ b/data/en_us/cas/2020-06-30/api-docs.php @@ -0,0 +1,10604 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'cas', + 'version' => '2020-06-30', + ], + 'directories' => [ + [ + 'children' => [ + 'CreateRootCACertificate', + 'CreateSubCACertificate', + 'CreateExternalCACertificate', + 'GetCAInstanceStatus', + 'DescribeCACertificateCount', + 'DescribeCACertificateList', + 'DescribeCACertificate', + 'UpdateCACertificateStatus', + ], + 'type' => 'directory', + 'title' => 'Private CA certificates', + ], + [ + 'children' => [ + 'CreateCustomCertificate', + 'CreateClientCertificate', + 'CreateClientCertificateWithCsr', + 'CreateServerCertificate', + 'CreateServerCertificateWithCsr', + 'CreateRevokeClientCertificate', + 'DeleteClientCertificate', + 'DescribeCertificatePrivateKey', + 'DescribeClientCertificate', + 'DescribeClientCertificateStatus', + 'ListClientCertificate', + 'ListRevokeCertificate', + ], + 'type' => 'directory', + 'title' => 'Client certificates and server certificates', + ], + [ + 'children' => [ + 'ListPcaCaCertificate', + 'ListCert', + 'UploadPcaCertToCas', + ], + 'type' => 'directory', + 'title' => 'Other', + ], + [ + 'children' => [ + 'AssignCertificateCount', + 'DescribeClientCertificateForSerialNumber', + 'DescribeClientCertificateStatusForSerialNumber', + 'DescribePcaAndExternalCACertificateList', + 'ListAllEndEntityInstance', + 'ListCACertificateLog', + 'ListTagResources', + 'MoveResourceGroup', + 'TagResources', + 'UntagResources', + 'UpdatePcaCertificate', + ], + 'title' => 'Others', + 'type' => 'directory', + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AssignCertificateCount' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '121082', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data source.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '33285', + 'title' => '', + ], + ], + [ + 'name' => 'CertTotalCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The total number of certificate records.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'E77C4794-F24F-58CB-9929-F0F0C0EDE7B2', + 'title' => '', + ], + 'CertCount' => [ + 'description' => 'The number of assigned certificates.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'CurrentYearFreeCertCount' => [ + 'description' => 'The number of free certificates for the current year.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + ], + 'title' => '', + 'description' => 'OpenApiResponse', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'AssignCertificateCount', + 'summary' => 'Assigns the total number of certificates to a data source.', + 'description' => '## QPS limit'."\n" + ."\n" + .'This API operation is limited to 10 queries per second (QPS) per user. If you exceed this limit, the system throttles your API calls, which can affect your business. Plan your calls accordingly.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:AssignCertificateCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E77C4794-F24F-58CB-9929-F0F0C0EDE7B2\\",\\n \\"CertCount\\": 2,\\n \\"CurrentYearFreeCertCount\\": 0\\n}","type":"json"}]', + ], + 'CreateClientCertificate' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83504', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SanType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of Subject Alternative Name (SAN) extension for the client certificate. Valid values:'."\n" + ."\n" + .'- **1**: Email'."\n" + ."\n" + .'- **6**: Uniform Resource Identifier (URI)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'SanValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension information for the client certificate. To enter multiple extensions, separate them with commas (,).', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + 'title' => '', + ], + ], + [ + 'name' => 'Organization', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the organization. Default: Alibaba Inc.', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云', + 'title' => '', + ], + ], + [ + 'name' => 'OrganizationUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the department. Default: Alibaba Cloud CDN.', + 'type' => 'string', + 'required' => false, + 'example' => 'IT', + 'title' => '', + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'description' => 'The country code. Default: CN.', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'title' => '', + ], + ], + [ + 'name' => 'CommonName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the certificate user. For a client authentication (ClientAuth) certificate, the user is typically an individual, a company, an organization, or an application. Specify the common name of the user, such as John Doe, Alibaba, Alibaba Cloud Cryptography Platform, or Tmall Genie.', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + 'title' => '', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the province or state of the certificate organization. The value can contain letters. The default value is the province or state of the organization for the intermediate CA that issued the certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'Zhejiang', + 'title' => '', + ], + ], + [ + 'name' => 'Locality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the city where the organization is located. The default value is the city of the subordinate CA that issues the certificate.', + 'type' => 'string', + 'required' => false, + 'example' => '杭州市', + '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 signature algorithm is Sha256WithRSA.'."\n" + ."\n" + .'- **RSA\\_2048**: The signature algorithm is Sha256WithRSA.'."\n" + ."\n" + .'- **RSA\\_4096**: The signature algorithm is Sha256WithRSA.'."\n" + ."\n" + .'- **ECC\\_256**: The signature algorithm is Sha256WithECDSA.'."\n" + ."\n" + .'- **ECC\\_384**: The signature algorithm is Sha256WithECDSA.'."\n" + ."\n" + .'- **ECC\\_512**: The signature algorithm is Sha256WithECDSA.'."\n" + ."\n" + .'- **SM2\\_256**: The signature algorithm is SM3WithSM2.'."\n" + ."\n" + .'The encryption algorithm of the client certificate must be the same as the subordinate CA certificate. The key length can be different. For example, if the subordinate CA certificate uses the RSA\\_2048 key algorithm, the client certificate must use RSA\\_1024, RSA\\_2048, or RSA\\_4096.'."\n" + ."\n" + .'> Call [DescribeCACertificate](~~465954~~) to find the key algorithm of the subordinate CA certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'RSA_2048', + 'title' => '', + ], + ], + [ + 'name' => 'ParentIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the subordinate CA certificate that issues this certificate.'."\n" + ."\n" + .'> Call DescribeCACertificateList to query the unique identifier of the subordinate CA certificate.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '273ae6bb538d538c70c01f81jh2****', + 'title' => '', + ], + ], + [ + 'name' => 'Years', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the certificate in years.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'title' => '', + ], + ], + [ + 'name' => 'Months', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the certificate in months.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Days', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the client certificate in days.'."\n" + .'The **Days**, **BeforeTime**, or **AfterTime** parameters cannot all be empty. The **BeforeTime** and **AfterTime** parameters must be set together or left empty. The parameters are configured as follows:'."\n" + ."\n" + .'- If you set the **Days** parameter, the **BeforeTime** and **AfterTime** parameters are optional.'."\n" + ."\n" + .'- If you do not set the **Days** parameter, you must set both the **BeforeTime** and **AfterTime** parameters.'."\n" + ."\n" + .'> * If you set the **Days**, **BeforeTime**, and **AfterTime** parameters, the value of the **Days** parameter takes precedence.'."\n" + ."\n" + .'- The validity period of the client certificate cannot exceed the validity period of the subordinate CA certificate. To view the validity period of the subordinate CA certificate, you can call [DescribeCACertificate](~~465954~~).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '365', + 'title' => '', + ], + ], + [ + 'name' => 'BeforeTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The issuance time of the client certificate in UNIX timestamp format. The unit is seconds. The default value is the time when you call this operation.'."\n" + ."\n" + .'> **BeforeTime** and **AfterTime** must be specified together or left empty together.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1634283958', + 'title' => '', + ], + ], + [ + 'name' => 'AfterTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration time of the client certificate in UNIX timestamp format. The unit is seconds.'."\n" + ."\n" + .'> **BeforeTime** and **AfterTime** must be specified together or left empty together.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1665819958', + 'title' => '', + ], + ], + [ + 'name' => 'Immediately', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the digital certificate immediately.'."\n" + ."\n" + .'- **0**: No. This is the default value.'."\n" + ."\n" + .'- **1**: Yes, return the certificate.'."\n" + ."\n" + .'- **2**: Yes, return the certificate and its certificate chain.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'EnableCrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include the Certificate Revocation List (CRL) address.'."\n" + ."\n" + .'Valid values: 0 (No) and 1 (Yes).', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.', + 'type' => 'string', + 'required' => false, + 'example' => 'account', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The tag value.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + 'description' => 'A list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'maxItems' => 100, + 'description' => 'A list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek****wia', + 'title' => '', + ], + ], + [ + 'name' => 'CustomIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom identifier. This is a unique key.', + 'type' => 'string', + 'required' => false, + 'example' => '****6bb538d538c70c01f81jh2****', + 'title' => '', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set the name of the issued certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'cert-name', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Used to ensure request idempotence. The client generates this parameter value, which must be unique across different requests. It can contain a maximum of 64 ASCII characters and must not include any non-ASCII characters.', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'CreateCertificateResponse<CertificateIdentifierWithParentDTO>', + 'description' => 'CreateCertificateResponse', + 'type' => 'object', + 'properties' => [ + 'X509Certificate' => [ + 'description' => 'The content of the client certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----', + 'title' => '', + ], + 'CertificateChain' => [ + 'description' => 'The CA certificate chain.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the client certificate.', + 'type' => 'string', + 'example' => '190ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The certificate serial number.', + 'type' => 'string', + 'example' => '084bde9cd233f0ddae33adc438cfbbbd****', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '8C467B38-3910-447D-87BC-AC049166F216', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'CreateClientCertificate', + 'summary' => 'Issues a client certificate based on a system-generated Certificate Signing Request (CSR).', + 'description' => 'Before you call this operation, you must create a root CA certificate by calling [CreateRootCACertificate](~~465962~~) and a subordinate CA certificate by calling [CreateSubCACertificate](~~465959~~). Only subordinate CA certificates can issue client certificates.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The queries per second (QPS) limit for this operation is 10 calls per second per user. Calls that exceed this limit are throttled, which can impact your business. We recommend that you call this operation at a reasonable rate.', + 'requestParamsDescription' => 'In addition to the request parameters specific to this operation, you must also specify the common request parameters for Alibaba Cloud APIs.'."\n" + ."\n" + .'For more information, see the request sample in the **Examples** section.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateClientCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\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 \\"Identifier\\": \\"190ae6bb538d538c70c01f81dcf2****\\",\\n \\"SerialNumber\\": \\"084bde9cd233f0ddae33adc438cfbbbd****\\",\\n \\"RequestId\\": \\"8C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', + ], + 'CreateClientCertificateWithCsr' => [ + 'summary' => 'Issues a client certificate based on a custom certificate signing request (CSR).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83505', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Csr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the certificate signing request (CSR). Use OpenSSL or Keytool to generate a CSR. For more information, see [Create a CSR file](~~42218~~).', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', + 'title' => '', + ], + ], + [ + 'name' => 'SanType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the Subject Alternative Name (SAN) extension for the client certificate. Valid values:'."\n" + ."\n" + .'- **1**: Email address.'."\n" + ."\n" + .'- **6**: Uniform Resource Identifier (URI).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'SanValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension for the client certificate. To specify multiple extensions, separate them with a comma.', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + 'title' => '', + ], + ], + [ + 'name' => 'Organization', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the organization. Default value: Alibaba Inc.', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云计算有限公司', + 'title' => '', + ], + ], + [ + 'name' => 'OrganizationUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the department. Default value: Alibaba Cloud CDN.', + 'type' => 'string', + 'required' => false, + 'example' => 'Security', + 'title' => '', + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'description' => 'The country code, for example, **CN** or **US**.', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'title' => '', + ], + ], + [ + 'name' => 'CommonName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The common name of the certificate. Chinese and English characters are supported.'."\n" + ."\n" + .'> If you specify the **Csr** parameter, the value of this parameter is determined by the information in the **Csr** parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyundoc.com', + 'title' => '', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the name of the province or state where the certificate organization is located. The value can contain letters. The default value is the name of the province or state of the intermediate CA\'s organization.', + 'type' => 'string', + 'required' => false, + 'example' => 'Zhejiang', + 'title' => '', + ], + ], + [ + 'name' => 'Locality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the city where the organization is located. Chinese and English characters are supported.'."\n" + .'By default, this parameter uses the city name of the organization that is associated with the issuing subordinate CA certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'Hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key algorithm of the client certificate. The key algorithm is in the `<Encryption algorithm>_<Key length>` format. 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 be the same as that of the subordinate CA certificate, but the key length can be different. For example, if the key algorithm of the subordinate CA certificate is RSA\\_2048, the key algorithm of the client certificate must be one of RSA\\_1024, RSA\\_2048, and RSA\\_4096.'."\n" + ."\n" + .'> Call [DescribeCACertificate](~~465954~~) to query the key algorithm of the subordinate CA certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'RSA_2048', + 'title' => '', + ], + ], + [ + 'name' => 'ParentIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the subordinate CA certificate that issues the client certificate.'."\n" + ."\n" + .'> Call [DescribeCACertificateList](~~465957~~) to query the unique identifiers of subordinate CA certificates.', + 'type' => 'string', + 'required' => false, + 'example' => '270ae6bb538d538c70c01f81fg3****', + 'title' => '', + ], + ], + [ + 'name' => 'Years', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the certificate, in years.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Months', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the certificate, in months.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + 'title' => '', + ], + ], + [ + 'name' => 'Days', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the client certificate, in days.'."\n" + .'You must specify the validity period using one of the following methods:'."\n" + ."\n" + .'- Specify the **Days** parameter.'."\n" + ."\n" + .'- Specify both the **BeforeTime** and **AfterTime** parameters.'."\n" + ."\n" + .'> * If you specify **Days**, **BeforeTime**, and **AfterTime** at the same time, the value of **Days** is used.'."\n" + ."\n" + .'- The validity period of the client certificate cannot exceed that of the subordinate CA certificate. Call [DescribeCACertificate](~~465954~~) to view the validity period of the subordinate CA certificate.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '365', + 'title' => '', + ], + ], + [ + 'name' => 'BeforeTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The issuance time of the client certificate. This is a UNIX timestamp in seconds. The default value is the time of the API call.'."\n" + ."\n" + .'> The **BeforeTime** and **AfterTime** parameters must be specified together or left empty.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1634283958', + 'title' => '', + ], + ], + [ + 'name' => 'AfterTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration time of the client certificate. This is a UNIX timestamp in seconds.'."\n" + ."\n" + .'> Specify the **BeforeTime** and **AfterTime** parameters together, or omit both.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1665819958', + 'title' => '', + ], + ], + [ + 'name' => 'Immediately', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the digital certificate.'."\n" + ."\n" + .'- **0**: Do not return the certificate. This is the default value.'."\n" + ."\n" + .'- **1**: Return the certificate.'."\n" + ."\n" + .'- **2**: Return the certificate and its certificate chain.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'EnableCrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include the Certificate Revocation List (CRL) address.'."\n" + ."\n" + .'0: No'."\n" + ."\n" + .'1: Yes', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.', + 'type' => 'string', + 'required' => false, + 'example' => 'database', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The value of the tag.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + 'description' => 'A list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'maxItems' => 100, + 'description' => 'A list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the certificate belongs.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae******4wia', + 'title' => '', + ], + ], + [ + 'name' => 'CustomIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom identifier. This is a unique key.', + 'type' => 'string', + 'required' => false, + 'example' => '***e6bb538d538c70c01f81fg3****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'CreateCertificateResponse<CertificateIdentifierWithParentDTO>', + 'description' => 'CreateCertificateResponse', + 'type' => 'object', + 'properties' => [ + 'X509Certificate' => [ + 'description' => 'The content of the client certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----', + 'title' => '', + ], + 'CertificateChain' => [ + 'description' => 'The CA certificate chain.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the client certificate.', + 'type' => 'string', + 'example' => '200ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The certificate serial number.', + 'type' => 'string', + 'example' => '084bde9cd233f0ddae33adc438cfbbbd****', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot and locate issues.', + 'type' => 'string', + 'example' => '31C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + 'CertSignBufKmc' => [ + 'description' => 'The encrypted content of the certificate.', + 'type' => 'string', + 'example' => 'MIIDYDCCAwWgAwIBAgIU'."\n" + .'***'."\n" + .'TmTk0CS3WNweqsjMEETyxd2pzU6DA', + 'title' => '', + ], + 'CertKmcRep1' => [ + 'description' => 'The ciphertext of the encrypted certificate.', + 'type' => 'string', + 'example' => 'userSeal=MHkCIEu94PQAahFWuFk%'."\n" + .'***'."\n" + .'EtFw%2FkMMBjw8i5bFfSkV%2FIUrcOJD', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\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 \\"Identifier\\": \\"200ae6bb538d538c70c01f81dcf2****\\",\\n \\"SerialNumber\\": \\"084bde9cd233f0ddae33adc438cfbbbd****\\",\\n \\"RequestId\\": \\"31C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"CertSignBufKmc\\": \\"MIIDYDCCAwWgAwIBAgIU\\\\n***\\\\nTmTk0CS3WNweqsjMEETyxd2pzU6DA\\",\\n \\"CertKmcRep1\\": \\"userSeal=MHkCIEu94PQAahFWuFk%\\\\n***\\\\nEtFw%2FkMMBjw8i5bFfSkV%2FIUrcOJD\\"\\n}","type":"json"}]', + 'title' => 'CreateClientCertificateWithCsr', + 'description' => 'Before you call this operation, you must create a root CA certificate by calling [CreateRootCACertificate](~~465962~~) and a subordinate CA certificate by calling [CreateSubCACertificate](~~465959~~). Only subordinate CA certificates can issue client certificates.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'This operation is limited to 10 queries per second (QPS) per user. If you exceed this limit, the system throttles your API calls, which may affect your business. We recommend that you plan your calls to avoid being throttled.', + 'requestParamsDescription' => 'In addition to the parameters described in this topic, you must also specify common request parameters when you call this operation.'."\n" + ."\n" + .'For the request format, see the request example in the **Examples** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateClientCertificateWithCsr', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateClientCertificateWithCsr', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateCustomCertificate' => [ + 'summary' => 'Issues a digital certificate using the specified certificate subject, subject alternative name, key usage, and extended key usage.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171944', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ParentIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The identifier of the CA certificate.', + 'type' => 'string', + 'required' => true, + 'example' => '1ed4068c-6f1b-6deb-8e32-3f8439a851cb', + 'title' => '', + ], + ], + [ + 'name' => 'Csr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the CSR. You can generate a CSR using tools such as OpenSSL or Keytool. For more information, see [Create a CSR file](~~42218~~).', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN CERTIFICATE REQUEST-----'."\n" + .'MIIBczCCARgCAQAwgYoxFDASBgNVBAMMC2FsaXl1bi50ZXN0MQ0wCwYDVQQ'."\n" + .'...'."\n" + .'...'."\n" + .'...'."\n" + .'vbIgMQIhAKHDWD6/WAMbtezAt4bysJ/BZIDz1jPWuUR5GV4TJ/mS'."\n" + .'-----END CERTIFICATE REQUEST-----', + 'title' => '', + ], + ], + [ + 'name' => 'Validity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the certificate. This period cannot exceed the validity period of the instance. You can use relative time or absolute time.'."\n" + ."\n" + .'Relative time: Supports years, months, and days.'."\n" + ."\n" + .'- Year - y'."\n" + ."\n" + .'- Month - m'."\n" + ."\n" + .'- Day - d'."\n" + ."\n" + .'Absolute time: Uses GMT. Format: `yyyy-MM-dd\'T\'HH:mm:ss\'Z\'`'."\n" + ."\n" + .'- Specify the end time - $NotAfter'."\n" + ."\n" + .'- Specify the start and end times - $NotBefore/$NotAfter', + 'type' => 'string', + 'required' => true, + 'example' => '相对时间：'."\n" + .'● 1y'."\n" + .'● 3m'."\n" + .'● 7d'."\n" + ."\n" + .'绝对时间：'."\n" + .'● 2006-01-02T15:04:05Z'."\n" + .'● 2006-01-02T15:04:05Z/2023-03-09T17:48:13Z', + 'title' => '', + ], + ], + [ + 'name' => 'ApiPassthrough', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'Pass-through parameters.', + 'type' => 'object', + 'properties' => [ + 'Subject' => [ + 'description' => 'The certificate subject.', + 'type' => 'object', + 'properties' => [ + 'Country' => [ + 'description' => 'The country code. Use the two-letter country code from ISO 3166-1. For more information, see [ISO](https://www.iso.org/obp/ui/#search/code/).', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'title' => '', + ], + 'State' => [ + 'description' => 'The province or state where the organization is located.', + 'type' => 'string', + 'required' => false, + 'example' => '浙江省', + 'title' => '', + ], + 'Locality' => [ + 'description' => 'The name of the city where the organization is located. Chinese characters and letters are supported.', + 'type' => 'string', + 'required' => false, + 'example' => '杭州市', + 'title' => '', + ], + 'Organization' => [ + 'description' => 'The name of the organization.', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX公司', + 'title' => '', + ], + 'OrganizationUnit' => [ + 'description' => 'The name of the department or branch within the organization.', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX部门', + 'title' => '', + ], + 'CommonName' => [ + 'description' => 'The common name of the certificate user.', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + 'title' => '', + ], + 'CustomAttributes' => [ + 'description' => 'The custom subject properties of the certificate.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ObjectIdentifier' => [ + 'description' => 'The key of the custom property. It must comply with industry standards. Examples:'."\n" + ."\n" + .'- 2.5.4.6: Country code'."\n" + ."\n" + .'- 2.5.4.10: Organization'."\n" + ."\n" + .'- 2.5.4.11: Organizational unit name'."\n" + ."\n" + .'- 2.5.4.12: Title'."\n" + ."\n" + .'- 2.5.4.3: Common name'."\n" + ."\n" + .'- 2.5.4.9: Street'."\n" + ."\n" + .'- 2.5.4.5: Serial number'."\n" + ."\n" + .'- 2.5.4.7: Locality'."\n" + ."\n" + .'- 2.5.4.8: State or province'."\n" + ."\n" + .'- 1.3.6.1.4.1.37244.1.1: Matter certificate - Node ID'."\n" + ."\n" + .'- 1.3.6.1.4.1.37244.1.5: Matter certificate - Fabric ID'."\n" + ."\n" + .'- 1.3.6.1.4.1.37244.2.1: Matter certificate Vendor ID (VID)'."\n" + ."\n" + .'- 1.3.6.1.4.1.37244.2.2: Matter certificate Product ID (PID)', + 'type' => 'string', + 'required' => false, + 'example' => '2.5.4.3', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The value of the custom property.', + 'type' => 'string', + 'required' => false, + 'example' => 'Aliyun', + 'title' => '', + ], + ], + 'required' => false, + 'description' => 'The custom subject properties of the certificate.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Extensions' => [ + 'description' => 'The certificate extensions.', + 'type' => 'object', + 'properties' => [ + 'KeyUsage' => [ + 'description' => 'The key usage.', + 'type' => 'object', + 'properties' => [ + 'DigitalSignature' => [ + 'description' => 'Digital signature. Allows the private key of the certificate to be used for digital signatures and the public key to be used to verify digital signatures.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + 'ContentCommitment' => [ + 'description' => 'Content commitment. Formerly known as NonRepudiation. Allows the certificate key to be used for content commitment.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + 'NonRepudiation' => [ + 'description' => 'Non-repudiation. This has been renamed to ContentCommitment in the X.509 standard.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + 'KeyEncipherment' => [ + 'description' => 'Key encipherment. Allows the certificate key to be used to encrypt other keys.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + 'DataEncipherment' => [ + 'description' => 'Data encipherment.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + 'KeyAgreement' => [ + 'description' => 'Key agreement.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + 'EncipherOnly' => [ + 'description' => 'When KeyAgreement is true, this marks that the certificate key can only be used for encryption.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + 'DecipherOnly' => [ + 'description' => 'When KeyAgreement is true, this marks that the certificate key can only be used for decryption.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ExtendedKeyUsages' => [ + 'description' => 'The extended key usages.', + 'type' => 'array', + 'items' => [ + 'description' => 'The following values are allowed:'."\n" + ."\n" + .'- any - No restrictions'."\n" + ."\n" + .'- serverAuth - Server authentication'."\n" + ."\n" + .'- clientAuth - Client authentication'."\n" + ."\n" + .'- codeSigning - Code signing'."\n" + ."\n" + .'- emailProtection - Email protection'."\n" + ."\n" + .'- timeStamping - Timestamping'."\n" + ."\n" + .'- OCSPSigning - OCSP signing'."\n" + ."\n" + .'- Other extended key usage OIDs', + 'type' => 'string', + 'required' => false, + 'example' => '1.3.6.1.4.1.311.20.2.2', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'SubjectAlternativeNames' => [ + 'description' => 'The subject alternative names (SANs) of the certificate.', + 'type' => 'array', + 'items' => [ + 'description' => 'The subject alternative names (SANs) of the certificate.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'otherName, rfc822Name, dNSName, x400Address, directoryName, ediPartyName, uniformResourceIdentifier, iPAddress, registeredID', + 'description' => 'The following values are allowed:'."\n" + ."\n" + .'- rfc822Name - Email address'."\n" + ."\n" + .'- dNSName - Domain name'."\n" + ."\n" + .'- uniformResourceIdentifier - Uniform Resource Identifier (URI)'."\n" + ."\n" + .'- iPAddress - IP address', + 'type' => 'string', + 'required' => true, + 'example' => 'dNSName', + ], + 'Value' => [ + 'description' => 'A value that matches the specified Type.', + 'type' => 'string', + 'required' => false, + 'example' => 'rfc822Name:'."\n" + .'example.aliyundoc.com'."\n" + ."\n" + .'dNSName:'."\n" + .'learn.aliyundoc.com'."\n" + ."\n" + .'uniformResourceIdentifier:'."\n" + .'acs:ecs:regionid:15619224785*****:instance/i-bp1bzvz55uz27hf*****'."\n" + ."\n" + .'iPAddress:'."\n" + .'127.0.0.1', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Criticals' => [ + 'description' => 'If an extension is critical, its name is included in the criticals list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the critical extension, such as ExtendedKeyUsages.', + 'type' => 'string', + 'required' => false, + 'example' => 'ExtendedKeyUsages', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'SerialNumber' => [ + 'description' => 'The custom serial number of the certificate. Must be a long integer.', + 'type' => 'string', + 'required' => false, + 'example' => '16889526086333', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Immediately', + 'in' => 'query', + 'schema' => [ + 'description' => 'Obtain the certificate immediately.'."\n" + ."\n" + .'- 0 - Issue the certificate asynchronously.'."\n" + ."\n" + .'- 1 - Issue the certificate immediately.'."\n" + ."\n" + .'- 2 - Issue the certificate immediately and return the CA certificate chain.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'EnableCrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include a CRL address.'."\n" + ."\n" + .'- 0 - No'."\n" + ."\n" + .'- 1 - Yes', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + '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' => '', + ], + ], + 'description' => 'The list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'maxItems' => 100, + 'description' => 'The list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. You can obtain this ID by calling the [ListResources](~~2716559~~) operation.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek****wia', + 'title' => '', + ], + ], + [ + 'name' => 'customIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom identifier.', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX068c-6f1b-6deb-8e32-3f8439a8XXX', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResponseV1<EnrollCertificateResultV2>', + 'description' => 'OpenApiResponseV1', + 'type' => 'object', + 'properties' => [ + 'Identifier' => [ + 'description' => 'The unique identifier of the certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'Certificate' => [ + 'description' => 'The content of the certificate.'."\n" + .'This is returned when Immediately is set to 1 or 2.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----'."\n" + .'MIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/'."\n" + .'...'."\n" + .'...'."\n" + .'...'."\n" + .'KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg=='."\n" + .'-----END CERTIFICATE-----', + 'title' => '', + ], + 'CertificateChain' => [ + 'description' => 'The CA certificate chain.'."\n" + .'This is returned when Immediately is set to 2.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----'."\n" + .'MIIBfzCCATGgAwIBAgIUfI5kSdcO2S0+LkpdL3b2VUJG10YwBQYDK2VwMDUxCzAJ'."\n" + .'...'."\n" + .'...'."\n" + .'...'."\n" + .'ZYYG'."\n" + .'-----END CERTIFICATE-----'."\n" + .'-----BEGIN CERTIFICATE-----'."\n" + .'MIIBczCCARgCAQAwgYoxFDASBgNVBAMMC2FsaXl1bi50ZXN0MQ0wCwYDVQQ'."\n" + .'...'."\n" + .'...'."\n" + .'...'."\n" + .'KL5cUmF'."\n" + .'-----END CERTIFICATE-----', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The serial number of the certificate.'."\n" + .'This is returned when Immediately is set to 1 or 2.', + 'type' => 'string', + 'example' => '084bde9cd233f0ddae33adc438cfbbbd****', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request. This is a unique identifier generated by Alibaba Cloud for the request. Use this ID to troubleshoot issues.', + 'type' => 'string', + 'example' => '12345678-1234-1234-1234-123456789ABC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Identifier\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/\\\\n...\\\\n...\\\\n...\\\\nKOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\\\\n-----END CERTIFICATE-----\\",\\n \\"CertificateChain\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIIBfzCCATGgAwIBAgIUfI5kSdcO2S0+LkpdL3b2VUJG10YwBQYDK2VwMDUxCzAJ\\\\n...\\\\n...\\\\n...\\\\nZYYG\\\\n-----END CERTIFICATE-----\\\\n-----BEGIN CERTIFICATE-----\\\\nMIIBczCCARgCAQAwgYoxFDASBgNVBAMMC2FsaXl1bi50ZXN0MQ0wCwYDVQQ\\\\n...\\\\n...\\\\n...\\\\nKL5cUmF\\\\n-----END CERTIFICATE-----\\",\\n \\"SerialNumber\\": \\"084bde9cd233f0ddae33adc438cfbbbd****\\",\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\"\\n}","type":"json"}]', + 'title' => 'CreateCustomCertificate', + 'description' => 'By default, the certificate subject is retrieved from the Certificate Signing Request (CSR). If you specify a certificate subject, the subject from the CSR is ignored and the specified subject is used to issue the certificate.'."\n" + ."\n" + .'You must specify the key usage or extended key usage based on your scenario. The following examples show common scenarios:'."\n" + ."\n" + .'- Server-side authentication certificate'."\n" + ."\n" + .'Key usage: digitalSignature, keyEncipherment'."\n" + ."\n" + .'Extended key usage: serverAuth'."\n" + ."\n" + .'- Client authentication certificate'."\n" + ."\n" + .'Key usage: digitalSignature, keyEncipherment'."\n" + ."\n" + .'Extended key usage: clientAuth'."\n" + ."\n" + .'- mTLS mutual authentication certificate'."\n" + ."\n" + .'Key usage: digitalSignature, keyEncipherment'."\n" + ."\n" + .'Extended key usage: serverAuth, clientAuth'."\n" + ."\n" + .'- Email signing certificate'."\n" + ."\n" + .'Key usage: digitalSignature, contentCommitment'."\n" + ."\n" + .'Extended key usage: emailProtection'."\n" + ."\n" + .'Note: Compliance CAs are managed by third-party authorities and do not support this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateCustomCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateCustomCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateExternalCACertificate' => [ + 'summary' => 'Creates and issues an external intermediate CA certificate using a Certificate Signing Request (CSR) and API parameters.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'title' => '', + 'description' => 'The ID of the external intermediate CA instance to enable.', + 'example' => 'cas_deposit-cn-1234abcd', + ], + ], + [ + 'name' => 'Csr', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'title' => '', + 'description' => 'Certificate Signing Request. The CSR can contain information such as the SubjectDN and custom extensions for the CA certificate. The CA generates the SubjectKeyIdentifier, AuthorityKeyIdentifier, and CRLDistributionPoints extensions. Any values for these extensions in the CSR are ignored.', + 'example' => '-----BEGIN CERTIFICATE REQUEST-----'."\n" + .'MIIBczCCARgCAQAwgYoxFDASBgNVBAMMC2FsaXl1bi50ZXN0MQ0wCwYDVQQ'."\n" + .'...'."\n" + .'vbIgMQIhAKHDWD6/WAMbtezAt4bysJ/BZIDz1jPWuUR5GV4TJ/mS'."\n" + .'-----END CERTIFICATE REQUEST-----'."\n", + ], + ], + [ + 'name' => 'Validity', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'title' => '', + 'description' => 'The certificate validity period. Supports relative and absolute time.'."\n" + ."\n" + .'> Relative time: Supports units of year, month, and day.'."\n" + ."\n" + .'- Year - y'."\n" + ."\n" + .'- Month - m'."\n" + ."\n" + .'- Day - d'."\n" + ."\n" + .'> Absolute time: Uses GMT. Format: `yyyy-MM-dd\'T\'HH:mm:ss\'Z\'`'."\n" + ."\n" + .'- Specify expiration time - `$NotAfter`'."\n" + ."\n" + .'- Specify start and expiration times - `$NotBefore/$NotAfter`', + 'example' => '10y', + ], + ], + [ + 'name' => 'ApiPassthrough', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Subject' => [ + 'type' => 'object', + 'properties' => [ + 'Country' => [ + 'type' => 'string', + 'title' => '', + 'description' => 'The country. Use the two-letter country code from ISO 3166-1.', + 'required' => false, + 'example' => 'CN', + ], + 'State' => [ + 'type' => 'string', + 'title' => '', + 'description' => 'The state or province.', + 'required' => false, + 'example' => 'Zhejiang', + ], + 'Locality' => [ + 'type' => 'string', + 'title' => '', + 'description' => 'The city or region.', + 'required' => false, + 'example' => 'Hangzhou', + ], + 'Organization' => [ + 'type' => 'string', + 'title' => '', + 'description' => 'The organization or company.', + 'required' => false, + 'example' => 'Alibaba', + ], + 'OrganizationUnit' => [ + 'type' => 'string', + 'title' => '', + 'description' => 'The subdivision within the organization, such as a department, team, project group, or branch.', + 'required' => false, + 'example' => 'Cloud Security', + ], + 'CommonName' => [ + 'type' => 'string', + 'title' => '', + 'description' => 'The name of the CA certificate.', + 'required' => false, + 'example' => 'Testing CA', + ], + ], + 'title' => '', + 'description' => 'The subject information for the CA certificate. If this value is specified, it overwrites the SubjectDN in the CSR.', + 'required' => false, + 'example' => '', + ], + 'Extensions' => [ + 'type' => 'object', + 'properties' => [ + 'PathLenConstraint' => [ + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'description' => 'The certificate path length constraint. For an EndEntity CA, this value must be 0. This indicates that the CA certificate is used to issue end-entity certificates.', + 'required' => false, + 'example' => '0', + ], + 'ExtendedKeyUsages' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'Allowed values:'."\n" + ."\n" + .'- any - No restrictions'."\n" + ."\n" + .'- serverAuth - Server authentication'."\n" + ."\n" + .'- clientAuth - Client authentication'."\n" + ."\n" + .'- codeSigning - Code signing'."\n" + ."\n" + .'- emailProtection - Email protection'."\n" + ."\n" + .'- timeStamping - Timestamping'."\n" + ."\n" + .'- OCSPSigning - OCSP signing'."\n" + ."\n" + .'- Other extended key usage OIDs', + 'required' => false, + 'enumValueTitles' => [ + 'codeSigning' => 'codeSigning', + 'emailProtection' => 'emailProtection', + 'serverAuth' => 'serverAuth', + 'timeStamping' => 'timeStamping', + 'any' => 'any', + 'clientAuth' => 'clientAuth', + 'OCSPSigning' => 'OCSPSigning', + ], + 'title' => '', + 'example' => 'serverAuth', + ], + 'title' => '', + 'description' => 'Extended key usages.', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'CA certificate extensions. If this value is specified, it overwrites the extension values in the CSR or adds them to the CA certificate extensions.', + 'required' => false, + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'Use API parameters to overwrite CSR content or add it to the CA certificate.', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'description' => 'The tag key.', + 'title' => '', + 'required' => false, + 'example' => 'database', + ], + 'Value' => [ + 'type' => 'string', + 'description' => 'The tag value.', + 'title' => '', + 'required' => false, + 'example' => '1', + ], + ], + 'description' => 'A list of tags.', + 'title' => '', + 'example' => '', + 'required' => false, + ], + 'maxItems' => 100, + 'description' => 'A list of tags.', + 'title' => '', + 'example' => '', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The ID of the resource group.', + 'title' => '', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + 'description' => 'The ID of the request.', + 'title' => '', + 'example' => '12345678-1234-1234-1234-123456789ABC', + ], + 'Identifier' => [ + 'type' => 'string', + 'description' => 'The unique identifier of the certificate.', + 'title' => '', + 'example' => '1ed4068c-6f1b-6deb-8e32-3f8439a851cb', + ], + 'Certificate' => [ + 'type' => 'string', + 'description' => 'The content of the certificate.', + 'title' => '', + 'example' => '-----BEGIN CERTIFICATE-----'."\n" + .'MIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/'."\n" + .'...'."\n" + .'...'."\n" + .'...'."\n" + .'KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg=='."\n" + .'-----END CERTIFICATE-----'."\n", + ], + 'CertificateChain' => [ + 'type' => 'string', + 'description' => 'The CA certificate chain.', + 'title' => '', + 'example' => '-----BEGIN CERTIFICATE-----'."\n" + .'...'."\n" + .'...'."\n" + .'-----END CERTIFICATE-----'."\n" + .'-----BEGIN CERTIFICATE-----'."\n" + .'...'."\n" + .'...'."\n" + .'-----END CERTIFICATE-----'."\n", + ], + ], + 'title' => '', + 'description' => 'OpenApiResponse', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'CreateExternalCACertificate', + 'description' => '## Description'."\n" + ."\n" + .'- This API operation creates an external intermediate CA certificate using a provided CSR and optional API pass-through parameters.'."\n" + ."\n" + .'- The `InstanceId` parameter is required. This parameter specifies the ID of the external intermediate CA instance that you want to use.'."\n" + ."\n" + .'- The `Csr` parameter must contain a valid CSR.'."\n" + ."\n" + .'- The `Validity` parameter specifies the certificate validity period. You can set this parameter to a value in a relative or absolute time format.'."\n" + ."\n" + .'- You can use the `ApiPassthrough` parameter to overwrite information in the CSR or add certificate extensions, such as subject information.'."\n" + ."\n" + .'- Note: For end-entity CA certificates, set the `pathLenConstraint` parameter to 0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateExternalCACertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\",\\n \\"Identifier\\": \\"1ed4068c-6f1b-6deb-8e32-3f8439a851cb\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/\\\\n...\\\\n...\\\\n...\\\\nKOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\\\\n-----END CERTIFICATE-----\\\\n\\",\\n \\"CertificateChain\\": \\"-----BEGIN CERTIFICATE-----\\\\n...\\\\n...\\\\n-----END CERTIFICATE-----\\\\n-----BEGIN CERTIFICATE-----\\\\n...\\\\n...\\\\n-----END CERTIFICATE-----\\\\n\\"\\n}","type":"json"}]', + ], + 'CreateRevokeClientCertificate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83506', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the client or server certificate to revoke.'."\n" + ."\n" + .'> Call [ListClientCertificate](~~465990~~) to query the unique identifiers of all client and server certificates.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SuccessResponse', + 'description' => 'SuccessResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'CreateRevokeClientCertificate', + 'summary' => 'Revokes a client certificate or a server certificate.', + 'description' => 'After a client or server certificate is revoked, the client or server where the certificate is installed cannot establish HTTPS connections with other devices.'."\n" + ."\n" + .'After a client or server certificate is revoked, you can call [DeleteClientCertificate](~~465981~~) to permanently delete the certificate.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The limit on queries per second (QPS) for this operation is 10 per user. If you exceed this limit, API calls are throttled, which can affect your business. Plan your API calls accordingly.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRevokeClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateRevokeClientCertificate', + '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"}]', + ], + 'CreateRootCACertificate' => [ + 'summary' => 'Creates a root CA certificate.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83507', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CommonName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The common name or abbreviation of the organization. Supports Chinese characters and letters.', + 'type' => 'string', + 'required' => true, + 'example' => 'Alibaba', + 'title' => '', + ], + ], + [ + 'name' => 'OrganizationUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the department or branch in the organization. Supports Chinese characters and letters.', + 'type' => 'string', + 'required' => true, + 'example' => 'Security', + 'title' => '', + ], + ], + [ + 'name' => 'Organization', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the organization for the root CA certificate. This is typically your company or enterprise name. Supports Chinese characters and letters.', + 'type' => 'string', + 'required' => true, + 'example' => 'Aliyun', + 'title' => '', + ], + ], + [ + 'name' => 'Locality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the city where the organization is located. Supports Chinese characters and letters.', + 'type' => 'string', + 'required' => true, + 'example' => 'Hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="intl">The name of the province or state where the organization is located. Supports Chinese characters and letters.</props>', + 'type' => 'string', + 'required' => true, + 'example' => 'Zhejiang', + 'title' => '', + ], + ], + [ + 'name' => 'CountryCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The two-letter uppercase code of the country or region where the organization is located. For example, **CN** indicates China and **US** indicates the United States.'."\n" + ."\n" + .'For more information about country codes, see the **Country codes** section in [Manage company information](~~198289~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'title' => '', + ], + ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key algorithm of the root CA certificate. The key algorithm is in the `<encryption algorithm>_<key length>` format. 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 root CA certificate must be the same as the **Certificate Algorithm** of the private root CA that you purchased. For example, if you set **Certificate Algorithm** to **RSA** when you purchase a private root CA, the key algorithm of the root CA certificate must be **RSA\\_1024**, **RSA\\_2048**, or **RSA\\_4096**.', + 'type' => 'string', + 'required' => false, + 'example' => 'RSA_2048', + 'title' => '', + ], + ], + [ + 'name' => 'Years', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the root CA certificate. Unit: years.'."\n" + ."\n" + .'> Set the validity period to 5 to 10 years.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token to ensure the idempotence of the request.'."\n" + ."\n" + .'Generate a unique value for this parameter from your client. The token supports only ASCII characters.'."\n" + ."\n" + .'> If you do not specify this parameter, the system uses the **RequestId** of the request as the **ClientToken**. The **RequestId** may be different for each request.', + 'type' => 'string', + 'required' => false, + 'example' => '3838B684-3075-582B-9A45-8C99104029DF', + 'title' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + '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' => '', + ], + ], + 'description' => 'The list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'maxItems' => 100, + 'description' => 'The list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek****wia', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResponse<CreateCaCertificateResult>', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The unique ID of the request. You can use this ID to troubleshoot issues.', + 'type' => 'string', + 'example' => '6D9B4C5F-7140-5B41-924C-329181DC00C1', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the created root CA certificate.', + 'type' => 'string', + 'example' => '1a83bcbb89e562885e40aa0108f5****', + 'title' => '', + ], + 'Certificate' => [ + 'description' => 'The created root certificate in PEM format.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----', + 'title' => '', + ], + 'CertificateChain' => [ + 'description' => 'The CA certificate chain of the created root certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'CreateRootCACertificate', + 'description' => 'This operation creates a self-signed root CA certificate. A root CA certificate is the starting point of a private trust chain within an enterprise. After you create a root CA certificate, you can use it to issue intermediate CA certificates. You can then use the intermediate CA certificates to issue client and server-side certificates.'."\n" + ."\n" + .'Before calling this operation, purchase a private root CA in the [SSL Certificate Service console](https://yundun.console.aliyun.com/?p=cas#/pca/rootlist). Otherwise, the call fails. For more information, see [Purchase a private CA](~~208553~~).'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The queries per second (QPS) limit for this operation is 10 calls per second per user. If you exceed the limit, API calls are throttled, which may affect your business. Call the API at a reasonable rate.', + 'requestParamsDescription' => 'When you call this operation, specify the common request parameters and the operation-specific parameters. For more information about the request format, see the request example in the **Examples** section of this topic.'."\n" + ."\n" + .'For the API request format, see the example in the **Example** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRootCACertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateRootCACertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D9B4C5F-7140-5B41-924C-329181DC00C1\\",\\n \\"Identifier\\": \\"1a83bcbb89e562885e40aa0108f5****\\",\\n \\"Certificate\\": \\"-----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"}]', + ], + 'CreateServerCertificate' => [ + 'summary' => 'Issues a server-side certificate using a system-generated Certificate Signing Request (CSR).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83508', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The additional domain names and IP addresses for the server certificate. This information lets you apply the certificate to multiple domain names and IP addresses.'."\n" + ."\n" + .'Separate multiple domain names or IP addresses with a comma (,).', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + 'title' => '', + ], + ], + [ + 'name' => 'Organization', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the organization. The default value is Alibaba Inc.', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云', + 'title' => '', + ], + ], + [ + 'name' => 'OrganizationUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the department. The default value is Alibaba Cloud CDN.', + 'type' => 'string', + 'required' => false, + 'example' => 'IT', + 'title' => '', + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'description' => 'The country code, such as CN or US.', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'title' => '', + ], + ], + [ + 'name' => 'CommonName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the certificate user. For a server authentication (ServerAuth) certificate, the user is the server. Enter the domain name or IP address that is bound to the server.', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + 'title' => '', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The province or state where the organization is located. Chinese and English characters are supported. The default value is the province or state of the organization that is associated with the subordinate CA certificate that issues this certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'Zhejiang', + 'title' => '', + ], + ], + [ + 'name' => 'Locality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The city where the organization is located. Chinese and English characters are supported.'."\n" + .'The default value is the city of the organization that is associated with the subordinate CA certificate that issues this certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'Hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key algorithm of the server certificate. The algorithm is in the `<encryption algorithm>_<key length>` format. 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 server certificate must be the same as the encryption algorithm of the subordinate CA certificate, but the key length can be different. For example, if the key algorithm of the subordinate CA certificate is RSA\\_2048, the key algorithm of the server certificate must be RSA\\_1024, RSA\\_2048, or RSA\\_4096.'."\n" + ."\n" + .'> Call [DescribeCACertificate](~~465954~~) to query the key algorithm of the subordinate CA certificate.', + 'type' => 'string', + 'required' => true, + 'example' => 'RSA_2048', + 'title' => '', + ], + ], + [ + 'name' => 'ParentIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the subordinate CA certificate that issues this certificate.'."\n" + ."\n" + .'> Call [DescribeCACertificateList](~~465957~~) to query the unique identifier of the subordinate CA certificate.', + 'type' => 'string', + 'required' => true, + 'example' => '271ae6bb538d538c70c01f81dg3****', + 'title' => '', + ], + ], + [ + 'name' => 'Years', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the certificate, in years.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Months', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the certificate, in months.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + 'title' => '', + ], + ], + [ + 'name' => 'Days', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the server certificate, in days.'."\n" + .'The **Days**, **BeforeTime**, and **AfterTime** parameters cannot all be empty. The **BeforeTime** and **AfterTime** parameters must be specified together or left empty together. The following rules describe how to set these parameters:'."\n" + ."\n" + .'- If you specify **Days**, the **BeforeTime** and **AfterTime** parameters are optional.'."\n" + ."\n" + .'- If you do not specify **Days**, you must specify both **BeforeTime** and **AfterTime**.'."\n" + ."\n" + .'> * If you specify **Days**, **BeforeTime**, and **AfterTime** at the same time, the value of **Days** determines the validity period of the server certificate.'."\n" + ."\n" + .'- The validity period of the server certificate cannot exceed the validity period of the subordinate CA certificate. You can call [DescribeCACertificate](~~465954~~) to view the validity period of the subordinate CA certificate.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '365', + 'title' => '', + ], + ], + [ + 'name' => 'BeforeTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The issuance time of the server certificate. This value is a UNIX timestamp in seconds. The default value is the time when you call this operation.'."\n" + ."\n" + .'> The **BeforeTime** and **AfterTime** parameters must be specified together or left empty together.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1634283958', + 'title' => '', + ], + ], + [ + 'name' => 'AfterTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration time of the server certificate. This value is a UNIX timestamp in seconds.'."\n" + ."\n" + .'> The **BeforeTime** and **AfterTime** parameters must be specified together or left empty together.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1665819958', + 'title' => '', + ], + ], + [ + 'name' => 'Immediately', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the digital certificate immediately.'."\n" + ."\n" + .'- **0**: No. This is the default value.'."\n" + ."\n" + .'- **1**: Returns the certificate.'."\n" + ."\n" + .'- **2**: Returns the certificate and its certificate chain.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'EnableCrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include the Certificate Revocation List (CRL) address.'."\n" + ."\n" + .'0: No'."\n" + ."\n" + .'1: Yes', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.', + 'type' => 'string', + 'required' => false, + 'example' => 'account', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The tag value.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + 'description' => 'A list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'maxItems' => 100, + 'description' => 'A list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. Call the [ListResources](~~2716559~~) operation to get this ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'CustomIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom identifier. This key must be unique.', + 'type' => 'string', + 'required' => false, + 'example' => '****6bb538d538c70c01f81dg3****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'CreateCertificateResponse<CertificateIdentifierWithParentDTO>', + 'description' => 'CreateCertificateResponse', + 'type' => 'object', + 'properties' => [ + 'X509Certificate' => [ + 'description' => 'The content of the server certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----', + 'title' => '', + ], + 'CertificateChain' => [ + 'description' => 'The CA certificate chain.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the server certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The serial number of the certificate.', + 'type' => 'string', + 'example' => '084bde9cd233f0ddae33adc438cfbbbd****', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud. Use this ID to troubleshoot issues.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\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 \\"Identifier\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"SerialNumber\\": \\"084bde9cd233f0ddae33adc438cfbbbd****\\",\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + 'title' => 'CreateServerCertificate', + 'description' => 'Before you call this operation, you must call [CreateRootCACertificate](~~465962~~) to create a root certificate authority (CA) certificate and [CreateSubCACertificate](~~465975~~) to create a subordinate CA certificate. Only a subordinate CA certificate can issue a server certificate.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed this limit, the system throttles your API calls, which can affect your business. Plan your calls accordingly.', + 'requestParamsDescription' => 'When you call this operation, you must include the common request parameters in addition to the request parameters described in this topic.'."\n" + ."\n" + .'For information about the request format, see the request example in the **Examples** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateServerCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateServerCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateServerCertificateWithCsr' => [ + 'summary' => 'Issues a server-side certificate based on a custom Certificate Signing Request (CSR).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83509', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Csr', + 'in' => 'query', + 'schema' => [ + 'description' => 'You can generate a CSR using OpenSSL or Keytool. For more information, see [How to create a CSR file](~~42218~~).'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'You can also create a CSR in the SSL Certificate console. For more information, see [Create a CSR](~~313297~~).'."\n" + ."\n" + .'</props>', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----', + 'title' => '', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => 'Additional domain names or IP addresses for the server-side certificate. Adding this information lets you apply the certificate to multiple domains or IP addresses.'."\n" + ."\n" + .'You can enter multiple domain names and IP addresses. Separate them with commas (,).', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + 'title' => '', + ], + ], + [ + 'name' => 'Organization', + 'in' => 'query', + 'schema' => [ + 'description' => 'Organization name. Default: Alibaba Inc.', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云', + 'title' => '', + ], + ], + [ + 'name' => 'OrganizationUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Department name. Default: Aliyun CDN.', + 'type' => 'string', + 'required' => false, + 'example' => 'IT', + 'title' => '', + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'description' => 'Country code, such as **CN**.', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'title' => '', + ], + ], + [ + 'name' => 'CommonName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set the common name for the certificate. Supports Chinese, English, and other characters.'."\n" + ."\n" + .'> If you set the **Csr** parameter, the value of **CommonName** comes from the corresponding field in the **Csr** parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'mtcsq.com', + 'title' => '', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="china">Set the name of the province, municipality, or autonomous region where the organization is located. Supports Chinese, English, and other characters. Defaults to the province, municipality, or autonomous region of the issuing sub-CA certificate\'s organization.</props>'."\n" + .'<props="intl">Set the name of the state or province where the organization is located. Supports Chinese, English, and other characters. Defaults to the state or province of the issuing sub-CA certificate\'s organization.</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'Zhejiang', + 'title' => '', + ], + ], + [ + 'name' => 'Locality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The city where the organization for the certificate is located. The name can contain both Chinese and English characters. By default, this parameter is set to the city of the organization for the issuing subordinate Certificate Authority (CA).', + 'type' => 'string', + 'required' => false, + 'example' => 'Hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => 'Key algorithm for the server-side certificate. Use the format `<encryption algorithm>_<key length>`. Valid values:'."\n" + ."\n" + .'- **RSA\\_1024**: Signature algorithm is Sha256WithRSA.'."\n" + ."\n" + .'- **RSA\\_2048**: Signature algorithm is Sha256WithRSA.'."\n" + ."\n" + .'- **RSA\\_4096**: Signature algorithm is Sha256WithRSA.'."\n" + ."\n" + .'- **ECC\\_256**: Signature algorithm is Sha256WithECDSA.'."\n" + ."\n" + .'- **ECC\\_384**: Signature algorithm is Sha256WithECDSA.'."\n" + ."\n" + .'- **ECC\\_512**: Signature algorithm is Sha256WithECDSA.'."\n" + ."\n" + .'- **SM2\\_256**: Signature algorithm is SM3WithSM2.'."\n" + ."\n" + .'The encryption algorithm of the server-side certificate must match that of the sub-CA certificate. The key length can differ. For example, if the sub-CA certificate uses RSA\\_2048, the server-side certificate must use RSA\\_1024, RSA\\_2048, or RSA\\_4096.'."\n" + ."\n" + .'> Call [DescribeCACertificate](~~465954~~) to check the key algorithm of the sub-CA certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'RSA_2048', + 'title' => '', + ], + ], + [ + 'name' => 'ParentIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier of the sub-CA certificate that issues this certificate.'."\n" + ."\n" + .'> Call [DescribeCACertificateList](~~465957~~) to query the unique identifier of the sub-CA certificate.', + 'type' => 'string', + 'required' => true, + 'example' => '270oe6bb538d538c70c01f81hfd3****', + 'title' => '', + ], + ], + [ + 'name' => 'Years', + 'in' => 'query', + 'schema' => [ + 'description' => 'Certificate validity period. Unit: years.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Months', + 'in' => 'query', + 'schema' => [ + 'description' => 'Certificate validity period. Unit: months.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + 'title' => '', + ], + ], + [ + 'name' => 'Days', + 'in' => 'query', + 'schema' => [ + 'description' => 'The **Days**, **BeforeTime**, and **AfterTime** parameters cannot all be empty. The **BeforeTime** and **AfterTime** parameters must both be empty or both set. Follow these rules:'."\n" + ."\n" + .'- If you set **Days**, you can optionally set **BeforeTime** and **AfterTime**.'."\n" + ."\n" + .'- If you do not set **Days**, you must set both **BeforeTime** and **AfterTime**.'."\n" + ."\n" + .'> * If you set **Days**, **BeforeTime**, and **AfterTime** together, the validity period uses the value of **Days**.'."\n" + ."\n" + .'- The server-side certificate validity period cannot exceed that of the sub-CA certificate. Call [DescribeCACertificate](~~465954~~) to check the sub-CA certificate validity period.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '365', + 'title' => '', + ], + ], + [ + 'name' => 'BeforeTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Issue time of the server-side certificate, in UNIX timestamp format. Default: current time when you call this API. Unit: seconds.'."\n" + ."\n" + .'> The **BeforeTime** and **AfterTime** parameters must both be empty or both configured.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1634283958', + 'title' => '', + ], + ], + [ + 'name' => 'AfterTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Expiration time of the server-side certificate, in UNIX timestamp format. Unit: seconds.'."\n" + ."\n" + .'> The **BeforeTime** and **AfterTime** parameters must both be empty or both configured.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1665819958', + 'title' => '', + ], + ], + [ + 'name' => 'Immediately', + 'in' => 'query', + 'schema' => [ + 'description' => 'Return the digital certificate immediately.'."\n" + ."\n" + .'- **0**: Do not return. Default.'."\n" + ."\n" + .'- **1**: Return the certificate.'."\n" + ."\n" + .'- **2**: Return the certificate and its certificate chain.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'EnableCrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Include CRL address.'."\n" + ."\n" + .'0 - No'."\n" + ."\n" + .'1 - Yes', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag key.', + 'type' => 'string', + 'required' => false, + 'example' => 'account', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Tag value.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + 'description' => 'List of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'maxItems' => 100, + 'description' => 'List of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek****wia', + 'title' => '', + ], + ], + [ + 'name' => 'CustomIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'Custom identifier. Unique key.', + 'type' => 'string', + 'required' => false, + 'example' => '***e6bb538d538c70c01f81hfd3****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'CreateCertificateResponse<CertificateIdentifierWithParentDTO>', + 'description' => 'CreateCertificateResponse', + 'type' => 'object', + 'properties' => [ + 'X509Certificate' => [ + 'description' => 'Content of the server-side certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----', + 'title' => '', + ], + 'CertificateChain' => [ + 'description' => 'CA certificate chain.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'Unique identifier of the server-side certificate.', + 'type' => 'string', + 'example' => '180ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'Certificate serial number.', + 'type' => 'string', + 'example' => '084bde9cd233f0ddae33adc438cfbbbd****', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID generated by Alibaba Cloud for this call. Use it to troubleshoot issues.', + 'type' => 'string', + 'example' => '55C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\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 \\"Identifier\\": \\"180ae6bb538d538c70c01f81dcf2****\\",\\n \\"SerialNumber\\": \\"084bde9cd233f0ddae33adc438cfbbbd****\\",\\n \\"RequestId\\": \\"55C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + 'title' => 'CreateServerCertificateWithCsr', + 'description' => 'Before you call this operation, you must call [CreateRootCACertificate](~~465962~~) to create a root CA certificate and [CreateSubCACertificate](~~465959~~) to create a subordinate CA certificate. Server-side certificates can be issued only by subordinate CA certificates.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'This operation has a queries per second (QPS) limit of 10 requests per user. If you exceed this limit, rate limiting is triggered, which may affect your business. Call this operation only as needed.', + 'requestParamsDescription' => 'When you call this operation, you must include the common request parameters for Alibaba Cloud APIs in addition to the parameters that are described in this topic.'."\n" + ."\n" + .'For information about the request format, see the **Examples** section.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateServerCertificateWithCsr', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateServerCertificateWithCsr', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateSubCACertificate' => [ + 'summary' => 'Creates an intermediate certificate authority (CA) certificate.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83510', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ParentIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the root CA certificate.'."\n" + ."\n" + .'> Call the [DescribeCACertificateList](~~465957~~) operation to get the unique identifiers of all CA certificates.', + 'type' => 'string', + 'required' => false, + 'example' => '1a83bcbb89e562885e40aa0108f5****', + 'title' => '', + ], + ], + [ + 'name' => 'CommonName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The common name of your organization. The name can contain Chinese characters and English letters.', + 'type' => 'string', + 'required' => true, + 'example' => 'Aliyun', + 'title' => '', + ], + ], + [ + 'name' => 'OrganizationUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the department in your organization. The name can contain Chinese characters and English letters.', + 'type' => 'string', + 'required' => true, + 'example' => 'Security', + 'title' => '', + ], + ], + [ + 'name' => 'Organization', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of your organization, such as your company. The name can contain Chinese characters and English letters.', + 'type' => 'string', + 'required' => true, + 'example' => 'Alibaba', + 'title' => '', + ], + ], + [ + 'name' => 'Locality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the city where your organization is located. The name can contain Chinese characters and English letters.', + 'type' => 'string', + 'required' => true, + 'example' => 'Hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="china">The name of the province, municipality, or autonomous region where the organization is located. Chinese characters and English letters are supported.</props>'."\n" + .'<props="intl">The name of the province or state where the organization is located. Chinese characters and English letters are supported.</props>', + 'type' => 'string', + 'required' => true, + 'example' => 'Zhejiang', + 'title' => '', + ], + ], + [ + 'name' => 'CountryCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The two- or three-letter country or region code in uppercase. For example, **CN** indicates China and **US** indicates the United States.'."\n" + ."\n" + .'For more information, see the **Country codes** section in [Manage company information](~~198289~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'title' => '', + ], + ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key algorithm for the intermediate CA certificate. The algorithm is in the `<Encryption algorithm>_<Key length>` format. 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" + .'- **SM2\\_256**: The corresponding signature algorithm is SM3WithSM2.'."\n" + ."\n" + .'The encryption algorithm of the intermediate CA certificate must be the same as that of the root CA certificate, but the key length can be different. For example, if the root CA certificate uses the **RSA\\_2048** algorithm, the intermediate CA certificate must use **RSA\\_1024**, **RSA\\_2048**, or **RSA\\_4096**.'."\n" + ."\n" + .'> Call the [DescribeCACertificate](~~465954~~) operation to get the key algorithm of the root CA certificate.', + 'type' => 'string', + 'required' => true, + 'example' => 'RSA_2048', + 'title' => '', + ], + ], + [ + 'name' => 'Years', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the intermediate CA certificate, in years. Valid values: 5 to 10.'."\n" + ."\n" + .'Set this parameter to a value from 5 to 10.'."\n" + ."\n" + .'> The validity period of the intermediate CA certificate cannot exceed that of the root CA certificate. Call the [DescribeCACertificate](~~465954~~) operation to get the validity period of the root CA certificate.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '5', + 'title' => '', + ], + ], + [ + 'name' => 'PathLenConstraint', + 'in' => 'query', + 'schema' => [ + 'description' => 'The certificate path length constraint. The default value is 0.', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'ExtendedKeyUsages', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The extended key usages.', + 'type' => 'array', + 'items' => [ + 'description' => 'The extended key usage. Valid values:'."\n" + ."\n" + .'- any'."\n" + ."\n" + .'- serverAuth'."\n" + ."\n" + .'- clientAuth'."\n" + ."\n" + .'- codeSigning'."\n" + ."\n" + .'- emailProtection'."\n" + ."\n" + .'- timeStamping'."\n" + ."\n" + .'- OCSPSigning'."\n" + ."\n" + .'- Other extended key usage object identifiers (OIDs).', + 'enumValueTitles' => [ + 'codeSigning' => 'Code signing', + 'emailProtection' => 'Email protection', + 'serverAuth' => 'Server authentication', + 'timeStamping' => 'Timestamping', + 'any' => 'Any', + 'clientAuth' => 'Client authentication', + 'OCSPSigning' => 'OCSP signing', + ], + 'type' => 'string', + 'required' => false, + 'example' => 'serverAuth', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'EnableCrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the certificate revocation list (CRL) feature.'."\n" + ."\n" + .'- false: No'."\n" + ."\n" + .'- true: Yes', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'CrlDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the CRL, in days. Valid values: 1 to 365.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + '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' => 'test', + 'title' => '', + ], + ], + 'description' => 'A list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'maxItems' => 100, + 'description' => 'A list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae****vty', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A client-generated token that is used to ensure the idempotence of the request. The token must be unique for each request. The token can be up to 64 ASCII characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResponse<CreateCaCertificateResult>', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the intermediate CA certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'Certificate' => [ + 'description' => 'The certificate returned by this call, in PEM format.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----', + 'title' => '', + ], + 'CertificateChain' => [ + 'description' => 'The CA certificate chain of the certificate that is returned by the call.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Identifier\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"Certificate\\": \\"-----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"}]', + 'title' => 'CreateSubCACertificate', + 'description' => 'This operation issues an intermediate certificate authority (CA) certificate from an existing root CA certificate. You can use the intermediate CA certificate to issue client and server certificates.'."\n" + ."\n" + .'Before calling this operation, you must call the [CreateRootCACertificate](~~465962~~) operation to create a root CA certificate.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The queries per second (QPS) limit for this operation is 10 calls per user. Calls that exceed this limit are throttled. This may affect your business. Plan your calls accordingly.', + 'responseParamsDescription' => '- serverAuth: Server authentication'."\n" + ."\n" + .'- clientAuth: Client authentication'."\n" + ."\n" + .'- codeSigning: Code signing'."\n" + ."\n" + .'- emailProtection: Email protection'."\n" + ."\n" + .'- timeStamping: Timestamping'."\n" + ."\n" + .'- OCSPSigning: OCSP signing'."\n" + ."\n" + .'- Other extended key usage OIDs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateSubCACertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateSubCACertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteClientCertificate' => [ + 'summary' => 'Deletes a revoked client or server-side certificate.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83511', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the client or server-side certificate to delete. The certificate must be in the **REVOKE** state.'."\n" + ."\n" + .'> Call [ListClientCertificate](~~465990~~) to query the unique identifiers and current states of all client and server-side certificates.', + 'type' => 'string', + 'required' => true, + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SuccessResponse', + 'description' => 'SuccessResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DeleteClientCertificate', + 'description' => 'Before you call this operation, you must call [CreateRevokeClientCertificate](~~465972~~) to revoke the client or server-side certificate.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'This operation supports up to 10 queries per second (QPS) for each user. If you exceed the limit, API calls are throttled. This may affect your business. Plan your calls accordingly.', + 'requestParamsDescription' => 'When you call this operation, you must include the common request parameters of Alibaba Cloud APIs in addition to the parameters described in this topic. For more information, see [Common parameters](~~327167~~).'."\n" + ."\n" + .'For information about the request format, see the request example in the **Examples** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'yundun-cert:DeleteClientCertificate', + '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"}]', + ], + 'DescribeCACertificate' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83512', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + 'FEATUREcasFBEHXR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the CA certificate to query.'."\n" + ."\n" + .'> Call [DescribeCACertificateList](~~465957~~) to query the unique identifiers of all CA certificates.', + 'type' => 'string', + 'required' => false, + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DescribeCertificateResponse<CaCertificateDTO>', + 'description' => 'DescribeCertificateResponse.', + 'type' => 'object', + 'properties' => [ + 'Certificate' => [ + 'description' => 'The details of the CA certificate.', + 'type' => 'object', + 'properties' => [ + 'CertificateType' => [ + 'description' => 'The type of the CA certificate. Valid values:'."\n" + ."\n" + .'- **ROOT**: A root CA certificate.'."\n" + ."\n" + .'- **SUB\\_ROOT**: A subordinate CA certificate.', + 'type' => 'string', + 'example' => 'SUB_ROOT', + 'title' => '', + ], + 'X509Certificate' => [ + 'description' => 'The content of the CA certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the CA certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The serial number of the CA certificate.', + 'type' => 'string', + 'example' => '70e3b2566d92805173767869727fb92e****', + 'title' => '', + ], + 'SubjectDN' => [ + 'description' => 'The subject of the CA certificate. It contains the following information:'."\n" + ."\n" + .'- **C**: The country code of the organization.'."\n" + ."\n" + .'- **O**: The name of the organization.'."\n" + ."\n" + .'- **OU**: The department of the organization.'."\n" + ."\n" + .'- **L**: The city where the organization is located.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **ST**: The province, municipality, or autonomous region where the organization is located.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- **ST**: The province or state where the organization is located.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'- **CN**: The common name or abbreviation of the organization.', + 'type' => 'string', + 'example' => 'C=CN,O=aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun', + 'title' => '', + ], + 'CommonName' => [ + 'description' => 'The common name or abbreviation of the organization that is associated with the CA certificate.', + 'type' => 'string', + 'example' => 'Aliyun', + 'title' => '', + ], + 'OrganizationUnit' => [ + 'description' => 'The name of the department in the organization that is associated with the CA certificate.', + 'type' => 'string', + 'example' => 'Security', + 'title' => '', + ], + 'Organization' => [ + 'description' => 'The name of the organization that is associated with the CA certificate.', + 'type' => 'string', + 'example' => 'aliyun', + 'title' => '', + ], + 'Locality' => [ + 'description' => 'The name of the city where the organization associated with the CA certificate is located.', + 'type' => 'string', + 'example' => 'Hangzhou', + 'title' => '', + ], + 'State' => [ + 'description' => '<props="china">The name of the province, municipality, or autonomous region where the organization associated with the CA certificate is located.</props>'."\n" + .'<props="intl">The name of the province or state where the organization associated with the CA certificate is located.</props>', + 'type' => 'string', + 'example' => 'Zhejiang', + 'title' => '', + ], + 'CountryCode' => [ + 'description' => 'The country code of the organization that is associated with the CA certificate.'."\n" + ."\n" + .'For more information about country codes, see the **International codes** section in [Manage company information](~~198289~~).', + 'type' => 'string', + 'example' => 'CN', + 'title' => '', + ], + 'Sans' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the CA certificate. Valid values:'."\n" + ."\n" + .'- **ISSUE**: The certificate is issued.'."\n" + ."\n" + .'- **REVOKE**: The certificate is revoked.', + 'type' => 'string', + 'example' => 'ISSUE', + 'title' => '', + ], + 'Algorithm' => [ + 'description' => 'The type of the encryption algorithm of the CA 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' => '', + ], + 'KeySize' => [ + 'description' => 'The key length of the CA certificate.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2048', + 'title' => '', + ], + 'SignAlgorithm' => [ + 'description' => 'The signature algorithm of the CA certificate.', + 'type' => 'string', + 'example' => 'SHA256WITHRSA', + 'title' => '', + ], + 'BeforeDate' => [ + 'description' => 'The date when the CA certificate was issued. This is a UNIX timestamp. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1634283958000', + 'title' => '', + ], + 'AfterDate' => [ + 'description' => 'The date when the CA certificate expires. This is a UNIX timestamp. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1665819958000', + 'title' => '', + ], + 'ParentIdentifier' => [ + 'description' => 'The unique identifier of the root CA certificate that issued the CA certificate.'."\n" + ."\n" + .'> This parameter is returned only when **CertificateType** is **SUB\\_ROOT**, which indicates a subordinate CA certificate.', + 'type' => 'string', + 'example' => '1a83bcbb89e562885e40aa0108f5****', + 'title' => '', + ], + 'Sha2' => [ + 'description' => 'The SHA-256 fingerprint of the CA certificate.', + 'type' => 'string', + 'example' => '14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****', + 'title' => '', + ], + 'Md5' => [ + 'description' => 'The MD5 fingerprint of the CA certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'CrlStatus' => [ + 'description' => 'The status of the Certificate Revocation List (CRL).', + 'type' => 'string', + 'example' => 'ACTIVE', + 'title' => '', + ], + 'CrlUrl' => [ + 'description' => 'The CRL URL.', + 'type' => 'string', + 'example' => 'https://crl-cn-publish.oss-cn-hangzhou.aliyuncs.com/pca/crl/1925647866611395/1ed40789-483f-6023-b6b8-29ddd3bb0a9a.crl', + 'title' => '', + ], + 'CertTotalCount' => [ + 'description' => 'The total certificate quota you purchased.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + 'title' => '', + ], + 'CertRemainingCount' => [ + 'description' => 'The number of remaining certificates that can be issued.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'title' => '', + ], + 'CertIssuedCount' => [ + 'description' => 'The number of certificates that the private CA instance has issued.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'title' => '', + ], + 'CaCertChain' => [ + 'description' => 'The complete certificate chain.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----'."\n" + .'-----END CERTIFICATE-----'."\n" + ."\n" + .'-----BEGIN CERTIFICATE-----'."\n" + .'-----END CERTIFICATE-----'."\n" + ."\n" + .'-----BEGIN CERTIFICATE-----'."\n" + .'-----END CERTIFICATE-----', + 'title' => '', + ], + 'CrlDay' => [ + 'description' => 'The validity period of the CRL. Valid values: 1 to 365. Unit: days.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + 'title' => '', + ], + 'IssuerType' => [ + 'description' => 'The issuer of the CA. Valid values:'."\n" + ."\n" + .'- local: A private certificate.'."\n" + ."\n" + .'- iTrusChina: A compliance CA.'."\n" + ."\n" + .'- external: An imported certificate.', + 'type' => 'string', + 'example' => 'local', + 'title' => '', + ], + 'Years' => [ + 'description' => 'The validity period of the CA certificate. Unit: years.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'FullAlgorithm' => [ + 'description' => 'The algorithm and its key length.', + 'type' => 'string', + 'example' => 'RSA_2048', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the certificate belongs.', + 'type' => 'string', + 'example' => 'rg-aek2pxd7ekpoo2y', + 'title' => '', + ], + 'ClusterId' => [ + 'description' => 'The ID of the hardware security module (HSM) cluster. This parameter is available when the CA is enabled using an HSM.', + 'type' => 'string', + 'example' => 'XXX-id', + 'title' => '', + ], + 'KeyIndex' => [ + 'description' => 'The index of the key in the HSM. This parameter is available when the CA is enabled using an HSM.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + 'title' => '', + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'The key of the tag.', + 'type' => 'string', + 'example' => '使用状态', + 'title' => '', + ], + 'TagValue' => [ + 'description' => 'The value of the tag.', + 'type' => 'string', + 'example' => 'BMS', + 'title' => '', + ], + ], + 'description' => 'A tag.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of tags.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + 'Years' => [ + 'description' => 'The validity period of the CA certificate. Unit: years.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DescribeCACertificate', + 'summary' => 'Queries the details of a CA certificate.', + 'description' => 'You can call this operation to query the details of a root or subordinate CA certificate by its unique identifier. The details include the serial number, subject information, and certificate content.'."\n" + ."\n" + .'Before you call this operation, you must create a root CA certificate by calling [CreateRootCACertificate](~~465962~~) and a subordinate CA certificate by calling [CreateSubCACertificate](~~465959~~).'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed the limit, API calls are throttled, which can affect your business. Plan your calls accordingly.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCACertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeCACertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Certificate\\": {\\n \\"CertificateType\\": \\"SUB_ROOT\\",\\n \\"X509Certificate\\": \\"-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----\\",\\n \\"Identifier\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"SerialNumber\\": \\"70e3b2566d92805173767869727fb92e****\\",\\n \\"SubjectDN\\": \\"C=CN,O=aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun\\",\\n \\"CommonName\\": \\"Aliyun\\",\\n \\"OrganizationUnit\\": \\"Security\\",\\n \\"Organization\\": \\"aliyun\\",\\n \\"Locality\\": \\"Hangzhou\\",\\n \\"State\\": \\"Zhejiang\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"Sans\\": \\"1\\",\\n \\"Status\\": \\"ISSUE\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"KeySize\\": 2048,\\n \\"SignAlgorithm\\": \\"SHA256WITHRSA\\",\\n \\"BeforeDate\\": 1634283958000,\\n \\"AfterDate\\": 1665819958000,\\n \\"ParentIdentifier\\": \\"1a83bcbb89e562885e40aa0108f5****\\",\\n \\"Sha2\\": \\"14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****\\",\\n \\"Md5\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"CrlStatus\\": \\"ACTIVE\\",\\n \\"CrlUrl\\": \\"https://crl-cn-publish.oss-cn-hangzhou.aliyuncs.com/pca/crl/1925647866611395/1ed40789-483f-6023-b6b8-29ddd3bb0a9a.crl\\",\\n \\"CertTotalCount\\": 40,\\n \\"CertRemainingCount\\": 30,\\n \\"CertIssuedCount\\": 10,\\n \\"CaCertChain\\": \\"-----BEGIN CERTIFICATE-----\\\\n-----END CERTIFICATE-----\\\\n\\\\n-----BEGIN CERTIFICATE-----\\\\n-----END CERTIFICATE-----\\\\n\\\\n-----BEGIN CERTIFICATE-----\\\\n-----END CERTIFICATE-----\\",\\n \\"CrlDay\\": 90,\\n \\"IssuerType\\": \\"local\\",\\n \\"Years\\": 1,\\n \\"FullAlgorithm\\": \\"RSA_2048\\",\\n \\"ResourceGroupId\\": \\"rg-aek2pxd7ekpoo2y\\",\\n \\"ClusterId\\": \\"XXX-id\\",\\n \\"KeyIndex\\": 8,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"使用状态\\",\\n \\"TagValue\\": \\"BMS\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Years\\": 10\\n}","type":"json"}]', + ], + 'DescribeCACertificateCount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83513', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The object.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of your CA certificates, including root and subordinate CA certificates.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + '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' => [], + ], + 'title' => 'DescribeCACertificateCount', + 'summary' => 'Queries the number of created Certificate Authority (CA) certificates.', + 'description' => 'This operation queries the number of CA certificates that you have created, including root CA certificates and subordinate CA certificates.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'Each user is limited to 10 queries per second (QPS) for this API operation. If you exceed the limit, your API calls are throttled. This may affect your business. Plan your calls accordingly.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCACertificateCount', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeCACertificateCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'DescribeCACertificateList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83514', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The default value is **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of CA certificates to return on each page. The default value is **20**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the CA certificate.'."\n" + ."\n" + .'> Call [DescribeCACertificateList](~~328095~~) to query the unique identifiers of all CA certificates.', + 'type' => 'string', + 'required' => false, + 'example' => '1ee47e24-c51b-67cc-aa6b-1f7561cf9d9a', + 'title' => '', + ], + ], + [ + 'name' => 'CertType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the CA. Valid values:'."\n" + ."\n" + .'- root: root CA.'."\n" + ."\n" + .'- subRoot: intermediate CA.'."\n" + ."\n" + .'- externalCa: an imported external CA.', + 'type' => 'string', + 'required' => false, + 'example' => 'subRoot', + 'title' => '', + ], + ], + [ + 'name' => 'CaStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the CA. Valid values:'."\n" + ."\n" + .'- issue: enabled.'."\n" + ."\n" + .'- forbidden: disabled.'."\n" + ."\n" + .'- revoke: revoked.', + 'type' => 'string', + 'required' => false, + 'example' => 'issue', + 'title' => '', + ], + ], + [ + 'name' => 'ValidStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity status of the CA. Valid values:'."\n" + ."\n" + .'- valid: The CA certificate is valid.'."\n" + ."\n" + .'- notValid: The CA certificate has expired.', + 'type' => 'string', + 'required' => false, + 'example' => 'valid', + 'title' => '', + ], + ], + [ + 'name' => 'IssuerType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The issuer of the CA. Valid values:'."\n" + ."\n" + .'- local: private certificate.'."\n" + ."\n" + .'- iTrusChina: a trusted CA.'."\n" + ."\n" + .'- external: an imported external CA.', + 'type' => 'string', + 'required' => false, + 'example' => 'local', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID. You can obtain this ID by calling the [ListResources](~~2716559~~) operation.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae******4wia', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The object.', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'The total number of root and intermediate CA certificates.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'PageCount' => [ + 'description' => 'The number of pages returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ShowSize' => [ + 'description' => 'The number of CA certificates on each page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'CertificateList' => [ + 'description' => 'The details of the CA certificates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The certificate information.', + 'type' => 'object', + 'properties' => [ + 'Years' => [ + 'description' => 'The validity period of the CA certificate in years.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the CA certificate. Valid values:'."\n" + ."\n" + .'- **ISSUE**: The certificate is issued.'."\n" + ."\n" + .'- **REVOKE**: The certificate is revoked.', + 'type' => 'string', + 'example' => 'ISSUE', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The serial number of the CA certificate.', + 'type' => 'string', + 'example' => '70e3b2566d92805173767869727fb92e****', + 'title' => '', + ], + 'CertificateType' => [ + 'description' => 'The type of the CA certificate. Valid values:'."\n" + ."\n" + .'- **ROOT**: root CA certificate.'."\n" + ."\n" + .'- **SUB\\_ROOT**: intermediate CA certificate.', + 'type' => 'string', + 'example' => 'SUB_ROOT', + 'title' => '', + ], + 'Algorithm' => [ + 'description' => 'The encryption algorithm of the CA certificate. Valid values:'."\n" + ."\n" + .'- **RSA**: RSA algorithm.'."\n" + ."\n" + .'- **ECC**: ECC algorithm.'."\n" + ."\n" + .'- **SM2**: SM2 algorithm.', + 'type' => 'string', + 'example' => 'RSA', + 'title' => '', + ], + 'State' => [ + 'description' => 'The name of the province or state where the organization associated with the CA certificate is located.', + 'type' => 'string', + 'example' => 'Zhejiang', + 'title' => '', + ], + 'Organization' => [ + 'description' => 'The name of the organization associated with the CA certificate.', + 'type' => 'string', + 'example' => '阿里云计算有限公司', + 'title' => '', + ], + 'ParentIdentifier' => [ + 'description' => 'The unique identifier of the root CA certificate that issued the CA certificate.'."\n" + ."\n" + .'> This parameter is returned only when **CertificateType** is **SUB\\_ROOT**, which indicates an intermediate CA certificate.', + 'type' => 'string', + 'example' => '1a83bcbb89e562885e40aa0108f5****', + 'title' => '', + ], + 'Locality' => [ + 'description' => 'The name of the city where the organization associated with the CA certificate is located.', + 'type' => 'string', + 'example' => 'Hangzhou', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the CA certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'Sans' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'KeySize' => [ + 'description' => 'The key length of the CA certificate.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2048', + 'title' => '', + ], + 'X509Certificate' => [ + 'description' => 'The content of the CA certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----', + 'title' => '', + ], + 'SubjectDN' => [ + 'description' => 'The distinguished name (DN) of the CA certificate. The DN indicates the user of the certificate and contains the following information:'."\n" + ."\n" + .'- **C**: The country code where the organization is located.'."\n" + ."\n" + .'- **O**: The name of the organization.'."\n" + ."\n" + .'- **OU**: The department of the organization.'."\n" + ."\n" + .'- **L**: The city where the organization is located.'."\n" + ."\n" + .'- **CN**: The common name or abbreviation of the organization.', + 'type' => 'string', + 'example' => 'C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun', + 'title' => '', + ], + 'SignAlgorithm' => [ + 'description' => 'The signature algorithm of the CA certificate.', + 'type' => 'string', + 'example' => 'SHA256WITHRSA', + 'title' => '', + ], + 'OrganizationUnit' => [ + 'description' => 'The name of the department of the organization associated with the CA certificate.', + 'type' => 'string', + 'example' => 'Security', + 'title' => '', + ], + 'AfterDate' => [ + 'description' => 'The expiration date of the CA certificate. This value is a UNIX timestamp. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1665819958000', + 'title' => '', + ], + 'Sha2' => [ + 'description' => 'The SHA-256 fingerprint of the CA certificate.', + 'type' => 'string', + 'example' => '14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****', + 'title' => '', + ], + 'CommonName' => [ + 'description' => 'The common name or abbreviation of the organization associated with the CA certificate.', + 'type' => 'string', + 'example' => 'Aliyun', + 'title' => '', + ], + 'Md5' => [ + 'description' => 'The MD5 fingerprint of the CA certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'CountryCode' => [ + 'description' => 'The country code of the country where the organization associated with the CA certificate is located.'."\n" + ."\n" + .'For more information about country codes, see the **Country codes** section in [Manage company information](~~198289~~).', + 'type' => 'string', + 'example' => 'CN', + 'title' => '', + ], + 'BeforeDate' => [ + 'description' => 'The issuance date of the CA certificate. This value is a UNIX timestamp. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1634283958000', + 'title' => '', + ], + 'Alias' => [ + 'description' => 'The alias of the instance.', + 'type' => 'string', + 'example' => 'Aliyun_CA', + 'title' => '', + ], + 'Trial' => [ + 'description' => 'Indicates whether the instance is a trial instance. Valid values:'."\n" + ."\n" + .'- 0: no.'."\n" + ."\n" + .'- 1: yes.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'Gift' => [ + 'description' => 'Indicates whether the instance is a free instance. Valid values:'."\n" + ."\n" + .'- 0: no.'."\n" + ."\n" + .'- 1: yes.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the certificate belongs.', + 'type' => 'string', + 'example' => 'rg-acfmzjwrhehpavi', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DescribeCACertificateList', + 'summary' => 'Queries information about all root and intermediate certificate authority (CA) certificates.', + 'description' => 'You can call this operation to query the details of all your root and intermediate CA certificates by page. The details include the unique identifier, serial number, subject information, and content of each certificate.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The queries per second (QPS) limit for this operation is 10 for each user. If you exceed the limit, API calls are throttled. This may affect your business. We recommend that you call this operation a reasonable number of times.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCACertificateList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeCACertificateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"TotalCount\\": 2,\\n \\"PageCount\\": 1,\\n \\"ShowSize\\": 20,\\n \\"CertificateList\\": [\\n {\\n \\"Years\\": 3,\\n \\"Status\\": \\"ISSUE\\",\\n \\"SerialNumber\\": \\"70e3b2566d92805173767869727fb92e****\\",\\n \\"CertificateType\\": \\"SUB_ROOT\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"State\\": \\"Zhejiang\\",\\n \\"Organization\\": \\"阿里云计算有限公司\\",\\n \\"ParentIdentifier\\": \\"1a83bcbb89e562885e40aa0108f5****\\",\\n \\"Locality\\": \\"Hangzhou\\",\\n \\"Identifier\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"Sans\\": \\"1\\",\\n \\"KeySize\\": 2048,\\n \\"X509Certificate\\": \\"-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----\\",\\n \\"SubjectDN\\": \\"C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun\\",\\n \\"SignAlgorithm\\": \\"SHA256WITHRSA\\",\\n \\"OrganizationUnit\\": \\"Security\\",\\n \\"AfterDate\\": 1665819958000,\\n \\"Sha2\\": \\"14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****\\",\\n \\"CommonName\\": \\"Aliyun\\",\\n \\"Md5\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"BeforeDate\\": 1634283958000,\\n \\"Alias\\": \\"Aliyun_CA\\",\\n \\"Trial\\": 0,\\n \\"Gift\\": 1,\\n \\"ResourceGroupId\\": \\"rg-acfmzjwrhehpavi\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCertificatePrivateKey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '103267', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the client or server-side certificate for which you want to get the private key.'."\n" + ."\n" + .'> Call [ListClientCertificate](~~465990~~) to query the unique identifiers of all client and server-side certificates.', + 'type' => 'string', + 'required' => true, + 'example' => 'bc37133bb7ed68c7938d928fd26d****', + 'title' => '', + ], + ], + [ + 'name' => 'EncryptedCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password to encrypt the private key. The password can contain uppercase letters, lowercase letters, digits, and special characters, such as `,.+-_#`. The maximum length is 32 bytes.'."\n" + ."\n" + .'><warning>'."\n" + ."\n" + .'Remember the password you set. You need this password to decrypt the encrypted private key. If you forget the password, you cannot decrypt the private key that you get from this API call. You must call this API again to get a new encrypted key.'."\n" + ."\n" + .'></warning>', + 'type' => 'string', + 'required' => true, + 'example' => '!Demo@WS3ed', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the certificate belongs.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetCertificatePrivateKeyResponse', + 'description' => 'GetCertificatePrivateKeyResponse.', + 'type' => 'object', + 'properties' => [ + 'EncryptedData' => [ + 'description' => 'The encrypted content of the private key.', + 'type' => 'string', + 'example' => '-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '09470F19-CEE8-5C63-BF2C-02B5E3F07A17', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DescribeCertificatePrivateKey', + 'summary' => 'Retrieves the encrypted private key of a single client certificate or server-side certificate.', + 'description' => 'This API applies only to certificates that are issued from a system-generated Certificate Signing Request (CSR). You can use this API to retrieve the encrypted private key of a client certificate or a server-side certificate. Before you call this API, you must have issued a client or server-side certificate by calling one of the following APIs:'."\n" + ."\n" + .'- [CreateClientCertificate](~~465967~~)'."\n" + ."\n" + .'- [CreateServerCertificate](~~465975~~)'."\n" + ."\n" + .'To keep the private key secure during transmission, this API uses a password that you set to encrypt the private key. The API then returns the encrypted private key. After you retrieve the encrypted private key, you can decrypt it using one of the following methods:'."\n" + ."\n" + .'- If the certificate uses the RSA encryption algorithm, run the `openssl rsa -in <encrypted_private_key_file> -passin pass:<private_key_password> -out <decrypted_private_key_file>` command to decrypt the private key. You must run this command on a computer that has [OpenSSL](https://www.openssl.org/source/) or [BabaSSL](https://github.com/BabaSSL/BabaSSL) installed.'."\n" + ."\n" + .'- If the certificate uses the ECC encryption algorithm, run the `openssl ec -in <encrypted_private_key_file> -passin pass:<private_key_password> -out <decrypted_private_key_file>` command to decrypt the private key. You must run this command on a computer that has [OpenSSL](https://www.openssl.org/source/) or [BabaSSL](https://github.com/BabaSSL/BabaSSL) installed.'."\n" + ."\n" + .'- If the certificate uses the SM2 encryption algorithm, run the `openssl ec -in <encrypted_private_key_file> -passin pass:<private_key_password> -out <decrypted_private_key_file>` command to decrypt the private key. You must run this command on a computer that has [BabaSSL](https://github.com/BabaSSL/BabaSSL) installed.'."\n" + ."\n" + .'> You can call [DescribeClientCertificate](~~465985~~) to query the encryption algorithm of the client or server-side certificate.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'This API has a queries per second (QPS) limit of 10 for each user. If you exceed this limit, your API calls are throttled. Throttling can affect your business. Plan your calls accordingly.', + 'requestParamsDescription' => 'In addition to the API-specific request parameters in this topic, you must specify common request parameters when you make an API call.'."\n" + ."\n" + .'For the request format, see the request example in the **Examples** section.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCertificatePrivateKey', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeCertificatePrivateKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EncryptedData\\": \\"-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----\\",\\n \\"RequestId\\": \\"09470F19-CEE8-5C63-BF2C-02B5E3F07A17\\"\\n}","type":"json"}]', + ], + 'DescribeClientCertificate' => [ + 'summary' => 'This operation queries the details of a specific client certificate or server-side certificate using its unique identifier.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83515', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the client certificate or server-side certificate to query.'."\n" + ."\n" + .'> Call [ListClientCertificate](~~465990~~) to query the unique identifiers of all client certificates and server-side certificates.', + 'type' => 'string', + 'required' => true, + 'example' => 'd3b95700998e47afc4d95f886579****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DescribeCertificateResponse<CertificateWithContentDTO>', + 'description' => 'DescribeCertificateResponse\\<CertificateWithContentDTO>', + 'type' => 'object', + 'properties' => [ + 'Certificate' => [ + 'description' => 'The details of the client certificate or server-side certificate.', + 'type' => 'object', + 'properties' => [ + 'X509Certificate' => [ + 'description' => 'The content of the certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the certificate.', + 'type' => 'string', + 'example' => 'd3b95700998e47afc4d95f886579****', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The serial number of the certificate.', + 'type' => 'string', + 'example' => '62b2b943a32d96883a6650e672ea0276****', + 'title' => '', + ], + 'SubjectDN' => [ + 'description' => 'The subject Distinguished Name (DN) of the certificate. This value is composed of the following fields:'."\n" + ."\n" + .'- **C**: Country.'."\n" + ."\n" + .'- **O**: Organization.'."\n" + ."\n" + .'- **OU**: Organizational unit.'."\n" + ."\n" + .'- **CN**: Common name.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **ST**: The province, municipality, or autonomous region.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- **ST**: Province or state.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'- **CN**: Common name.', + 'type' => 'string', + 'example' => 'C=CN,O=Aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun', + 'title' => '', + ], + 'CommonName' => [ + 'description' => 'The common name of the certificate.', + 'type' => 'string', + 'example' => 'aliyun.com', + 'title' => '', + ], + 'OrganizationUnit' => [ + 'description' => 'The organizational unit of the certificate subject.', + 'type' => 'string', + 'example' => 'Security', + 'title' => '', + ], + 'Organization' => [ + 'description' => 'The organization associated with the certificate of the issuing subordinate CA.', + 'type' => 'string', + 'example' => 'Aliyun', + 'title' => '', + ], + 'Locality' => [ + 'description' => 'The city where the subject organization is located.', + 'type' => 'string', + 'example' => 'Hangzhou', + 'title' => '', + ], + 'State' => [ + 'description' => 'The state or province where the subject organization is located.', + 'type' => 'string', + 'example' => 'Zhejiang', + 'title' => '', + ], + 'CountryCode' => [ + 'description' => 'The country code of the subject organization.'."\n" + ."\n" + .'For more information about country codes, see the **International codes** section in [Manage company profiles](~~198289~~).', + 'type' => 'string', + 'example' => 'CN', + 'title' => '', + ], + 'Sans' => [ + 'description' => 'The Subject Alternative Name (SAN) extension of the certificate. The SAN extension indicates other domain names or IP addresses that are associated with the certificate.'."\n" + ."\n" + .'This parameter is a string that is converted from a JSON array. Each element in the JSON array is a struct that corresponds to a SAN extension.'."\n" + .'Each SAN extension struct contains the following parameters:'."\n" + ."\n" + .'- **Type**: The type of the extension. This parameter is of the Integer type. Valid values:'."\n" + ."\n" + .' - **1**: an email address.'."\n" + ."\n" + .' - **2**: a domain name.'."\n" + ."\n" + .' - **6**: a Uniform Resource Identifier (URI).'."\n" + ."\n" + .' - **7**: an IP address.'."\n" + ."\n" + .'- **Value**: The content of the extension. This parameter is of the String type.', + 'type' => 'string', + 'example' => '[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]', + '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' => '', + ], + 'BeforeDate' => [ + 'description' => 'The issuance date of the certificate. This value is a UNIX timestamp. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1634283958000', + 'title' => '', + ], + 'AfterDate' => [ + 'description' => 'The expiration date of the certificate. This value is a UNIX timestamp. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1665819958000', + 'title' => '', + ], + 'Algorithm' => [ + 'description' => 'The type of the encryption 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' => '', + ], + 'KeySize' => [ + 'description' => 'The key length of the certificate.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4096', + 'title' => '', + ], + 'SignAlgorithm' => [ + 'description' => 'The signature algorithm of the certificate.', + 'type' => 'string', + 'example' => 'SHA256WITHRSA', + 'title' => '', + ], + 'CertificateType' => [ + 'description' => 'The type of the certificate. Valid values:'."\n" + ."\n" + .'- **CLIENT**: a client certificate.'."\n" + ."\n" + .'- **SERVER**: a server-side certificate.', + 'type' => 'string', + 'example' => 'SERVER', + 'title' => '', + ], + 'ParentIdentifier' => [ + 'description' => 'The unique identifier of the subordinate CA certificate that issued the certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'Sha2' => [ + 'description' => 'The SHA-256 fingerprint of the certificate.', + 'type' => 'string', + 'example' => '14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****', + 'title' => '', + ], + 'Md5' => [ + 'description' => 'The MD5 fingerprint of the certificate.', + 'type' => 'string', + 'example' => 'd3b95700998e47afc4d95f886579****', + 'title' => '', + ], + 'Days' => [ + 'description' => 'The validity period of the certificate. Unit: days.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '365', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the certificate belongs.', + 'type' => 'string', + 'example' => 'rg-acfmxllajdpw3fi', + 'title' => '', + ], + 'CertChain' => [ + 'description' => 'The complete certificate chain.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----'."\n" + .'cert'."\n" + .'-----END CERTIFICATE-----'."\n" + .'-----BEGIN CERTIFICATE-----'."\n" + .'subCA'."\n" + .'-----END CERTIFICATE-----'."\n" + .'-----BEGIN CERTIFICATE-----'."\n" + .'rootCA'."\n" + .'-----END CERTIFICATE-----', + 'title' => '', + ], + 'CustomIdentifier' => [ + 'description' => 'The custom identifier, which is a unique key.', + 'type' => 'string', + 'example' => '***3a32d96883a6650e672ea0276****', + 'title' => '', + ], + 'UploadFlag' => [ + 'description' => 'Indicates whether the certificate is synchronized to Digital Certificate Management Service.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'FullAlgorithm' => [ + 'description' => 'The algorithm and its length.', + 'type' => 'string', + 'example' => 'RSA_2048', + 'title' => '', + ], + 'AliasName' => [ + 'description' => 'The alias of the issued certificate.', + 'type' => 'string', + 'example' => 'rsa_root_2048', + 'title' => '', + ], + 'Id' => [ + 'description' => 'The ID of the data source to which the certificate order belongs.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1137354', + 'title' => '', + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'The tag key.', + 'type' => 'string', + 'example' => 'testKey', + 'title' => '', + ], + 'TagValue' => [ + 'description' => 'The tag value.', + 'type' => 'string', + 'example' => '[{\\"tag\\":\\"PROPERTY_TYPE\\",\\"values\\":[]}]', + 'title' => '', + ], + ], + 'description' => 'The tag value.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of tags.', + 'title' => '', + 'example' => 'mtls', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Certificate\\": {\\n \\"X509Certificate\\": \\"-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----\\",\\n \\"Identifier\\": \\"d3b95700998e47afc4d95f886579****\\",\\n \\"SerialNumber\\": \\"62b2b943a32d96883a6650e672ea0276****\\",\\n \\"SubjectDN\\": \\"C=CN,O=Aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun\\",\\n \\"CommonName\\": \\"aliyun.com\\",\\n \\"OrganizationUnit\\": \\"Security\\",\\n \\"Organization\\": \\"Aliyun\\",\\n \\"Locality\\": \\"Hangzhou\\",\\n \\"State\\": \\"Zhejiang\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"Sans\\": \\"[ {\\\\\\"Type\\\\\\": 7, \\\\\\"Value\\\\\\": \\\\\\"192.0.XX.XX\\\\\\"}, {\\\\\\"Type\\\\\\": 2, \\\\\\"Value\\\\\\": \\\\\\"www.aliyundoc.com\\\\\\"}, ]\\",\\n \\"Status\\": \\"ISSUE\\",\\n \\"BeforeDate\\": 1634283958000,\\n \\"AfterDate\\": 1665819958000,\\n \\"Algorithm\\": \\"RSA\\",\\n \\"KeySize\\": 4096,\\n \\"SignAlgorithm\\": \\"SHA256WITHRSA\\",\\n \\"CertificateType\\": \\"SERVER\\",\\n \\"ParentIdentifier\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"Sha2\\": \\"14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****\\",\\n \\"Md5\\": \\"d3b95700998e47afc4d95f886579****\\",\\n \\"Days\\": 365,\\n \\"ResourceGroupId\\": \\"rg-acfmxllajdpw3fi\\",\\n \\"CertChain\\": \\"-----BEGIN CERTIFICATE-----\\\\ncert\\\\n-----END CERTIFICATE-----\\\\n-----BEGIN CERTIFICATE-----\\\\nsubCA\\\\n-----END CERTIFICATE-----\\\\n-----BEGIN CERTIFICATE-----\\\\nrootCA\\\\n-----END CERTIFICATE-----\\",\\n \\"CustomIdentifier\\": \\"***3a32d96883a6650e672ea0276****\\",\\n \\"UploadFlag\\": 1,\\n \\"FullAlgorithm\\": \\"RSA_2048\\",\\n \\"AliasName\\": \\"rsa_root_2048\\",\\n \\"Id\\": 1137354,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"[{\\\\\\\\\\\\\\"tag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PROPERTY_TYPE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"values\\\\\\\\\\\\\\":[]}]\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + 'title' => 'DescribeClientCertificate', + 'description' => 'You can call this operation to query the details of a client certificate or a server-side certificate by its unique identifier. The details include the serial number, subject, content, and status of the certificate.'."\n" + ."\n" + .'Before you call this operation, you must create a client certificate or a server-side certificate.'."\n" + ."\n" + .'To create a client certificate by calling an API, see the following topics:'."\n" + ."\n" + .'- [CreateClientCertificate](~~465967~~)'."\n" + ."\n" + .'- [CreateClientCertificateWithCsr](~~465970~~)'."\n" + ."\n" + .'To create a server-side certificate by calling an API, see the following topics:'."\n" + ."\n" + .'- [CreateServerCertificate](~~465975~~)'."\n" + ."\n" + .'- [CreateServerCertificateWithCsr](~~465979~~)'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'The queries per second (QPS) limit for this API call is 10 per user. If you exceed this limit, throttling is triggered, which may affect your business. Plan your calls accordingly.', + 'requestParamsDescription' => 'In addition to the preceding request parameters, you must specify common request parameters when you call this API. For more information about common request parameters, see Common Parameters.'."\n" + ."\n" + .'For the request format, see the request sample in the **Examples** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeClientCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeClientCertificateForSerialNumber' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SerialNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The serial numbers of the client or server-side certificates that you want to query. Separate multiple serial numbers with commas (,).'."\n" + ."\n" + .'> You can call the [ListClientCertificate](~~330884~~) operation to query the serial numbers of all client and server-side certificates.', + 'type' => 'string', + 'required' => true, + 'example' => '084bde9cd233f0ddae33adc438cfbbbd****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'ListCertificateResponse', + 'properties' => [ + 'CertificateList' => [ + 'description' => 'The details of the client or server-side certificates.', + 'items' => [ + 'properties' => [ + 'X509Certificate' => [ + 'description' => 'The content of the certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the certificate.', + 'type' => 'string', + 'example' => 'd3b95700998e47afc4d95f886579****', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The serial number of the certificate.', + 'type' => 'string', + 'example' => '084bde9cd233f0ddae33adc438cfbbbd****', + 'title' => '', + ], + 'SubjectDN' => [ + 'description' => 'The distinguished name (DN) of the certificate. The DN contains the following information about the certificate owner:'."\n" + ."\n" + .'- **C**: Country'."\n" + ."\n" + .'- **O**: Organization'."\n" + ."\n" + .'- **OU**: Department'."\n" + ."\n" + .'- **CN**: Common name'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **ST**: Province, municipality, or autonomous region.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- **ST**: The province or state.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'- **CN**: Common name.', + 'type' => 'string', + 'example' => 'C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun', + 'title' => '', + ], + 'CommonName' => [ + 'description' => 'The common name of the certificate.', + 'type' => 'string', + 'example' => 'aliyun.com', + 'title' => '', + ], + 'OrganizationUnit' => [ + 'description' => 'The name of the department in the organization that is associated with the subordinate CA certificate that issued this certificate.', + 'type' => 'string', + 'example' => 'Security', + 'title' => '', + ], + 'Organization' => [ + 'description' => 'The name of the organization that is associated with the subordinate CA certificate that issued this certificate.', + 'type' => 'string', + 'example' => '阿里云计算有限公司', + 'title' => '', + ], + 'Locality' => [ + 'description' => 'The name of the city where the organization that is associated with the subordinate CA certificate that issued this certificate is located.', + 'type' => 'string', + 'example' => 'Hangzhou', + 'title' => '', + ], + 'State' => [ + 'description' => 'The name of the province, state, municipality, or autonomous region where the organization that is associated with the subordinate CA certificate that issued this certificate is located.', + 'type' => 'string', + 'example' => 'Zhejiang', + 'title' => '', + ], + 'CountryCode' => [ + 'description' => 'The country code of the country where the organization that is associated with the subordinate CA certificate that issued this certificate is located.'."\n" + ."\n" + .'For more information about country codes, see the **Country codes** section in [Manage company profiles](~~198289~~).', + 'type' => 'string', + 'example' => 'CN', + 'title' => '', + ], + 'Sans' => [ + 'description' => 'The subject alternative name (SAN) extension of the certificate. The SAN extension indicates other domain names or IP addresses that are associated with the certificate.'."\n" + ."\n" + .'This parameter is a string that is converted from a JSON array. Each element in the JSON array is a struct that corresponds to a SAN extension. Each SAN extension struct contains the following parameters:'."\n" + ."\n" + .'- **Type**: The type of the extension. This parameter is of the integer type. Valid values:'."\n" + ."\n" + .' - **1**: email address'."\n" + ."\n" + .' - **2**: domain name'."\n" + ."\n" + .' - **6**: Uniform Resource Identifier (URI)'."\n" + ."\n" + .' - **7**: IP address'."\n" + ."\n" + .'- **Value**: The content of the extension. This parameter is of the string type.', + 'type' => 'string', + 'example' => '[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]', + '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' => '', + ], + 'BeforeDate' => [ + 'description' => 'The time when the certificate was issued.', + 'type' => 'string', + 'example' => '2021-10-28T16:15Z', + 'title' => '', + ], + 'AfterDate' => [ + 'description' => 'The time when the certificate expires.', + 'type' => 'string', + 'example' => '2022-08-23T16:15Z', + 'title' => '', + ], + 'Algorithm' => [ + 'description' => 'The type of the encryption algorithm. Valid values:'."\n" + ."\n" + .'- **RSA**: RSA algorithm'."\n" + ."\n" + .'- **ECC**: ECC algorithm'."\n" + ."\n" + .'- **SM2**: SM2 algorithm', + 'type' => 'string', + 'example' => 'RSA', + 'title' => '', + ], + 'KeySize' => [ + 'description' => 'The key length of the certificate.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4096', + 'title' => '', + ], + 'SignAlgorithm' => [ + 'description' => 'The signature algorithm of the certificate.', + 'type' => 'string', + 'example' => 'SHA256WITHRSA', + 'title' => '', + ], + 'CertificateType' => [ + 'description' => 'The type of the certificate.', + 'type' => 'string', + 'example' => 'SUB_ROOT', + 'title' => '', + ], + 'ParentIdentifier' => [ + 'description' => 'If this parameter is not empty, the issuer of the client certificate is Alibaba Cloud.', + 'type' => 'string', + 'example' => '1a83bcbb89e562885e40aa0108f5****', + 'title' => '', + ], + 'Sha2' => [ + 'description' => 'The SHA-256 fingerprint of the certificate.', + 'type' => 'string', + 'example' => '14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****', + 'title' => '', + ], + 'Md5' => [ + 'description' => 'The MD5 fingerprint of the certificate.', + 'type' => 'string', + 'example' => 'd3b95700998e47afc4d95f886579****', + 'title' => '', + ], + 'Years' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => 'The certificate information.', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + ], + 'title' => 'ListCertificateResponse<CertificateWithContentDTO>', + 'type' => 'object', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'cas::2020-06-30::DescribeClientCertificate', + ], + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DescribeClientCertificateForSerialNumber', + 'summary' => 'Queries the details of multiple client or server-side certificates by their serial numbers.', + 'description' => '# QPS limit'."\n" + ."\n" + .'The queries per second (QPS) limit for this operation is 10 calls per second per account. If the number of 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" + ."\n" + .'Before you call this operation, make sure that you have created a client certificate or a server certificate.'."\n" + ."\n" + .'You can call the following operations to create a client certificate:'."\n" + ."\n" + .'- [CreateClientCertificate](~~330873~~)'."\n" + ."\n" + .'- [CreateClientCertificateWithCsr](~~330875~~)'."\n" + ."\n" + .'- [CreateCertificateWithExtension](~~328092~~)'."\n" + ."\n" + .'You can call the following operations to create a server certificate:'."\n" + ."\n" + .'- [CreateServerCertificate](~~330877~~)'."\n" + ."\n" + .'- [CreateServerCertificateWithCsr](~~330878~~)'."\n" + ."\n" + .'- [CreateCertificateWithExtension](~~328092~~)'."\n" + ."\n" + .'# QPS limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. Exceeding this limit triggers throttling, which can affect your business. We recommend that you plan your calls accordingly.', + 'requestParamsDescription' => 'When you call this operation, you must also include the common request parameters. For more information, see [Common parameters](~~327167~~).'."\n" + ."\n" + .'For the request format, see the request example in the **Examples** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeClientCertificateForSerialNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertificateList\\": [\\n {\\n \\"X509Certificate\\": \\"-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----\\",\\n \\"Identifier\\": \\"d3b95700998e47afc4d95f886579****\\",\\n \\"SerialNumber\\": \\"084bde9cd233f0ddae33adc438cfbbbd****\\",\\n \\"SubjectDN\\": \\"C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun\\",\\n \\"CommonName\\": \\"aliyun.com\\",\\n \\"OrganizationUnit\\": \\"Security\\",\\n \\"Organization\\": \\"阿里云计算有限公司\\",\\n \\"Locality\\": \\"Hangzhou\\",\\n \\"State\\": \\"Zhejiang\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"Sans\\": \\"[ {\\\\\\"Type\\\\\\": 7, \\\\\\"Value\\\\\\": \\\\\\"192.0.XX.XX\\\\\\"}, {\\\\\\"Type\\\\\\": 2, \\\\\\"Value\\\\\\": \\\\\\"www.aliyundoc.com\\\\\\"}, ]\\",\\n \\"Status\\": \\"ISSUE\\",\\n \\"BeforeDate\\": \\"2021-10-28T16:15Z\\",\\n \\"AfterDate\\": \\"2022-08-23T16:15Z\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"KeySize\\": 4096,\\n \\"SignAlgorithm\\": \\"SHA256WITHRSA\\",\\n \\"CertificateType\\": \\"SUB_ROOT\\",\\n \\"ParentIdentifier\\": \\"1a83bcbb89e562885e40aa0108f5****\\",\\n \\"Sha2\\": \\"14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****\\",\\n \\"Md5\\": \\"d3b95700998e47afc4d95f886579****\\",\\n \\"Years\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'DescribeClientCertificateStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83517', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the client or server-side certificate that you want to query. Separate multiple identifiers with commas (,).'."\n" + ."\n" + .'> Call [ListClientCertificate](~~465990~~) to query the unique identifiers of all client and server-side certificates.', + 'type' => 'string', + 'required' => true, + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + 'CertificateStatus' => [ + 'description' => 'The details of the certificate status.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object.', + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => [ + 'description' => 'The serial number of the certificate.', + 'type' => 'string', + 'example' => 'b67e53ebcea9b77d65b0c3236646d715****', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The current status of the certificate. Valid values:'."\n" + ."\n" + .'- **good**: The certificate is not revoked.'."\n" + ."\n" + .'- **revoked**: The certificate is revoked.'."\n" + ."\n" + .'- **unknown**: The server cannot determine the status of the certificate.', + 'type' => 'string', + 'example' => 'good', + 'title' => '', + ], + 'RevokeTime' => [ + 'description' => 'The date when the certificate was revoked.'."\n" + ."\n" + .'> This parameter is returned only when the value of **Status** is **revoked**.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-01-01T00:00Z', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DescribeClientCertificateStatus', + 'summary' => 'Queries the status of client and server-side certificates using their unique identifiers.', + 'description' => 'This operation queries the status of multiple client or server-side certificates in a batch using their unique identifiers. For example, you can check whether a certificate is revoked.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'This operation is limited to 10 queries per second (QPS) for each user. API calls that exceed this limit are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.', + 'requestParamsDescription' => 'When you call this operation, you must also include the common request parameters for Alibaba Cloud APIs.'."\n" + ."\n" + .'For the request format, see the example in the **Examples** section.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeClientCertificateStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeClientCertificateStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"CertificateStatus\\": [\\n {\\n \\"SerialNumber\\": \\"b67e53ebcea9b77d65b0c3236646d715****\\",\\n \\"Status\\": \\"good\\",\\n \\"RevokeTime\\": 0\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeClientCertificateStatusForSerialNumber' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83518', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SerialNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The serial number of the client or server certificate to query. To query multiple certificates, separate the serial numbers with a comma (,).'."\n" + ."\n" + .'> Call the [ListClientCertificate](~~330884~~) operation to query the serial numbers of all client and server certificates.', + 'type' => 'string', + 'required' => true, + 'example' => 'b67e53ebcea9b77d65b0c3236646d715****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + 'CertificateStatus' => [ + 'description' => 'The details of the certificate status.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => [ + 'description' => 'The serial number of the certificate.', + 'type' => 'string', + 'example' => 'b67e53ebcea9b77d65b0c3236646d715****', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The current status of the certificate. Valid values:'."\n" + ."\n" + .'- **good**: The certificate is not revoked.'."\n" + ."\n" + .'- **revoked**: The certificate is revoked.'."\n" + ."\n" + .'- **unknown**: The server cannot determine the status of the certificate.', + 'type' => 'string', + 'example' => 'good', + 'title' => '', + ], + 'RevokeTime' => [ + 'description' => 'The time when the certificate was revoked. This value is a UNIX timestamp. The value is **0** if the certificate has not been revoked.'."\n" + ."\n" + .'> This parameter is returned only when **Status** is **revoked**.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-01-01T00:00', + 'title' => '', + ], + ], + 'description' => 'The object.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DescribeClientCertificateStatusForSerialNumber', + 'summary' => 'Queries the status of client and server-side certificates using their serial numbers.', + 'description' => '# QPS limit'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If you exceed this limit, throttling is triggered, which can affect your business. Plan your calls accordingly.'."\n" + ."\n" + .'# QPS Throttling'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds this limit, throttling is triggered. This may affect your business. We recommend that you note this limit when you call the operation.', + 'requestParamsDescription' => 'In addition to the parameters described in this topic, you must also specify common request parameters. For more information, see [Common parameters](~~327167~~).'."\n" + ."\n" + .'For the request format, see the request example in the **Examples** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeClientCertificateStatusForSerialNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"CertificateStatus\\": [\\n {\\n \\"SerialNumber\\": \\"b67e53ebcea9b77d65b0c3236646d715****\\",\\n \\"Status\\": \\"good\\",\\n \\"RevokeTime\\": 0\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribePcaAndExternalCACertificateList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The current page number.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of records to display on each page. The default value is 50.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The current page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'The total number of records.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PageCount' => [ + 'description' => 'The number of entries in the list.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ShowSize' => [ + 'description' => 'The number of records to display on each page. The default value is 50.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'CertificateList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Years' => [ + 'description' => 'The validity period of the certificate in years.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the certificate. Valid values: -**payed**: The certificate is paid. -**checking**: The certificate is under review. -**issued**: The certificate is issued. -**revoked**: The certificate is revoked. -**checked\\_fail**: The review failed.', + 'type' => 'string', + 'example' => 'ISSUE', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The serial number of the certificate.', + 'type' => 'string', + 'example' => '62b2b943a32d96883a6650e672ea0276****', + 'title' => '', + ], + 'CertificateType' => [ + 'description' => 'The type of the certificate.', + 'type' => 'string', + 'example' => 'SUB_ROOT', + 'title' => '', + ], + 'Algorithm' => [ + 'description' => 'The algorithm.', + 'type' => 'string', + 'example' => 'RSA', + 'title' => '', + ], + 'State' => [ + 'description' => 'The status of the certificate. The possible values are: - **success**: The certificate is active. - **checking**: The system is checking whether the domain name is added to Global Accelerator. - **cname\\_error**: The CNAME record of the domain name does not point to the Global Accelerator instance. - **domain\\_invalid**: The domain name contains invalid characters. - **unsupport\\_wildcard**: Wildcard domain names are not supported.', + 'type' => 'string', + 'example' => 'Zhejiang', + 'title' => '', + ], + 'Organization' => [ + 'description' => 'The organization.', + 'type' => 'string', + 'example' => '阿里云计算有限公司', + 'title' => '', + ], + 'ParentIdentifier' => [ + 'description' => 'The ID of the parent certificate.', + 'type' => 'string', + 'example' => '1a83bcbb89e562885e40aa0108f5****', + 'title' => '', + ], + 'Locality' => [ + 'description' => 'The primary domain name that the certificate is attached to.', + 'type' => 'string', + 'example' => 'Hangzhou', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The ID of the certificate.', + 'type' => 'string', + 'example' => '05e148d8d3ecc9976d9ecd2b2f25****', + 'title' => '', + ], + 'Sans' => [ + 'description' => 'All domain names bound to the certificate.', + 'type' => 'string', + 'example' => '[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]', + 'title' => '', + ], + 'KeySize' => [ + 'description' => 'The size of the certificate key. Unit: bits.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2048', + 'title' => '', + ], + 'X509Certificate' => [ + 'description' => 'The X.509 certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----', + 'title' => '', + ], + 'SubjectDN' => [ + 'description' => 'The subject (owner) of the certificate, in Distinguished Name (DN) format.', + 'type' => 'string', + 'example' => 'C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun', + 'title' => '', + ], + 'SignAlgorithm' => [ + 'description' => 'The signature algorithm of the certificate.', + 'type' => 'string', + 'example' => 'SHA256WITHRSA', + 'title' => '', + ], + 'OrganizationUnit' => [ + 'description' => 'The certification authority.', + 'type' => 'string', + 'example' => 'Security', + 'title' => '', + ], + 'AfterDate' => [ + 'description' => 'The expiration date of the certificate.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-08-23T16:15Z', + 'title' => '', + ], + 'Sha2' => [ + 'description' => 'The primary domain name with the attached certificate.', + 'type' => 'string', + 'example' => '14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****', + 'title' => '', + ], + 'CommonName' => [ + 'description' => 'The primary domain name bound to the certificate.', + 'type' => 'string', + 'example' => 'aliyun.com', + 'title' => '', + ], + 'Md5' => [ + 'description' => 'The MD5 hash of the certificate.', + 'type' => 'string', + 'example' => '05e148d8d3ecc9976d9ecd2b2f25****', + 'title' => '', + ], + 'CountryCode' => [ + 'description' => 'The country code.', + 'type' => 'string', + 'example' => 'CN', + 'title' => '', + ], + 'BeforeDate' => [ + 'description' => 'The issuance date of the certificate.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-01-01T00:00Z', + 'title' => '', + ], + ], + 'description' => 'The list of certificates.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of certificates.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'cas::2020-06-30::ListAllEndEntityInstance', + ], + ], + 'title' => 'DescribePcaAndExternalCACertificateList', + 'summary' => 'Returns all your certification authority (CA) certificates. These include certificates generated by Private CA and imported external certificates.', + 'description' => 'Performs a paged query to retrieve details for all your CA certificates, including root and subordinate CA certificates. Details include the unique identifier, serial number, subject information, and certificate content.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The queries per second (QPS) limit for a single user is 10 calls per second. API calls that exceed this limit are throttled. This can affect your business. Call this operation at a reasonable rate.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribePcaAndExternalCACertificateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"TotalCount\\": 10,\\n \\"PageCount\\": 1,\\n \\"ShowSize\\": 10,\\n \\"CertificateList\\": [\\n {\\n \\"Years\\": 3,\\n \\"Status\\": \\"ISSUE\\",\\n \\"SerialNumber\\": \\"62b2b943a32d96883a6650e672ea0276****\\",\\n \\"CertificateType\\": \\"SUB_ROOT\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"State\\": \\"Zhejiang\\",\\n \\"Organization\\": \\"阿里云计算有限公司\\",\\n \\"ParentIdentifier\\": \\"1a83bcbb89e562885e40aa0108f5****\\",\\n \\"Locality\\": \\"Hangzhou\\",\\n \\"Identifier\\": \\"05e148d8d3ecc9976d9ecd2b2f25****\\",\\n \\"Sans\\": \\"[ {\\\\\\"Type\\\\\\": 7, \\\\\\"Value\\\\\\": \\\\\\"192.0.XX.XX\\\\\\"}, {\\\\\\"Type\\\\\\": 2, \\\\\\"Value\\\\\\": \\\\\\"www.aliyundoc.com\\\\\\"}, ]\\",\\n \\"KeySize\\": 2048,\\n \\"X509Certificate\\": \\"-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----\\",\\n \\"SubjectDN\\": \\"C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun\\",\\n \\"SignAlgorithm\\": \\"SHA256WITHRSA\\",\\n \\"OrganizationUnit\\": \\"Security\\",\\n \\"AfterDate\\": 0,\\n \\"Sha2\\": \\"14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****\\",\\n \\"CommonName\\": \\"aliyun.com\\",\\n \\"Md5\\": \\"05e148d8d3ecc9976d9ecd2b2f25****\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"BeforeDate\\": 0\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetCAInstanceStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83519', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the private CA instance to query.'."\n" + ."\n" + .'> After you purchase a private CA instance in the [Certificate Management Service console](https://yundun.console.aliyun.com/?p=cas#/pca/rootlist), you can go to the **Private Certificates** page and view the **details** of the instance to obtain its ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cas-member-0hmi****', + 'title' => '', + ], + ], + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the client certificate or server-side certificate to query.'."\n" + ."\n" + .'> Call [ListClientCertificate](~~330884~~) to query the unique identifiers of all client certificates and server-side certificates.', + 'type' => 'string', + 'required' => false, + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '25589516-2A56-5159-AB88-4A1D9824E183', + 'title' => '', + ], + 'InstanceStatusList' => [ + 'description' => 'The status details of the private CA instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The object.', + 'type' => 'object', + 'properties' => [ + 'CertTotalCount' => [ + 'description' => 'The number of certificates that the private CA instance can issue.'."\n" + ."\n" + .'If the private CA is a root CA (**Type** is **ROOT**), this parameter indicates the number of intermediate CA certificates that can be issued.'."\n" + .'If the private CA is an intermediate CA (**Type** is **SUB\\_ROOT**), this parameter indicates the total number of client certificates and server-side certificates that can be issued.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the private CA instance. Valid values:'."\n" + ."\n" + .'- **BUY**: The instance is purchased but not enabled.'."\n" + ."\n" + .'- **USED**: The instance is enabled.'."\n" + ."\n" + .'- **REFUND**: A refund has been issued for the instance.'."\n" + ."\n" + .'- **REVOKE**: The instance is revoked.', + 'type' => 'string', + 'example' => 'USED', + 'title' => '', + ], + 'Type' => [ + 'description' => 'The type of the private CA instance. Valid values:'."\n" + ."\n" + .'- **ROOT**: Root CA instance.'."\n" + ."\n" + .'- **SUB\\_ROOT**: Intermediate CA instance.', + 'type' => 'string', + 'example' => 'ROOT', + 'title' => '', + ], + 'CertIssuedCount' => [ + 'description' => 'The number of certificates that the private CA instance has issued.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'BeforeTime' => [ + 'description' => 'The issuance date of the private CA certificate. This value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> This parameter is returned only if **Status** is **USED** (the private CA instance is enabled) or **REVOKE** (the private CA instance is revoked).', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1635177600000', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the private CA certificate.'."\n" + ."\n" + .'> This parameter is returned only if **Status** is **USED** (the private CA instance is enabled) or **REVOKE** (the private CA instance is revoked).', + 'type' => 'string', + 'example' => 'a7bb2dd212a2112128cd5cc9b753****', + 'title' => '', + ], + 'AfterTime' => [ + 'description' => 'The expiration date of the private CA certificate. This value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> This parameter is returned only if **Status** is **USED** (the private CA instance is enabled) or **REVOKE** (the private CA instance is revoked).', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1792944000000', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'The ID of the private CA instance.', + 'type' => 'string', + 'example' => 'cas-member-0hmi****', + 'title' => '', + ], + 'UseExpireTime' => [ + 'description' => 'The expiration date of the private CA instance. This value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> This parameter corresponds to the subscription duration that you selected for the Private Certificate Authority (PCA) service when you purchased the instance.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637251200000', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'GetCAInstanceStatus', + 'summary' => 'Queries the status of a private root or intermediate CA instance that you purchased in the Certificate Management Service console.', + 'description' => 'Use this operation to query the status of a private CA instance by its ID. The status information includes the instance\'s status, the total number of certificates it can issue, and the number of certificates already issued.'."\n" + ."\n" + .'Before you call this operation, purchase a private CA in the [Certificate Management Service console](https://yundun.console.aliyun.com/?p=cas#/pca/rootlist). For more information, see [Purchase a private CA](~~208553~~).'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'This operation has a queries per second (QPS) limit of 10 for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this operation at a reasonable rate.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCAInstanceStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:GetCAInstanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25589516-2A56-5159-AB88-4A1D9824E183\\",\\n \\"InstanceStatusList\\": [\\n {\\n \\"CertTotalCount\\": 10,\\n \\"Status\\": \\"USED\\",\\n \\"Type\\": \\"ROOT\\",\\n \\"CertIssuedCount\\": 1,\\n \\"BeforeTime\\": 1635177600000,\\n \\"Identifier\\": \\"a7bb2dd212a2112128cd5cc9b753****\\",\\n \\"AfterTime\\": 1792944000000,\\n \\"InstanceId\\": \\"cas-member-0hmi****\\",\\n \\"UseExpireTime\\": 1637251200000\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListAllEndEntityInstance' => [ + 'summary' => 'Queries end-entity instances.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '121135', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the parent instance.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '37633', + 'title' => '', + ], + ], + [ + 'name' => 'RecursiveChildren', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return information about the billing type in the response. Valid values: -**0**: The information is not returned. -**1**: The information is returned.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '9', + 'title' => '', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the instance list.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to display on each page for a paged query.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for this call.', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1000', + 'minimum' => '0', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to retrieve the next page of results. You can get this token from the \\`NextToken\\` response parameter of the previous query.', + 'type' => 'string', + 'required' => false, + 'example' => '1d2db86sca4384811e0b5e8707e68181f', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '443C05A8-6C16-52B5-BB97-5D8798F7A49A', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'The total number of records.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + 'title' => '', + ], + 'PageCount' => [ + 'description' => 'The total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'CurrentPage' => [ + 'description' => 'The page number of the instance list.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ShowSize' => [ + 'description' => 'The maximum number of entries displayed on each page of a paged query.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'The details of the end-entity instance.', + 'type' => 'any', + 'example' => "\n" + .' {'."\n" + .' "CurrentYearFreeCertCount": 0,'."\n" + .' "ParentId": 36739,'."\n" + .' "Trial": false,'."\n" + .' "InstanceId": "cas_deposit-cn-XXX",'."\n" + .' "IssuedCertCount": 29,'."\n" + .' "Algorithm": "RSA",'."\n" + .' "Gift": true,'."\n" + .' "AliasName": "pca-subordinate-XXX",'."\n" + .' "CertCount": 60,'."\n" + .' "CurrentYearIssuedFreeCertCount": 0,'."\n" + .' "Id": 36740,'."\n" + .' "HistoricalIssuedFreeCertCount": 0,'."\n" + .' "Detail": {'."\n" + .' "Identifier": "1f0d426f-8645-62ef-9bd1-XXX",'."\n" + .' "Organization": "a",'."\n" + .' "SerialNumber": "XXX",'."\n" + .' "OrganizationUnit": "a",'."\n" + .' "SubjectDN": "C=AE,ST=a,L=a,O=a,OU=a,CN=a",'."\n" + .' "CommonName": "a"'."\n" + .' }'."\n" + .' }'."\n" + .' ', + 'title' => '', + ], + 'description' => 'The list of instances.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of instances.', + 'title' => '', + 'example' => '', + ], + 'NextToken' => [ + 'description' => 'The token that you can use to retrieve the next page of results. If this parameter is empty, all results have been returned.', + 'type' => 'string', + 'example' => '1d2db86sca4384811e0b5e8707e68181f', + 'title' => '', + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned in this call.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + ], + 'title' => '', + 'description' => 'OpenApiResponse\\<PagedResultData\\<Map\\<String, Object>>>', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ListAllEndEntityInstance', + 'description' => 'This operation queries the status of a private Certificate Authority (CA) instance by its ID. It returns details for a private CA instance that you purchased in the Certificate Management Service console. These details include the instance status, the number of certificates it contains, and the number of issued certificates.'."\n" + ."\n" + .'Before calling this operation, purchase a private CA from the [Certificate Management Service console](https://yundun.console.aliyun.com/?p=cas#/pca/rootlist). For more information, see [Purchase a private CA](~~208553~~).'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed the limit, API calls are throttled, which may affect your business. Plan your calls accordingly.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListAllEndEntityInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"443C05A8-6C16-52B5-BB97-5D8798F7A49A\\",\\n \\"TotalCount\\": 23,\\n \\"PageCount\\": 1,\\n \\"CurrentPage\\": 1,\\n \\"ShowSize\\": 10,\\n \\"List\\": [\\n {\\n \\"key\\": \\"\\\\n {\\\\n \\\\\\"CurrentYearFreeCertCount\\\\\\": 0,\\\\n \\\\\\"ParentId\\\\\\": 36739,\\\\n \\\\\\"Trial\\\\\\": false,\\\\n \\\\\\"InstanceId\\\\\\": \\\\\\"cas_deposit-cn-XXX\\\\\\",\\\\n \\\\\\"IssuedCertCount\\\\\\": 29,\\\\n \\\\\\"Algorithm\\\\\\": \\\\\\"RSA\\\\\\",\\\\n \\\\\\"Gift\\\\\\": true,\\\\n \\\\\\"AliasName\\\\\\": \\\\\\"pca-subordinate-XXX\\\\\\",\\\\n \\\\\\"CertCount\\\\\\": 60,\\\\n \\\\\\"CurrentYearIssuedFreeCertCount\\\\\\": 0,\\\\n \\\\\\"Id\\\\\\": 36740,\\\\n \\\\\\"HistoricalIssuedFreeCertCount\\\\\\": 0,\\\\n \\\\\\"Detail\\\\\\": {\\\\n \\\\\\"Identifier\\\\\\": \\\\\\"1f0d426f-8645-62ef-9bd1-XXX\\\\\\",\\\\n \\\\\\"Organization\\\\\\": \\\\\\"a\\\\\\",\\\\n \\\\\\"SerialNumber\\\\\\": \\\\\\"XXX\\\\\\",\\\\n \\\\\\"OrganizationUnit\\\\\\": \\\\\\"a\\\\\\",\\\\n \\\\\\"SubjectDN\\\\\\": \\\\\\"C=AE,ST=a,L=a,O=a,OU=a,CN=a\\\\\\",\\\\n \\\\\\"CommonName\\\\\\": \\\\\\"a\\\\\\"\\\\n }\\\\n }\\\\n \\"\\n }\\n ],\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68181f\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + ], + 'ListCACertificateLog' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83520', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the CA certificate to query.'."\n" + ."\n" + .'> Call [DescribeCACertificateList](~~328095~~) to query the unique identifiers of all CA certificates.', + 'type' => 'string', + 'required' => true, + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + 'LogList' => [ + 'description' => 'A list of operation logs for the CA certificate.', + 'items' => [ + 'properties' => [ + 'Identifier' => [ + 'description' => 'The unique identifier of the CA certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'Content' => [ + 'description' => 'The description of the operation.', + 'type' => 'string', + 'example' => 'add sub-root ca', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'The time of the operation. This is a UNIX timestamp. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1634539509000', + 'title' => '', + ], + 'OpType' => [ + 'description' => 'The type of the operation. Valid values:'."\n" + ."\n" + .'- **ADD**: A CA certificate is created.'."\n" + ."\n" + .'- **UPDATE**: The status of the CA certificate is updated.', + 'type' => 'string', + 'example' => 'ADD', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => 'The object.', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => 'The object.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ListCACertificateLog', + 'summary' => 'Queries the operation logs for a CA certificate.', + 'description' => 'You can use this API to query the operation logs for a Certificate Authority (CA) certificate. These logs record operations, such as certificate creation and status changes, for both root and subordinate CA certificates.'."\n" + ."\n" + .'This API is limited to 10 queries per second (QPS) per user. API calls that exceed this limit are throttled. This can impact your business. Ensure that you call the API within this limit.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must include the common request parameters for Alibaba Cloud APIs.'."\n" + ."\n" + .'For the request format, see the request example in the **Examples** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListCACertificateLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"LogList\\": [\\n {\\n \\"Identifier\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"Content\\": \\"add sub-root ca\\",\\n \\"CreateTime\\": 1634539509000,\\n \\"OpType\\": \\"ADD\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListCert' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '158822', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => '1ef79512-569b-6a4e-9105-9b91473562f7', + 'title' => '', + ], + ], + [ + 'name' => 'BeforeDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the certificate was updated.', + 'type' => 'string', + 'required' => false, + 'example' => '2025-09-04', + 'title' => '', + ], + ], + [ + 'name' => 'AfterDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host record attached to the certificate.', + 'type' => 'string', + 'required' => false, + 'example' => '2024-05-13 12:59:45', + 'title' => '', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the certificate. Valid values:'."\n" + ."\n" + .'- ISSUE: Normal.'."\n" + ."\n" + .'- REVOKE: Revoked.', + 'type' => 'string', + 'required' => false, + 'example' => 'ISSUE', + 'title' => '', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the certificate. Valid values:'."\n" + ."\n" + .'- SERVER: Server-side certificate.'."\n" + ."\n" + .'- CLIENT: Client certificate.'."\n" + ."\n" + .'- END\\_ENTITY: End-entity certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'CLIENT', + 'title' => '', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The current page number.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The certificate size in bytes.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + 'title' => '', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for this call.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token to start the next query. An empty value indicates that there are no more results.', + 'type' => 'string', + 'required' => false, + 'example' => '1d2db86sca4384811e0b5e8707e68181f', + 'title' => '', + ], + ], + [ + 'name' => 'ParentIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'CA identity. The identity of the intermediate CA that issued the certificate.', + 'type' => 'string', + 'required' => false, + 'example' => '273ae6bb538d538c70c01f81jh2****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResponse<PagedResultData<CertificateMeta>>', + 'description' => 'OpenApiResponse\\<PagedResultData>', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of certificates.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'title' => '', + ], + 'PageCount' => [ + 'description' => 'The number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'CurrentPage' => [ + 'description' => 'The current page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ShowSize' => [ + 'description' => 'The size of the certificate in bytes.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + 'title' => '', + ], + 'List' => [ + 'description' => 'The ID of the data source associated with the certificate.', + 'type' => 'array', + 'items' => [ + 'description' => 'The certificate information.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the certificate. Valid values:'."\n" + ."\n" + .'- ISSUE: Normal.'."\n" + ."\n" + .'- REVOKE: Revoked.', + 'type' => 'string', + 'example' => 'complete', + 'title' => '', + ], + 'AfterDate' => [ + 'description' => 'The expiration time of the certificate.', + 'type' => 'string', + 'example' => '2024-05-13 12:59:45', + 'title' => '', + ], + 'Organization' => [ + 'description' => 'The organization of the certificate.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'KeyExportable' => [ + 'description' => 'Specifies whether the private key is exportable. Valid values:'."\n" + ."\n" + .'- true: The private key is exportable.'."\n" + ."\n" + .'- false: The private key is not exportable.', + 'type' => 'boolean', + 'title' => '', + 'example' => '', + ], + 'SubjectDn' => [ + 'description' => 'The subscription relationship ID.', + 'type' => 'string', + 'example' => 'SubjectDn', + 'title' => '', + ], + 'Algorithm' => [ + 'description' => 'The algorithm type.', + 'type' => 'string', + 'example' => 'RSA', + 'title' => '', + ], + 'CertificateType' => [ + 'description' => 'The type of the certificate. Valid values:'."\n" + ."\n" + .'- free: Free certificate.'."\n" + ."\n" + .'- cas: Alibaba Cloud Security certificate.'."\n" + ."\n" + .'- upload: Custom upload.', + 'type' => 'string', + 'example' => 'Server', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The certificate identifier.', + 'type' => 'string', + 'example' => '1ef539a8-1e1f-6b88-8c11-21cf01a203e9', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The certificate serial number.', + 'type' => 'string', + 'example' => '3a3ee3c3597d675e', + 'title' => '', + ], + 'Extra' => [ + 'description' => 'The extension field.', + 'type' => 'string', + 'example' => '{"appId":"APP_PFHMIGUHKDUW6S3N7ZL2"}', + 'title' => '', + ], + 'OrganizationUnit' => [ + 'description' => 'The name of the purchasing company or organization.', + 'type' => 'string', + 'example' => 'IT', + 'title' => '', + ], + 'BeforeTime' => [ + 'description' => 'The issuance time of the client certificate. This is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> The **BeforeTime** and **AfterTime** parameters must both be empty or both be set.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1728921600000', + 'title' => '', + ], + 'AliasName' => [ + 'description' => 'The name of the issued certificate.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'AfterTime' => [ + 'description' => 'The service expiration time of the client certificate. This is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> The **BeforeTime** and **AfterTime** parameters must both be empty or both be set.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1728921600000', + 'title' => '', + ], + 'Id' => [ + 'description' => 'The data source ID of the certificate order.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1806958', + 'title' => '', + ], + 'Tags' => [ + 'description' => 'The certificate tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The certificate tag.', + 'type' => 'string', + 'example' => '{"app-57074":"test"}', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CommonName' => [ + 'description' => 'The primary domain name to which the certificate is bound.', + 'type' => 'string', + 'example' => 'www.kfsjn.xyz', + 'title' => '', + ], + 'BeforeDate' => [ + 'description' => 'The issuance time of the certificate.', + 'type' => 'string', + 'example' => '2026-05-19', + 'title' => '', + ], + 'CustomIdentifier' => [ + 'description' => 'The custom identifier, which is a unique key.', + 'type' => 'string', + 'example' => '***b86sca4384811e0b5e8707e68***', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + 'NextToken' => [ + 'description' => 'The token to start the next query. An empty value indicates that there are no more results.', + 'type' => 'string', + 'example' => '1d2db86sca4384811e0b5e8707e68181f', + 'title' => '', + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries to return.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ListCert', + 'summary' => 'Retrieves a list of certificates.', + 'description' => 'The queries per second (QPS) limit for this API is 10 for each user. If you exceed this limit, your API calls are throttled, which can impact your business. We recommend that you call the API at a reasonable rate.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListCert', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"PageCount\\": 1,\\n \\"CurrentPage\\": 1,\\n \\"ShowSize\\": 50,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"complete\\",\\n \\"AfterDate\\": \\"2024-05-13 12:59:45\\",\\n \\"Organization\\": \\"test\\",\\n \\"KeyExportable\\": false,\\n \\"SubjectDn\\": \\"SubjectDn\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"CertificateType\\": \\"Server\\",\\n \\"Identifier\\": \\"1ef539a8-1e1f-6b88-8c11-21cf01a203e9\\",\\n \\"SerialNumber\\": \\"3a3ee3c3597d675e\\",\\n \\"Extra\\": \\"{\\\\\\"appId\\\\\\":\\\\\\"APP_PFHMIGUHKDUW6S3N7ZL2\\\\\\"}\\",\\n \\"OrganizationUnit\\": \\"IT\\",\\n \\"BeforeTime\\": 1728921600000,\\n \\"AliasName\\": \\"test\\",\\n \\"AfterTime\\": 1728921600000,\\n \\"Id\\": 1806958,\\n \\"Tags\\": [\\n \\"{\\\\\\"app-57074\\\\\\":\\\\\\"test\\\\\\"}\\"\\n ],\\n \\"CommonName\\": \\"www.kfsjn.xyz\\",\\n \\"BeforeDate\\": \\"2026-05-19\\",\\n \\"CustomIdentifier\\": \\"***b86sca4384811e0b5e8707e68***\\"\\n }\\n ],\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68181f\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + ], + 'ListClientCertificate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83521', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The default value is **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of certificates to return on each page. The default value is **20**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the client or server-side certificate that you want to query.'."\n" + ."\n" + .'> You can call [ListClientCertificate](~~330884~~) to query the unique identifiers of all client and server-side certificates.', + 'type' => 'string', + 'required' => false, + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. Call the [ListResources](~~2716559~~) operation to obtain this ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae******4wia', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListCertificateResponse2<CertificateWithContentDTO>', + 'description' => 'ListCertificateResponse2', + 'type' => 'object', + 'properties' => [ + 'CertificateList' => [ + 'description' => 'A list of details about the client or server-side certificates.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object.', + 'type' => 'object', + 'properties' => [ + 'X509Certificate' => [ + 'description' => 'The content of the certificate.', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the certificate.', + 'type' => 'string', + 'example' => 'd3b95700998e47afc4d95f886579****', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The serial number of the certificate.', + 'type' => 'string', + 'example' => '62b2b943a32d96883a6650e672ea0276****', + 'title' => '', + ], + 'SubjectDN' => [ + 'description' => 'The Distinguished Name (DN) of the certificate. The DN indicates the user of the certificate and contains the following information:'."\n" + ."\n" + .'- **C**: The country.'."\n" + ."\n" + .'- **O**: The organization.'."\n" + ."\n" + .'- **OU**: The department.'."\n" + ."\n" + .'- **L**: The city.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **ST**: The province, municipality, or autonomous region.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- **ST**: The province or state.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'- **CN**: The common name.', + 'type' => 'string', + 'example' => 'C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun', + 'title' => '', + ], + 'CommonName' => [ + 'description' => 'The common name of the certificate.', + 'type' => 'string', + 'example' => 'aliyundoc.com', + 'title' => '', + ], + 'OrganizationUnit' => [ + 'description' => 'The name of the department of the organization that is associated with the issuing subordinate certificate authority (CA) certificate.', + 'type' => 'string', + 'example' => 'Security', + 'title' => '', + ], + 'Organization' => [ + 'description' => 'The name of the organization that is associated with the issuing subordinate CA certificate.', + 'type' => 'string', + 'example' => '阿里云计算有限公司', + 'title' => '', + ], + 'Locality' => [ + 'description' => 'The city where the organization associated with the issuing subordinate CA certificate is located.', + 'type' => 'string', + 'example' => 'Hangzhou', + 'title' => '', + ], + 'State' => [ + 'description' => '<props="china">The name of the province, municipality, or autonomous region where the organization associated with the issuing subordinate CA certificate is located.</props>'."\n" + .'<props="intl">The name of the province or state where the organization associated with the issuing subordinate CA certificate is located.</props>', + 'type' => 'string', + 'example' => 'Zhejiang', + 'title' => '', + ], + 'CountryCode' => [ + 'description' => 'The country code of the country where the organization associated with the issuing subordinate CA certificate is located.'."\n" + ."\n" + .'For more information about country codes, see the **Country codes** section of [Manage company information](~~198289~~).', + 'type' => 'string', + 'example' => 'CN', + 'title' => '', + ], + 'Sans' => [ + 'description' => 'The Subject Alternative Name (SAN) extension of the certificate. This extension indicates other domain names, IP addresses, and so on that are associated with the certificate.'."\n" + ."\n" + .'This parameter is a string that is converted from a JSON array. Each element in the JSON array is a struct that corresponds to a SAN extension.'."\n" + .'Each SAN extension struct contains the following parameters:'."\n" + ."\n" + .'- **Type**: The type of the extension. This parameter is of the Integer type. Valid values:'."\n" + ."\n" + .' - **1**: an email address.'."\n" + ."\n" + .' - **2**: a domain name.'."\n" + ."\n" + .' - **6**: a Uniform Resource Identifier (URI).'."\n" + ."\n" + .' - **7**: an IP address.'."\n" + ."\n" + .'- **Value**: The content of the extension. This parameter is of the String type.', + 'type' => 'string', + 'example' => '[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]', + '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' => '', + ], + 'BeforeDate' => [ + 'description' => 'The issuance date of the certificate. This value is a UNIX timestamp. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1634283958000', + 'title' => '', + ], + 'AfterDate' => [ + 'description' => 'The expiration date of the certificate. This value is a UNIX timestamp. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1665819958000', + 'title' => '', + ], + 'Algorithm' => [ + 'description' => 'The type of the encryption algorithm of the certificate. Valid values:'."\n" + ."\n" + .'- **RSA**: RSA algorithm.'."\n" + ."\n" + .'- **ECC**: ECC algorithm.'."\n" + ."\n" + .'- **SM2**: SM2 algorithm.', + 'type' => 'string', + 'example' => 'RSA', + 'title' => '', + ], + 'KeySize' => [ + 'description' => 'The key length of the certificate.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4096', + 'title' => '', + ], + 'SignAlgorithm' => [ + 'description' => 'The signature algorithm of the certificate.', + 'type' => 'string', + 'example' => 'SHA256WITHRSA', + 'title' => '', + ], + 'CertificateType' => [ + 'description' => 'The type of the certificate. Valid values:'."\n" + ."\n" + .'- **CLIENT**: a client certificate.'."\n" + ."\n" + .'- **SERVER**: a server-side certificate.', + 'type' => 'string', + 'example' => 'SERVER', + 'title' => '', + ], + 'ParentIdentifier' => [ + 'description' => 'The unique identifier of the subordinate CA certificate that issued this certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'Sha2' => [ + 'description' => 'The SHA-256 fingerprint of the certificate.', + 'type' => 'string', + 'example' => '14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****', + 'title' => '', + ], + 'Md5' => [ + 'description' => 'The MD5 fingerprint of the certificate.', + 'type' => 'string', + 'example' => 'd3b95700998e47afc4d95f886579****', + 'title' => '', + ], + 'Days' => [ + 'description' => 'The validity period of the certificate. Unit: days.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '365', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the certificate belongs.', + 'type' => 'string', + 'example' => 'rg-acfmyxa2uv6cu5a', + 'title' => '', + ], + 'CustomIdentifier' => [ + 'description' => 'The custom identifier, which is a unique key.', + 'type' => 'string', + 'example' => '****48d8d3ecc9976d9ecd2b2f25****', + 'title' => '', + ], + 'Id' => [ + 'description' => 'The primary key ID of the certificate.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12321', + 'title' => '', + ], + 'AliasName' => [ + 'description' => 'The name of the issued certificate.', + 'type' => 'string', + 'example' => '生产培训10.153.13.177', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageCount' => [ + 'description' => 'The total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ShowSize' => [ + 'description' => 'The number of certificates returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'The total number of client and server-side certificates that are queried.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + 'MaxResults' => [ + 'description' => 'Paging parameter: the maximum number of entries in the result set.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ListClientCertificate', + 'summary' => 'Queries the details of all client and server-side certificates.', + 'description' => 'This API performs a paged query to retrieve the details of all client and server-side certificates that you have created. These details include the unique identifier, serial number, subject information, content, and status of each certificate.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The QPS limit for a single user is 10 calls per second. If you exceed this limit, your API calls are throttled, which may affect your business. Call this API at a reasonable rate.', + 'requestParamsDescription' => 'When you call this API, you must include the common request parameters for Alibaba Cloud APIs in addition to the request parameters described in this topic.'."\n" + ."\n" + .'For the request format, see the request example in the **Examples** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListClientCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertificateList\\": [\\n {\\n \\"X509Certificate\\": \\"-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----\\",\\n \\"Identifier\\": \\"d3b95700998e47afc4d95f886579****\\",\\n \\"SerialNumber\\": \\"62b2b943a32d96883a6650e672ea0276****\\",\\n \\"SubjectDN\\": \\"C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun\\",\\n \\"CommonName\\": \\"aliyundoc.com\\",\\n \\"OrganizationUnit\\": \\"Security\\",\\n \\"Organization\\": \\"阿里云计算有限公司\\",\\n \\"Locality\\": \\"Hangzhou\\",\\n \\"State\\": \\"Zhejiang\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"Sans\\": \\"[ {\\\\\\"Type\\\\\\": 7, \\\\\\"Value\\\\\\": \\\\\\"192.0.XX.XX\\\\\\"}, {\\\\\\"Type\\\\\\": 2, \\\\\\"Value\\\\\\": \\\\\\"www.aliyundoc.com\\\\\\"}, ]\\",\\n \\"Status\\": \\"ISSUE\\",\\n \\"BeforeDate\\": 1634283958000,\\n \\"AfterDate\\": 1665819958000,\\n \\"Algorithm\\": \\"RSA\\",\\n \\"KeySize\\": 4096,\\n \\"SignAlgorithm\\": \\"SHA256WITHRSA\\",\\n \\"CertificateType\\": \\"SERVER\\",\\n \\"ParentIdentifier\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"Sha2\\": \\"14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****\\",\\n \\"Md5\\": \\"d3b95700998e47afc4d95f886579****\\",\\n \\"Days\\": 365,\\n \\"ResourceGroupId\\": \\"rg-acfmyxa2uv6cu5a\\",\\n \\"CustomIdentifier\\": \\"****48d8d3ecc9976d9ecd2b2f25****\\",\\n \\"Id\\": 12321,\\n \\"AliasName\\": \\"生产培训10.153.13.177\\"\\n }\\n ],\\n \\"CurrentPage\\": 1,\\n \\"PageCount\\": 1,\\n \\"ShowSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + ], + 'ListPcaCaCertificate' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '241920', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token for the next page of results. Leave this parameter empty to start the query from the first page.', + 'type' => 'string', + 'required' => false, + 'example' => '1d2db86sca4384811e0b5e8707e68181f', + 'title' => '', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return on each page. The default value is 20.'."\n" + ."\n" + .'Valid values: 1 to 2000.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'NextTokenWithTotalCountPaginationResponse<ListCaCertificateResult>', + 'description' => 'The response object for the paginated list of honeypot probe data.', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'The data for the honeypot probes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data returned by the honeypot probe.', + 'type' => 'object', + 'properties' => [ + 'CertIdentifier' => [ + 'description' => 'The certificate identifier. Use this identifier to query certificate details.', + 'type' => 'string', + 'title' => '', + 'example' => '1ef78be5-******-b5ef0f0eba3d', + ], + 'Status' => [ + 'description' => 'The certificate status.', + 'type' => 'string', + 'title' => '', + 'example' => 'ISSUE', + ], + 'CommonName' => [ + 'description' => 'The common name of the certificate. This value is the same as the **CommonName** field in the **Subject** of the certificate.', + 'type' => 'string', + 'title' => '', + 'example' => 'Example Co., Ltd.', + ], + 'IssuerIdentifier' => [ + 'description' => 'The identifier of the issuer certificate. Use this identifier to query the issuer certificate.', + 'type' => 'string', + 'title' => '', + 'example' => '1ef78be5-******-b5ef0f0eba3d', + ], + 'PrivateCaInstanceId' => [ + 'description' => 'The ID of the private CA instance.', + 'type' => 'string', + 'title' => '', + 'example' => 'cas_deposit-cn-******', + ], + 'PrivateCaRegionId' => [ + 'description' => 'The region ID of the private CA instance.', + 'type' => 'string', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + 'UserId' => [ + 'description' => 'The Alibaba Cloud account ID.', + 'type' => 'string', + 'title' => '', + 'example' => '166********', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '12345678-1234-1234-1234-123456789ABC', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries in the result set.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'title' => '', + ], + 'NextToken' => [ + 'description' => 'The token for the next page of results. If this parameter is not returned, all results have been returned.', + 'type' => 'string', + 'example' => '1d2db86sca4384811e0b5e8707e68181f', + 'title' => '', + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned on each page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ListPcaCaCertificate', + 'summary' => 'Queries private CA certificates.', + 'description' => 'This operation queries the operation logs for both root and subordinate Certificate Authority (CA) certificates. These logs record operations such as certificate creation and status changes.'."\n" + ."\n" + .'This operation has a limit of 10 queries per second (QPS) for each user. If you exceed the limit, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListPcaCaCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"CertIdentifier\\": \\"1ef78be5-******-b5ef0f0eba3d\\",\\n \\"Status\\": \\"ISSUE\\",\\n \\"CommonName\\": \\"Example Co., Ltd.\\",\\n \\"IssuerIdentifier\\": \\"1ef78be5-******-b5ef0f0eba3d\\",\\n \\"PrivateCaInstanceId\\": \\"cas_deposit-cn-******\\",\\n \\"PrivateCaRegionId\\": \\"cn-hangzhou\\",\\n \\"UserId\\": \\"166********\\"\\n }\\n ],\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789ABC\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68181f\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + ], + 'ListRevokeCertificate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83522', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the results to return. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ShowSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of revoked certificates to return on each page. Default value: **20**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListCertificateResponse2<RevokedCertificateDTO>', + 'description' => 'A ListCertificateResponse2 object that contains a list of RevokedCertificateDTO objects.', + 'type' => 'object', + 'properties' => [ + 'CertificateList' => [ + 'description' => 'The details of the revoked client or server-side certificates.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object that represents a certificate.', + 'type' => 'object', + 'properties' => [ + 'RevokeDate' => [ + 'description' => 'The date when the certificate was revoked. The format is `yyyy-MM-ddT00:00Z`. For example, `2021-09-01T00:00Z` indicates September 1, 2021.', + 'type' => 'string', + 'example' => '2021-09-01T00:00Z', + 'title' => '', + ], + 'Identifier' => [ + 'description' => 'The unique identifier of the certificate.', + 'type' => 'string', + 'example' => '05e148d8d3ecc9976d9ecd2b2f25****', + 'title' => '', + ], + 'SerialNumber' => [ + 'description' => 'The serial number of the certificate.', + 'type' => 'string', + 'example' => '168b12c42e62339f8d2340ff530f9365****', + 'title' => '', + ], + 'SubjectDN' => [ + 'description' => 'The Distinguished Name (DN) of the certificate. The DN indicates the user of the certificate and contains the following information:'."\n" + ."\n" + .'- **C**: The country.'."\n" + ."\n" + .'- **O**: The organization.'."\n" + ."\n" + .'- **OU**: The department.'."\n" + ."\n" + .'- **CN**: The common name.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **ST**: The province, municipality, or autonomous region.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- **ST**: The province or state.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'- **CN**: The common name.', + 'type' => 'string', + 'example' => 'C=CN,O=阿里云计算有限公司,OU=Security,L=ZheJiang,ST=HangZhou,CN=aliyundoc.com', + 'title' => '', + ], + 'CommonName' => [ + 'description' => 'The common name of the certificate.', + 'type' => 'string', + 'example' => 'aliyundoc.com', + 'title' => '', + ], + 'OrganizationUnit' => [ + 'description' => 'The name of the department of the organization that is associated with the subordinate CA certificate that issued the certificate.', + 'type' => 'string', + 'example' => 'Security', + 'title' => '', + ], + 'Organization' => [ + 'description' => 'The name of the organization that is associated with the subordinate CA certificate that issued the certificate.', + 'type' => 'string', + 'example' => '阿里云计算有限公司', + 'title' => '', + ], + 'Locality' => [ + 'description' => 'The name of the city where the organization of the subordinate CA certificate that issued the certificate is located.', + 'type' => 'string', + 'example' => 'Hangzhou', + 'title' => '', + ], + 'State' => [ + 'description' => 'The name of the province or state of the organization that is associated with the subordinate CA certificate that issued the certificate.', + 'type' => 'string', + 'example' => 'Zhejiang', + 'title' => '', + ], + 'CountryCode' => [ + 'description' => 'The country code of the organization that is associated with the subordinate CA certificate that issued the certificate.'."\n" + ."\n" + .'For more information about country codes, see the "Country codes" section in [Manage company information](~~198289~~).', + 'type' => 'string', + 'example' => 'CN', + 'title' => '', + ], + 'Sans' => [ + 'description' => 'The Subject Alternative Name (SAN) extension of the certificate.'."\n" + ."\n" + .'This parameter is a string that is converted from a JSON array. Each element in the JSON array is a struct that corresponds to a SAN extension. Each SAN extension struct contains the following parameters:'."\n" + ."\n" + .'- **Type**: The type of the extension. This parameter is of the integer type. Valid values:'."\n" + ."\n" + .' - **1**: an email address.'."\n" + ."\n" + .' - **2**: a domain name.'."\n" + ."\n" + .' - **6**: a Uniform Resource Identifier (URI).'."\n" + ."\n" + .' - **7**: an IP address.'."\n" + ."\n" + .'- **Value**: The content of the extension. This parameter is of the string type.', + 'type' => 'string', + 'example' => '[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the certificate.', + 'type' => 'string', + 'example' => 'ISSUE', + 'title' => '', + ], + 'BeforeDate' => [ + 'description' => 'The date when the certificate was issued. The format is `yyyy-MM-ddT00:00Z`. For example, `2021-01-01T00:00Z` indicates January 1, 2021.', + 'type' => 'string', + 'example' => '2021-01-01T00:00Z', + 'title' => '', + ], + 'AfterDate' => [ + 'description' => 'The expiration date of the certificate. The format is `yyyy-MM-ddT00:00Z`. For example, `2021-12-31T00:00Z` indicates December 31, 2021.', + 'type' => 'string', + 'example' => '2021-12-31T00:00Z', + 'title' => '', + ], + 'Algorithm' => [ + 'description' => 'The type of 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' => '', + ], + 'KeySize' => [ + 'description' => 'The key length of the certificate.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4096', + 'title' => '', + ], + 'SignAlgorithm' => [ + 'description' => 'The signature algorithm of the certificate.', + 'type' => 'string', + 'example' => 'SHA256WITHRSA', + 'title' => '', + ], + 'CertificateType' => [ + 'description' => 'The type of the certificate.', + 'type' => 'string', + 'example' => 'SERVER', + 'title' => '', + ], + 'ParentIdentifier' => [ + 'description' => 'The identifier of the parent certificate.', + 'type' => 'string', + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + 'Sha2' => [ + 'description' => 'The SHA-256 fingerprint of the certificate.', + 'type' => 'string', + 'example' => 'b60eff7e04323ff662f9ab5e6986f849f626a9c7bf2c59dcc752fa23779a****', + 'title' => '', + ], + 'Md5' => [ + 'description' => 'The MD5 fingerprint of the certificate.', + 'type' => 'string', + 'example' => '05e148d8d3ecc9976d9ecd2b2f25****', + 'title' => '', + ], + 'CustomIdentifier' => [ + 'description' => 'The custom identifier. This is a unique key.', + 'type' => 'string', + 'example' => '****48d8d3ecc9976d9ecd2b2f25****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CurrentPage' => [ + 'description' => 'The page number of the current page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageCount' => [ + 'description' => 'The total number of pages returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ShowSize' => [ + 'description' => 'The number of revoked certificates on each page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'The total number of revoked client and server-side certificates.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ListRevokeCertificate', + 'summary' => 'Queries the details of all revoked client and server-side certificates.', + 'description' => 'Performs a paged query to retrieve the details of all revoked client and server-side certificates, such as the unique identifier, serial number, and revocation date.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The queries per second (QPS) limit for this API is 10 for each user. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this API at a reasonable rate.', + 'requestParamsDescription' => 'When you call this API operation, you must include the common request parameters. For more information about the request format, see the request example in the **Examples** section of this topic.'."\n" + ."\n" + .'For an example of the request format, see the **Examples** section of this topic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRevokeCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListRevokeCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertificateList\\": [\\n {\\n \\"RevokeDate\\": \\"2021-09-01T00:00Z\\",\\n \\"Identifier\\": \\"05e148d8d3ecc9976d9ecd2b2f25****\\",\\n \\"SerialNumber\\": \\"168b12c42e62339f8d2340ff530f9365****\\",\\n \\"SubjectDN\\": \\"C=CN,O=阿里云计算有限公司,OU=Security,L=ZheJiang,ST=HangZhou,CN=aliyundoc.com\\",\\n \\"CommonName\\": \\"aliyundoc.com\\",\\n \\"OrganizationUnit\\": \\"Security\\",\\n \\"Organization\\": \\"阿里云计算有限公司\\",\\n \\"Locality\\": \\"Hangzhou\\",\\n \\"State\\": \\"Zhejiang\\",\\n \\"CountryCode\\": \\"CN\\",\\n \\"Sans\\": \\"[ {\\\\\\"Type\\\\\\": 7, \\\\\\"Value\\\\\\": \\\\\\"192.0.XX.XX\\\\\\"}, {\\\\\\"Type\\\\\\": 2, \\\\\\"Value\\\\\\": \\\\\\"www.aliyundoc.com\\\\\\"}, ]\\",\\n \\"Status\\": \\"ISSUE\\",\\n \\"BeforeDate\\": \\"2021-01-01T00:00Z\\",\\n \\"AfterDate\\": \\"2021-12-31T00:00Z\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"KeySize\\": 4096,\\n \\"SignAlgorithm\\": \\"SHA256WITHRSA\\",\\n \\"CertificateType\\": \\"SERVER\\",\\n \\"ParentIdentifier\\": \\"160ae6bb538d538c70c01f81dcf2****\\",\\n \\"Sha2\\": \\"b60eff7e04323ff662f9ab5e6986f849f626a9c7bf2c59dcc752fa23779a****\\",\\n \\"Md5\\": \\"05e148d8d3ecc9976d9ecd2b2f25****\\",\\n \\"CustomIdentifier\\": \\"****48d8d3ecc9976d9ecd2b2f25****\\"\\n }\\n ],\\n \\"CurrentPage\\": 1,\\n \\"PageCount\\": 1,\\n \\"ShowSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'ListTagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81794', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'description' => 'The region ID.', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'description' => 'The resource type. Set the value to **instance**.', + 'title' => '', + 'example' => 'instance', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The token that is used to start the next query. If this parameter is empty, no more results exist.', + 'title' => '', + 'example' => '1d2db86sca4384811e0b5e8707e68181f', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The resource ID.', + 'required' => false, + 'title' => '', + 'example' => 'cas-cn-4591d3xa****', + ], + 'required' => false, + 'maxItems' => 51, + 'description' => 'The resource ID.', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'description' => 'The key of the tag to query. You can specify multiple tag keys. n is a positive integer.', + 'required' => false, + 'title' => '', + 'example' => 'testKey1', + ], + 'Value' => [ + 'type' => 'string', + 'description' => 'The tag value. The value of n can be from 1 to 20.', + 'required' => false, + 'title' => '', + 'example' => 'testValue1', + ], + ], + 'description' => 'The information about the instances and tags that are queried.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'description' => 'The information about the instances and tags that are queried.', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1000', + 'minimum' => '1', + 'default' => '1000', + 'description' => 'The maximum number of entries to return for this call.', + 'required' => false, + 'title' => '', + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + 'description' => 'The ID of the request.', + 'title' => '', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'type' => 'string', + 'description' => 'The token that is used to start the next query. If this parameter is empty, no more results exist.', + 'title' => '', + 'example' => '24262', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResources' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'type' => 'string', + 'description' => 'The ID of the resource.', + 'title' => '', + 'example' => 'cas-upload-xgjcng', + ], + 'ResourceType' => [ + 'type' => 'string', + 'description' => 'The type of the resource.', + 'title' => '', + 'example' => 'ALIYUN::CAS::PCACERTIFICATE', + ], + 'TagKey' => [ + 'type' => 'string', + 'description' => 'The key of the tag.', + 'title' => '', + 'example' => '正式环境', + ], + 'TagValue' => [ + 'type' => 'string', + 'description' => 'The value of the tag.', + 'title' => '', + 'example' => 'PVDCDC', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'MaxResults' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'The maximum number of entries returned for this call.', + 'title' => '', + 'example' => '20', + ], + ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ListTagResources', + 'summary' => 'Queries the associations between resources (SSL Certificate instances) and their tags.', + 'description' => 'Before you call this operation, you must purchase a private CA in the [Certificate Management Service console](https://yundun.console.aliyun.com/?p=cas#/pca/rootlist). For more information, see [Purchase a private CA](~~208553~~).'."\n" + ."\n" + .'You can call this operation up to 10 times per second per Alibaba Cloud account. If the number of calls per second exceeds this limit, throttling is triggered. This may affect your business. We recommend that you plan your calls accordingly.'."\n" + ."\n" + .'## QPS Limit'."\n" + ."\n" + .'You can call this operation up to 10 times per second for each Alibaba Cloud account. If the number of calls per second exceeds this limit, throttling is triggered, which may affect your business. We recommend that you plan your calls accordingly.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189484043\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"24262\\",\\n \\"TagResources\\": {\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"cas-upload-xgjcng\\",\\n \\"ResourceType\\": \\"ALIYUN::CAS::PCACERTIFICATE\\",\\n \\"TagKey\\": \\"正式环境\\",\\n \\"TagValue\\": \\"PVDCDC\\"\\n }\\n ]\\n },\\n \\"MaxResults\\": 20\\n }\\n}","type":"json"}]', + ], + 'MoveResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226097', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource to move.', + 'type' => 'string', + 'required' => true, + 'example' => 'cas-cn-4591d3xa****', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination resource group.', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-acfmykgxu5d46ey', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to **instance**.', + 'type' => 'string', + 'required' => true, + 'example' => 'instance', + 'title' => '', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'MoveResourceGroup', + 'summary' => 'Moves a resource to a different resource group.', + 'description' => 'This operation queries the status information of a private CA instance that you purchased in the Certificate Management Service console. You can query by the private CA instance ID to retrieve information such as the status of the CA instance, the number of certificates it contains, and the number of issued certificates.'."\n" + ."\n" + .'Before you call this operation, you must purchase a private CA in the [Certificate Management Service console](https://yundun.console.aliyun.com/?p=cas#/pca/rootlist). For more information, see [Purchase a private CA](~~208553~~).'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'This operation is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this operation within the specified limit.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E\\"\\n}","type":"json"}]', + ], + 'TagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81796', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'description' => 'The ID of the region.', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'description' => 'The type of the resource. Set the value to **instance**.', + 'title' => '', + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The ID of the resource.', + 'required' => false, + 'title' => '', + 'example' => 'cas-cn-4591d3xa****', + ], + 'required' => true, + 'maxItems' => 50, + 'description' => 'The IDs of the resources.', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'maxLength' => 128, + 'description' => 'The key of the tag.', + 'required' => false, + 'title' => '', + 'example' => 'testKey1', + ], + 'Value' => [ + 'type' => 'string', + 'maxLength' => 256, + 'description' => 'The value of the tag.', + 'required' => false, + 'title' => '', + 'example' => 'testValue1', + ], + ], + 'description' => 'The tags of the resource.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 20, + 'description' => 'The tags to add to the resources. You can specify up to 20 tags.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + 'description' => 'The ID of the request.', + 'title' => '', + 'example' => '9D85A4B3-8F5B-411B-A91C-EF91B5183E2E', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'TagResources', + 'summary' => 'Attaches tags to one or more resources.', + 'description' => 'This operation adds tags to one or more resources. You can add tags to private CA instances that you purchased in the Certificate Management Service console.'."\n" + ."\n" + .'Before calling this operation, purchase a private CA in the [Certificate Management Service console](https://yundun.console.aliyun.com/?p=cas#/pca/rootlist). For more information, see [Purchase a private CA](~~208553~~).'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'This operation is limited to 10 queries per second (QPS) per user. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D85A4B3-8F5B-411B-A91C-EF91B5183E2E\\"\\n}","type":"json"}]', + ], + 'UntagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81797', + 'abilityTreeNodes' => [ + 'FEATUREcasDX3LGS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'description' => 'The region ID.', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'description' => 'The type of the resource. Set the value to **instance**.', + 'title' => '', + 'example' => 'instance', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => 'Specifies whether to remove all tags. This parameter takes effect only when TagKey.N is empty. Valid values: true and false. Default value: false.', + 'title' => '', + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The resource ID.', + 'required' => false, + 'title' => '', + 'example' => 'cas-cn-4591d3xa****', + ], + 'required' => true, + 'maxItems' => 50, + 'description' => 'The resource ID.', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The tag key.', + 'required' => false, + 'title' => '', + 'example' => 'testKey1', + ], + 'required' => false, + 'maxItems' => 21, + 'description' => 'The tag key.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + 'description' => 'The request ID.', + 'title' => '', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'UntagResources', + 'summary' => 'Removes tags from resources.', + 'description' => 'This operation queries status information for a private Certificate Authority (CA) instance that you purchased in the Certificate Management Service console. You can use the private CA instance ID to retrieve information such as the instance status, the number of certificates it contains, and the number of certificates issued.'."\n" + ."\n" + .'Before you call this operation, you must purchase a private CA from the [Certificate Management Service console](https://yundun.console.aliyun.com/?p=cas#/pca/rootlist). For more information, see [Purchase a private CA](~~208553~~).'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The queries per second (QPS) limit for this operation is 10 calls per second per user. If you exceed this limit, API calls are throttled. This may affect your business. Plan your calls accordingly.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189484043\\"\\n}","type":"json"}]', + ], + 'UpdateCACertificateStatus' => [ + 'summary' => 'Changes the status of a root Certificate Authority (CA) certificate or an intermediate CA certificate from ISSUE to REVOKE.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '83523', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the CA certificate.'."\n" + ."\n" + .'> Call [DescribeCACertificateList](~~465957~~) to query the unique identifiers of all CA certificates.', + 'type' => 'string', + 'required' => true, + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation to perform on the CA certificate. Set the value to **REVOKE**. This revokes the CA certificate and changes its status to **REVOKE**.'."\n" + ."\n" + .'> This operation is supported only when the CA certificate is in the **ISSUE** state. Call [DescribeCACertificate](~~465954~~) to query the current status of the CA certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'REVOKE', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token used to ensure the idempotence of the request.'."\n" + ."\n" + .'Generate a unique parameter value from your client for each request. The ClientToken parameter supports only ASCII characters.'."\n" + ."\n" + .'> If you do not specify this parameter, the system automatically uses the **RequestId** of the API request as the **ClientToken**. The **RequestId** of each API request is different.', + 'type' => 'string', + 'required' => false, + 'example' => '3838B684-3075-582B-9A45-8C99104029DF', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + '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' => [], + ], + 'title' => 'UpdateCACertificateStatus', + 'description' => 'When you create a Certificate Authority (CA) certificate, its status is ISSUE by default. You can call this API operation to change the status of a CA certificate from ISSUE to REVOKE. A CA certificate in the ISSUE state can be used to issue certificates. A CA certificate in the REVOKE state cannot be used to issue certificates, and all certificates issued by this CA certificate become invalid.'."\n" + ."\n" + .'Before you call this API operation, create a root CA certificate by calling [CreateRootCACertificate](~~465962~~) and an intermediate CA certificate by calling [CreateSubCACertificate](~~465959~~).'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'This operation is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled. This may affect your business. Plan your calls accordingly.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCACertificateStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:UpdateCACertificateStatus', + '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"}]', + ], + 'UpdatePcaCertificate' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200358', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The alias of the certificate.', + 'type' => 'string', + 'required' => false, + 'example' => 'cert-name', + 'title' => '', + ], + ], + [ + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the CA certificate.'."\n" + ."\n" + .'> Call [DescribeCACertificateList](~~328095~~) to query the unique identifiers of all CA certificates.', + 'type' => 'string', + 'required' => false, + 'example' => '160ae6bb538d538c70c01f81dcf2****', + 'title' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + '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' => 'test', + 'title' => '', + ], + ], + 'description' => 'The list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'maxItems' => 100, + 'description' => 'The list of tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae******4wia', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A client token used to ensure the idempotence of the request. The client generates this value to make sure that it is unique among different requests. The token can be a maximum of 64 ASCII characters and cannot contain non-ASCII characters.', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '09470F19-CEE8-5C63-BF2C-02B5E3F07A17', + ], + 'AccessDeniedDetail' => [ + 'type' => 'object', + 'properties' => [ + 'AuthAction' => [ + 'description' => 'The unauthorized operation that you attempted to perform.', + 'type' => 'string', + 'example' => 'yundun-cert:XXX', + 'title' => '', + ], + 'AuthPrincipalDisplayName' => [ + 'description' => 'The identity that is used for authorization in the request. Valid values:'."\n" + ."\n" + .'- RAM user: UID of the RAM user'."\n" + ."\n" + .'- RAM role: RoleName:RoleSessionName'."\n" + ."\n" + .'- Federated user: ProviderType/ProviderName', + 'type' => 'string', + 'example' => 'RoleSessionName', + 'title' => '', + ], + 'AuthPrincipalOwnerId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the authorized principal belongs.', + 'type' => 'string', + 'example' => '186XXX', + 'title' => '', + ], + 'AuthPrincipalType' => [ + 'description' => 'The type of the identity.', + 'type' => 'string', + 'example' => 'SubUser', + 'title' => '', + ], + 'EncodedDiagnosticMessage' => [ + 'description' => 'The complete diagnostic information that is encrypted.', + 'type' => 'string', + 'example' => 'AQEAAAAAaEjlETkzRkQ5QjVELTI3NTEtM0I2Ni1BM0E1LThBQUYzMkJBNEJCQg==', + 'title' => '', + ], + 'NoPermissionType' => [ + 'description' => 'The reason why the authorization failed. Valid values:'."\n" + .'ExplicitDeny: The authorization is explicitly denied.'."\n" + .'ImplicitDeny: The authorization is implicitly denied.', + 'type' => 'string', + 'example' => 'ImplicitDeny', + 'title' => '', + ], + 'PolicyType' => [ + 'description' => 'The type of the policy.', + 'type' => 'string', + 'example' => 'Custom', + 'title' => '', + ], + ], + 'description' => 'The error details of the authorization.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'UpdatePcaCertificate', + 'summary' => 'Updates the properties of a certificate.', + 'description' => 'When a Certificate Authority (CA) certificate is created, its status is Normal by default. You can call this API operation to change the status of a CA certificate to Revoked. A CA certificate in the Normal status can be used to issue certificates. A revoked CA certificate cannot be used to issue certificates, and all certificates previously issued by it become invalid.'."\n" + ."\n" + .'Before you call this API operation, you must create a root CA certificate by calling [CreateRootCACertificate](~~465962~~) and a subordinate CA certificate by calling [CreateSubCACertificate](~~465959~~).'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'This API operation is limited to 10 queries per second (QPS) per user. If you exceed this limit, API calls are throttled, which may affect your business. Call this API operation at a reasonable rate.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:UpdatePcaCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09470F19-CEE8-5C63-BF2C-02B5E3F07A17\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"yundun-cert:XXX\\",\\n \\"AuthPrincipalDisplayName\\": \\"RoleSessionName\\",\\n \\"AuthPrincipalOwnerId\\": \\"186XXX\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaEjlETkzRkQ5QjVELTI3NTEtM0I2Ni1BM0E1LThBQUYzMkJBNEJCQg==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"Custom\\"\\n }\\n}","type":"json"}]', + ], + 'UploadPcaCertToCas' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcasPYG3UJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of primary key identifiers to synchronize to Certificate Service. Separate multiple IDs with commas (,).', + 'type' => 'string', + 'required' => true, + 'example' => '59425,59426', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'cas::2020-06-30::ListCert', + 'callbackInterval' => 3000, + 'maxCallbackTimes' => 10, + ], + 'title' => 'UploadPcaCertToCas', + 'summary' => 'Uploads a PCA certificate to Certificate Service.', + 'description' => 'This API operation uploads a PCA certificate to a certificate repository.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'This operation has a queries per second (QPS) limit of 10 calls per second for each user. If you exceed the limit, your API calls are throttled. Throttling may affect your business. We recommend that you call this operation at a reasonable rate.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadPcaCertToCas', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:UploadPcaCertToCas', + '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"}]', + ], + ], + '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' => '', + ], + [ + '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' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateServerCertificate', + ], + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteClientCertificate', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCACertificateCount', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCAInstanceStatus', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRevokeCertificate', + ], + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeClientCertificate', + ], + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateServerCertificateWithCsr', + ], + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateCustomCertificate', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListClientCertificate', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadPcaCertToCas', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeClientCertificateStatus', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRootCACertificate', + ], + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateClientCertificateWithCsr', + ], + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRevokeClientCertificate', + ], + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateClientCertificate', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateSubCACertificate', + ], + [ + 'threshold' => '1000', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCACertificate', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCertificatePrivateKey', + ], + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCACertificateList', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCACertificateStatus', + ], + ], + ], + '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' => 'AssignCertificateCount', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:AssignCertificateCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeCACertificateCount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeCACertificateCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateServerCertificateWithCsr', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateServerCertificateWithCsr', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateSubCACertificate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateSubCACertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteClientCertificate', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'yundun-cert:DeleteClientCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateClientCertificateWithCsr', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateClientCertificateWithCsr', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListCACertificateLog', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListCACertificateLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdatePcaCertificate', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:UpdatePcaCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListAllEndEntityInstance', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListAllEndEntityInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeClientCertificateStatusForSerialNumber', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeClientCertificateStatusForSerialNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateCustomCertificate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateCustomCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeCACertificate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeCACertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeCertificatePrivateKey', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeCertificatePrivateKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateCACertificateStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:UpdateCACertificateStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeCACertificateList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeCACertificateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListClientCertificate', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListClientCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeClientCertificateForSerialNumber', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeClientCertificateForSerialNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeClientCertificateStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeClientCertificateStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListPcaCaCertificate', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListPcaCaCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateServerCertificate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateServerCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListCert', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListCert', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribePcaAndExternalCACertificateList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribePcaAndExternalCACertificateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeClientCertificate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:DescribeClientCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UploadPcaCertToCas', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:UploadPcaCertToCas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateExternalCACertificate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateExternalCACertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'MoveResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:MoveResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListRevokeCertificate', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListRevokeCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-cert:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetCAInstanceStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-cert:GetCAInstanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRootCACertificate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateRootCACertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRevokeClientCertificate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateRevokeClientCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateClientCertificate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-cert:CreateClientCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-cert:ListTagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'SSLCertificatesService', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'resourceTypes' => [], + ], +]; |