Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
18 KiB
Managing the Administrator Password (a V3 API)
Function
If it is the first time to call this API, it is used to create an administrator and reset its password for a DDM instance. Then this API can only be used to update the administrator password.
URI
PUT /v3/{project_id}/instances/{instance_id}/admin-user
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID of a tenant in a region |
instance_id |
Yes |
String |
DDM instance ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Content-Type |
Yes |
String |
MIME type of the request body. Value range:
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
name |
Yes |
String |
Username of the administrator. The username:
|
password |
Yes |
String |
Password of the administrator. The password:
|
Response Parameters
Status code: 202
Parameter |
Type |
Description |
|---|---|---|
job_id |
String |
Task ID |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
errCode |
String |
Service error code |
externalMessage |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
|---|---|---|
errCode |
String |
Service error code |
externalMessage |
String |
Error message |
Example Request
PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/admin-user
{
"name" : "root",
"password" : "****"
}
Example Response
Status code: 202
OK
{
"job_id" : "b9e057a0-f0fb-4987-9d21-f3a7550b32e7"
}
Status code: 400
bad request
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
}
Status code: 500
server error
{
"externalMessage" : "Server failure.",
"errCode" : "DBS.200412"
}
Status Codes
Status Code |
Description |
|---|---|
202 |
OK |
400 |
bad request |
500 |
server error |
Error Codes
For details, see Error Codes.