CreateSecret-阿里云帮助中心

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

sae:CreateSecret

*All Resource

*

None

Request syntax

POST /pop/v1/sam/secret/secret HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	The ID of the namespace where the Secret resides. If the namespace is the default namespace, you need to only enter the region ID, such as `cn-beijing`.	cn-beijing:test
SecretName	string	Yes	The Secret name. The name can contain digits, letters, and underscores (_). The name must start with a letter.	registry-auth-acree
SecretType	string	Yes	The supported Secret type. Valid values: kubernetes.io/dockerconfigjson: the Secret for the username and password of the image repository. The Secret is used for authentication when images are pulled during application deployment. Valid values: Opaque kubernetes.io/dockerconfigjson kubernetes.io/tls	kubernetes.io/dockerconfigjson
SecretData	object	Yes	The Secret data.
SecretData	string	Yes	The information about the key-value pairs of the Secret. This parameter is required. The following formats are supported: {"Data":"{"k1":"v1", "k2":"v2"}"} k specifies a key and v specifies a value.	{".dockerconfigjson":"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0="}

Example 1: Use a username and password to pull an image from Container Registry over an internal network across accounts

Enter both the public and internal domain names.
Configure the username, password, and auth fields to prevent authentication failures. The format of auth is base64Encode($username:$password).

The following code describes the default formats of the field values:

SecretData[".dockerconfigjson"]=base64Encode(
{
  "auths": {
    "registry-vpc.cn-beijing.aliyuncs.com": {  // $internal domain name
      "username": "username",
      "password": "password",
      "auth": "dXNlcm5hbWU6cGFzc3dvcmQ="
    },
    "registry.cn-beijing.aliyuncs.com": {     // $public domain name      "username": "username",                 // $username
      "password": "password",                 // $password
      "auth": "dXNlcm5hbWU6cGFzc3dvcmQ="      // base64Encode($username:$password)
    }
  }
} )

Response elements

Element	Type	Description	Example
	object	The queried polices.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The message returned for the operation.	success
TraceId	string	The ID of the trace. The ID is used to query the details of a request.	0a98a02315955564772843261e****
Data	object	The returned result.
SecretId	integer	The ID of the created Secret.	16
ErrorCode	string	The status code. Value values: If the request was successful, ErrorCode is not returned. If the request failed, ErrorCode is returned. For more information, see Error codes in this topic.	400
Code	string	The HTTP status code or the error code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the Secret was created. Valid values: true: The ConfigMap was created. false: The ConfigMap failed to be created.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "SecretId": 16
  },
  "ErrorCode": "400",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	SecretNameConflict.AlreadyExist	The specified SecretName [%s] already exist in this namespace.
400	QuotaExceeded.SecretInNamespace	The specified secret exceeded quota [%s].
400	QuotaExceeded.SecretDataKey	The specified key in SecretData exceeded quota [%s].
400	InvalidSecretType.NotAvailable	The specified SecretType [%s] is not supported.
400	InvalidSecretDataKey.NotFound	The specified Key [%s] does not exist in the specified Secret [%s].
500	OperationFailed.RPCError	Internal RPC request processing error.	Internal RPC request processing error.
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.