接口功能介绍
创建证书,该接口为异步接口,第一次请求会返回资源在创建中,需要用户发起多次请求,直到 status 为 done 为止。
接口约束
当前接口使用前使用资源池概况信息查询接口查询待对接的资源池信息,如资源池概况信息查询结果为"regionVersion":"v3.0",即可使用;如资源池概况信息结果为"regionVersion":"v4.0",请使用API内接口创建证书。
URI
POST /v4/elb/async-create-certificate
请求参数
请求Body参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
clientToken | String | 是 | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | |
regionID | String | 是 | 资源池ID | |
azName | String | 否 | 可用区名称 | |
projectID | String | 否 | 企业项目ID,默认为"0" | |
name | String | 是 | 监听器证书名称 | |
description | String | 否 | 描述 | |
type | String | 是 | 证书类型。取值范围:Server(服务器证书)、Ca(Ca证书) | |
privateKey | String | 否 | 服务器证书私钥,服务器证书此字段必填 | |
certificate | String | 是 | type为Server该字段表示服务器证书公钥Pem内容;type为Ca该字段表示Ca证书Pem内容 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 |
message | String | statusCode为900时的错误信息,英文 | success |
descritption | String | statusCode为800时的错误信息,中文 | |
errorCode | String | 错误明细 | SUCCESS |
returnObj | Object | 返回结果 | 见下表 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
status | String | 创建进度: in_progress / done | in_progress |
message | String | 进度说明 | 请使用相同请求,进行重试 |
certificateID | String | 负载均衡ID,可能为 null | edbe1a3e-bac3-48a5-9357-d9239d7d1577 |
请求示例
POST /v4/elb/async-create-certificate
请求体Body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"name": "yacos_test",
"description": "yacos_test",
"type": "Ca",
"privateKey": "abc",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDaTCCAlGgAwIBAgIJAJcFQVjMvmi/MA0GCSqGSIb3DQEBCwUAMEsxCzAJBgNV\nBAYTAkNOMRAwDgYDVQQHDAdCZWlqaW5nMQ4wDAYDVQQKDAVDVHl1bjEaMBgGA1UE\nAwwRbmV0cHJvYmUuY3R5dW4uY24wHhcNMjIwMTA3MDY0ODMzWhcNMzIwMTA1MDY0\nODMzWjBLMQswCQYDVQQGEwJDTjEQMA4GA1UEBwwHQmVpamluZzEOMAwGA1UECgwF\nQ1R5dW4xGjAYBgNVBAMMEW5ldHByb2JlLmN0eXVuLmNuMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3jBGvTz3PgMW+cRvNtgXEPAH7XeEDQqB67fHTOD+\nIbcCwyl2xpCwhFNq3BAJv+UAsgl5jIxNQBPJpQ6DsZqRGVdMlaeqHzVoiaEigMMS\ncLJqFAwjrNwv2vZ3WVX8/7hW+EBdfWf61WcLFHNajMMREWGLCc6ESjHEgubdFNOl\nK7tfppNIQQDpXBsk51TmpndpNdjMmmd8ICIDhPHwniZmpKZTTLlxSZxy24hRGk1W\nOEDjPO1qchx+HmFP+1Nsez/zQjhMEc6XF6NXuAcr9Z9ul1BzQ+JORZ+2xk9qfTfT\nkL+F03zokAAgyeHS3ug7xDxc1d94RFGSbjAyxcvL2RqSBQIDAQABo1AwTjAdBgNV\nHQ4EFgQUUTICeidDhrIpZrjJEmHSX7qVAZ8wHwYDVR0jBBgwFoAUUTICeidDhrIp\nZrjJEmHSX7qVAZ8wDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAJe3a\nTmAGB+xEv6J3CVBvY/KM5Cq1FlczldgqWtqqfxRbSsGyNeMUOQAavhV6IxMapffi\n4QHv/gj1ADFWT8qXHhzynfTZhZeV/hHpGvm9XyfrbTN/RQDyn3OabXg+RmQ9G/4C\nW5KGp0Vq5AclQ0gSSoPu0a3TVW674n2aKo1W4TM/bIl+ZIU6NEPE8CeDmT8BM9ej\nnJ0abL4dCokYqztAAEOJIoYeGfzHWvvaleFMUiDYokBfS7g/E3FfDClDi8p9FoPu\nGimfrM61TukYo/MaY9ne2Rw1uOOcePPLrKlZinpG9r+FX9ISLnbKuheLcijeCsws\nKB3FnWzcDWLfZyjCLg==\n-----END CERTIFICATE-----\n"
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": {
"status": "in_progress",
"message": "请使用相同请求,进行重试",
"certificateID": null
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。