UpdateInstance - Certificate Management Service - Alibaba Cloud Documentation Center

Updates an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:UpdateInstance

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	cas-cn-68n1mm16****
CertificateName	string	No	The name of the instance. When a certificate is issued, this name is used as the default name of the certificate.	123
Domain	string	No	The domain name to which the certificate is bound. Requirements: You can specify a single domain name or a wildcard domain name (for example, `.aliyundoc.com`). You can specify multiple domain names. Separate multiple domain names with commas (,). Whether a free domain name is included is determined based on the first domain name. Important* When the certificate is bound to multiple domain names, this parameter is required. This parameter and the Csr parameter cannot both be empty. If you specify both this parameter and the Csr parameter, the CN field value in the Csr parameter is used as the domain name to which the certificate is bound.	test.com
KeyAlgorithm	string	No	The certificate algorithm. Default value: RSA_2048. Valid values: RSA_2048 RSA_3072 RSA_4096 ECC_256 SM2	RSA_2048
AutoReissue	string	No	Specifies whether to enable automatic hosting. Valid values: enable: Enabled. disable: Disabled.	enable
CompanyId	integer	No	The company information ID. This parameter is required for OV and EV certificates. Otherwise, you cannot call the ApplyCertificate operation to apply for a certificate.	44211
ContactIdList	array	No	The list of contact IDs. If a contact already exists, you do not need to specify this parameter. If no contact has been configured, specify at least one contact ID. Otherwise, you cannot call the ApplyCertificate operation to apply for a certificate.
	integer	No	The contact information ID.	123
GenerateCsrMethod	string	No	The method used to generate the certificate signing request (CSR). Default value: online. Valid values: online: The system generates the CSR. The Csr parameter is ignored. upload: You upload the CSR. The Csr parameter is required.	online
Csr	string	No	The CSR content. You can use OpenSSL or Keytool to generate a CSR. For more information, see How do I create a CSR file?.	-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
ValidationMethod	string	No	The validation method for the certificate application. Valid values: DNS: DNS validation, which uses TXT or CNAME records. HTTP: File validation.	DNS
City	string	No	The city where the company or organization of the certificate purchaser is located. This field is required when generating a CSR for a DV certificate. Default value: Beijing.	Beijing
Province	string	No	The province or region where the company is located. This field is required when generating a CSR for a DV certificate. Default value: Beijing.	Beijing
CountryCode	string	No	The country or region code of the certificate organization. For example, CN indicates China and US indicates the United States. This field is required when generating a CSR for a DV certificate. Default value: CN.	CN
ResourceGroupId	string	No	The ID of the resource group.	rg-ae******4wia
Tags	array<object>	No	The list of tags.
	object	No	The list of tags.
TagKey	string	No	The tag key of the instance. Valid values of N: 1 to 20. If you specify this parameter, the value cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	test
TagValue	string	No	The tag value of the instance. Valid values of N: 1 to 20. If you specify this parameter, the value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	0068247C-A454-5FC9-93BF-C41CBB5CD19E

Examples

Success response

JSON format

{
  "RequestId": "0068247C-A454-5FC9-93BF-C41CBB5CD19E"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.