更新CA证书
功能介绍
应用服务器可调用此接口在物联网平台上更新CA证书。仅标准版实例、企业版实例支持该接口调用,基础版不支持。
调用方法
请参见如何调用API。
URI
PUT /v5/iot/{project_id}/certificates/{certificate_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见 获取项目ID 。 |
certificate_id |
是 |
String |
CA证书ID,在上传CA证书时由平台分配的唯一标识。 最小长度:1 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。。 |
Instance-Id |
否 |
String |
实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
provision_enable |
否 |
Boolean |
是否开启自注册能力,当为true时该功能必须配合预调配功能使用,true:是,false:否。 |
template_id |
否 |
String |
预调配模板ID,该CA证书绑定的预调配模板id,当该字段传null时表示解除绑定关系。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
certificate_id |
String |
CA证书ID,在上传CA证书时由平台分配的唯一标识。 |
cn_name |
String |
CA证书CN名称。 |
owner |
String |
CA证书所有者。 |
status |
Boolean |
CA证书验证状态。true代表证书已通过验证,可进行设备证书认证接入。false代表证书未通过验证。 |
verify_code |
String |
CA证书验证码。 |
provision_enable |
Boolean |
是否开启自注册能力,当为true时该功能必须配合预调配功能使用,true:是,false:否。 |
template_id |
String |
绑定的预调配模板ID。 |
create_date |
String |
创建证书日期。格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。 |
effective_date |
String |
CA证书生效日期。格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。 |
expiry_date |
String |
CA证书失效日期。格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。 |
请求示例
证书关联自注册模板,并开启自注册功能。
PUT https://{endpoint}/v5/iot/{project_id}/certificates/{certificate_id} { "template_id" : "61c970ce2d63eb6ee655dbf0", "provision_enable" : true }
响应示例
状态码: 200
Successful response
{ "certificate_id" : "string", "cn_name" : "string", "owner" : "string", "status" : true, "verify_code" : "string", "provision_enable" : true, "template_id" : "61c970ce2d63eb6ee655dbf0", "create_date" : "20191212T121212Z", "effective_date" : "20191212T121212Z", "expiry_date" : "20221212T121212Z" }
SDK代码示例
SDK代码示例如下。
证书关联自注册模板,并开启自注册功能。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.AbstractCredentials; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.core.region.Region; import com.huaweicloud.sdk.iotda.v5.*; import com.huaweicloud.sdk.iotda.v5.model.*; public class UpdateCertificateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); // ENDPOINT:请在控制台的"总览"界面的"平台接入地址"中查看“应用侧”的https接入地址。 String iotdaEndpoint = "<YOUR ENDPOINT>"; ICredential auth = new BasicCredentials() // 标准版/企业版需要使用衍生算法,基础版请删除配置"withDerivedPredicate"; .withDerivedPredicate(AbstractCredentials.DEFAULT_DERIVED_PREDICATE) // Used in derivative ak/sk authentication scenarios .withAk(ak) .withSk(sk); IoTDAClient client = IoTDAClient.newBuilder() .withCredential(auth) // 标准版/企业版:需自行创建Region对象,基础版:请使用IoTDARegion的region对象,如"withRegion(IoTDARegion.CN_NORTH_4)" .withRegion(new Region("cn-north-4", iotdaEndpoint)) .build(); UpdateCertificateRequest request = new UpdateCertificateRequest(); UpdateCertificateDTO body = new UpdateCertificateDTO(); body.withTemplateId("61c970ce2d63eb6ee655dbf0"); body.withProvisionEnable(true); request.withBody(body); try { UpdateCertificateResponse response = client.updateCertificate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
证书关联自注册模板,并开启自注册功能。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcore.auth.credentials import DerivedCredentials from huaweicloudsdkcore.region.region import Region as coreRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkiotda.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] // ENDPOINT:请在控制台的"总览"界面的"平台接入地址"中查看“应用侧”的https接入地址。 iotdaEndpoint = "<YOUR ENDPOINT>"; credentials = BasicCredentials(ak, sk).with_derived_predicate(DerivedCredentials.get_default_derived_predicate()) client = IoTDAClient.new_builder() \ .with_credentials(credentials) \ # 标准版/企业版:需要使用自行创建的Region对象,基础版:请选择IoTDAClient中的Region对象 如: .with_region(IoTDARegion.CN_NORTH_4) .with_region(coreRegion(id="cn-north-4", endpoint=endpoint)) \ .build() try: request = UpdateCertificateRequest() request.body = UpdateCertificateDTO( template_id="61c970ce2d63eb6ee655dbf0", provision_enable=True ) response = client.update_certificate(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
证书关联自注册模板,并开启自注册功能。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" iotda "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/region" core_auth "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") // endpoint:请在控制台的"总览"界面的"平台接入地址"中查看"应用侧"的https接入地址 endpoint := "<YOUR ENDPOINT>" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). // 企业版/标准版需要使用衍生算法,基础版请删除该配置"WithDerivedPredicate" WithDerivedPredicate(core_auth.GetDefaultDerivedPredicate()). // Used in derivative ak/sk authentication scenarios Build() client := iotda.NewIoTDAClient( iotda.IoTDAClientBuilder(). // 标准版/企业版需要自行创建region,基础版使用IoTDARegion中的region对象 WithRegion(region.NewRegion("cn-north-4", endpoint)). WithCredential(auth). Build()) request := &model.UpdateCertificateRequest{} templateIdUpdateCertificateDto:= "61c970ce2d63eb6ee655dbf0" provisionEnableUpdateCertificateDto:= true request.Body = &model.UpdateCertificateDto{ TemplateId: &templateIdUpdateCertificateDto, ProvisionEnable: &provisionEnableUpdateCertificateDto, } response, err := client.UpdateCertificate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Successful response |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
403 |
Forbidden |
500 |
Internal Server Error |
错误码
请参见错误码。